> For the complete documentation index, see [llms.txt](https://xcore.gitbook.io/xcore-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xcore.gitbook.io/xcore-docs/chat/config-file.md).

# CONFIG FILE

```lua
-- Main configuration table
config = {}

-- Hologram settings
config.holograms_settings = {
    render_interval = 2, -- Interval in seconds for rendering holograms
    max_rendered_messages = 4 -- Maximum number of rendered messages at once
}

-- Custom job commands configuration
config.custom = {
    job_commands = {
        {
            command = "ems", -- Command for EMS job
            job = "ambulance", -- Job name
            min_grade = 0, -- Minimum job grade required
            title = "[EMS] _playername_", -- Title format for EMS messages
            icon = "https://www.svgrepo.com/show/399495/health-services.svg", -- Icon URL
            icon_bg_color = "#FF6068", -- Icon background color
            left_up_gradiant = "#00040978", -- Gradient color (top left)
            right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
            embedcolor = 11342935 -- Embed color (for Discord or similar)
        },
        {
            command = "doj", -- Command for DOJ job
            job = "DOJ", -- Job name
            min_grade = 0, -- Minimum job grade required
            title = "[DOJ] _playername_", -- Title format for DOJ messages
            icon = "https://www.svgrepo.com/show/152269/justice.svg", -- Icon URL
            icon_bg_color = "#143047", -- Icon background color
            left_up_gradiant = "#00040978", -- Gradient color (top left)
            right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
            embedcolor = 9807270 -- Embed color
        },
        {
            command = "police", -- Command for Police job
            job = "police", -- Job name
            min_grade = 0, -- Minimum job grade required
            title = "[LSPD] _playername_", -- Title format for Police messages
            icon = "https://www.svgrepo.com/show/366787/police.svg", -- Icon URL
            icon_bg_color = "#5D5DEA", -- Icon background color
            left_up_gradiant = "#00040978", -- Gradient color (top left)
            right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
            embedcolor = 2123412 -- Embed color
        },
        {
            command = "fbi", -- Command for FBI job
            job = "fbi", -- Job name
            min_grade = 0, -- Minimum job grade required
            title = "[FBI] _playername_", -- Title format for FBI messages
            icon = "https://www.svgrepo.com/show/152081/fbi-waistcoat-protection-tool.svg", -- Icon URL
            icon_bg_color = "#0d0738", -- Icon background color
            left_up_gradiant = "#00040978", -- Gradient color (top left)
            right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
            embedcolor = 2123412 -- Embed color
        },
    }
}

-- Main settings table
config.settings = {
    lang = "en", -- Language (EN for English)
    
    auto_message_settings = {
        enabled = true, -- Enable automatic messages
        interval = 1800000, -- Interval in milliseconds (1000 = 1s)
        messages = {
            {
                title = "XCORE", -- Title for auto message
                message = "THIS IS AUTO MESSAGE CHAT. (PLEASE CHANGE ME)", -- Auto message text
                icon = "https://www.svgrepo.com/show/485809/notice.svg", -- Icon URL
                icon_bg_color = "#FF4218", -- Icon background color
                left_up_gradiant = "#00040978", -- Gradient color (top left)
                right_bottom_gradiant = "#FF421878", -- Gradient color (bottom right)
            },
        }
    },

    doc_message_settings = {
        enabled = true, -- Enable DOC messages
        max_send_dist = 30.0, -- Maximum send distance
        render_holo = true, -- Render as hologram
        holo_txt_color = { r = 226, g = 255, b = 20}, -- Hologram text color
        holo_bar_color = { r = 182, g = 255, b = 0 }, -- Hologram bar color
        max_doc = 100, -- Maximum DOC messages
        title = "[DOC] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/58810/wait.svg", -- Icon URL
        icon_bg_color = "#CFFF56", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
    },

    ad_message_settings = {
        enabled = true, -- Enable advertisements
        price = 1000, -- Price for ad
        title = "[AD]", -- Title for ad
        icon = "https://www.svgrepo.com/show/352699/ad.svg", -- Icon URL
        icon_bg_color = "#EFD051", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
        -- 
        bad_title = "[SYSTEM]", -- Title for failed ad
        bad_icon = "https://www.svgrepo.com/show/485943/warning.svg", -- Icon for failed ad
        bad_icon_bg_color = "#ff265e", -- Icon background color for failed ad
        bad_left_up_gradiant = "#00040978", -- Gradient color (top left) for failed ad
        bad_right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right) for failed ad
    },
    
    server_message_settings = {
        enabled = true, -- Enable server messages
        title = "[SERVER]", -- Server message title
        message = "Our discord is https://feelrp.eu/discord", -- Server message text
        icon = "https://www.svgrepo.com/show/495402/info-circle.svg", -- Icon URL
        icon_bg_color = "#ED6D5E", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    twitter_message_settings = {
        enabled = false, -- Enable Twitter messages
        title = "_playername_", -- Twitter message title
        message = "Our discord is https://feelrp.eu/discord", -- Twitter message text
        icon = "https://www.svgrepo.com/show/474251/message.svg", -- Icon URL
        icon_bg_color = "#2AA9E0", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    discord_message_settings = {
        enabled = true, -- Enable Discord messages
        title = "Discord", -- Discord message title
        message = "Our discord is https://feelrp.eu/discord", -- Discord message text
        icon = "https://www.svgrepo.com/show/474251/message.svg", -- Icon URL
        icon_bg_color = "#707BF4", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    try_message_settings = {
        enabled = true, -- Enable TRY messages
        max_send_dist = 30.0, -- Maximum send distance
        render_holo = true, -- Render as hologram
        holo_txt_color = { r = 239, g = 139, b = 164}, -- Hologram text color
        holo_bar_color = { r = 241, g = 72, b = 112 }, -- Hologram bar color
        title = "[TRY] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/474221/comment.svg", -- Icon URL
        icon_bg_color = "#F34971", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    cjob_message_settings = {
        enabled = true, -- Enable custom job messages
        title = "[GOOC _job_] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/501214/group.svg", -- Icon URL
        icon_bg_color = "#3AFF51", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    staff_message_settings = {
        enabled = true, -- Enable staff messages
        title = "[STAFF] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/501438/admin.svg", -- Icon URL
        icon_bg_color = "#FF4294", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    anon_message_settings = {
        enabled = false, -- Enable anonymous messages
        price = 1000, -- Price for anonymous message
        blocked_jobs = {
            "police", -- Blocked job: police
            "sherif" -- Blocked job: sheriff
        },
        title = "Anonymous", -- Anonymous message title
        icon = "https://www.svgrepo.com/show/267338/mask.svg", -- Icon URL
        icon_bg_color = "#8900C4", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
        bad_title = "[SYSTEM]", -- Title for failed anonymous message
        bad_icon = "https://www.svgrepo.com/show/485943/warning.svg", -- Icon for failed anonymous message
        bad_icon_bg_color = "#ff265e", -- Icon background color for failed anonymous message
        bad_left_up_gradiant = "#00040978", -- Gradient color (top left) for failed anonymous message
        bad_right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right) for failed anonymous message
    },

    do_message_settings = {
        enabled = true, -- Enable DO messages
        max_send_dist = 30.0, -- Maximum send distance
        render_holo = true, -- Render as hologram
        holo_txt_color = { r = 175, g = 247, b = 199 }, -- Hologram text color
        holo_bar_color = { r = 121, g = 249, b = 164 }, -- Hologram bar color
        title = "[DO] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/418965/user-avatar-profile.svg", -- Icon URL
        icon_bg_color = "#79FAA4", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
        bad_title = "[SYSTEM]", -- Title for failed DO message
        bad_icon = "https://www.svgrepo.com/show/485943/warning.svg", -- Icon for failed DO message
        bad_icon_bg_color = "#ff265e", -- Icon background color for failed DO message
        bad_left_up_gradiant = "#00040978", -- Gradient color (top left) for failed DO message
        bad_right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right) for failed DO message
    },

    me_message_settings = {
        enabled = true, -- Enable ME messages
        max_send_dist = 30.0, -- Maximum send distance
        render_holo = true, -- Render as hologram
        holo_txt_color = { r = 168, g = 211, b = 255 }, -- Hologram text color
        holo_bar_color = { r = 168, g = 211, b = 255 }, -- Hologram bar color
        title = "[ME] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/418965/user-avatar-profile.svg", -- Icon URL
        icon_bg_color = "#79B8FA", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    pm_message_settings = {
        enabled = true, -- Enable private messages
        from_title = "[PM] From _playername_ (_playerid_)", -- Title for sender
        for_title = "[PM] To _playername2_", -- Title for recipient
        icon = "https://www.svgrepo.com/show/132270/email.svg", -- Icon URL
        icon_bg_color = "#6D65FF", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78", -- Gradient color (bottom right)
        --
        bad_title = "[SYSTEM]", -- Title for failed PM
        bad_icon = "https://www.svgrepo.com/show/485943/warning.svg", -- Icon for failed PM
        bad_icon_bg_color = "#ff265e", -- Icon background color for failed PM
        bad_left_up_gradiant = "#00040978", -- Gradient color (top left) for failed PM
        bad_right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right) for failed PM
    },

    ooc_message_settings = {
        enabled = true, -- Enable OOC messages
        max_send_dist = 30.0, -- Maximum send distance
        title = "[LOOC] _playername_", -- Title format
        icon = "https://www.svgrepo.com/show/332733/message.svg", -- Icon URL
        icon_bg_color = "white", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    max_charaters_system = {
        enable = true, -- Enable character limit system
        maximum_charaters = 155, -- Maximum allowed characters
        title = "[SYSTEM]", -- Title for character limit warning
        icon = "https://www.svgrepo.com/show/485943/warning.svg", -- Icon URL
        icon_bg_color = "#ff265e", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    -- Blocked system settings
    blocked_system = {
        enable = true, -- Enable blocked system
        title = "[SYSTEM]", -- Title for blocked system
        icon = "https://www.svgrepo.com/show/485943/warning.svg", -- Icon URL
        icon_bg_color = "#ff265e", -- Icon background color
        left_up_gradiant = "#00040978", -- Gradient color (top left)
        right_bottom_gradiant = "#1E001B78" -- Gradient color (bottom right)
    },

    -- Blacklist of forbidden words (for chat filtering)
    black_list_world = {
        "negr",
        "n e g r",
        "n3 gr",
        "n3g3r",
        "n3g 3r",
        "n3g3 r",
        "negr 1",
        "n 3g 4r",
        "n 3 g r",
        "ne2g r",
        "n3g4 r",
        "ne5gr",
        "n2egr",
        "n3eg8r",
        "n3g2 r",
        "n 3g9r",
        "n5 egr",
        "n4 egr",
        "neg 5r",
        "n2e g3r",
        "n3eg 8r",
        "n3g2r",
        "n3g 1r",
        "n 3gr0",
        "ne 9gr",
        "n e 8gr",
        "n3 g3r8",
        "n3g4r5",
        "n6e gr",
        "n3g 5r",
        "n 3g0r",
        "n9e gr",
        "ne6 gr",
        "n egr",
        "negr0",
        "n eg r",
        "negr ",
        "n3 gr ",
        "negr123",
        "n3gr456",
        "n egr 789",
        "ne9 gr",
        "n e8 gr",
        "n3 g3r 8",
        "n3 g4r 5",
        "n6egr",
        "n3 g5r",
        "n3 g0r",
        "n9egr",
        "ne6gr",
        "ne gr",
        "ne  gr",
        "n e gr",
        "n egr ",
        "n3 gr ",
        "n egr1",
        "n3gr4",
        "n e gr5",
        "n3gr6",
        "n e gr7",
        "ne gr8",
        "n egr9",
        "negr",
        "n3gr",
        "negři",
        "negri",
        "n3gr1",
        "Negr1",
        "N3gri",
        "Negroušci",
        "n3groušc1",
        "negroušc1",
        "n3groušci",
        "negrousci",
        "n3grousc1",
        "negrousc1",
        "n3grousci",
        "negrouš",
        "negřice",
        "negrice",
        "negros",
        "Nigga",
        "niga",
        "n1gga",
        "nigga",
        "negroušek",
        "negreousek",
        "n3groman",
        "3egroušek",
        "n3greousek",
        "n3groman",
        "simp",
        "s1mp",
        "buzna",
        "buzik",
        "jew",
        "jews",
        "jewish",
        "j3w",
        "j3ws",
        "jewgirl",
        "j3wgirl"
        -- Add more forbidden words as needed
    }
}

return config

```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://xcore.gitbook.io/xcore-docs/chat/config-file.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.