Skip to main content

Config

Types

Config

interface Config {
ThemeTheme?
Featured{Items{Item}?}?
HiddenCoreGui{CoreGuiItem}?
}

CoreGuiItem

type CoreGuiItem = string

Valid CoreGui strings: "Chat" | "PlayerList" | "Backpack" | "Captures" | "Emotes" | "TouchControls"

Theme

type Theme = Theme

The default dark theme can be found here for reference.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "Config",
            "desc": "",
            "fields": [
                {
                    "name": "Theme",
                    "lua_type": "Theme?",
                    "desc": ""
                },
                {
                    "name": "Featured",
                    "lua_type": "{ Items: { Item }? }?",
                    "desc": ""
                },
                {
                    "name": "HiddenCoreGui",
                    "lua_type": "{ CoreGuiItem }?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 37,
                "path": "src/API/Config.luau"
            }
        },
        {
            "name": "CoreGuiItem",
            "desc": "Valid CoreGui strings: \"Chat\" | \"PlayerList\" | \"Backpack\" | \"Captures\" | \"Emotes\" | \"TouchControls\"",
            "lua_type": "string",
            "source": {
                "line": 43,
                "path": "src/API/Config.luau"
            }
        },
        {
            "name": "Theme",
            "desc": "The default dark theme can be [found here](https://github.com/UseAvalog/Avalog/blob/main/src/Client/UI/Themes/Dark.luau) for reference.",
            "lua_type": "Theme",
            "source": {
                "line": 49,
                "path": "src/API/Config.luau"
            }
        }
    ],
    "name": "Config",
    "desc": "",
    "source": {
        "line": 29,
        "path": "src/API/Config.luau"
    }
}