Config Library

This page documents the functions for working with configuration and settings.

---

Overview

The config library (lia.config) provides a comprehensive system for managing server configurations, settings, and options in the Lilia framework, serving as the core configuration management system that enables flexible and dynamic server customization through centralized settings control. This library handles sophisticated configuration management with support for multiple configuration types, dynamic value updates, and real-time configuration synchronization that enables responsive server administration and seamless configuration changes. The system features advanced configuration registration with support for custom configuration definitions, value validation, and automatic configuration discovery that allows for flexible and extensible configuration management throughout the framework. It includes comprehensive value management with support for typed configurations, default value handling, and configuration inheritance that ensures consistent and reliable configuration behavior across all server components. The library provides robust configuration networking with support for client-server synchronization, real-time updates, and configuration caching that ensures optimal performance and consistent configuration state across all connected clients. Additional features include integration with the framework's persistence system for configuration storage, performance optimization for large configuration databases, and comprehensive administrative interfaces that enable intuitive configuration management and provide powerful server customization capabilities, making it essential for creating flexible and maintainable server configurations that adapt to different gameplay scenarios and administrative needs.

---

add

Purpose

Adds a new configuration option to the config system.

Parameters

• key (string): The configuration key.
• data (table): The configuration data table containing type, default, etc.

Returns

None

Realm

Shared.

Example Usage

-- Add a basic configuration option
lia.config.add("ServerName", {
    type = "string",
    default = "My Server",
    category = "General"
})

-- Add a configuration with more options
lia.config.add("MaxPlayers", {
    type = "number",
    default = 32,
    min = 1,
    max = 128,
    category = "Server",
    onChanged = function(oldValue, newValue)
        print("Max players changed from " .. oldValue .. " to " .. newValue)
    end
})

-- Add a boolean configuration
lia.config.add("EnablePVP", {
    type = "boolean",
    default = true,
    category = "Gameplay"
})

-- Add a color configuration
lia.config.add("ThemeColor", {
    type = "color",
    default = Color(255, 0, 0),
    category = "UI"
})

---

getOptions

Purpose

Gets all configuration options.

Parameters

None

Returns

• options (table): Table of all configuration options.

Realm

Shared.

Example Usage

-- Get all configuration options
local function getAllOptions()
    return lia.config.getOptions()
end

-- Use in a function
local function showAllOptions()
    local options = lia.config.getOptions()
    for key, data in pairs(options) do
        print("Option: " .. key .. " = " .. tostring(data.default))
    end
end

-- Use in a configuration menu
local function createConfigMenu()
    local options = lia.config.getOptions()
    local menu = vgui.Create("DFrame")

    for key, data in pairs(options) do
        local label = vgui.Create("DLabel", menu)
        label:SetText(key .. ": " .. tostring(data.default))
    end

    return menu
end

---

setDefault

Purpose

Sets the default value for a configuration option.

Parameters

• key (string): The configuration key.
• value (any): The default value to set.

Returns

None

Realm

Shared.

Example Usage

-- Set default value for a configuration
lia.config.setDefault("ServerName", "My New Server")

-- Set default value for multiple configurations
local function setDefaults()
    lia.config.setDefault("MaxPlayers", 64)
    lia.config.setDefault("EnablePVP", false)
    lia.config.setDefault("ThemeColor", Color(0, 255, 0))
end

-- Use in a function
local function resetToDefaults()
    local options = lia.config.getOptions()
    for key, data in pairs(options) do
        lia.config.setDefault(key, data.default)
    end
end

---

forceSet

Purpose

Forces a configuration value to be set without triggering callbacks.

Parameters

• key (string): The configuration key.
• value (any): The value to set.

Returns

None

Realm

Server.

Example Usage

-- Force set a configuration value
lia.config.forceSet("ServerName", "Forced Server Name")

-- Force set multiple values
local function forceSetMultiple()
    lia.config.forceSet("MaxPlayers", 100)
    lia.config.forceSet("EnablePVP", true)
end

-- Use in a function
local function updateConfigSilently(key, value)
    lia.config.forceSet(key, value)
    print("Configuration updated silently: " .. key)
end

---

set

Purpose

Sets a configuration value and triggers callbacks.

Parameters

• key (string): The configuration key.
• value (any): The value to set.

Returns

None

Realm

Server.

Example Usage

-- Set a configuration value
lia.config.set("ServerName", "New Server Name")

-- Set multiple values
local function updateConfigs()
    lia.config.set("MaxPlayers", 64)
    lia.config.set("EnablePVP", true)
    lia.config.set("ThemeColor", Color(255, 0, 0))
end

-- Use in a command
lia.command.add("setconfig", {
    arguments = {
        {name = "key", type = "string"},
        {name = "value", type = "string"}
    },
    privilege = "Admin Access",
    onRun = function(client, arguments)
        lia.config.set(arguments[1], arguments[2])
        client:notify("Configuration updated: " .. arguments[1])
    end
})

---

get

Purpose

Gets a configuration value.

Parameters

• key (string): The configuration key.

Returns

• value (any): The configuration value.

Realm

Shared.

Example Usage

-- Get a configuration value
local serverName = lia.config.get("ServerName")
print("Server name:", serverName)

-- Get multiple values
local function getServerInfo()
    local name = lia.config.get("ServerName")
    local maxPlayers = lia.config.get("MaxPlayers")
    local pvp = lia.config.get("EnablePVP")

    return {
        name = name,
        maxPlayers = maxPlayers,
        pvp = pvp
    }
end

-- Use in a function
local function checkConfig(key)
    local value = lia.config.get(key)
    if value then
        print("Configuration " .. key .. " = " .. tostring(value))
    else
        print("Configuration " .. key .. " not found")
    end
end

---

load

Purpose

Loads configuration from the database.

Parameters

None

Returns

None

Realm

Server.

Example Usage

-- Load configuration on server start
local function initializeConfig()
    lia.config.load()
    print("Configuration loaded from database")
end

-- Use in a hook
hook.Add("Initialize", "LoadConfig", function()
    lia.config.load()
end)

-- Use in a function
local function reloadConfig()
    lia.config.load()
    print("Configuration reloaded")
end

---

getChangedValues

Purpose

Gets all configuration values that have been changed from their defaults.

Parameters

None

Returns

• changedValues (table): Table of changed configuration values.

Realm

Server.

Example Usage

-- Get changed configuration values
local function getChangedConfigs()
    return lia.config.getChangedValues()
end

-- Use in a function
local function showChangedConfigs()
    local changed = lia.config.getChangedValues()
    for key, value in pairs(changed) do
        print("Changed: " .. key .. " = " .. tostring(value))
    end
end

-- Use in a command
lia.command.add("showchanged", {
    privilege = "Admin Access",
    onRun = function(client, arguments)
        local changed = lia.config.getChangedValues()
        for key, value in pairs(changed) do
            client:notify(key .. " = " .. tostring(value))
        end
    end
})

---

send

Purpose

Sends configuration to a client.

Parameters

• client (Player): The client to send configuration to.

Returns

None

Realm

Server.

Example Usage

-- Send configuration to a client
local function sendConfigToClient(client)
    lia.config.send(client)
end

-- Use in a hook
hook.Add("PlayerInitialSpawn", "SendConfig", function(client)
    lia.config.send(client)
end)

-- Use in a function
local function updateClientConfig(client)
    lia.config.send(client)
    client:notify("Configuration updated")
end

---

save

Purpose

Saves configuration to the database.

Parameters

None

Returns

None

Realm

Server.

Example Usage

-- Save configuration to database
local function saveConfig()
    lia.config.save()
    print("Configuration saved to database")
end

-- Use in a timer
timer.Create("SaveConfig", 300, 0, function()
    lia.config.save()
end)

-- Use in a command
lia.command.add("saveconfig", {
    privilege = "Admin Access",
    onRun = function(client, arguments)
        lia.config.save()
        client:notify("Configuration saved")
    end
})

---

reset

Purpose

Resets a configuration value to its default.

Parameters

• key (string): The configuration key to reset.

Returns

None

Realm

Server.

Example Usage

-- Reset a configuration to default
lia.config.reset("ServerName")

-- Reset multiple configurations
local function resetMultiple()
    lia.config.reset("MaxPlayers")
    lia.config.reset("EnablePVP")
    lia.config.reset("ThemeColor")
end

-- Use in a command
lia.command.add("resetconfig", {
    arguments = {
        {name = "key", type = "string"}
    },
    privilege = "Admin Access",
    onRun = function(client, arguments)
        lia.config.reset(arguments[1])
        client:notify("Configuration reset: " .. arguments[1])
    end
})