Skip to content

Configuration

All of Vcord's configuration lives in the config.lua file, at the root of the resource. This file is excluded from escrow (escrow_ignore), so you can edit it freely.

TIP

After each change to config.lua, restart the resource (restart lo_vcord) to apply the changes.

Main options

OptionTypeDefaultDescription
Config.Localestring'en'Application language (must match a file in locales/, e.g. 'fr'locales/fr.json).
Config.DebugbooleanfalseShows detailed logs in the server/client console.
Config.ThemeColorstring"FF5865F2"Theme color (Discord style, Blurple), in ARGB format.
Config.StaffGroupstable{'owner','admin','superadmin','god'}Groups with access to admin functions.
Config.MaxServersPerUsernumber10Max number of servers a user can create.
Config.MaxChannelsPerServernumber50Max number of channels per server.
Config.MaxMembersPerServernumber100Max number of members per server.
Config.MaxMessageLengthnumber2000Max length of a message.
Config.MessageHistoryLimitnumber50Number of messages loaded by default in history.
Config.MaxAttachmentsPerMessagenumber5Max number of attachments per message.
Config.MaxDMsPerUsernumber50Max number of direct message conversations (DMs).
Config.MaxFriendsPerUsernumber100Max number of friends.

Webhooks & logs

Vcord can log its events to Discord through two separate webhooks. Leave a value empty ("") to disable a webhook.

lua
Config.Webhooks = {
    -- Webhook for SERVER logs (messages, channels, roles, categories)
    Server = "",
    -- Webhook for DIRECT MESSAGE logs (DMs)
    DM = "",
}

Which events are logged is then controlled in Config.Logs:

lua
Config.Logs = {
    -- Server logs
    ServerMessages = true,      -- Messages sent in servers
    ServerChannels = true,      -- Channel creation/deletion
    ServerCategories = true,    -- Category creation/deletion
    ServerRoles = true,         -- Role creation/edit/deletion
    ServerCreation = true,      -- Server creation

    -- DM logs
    DMMessages = true,          -- Direct messages sent
}

NOTE

Server logs (messages, channels, categories, roles, creations) use Config.Webhooks.Server, while DM logs use Config.Webhooks.DM. A log type is only sent if its matching webhook is set and the option is true.

Limits

These values frame how the application is used per user and per server:

lua
Config.MaxServersPerUser = 10          -- Servers created per user
Config.MaxChannelsPerServer = 50       -- Channels per server
Config.MaxMembersPerServer = 100       -- Members per server

Config.MaxMessageLength = 2000         -- Message length
Config.MessageHistoryLimit = 50        -- Messages loaded by default
Config.MaxAttachmentsPerMessage = 5    -- Attachments per message

Config.MaxDMsPerUser = 50              -- Direct message conversations (DMs)
Config.MaxFriendsPerUser = 100         -- Friends

TIP

Adapt these limits to the size of your server. Lower values reduce database load and message volume.

Profile colors & theme

lua
Config.ThemeColor = "FF5865F2" -- Blurple (Discord style), ARGB format

Config.ProfileColors = {
    '#5865F2', -- Blurple
    '#57F287', -- Green
    '#FEE75C', -- Yellow
    '#EB459E', -- Fuchsia
    '#ED4245', -- Red
    '#3498db', -- Blue
    '#9b59b6', -- Purple
    '#e91e63', -- Pink
    '#00bcd4', -- Cyan
    '#ff9800', -- Orange
    '#FFFFFF', -- White
    '#000000'  -- Black
}
  • Config.ThemeColor sets the accent color of the interface (Blurple by default), in ARGB format (alpha + RGB).
  • Config.ProfileColors lists the profile colors users can choose from.

The available statuses and default avatars are also set here:

lua
Config.DefaultAvatars = {} -- Empty = name initials (users can pick a photo from the gallery)

Config.UserStatuses = {
    'online',
    'idle',
    'dnd',      -- Do Not Disturb
    'invisible'
}

Staff groups

The groups listed in Config.StaffGroups have access to the application's admin functions:

lua
Config.StaffGroups = {'owner', 'admin', 'superadmin', 'god'}

NOTE

Enter here the group names (ace/permission) of your server that are allowed to use Vcord's admin tools.

Voice channels

Vcord supports voice channels through the voice system present on your server:

lua
Config.Voice = {
    -- Voice system: "auto", "pma", "mumble", "salty", "toko"
    -- "auto" automatically detects the installed system
    System = "auto",

    -- Maximum number of members per voice channel
    MaxMembersPerChannel = 10,

    -- Offset for voice channel IDs (avoids conflicts with player IDs)
    ChannelOffset = 65535,
}

The default channel icons are also configurable (Font Awesome classes):

lua
Config.DefaultChannelIcons = {
    text = 'fa-hashtag',
    announcement = 'fa-bullhorn',
    rules = 'fa-scroll',
    voice = 'fa-microphone'
}

TIP

Leave System = "auto" so Vcord automatically detects PMA-Voice, Mumble, SaltyChat or TokoVOIP.

Languages

Vcord ships with 6 languages: English (en), French (fr), German (de), Spanish (es), Italian (it) and Portuguese (pt), via the locales/*.json files.

  • To change the application's language, adjust Config.Locale (e.g. 'fr').
  • The value must match an existing file in locales/ (locales/fr.json for 'fr').
  • You can customize the texts by editing the locales/*.json files directly.
lua
Config.Locale = 'en'

Tips

  • Always edit config.lua at the root (excluded from escrow); do not touch the compiled resource files.
  • After each change, run restart lo_vcord.
  • Leave the webhooks empty ("") if you don't want Discord logging.
  • Enable Config.Debug = true only to diagnose an issue: it prints detailed logs to the console.
  • Adapt the limits (Max...) to the size of your server to keep the load under control.