Module Fields

This document describes the default MODULE fields provided by the Lilia framework. Use these to configure module metadata, dependencies, loading behavior, and lifecycle hooks.

Unspecified fields will use sensible defaults.

Overview

A MODULE table defines a self-contained add-on for the Lilia framework. Each field controls how the module is identified, loaded, and interacts with permissions and workshop content.

Field Summary

Field	Type	Default	Description
`name`	`string`	`"Unknown"`	Identifies the module in logs and UI.
`author`	`string`	`"Anonymous"`	Name or SteamID64 of the module’s author.
`discord`	`string`	`""`	Discord tag or support channel.
`version`	`string`	`""`	Version string for compatibility checks.
`desc`	`string`	`"No Description"`	Short description of module functionality.
`CAMIPrivileges`	`table`	`nil`	CAMI privileges defined or required by the module.
`WorkshopContent`	`table`	`nil`	Steam Workshop add-on IDs required.
`enabled`	`boolean` or `function`	`true`	Controls whether the module loads.
`Dependencies`	`table`	`nil`	Files or folders required for the module to run.
`folder`	`string`	`""`	Filesystem path where the module resides.
`path`	`string`	`""`	Absolute path to the module’s root directory.
`uniqueID`	`string`	`""`	Internal identifier for the module list.
`loading`	`boolean`	`false`	True while the module is in the process of loading.
`ModuleLoaded`	`function`	`nil`	Callback run after module finishes loading.
`Public`	`boolean`	`false`	Participates in public version checks.
`Private`	`boolean`	`false`	Uses private version checking.

Field Details

Identification & Metadata

`name`

Type:

string

Description:

Identifies the module in logs and UI elements.

Example Usage:

MODULE.name = "My Module"

`author`

Type:

string

Description:

Name or SteamID64 of the module’s author.

Example Usage:

MODULE.author = "Samael"

`discord`

Type:

string

Description:

Discord tag or support channel for the module.

Example Usage:

MODULE.discord = "@liliaplayer"

`desc`

Type:

string

Description:

Short description of what the module provides.

Example Usage:

MODULE.desc = "Adds a Chatbox"

Version & Compatibility

`version`

Type:

string

Description:

Version string used for compatibility checks.

Example Usage:

MODULE.version = "1.0"

`Public`

Type:

boolean

Description:

When true, the module participates in public version checks.

Example Usage:

MODULE.Public = true

`Private`

Type:

boolean

Description:

When true, the module uses private version checking.

Example Usage:

MODULE.Private = true

Dependencies & Content

`CAMIPrivileges`

Type:

table

Description:

CAMI privileges required or provided by the module.

Example Usage:

MODULE.CAMIPrivileges = {
    { Name = "Staff Permissions - Admin Chat", MinAccess = "admin" }
}

`WorkshopContent`

Type:

table

Description:

Steam Workshop add-on IDs required by this module.

Example Usage:

MODULE.WorkshopContent = {
    "2959728255", -- shared assets
    "1234567890"  -- map data
}

`Dependencies`

Type:

table

Description:

Files or folders that this module requires to run.

Example Usage:

MODULE.Dependencies = {
    { File = "logs.lua", Realm = "server" },
    { Folder = "libs", Realm = "shared" },
}

Loading & Lifecycle

`enabled`

Type:

boolean or function

Description:

Controls whether the module loads. Can be a static boolean or a function returning a boolean.

Example Usage:

-- Enabled by default
MODULE.enabled = true

-- Or evaluate a configuration value
MODULE.enabled = function()
    return lia.config.get("EnableMyModule", true)
end

`loading`

Type:

boolean

Description:

True while the module is in the process of loading.

Example Usage:

if MODULE.loading then return end

`ModuleLoaded`

Type:

function

Description:

Optional callback run after the module finishes loading.

Example Usage:

function MODULE:ModuleLoaded()
    print("Module fully initialized")
end

Access & Visibility

`folder`

Type:

string

Description:

Filesystem path where the module is located.

Example Usage:

print(MODULE.folder)

`path`

Type:

string

Description:

Absolute path to the module’s root directory.

Example Usage:

print(MODULE.path)

`uniqueID`

Type:

string

Description:

Identifier used internally for the module list.

Example Usage:

print(MODULE.uniqueID)