Skip to content

General Settings

This page covers the main configuration options in config/config.lua.

πŸ“ Configuration File#

All general settings are located in:

text
0r-multicharacterv3/config/config.lua

πŸ› οΈ Developer Settings#

lua
Config.Debug = true           -- Enable debug messages in console
Config.DeveloperMode = true   -- Enable developer features
OptionTypeDefaultDescription
DebugbooleantruePrints debug info to F8/server console
DeveloperModebooleantrueEnables additional developer features

Set both to false in production for better performance!


🌍 Language Settings#

lua
Config.Locale = 'en'  -- Language code

Available Languages#

CodeLanguage
enEnglish
trTurkish
frFrench
arArabic

Adding Custom Languages#

  1. Copy locales/en.json to locales/xx.json
  2. Translate all strings
  3. Set Config.Locale = 'xx'

🎯 General UI Settings#

lua
Config.HideRadar = false              -- Hide minimap during selection
Config.SkipWarning = false            -- Skip the warning/welcome screen
Config.DisableDeleteCharacter = true  -- Disable character deletion
OptionTypeDefaultDescription
HideRadarbooleanfalseHides the minimap during character selection
SkipWarningbooleanfalseSkips the initial warning screen
DisableDeleteCharacterbooleantruePrevents players from deleting characters

DisableDeleteCharacter = true is recommended for most servers to prevent accidental deletions.


πŸ”’ Character Slots#

lua
Config.DefaultCharacterSlots = 1  -- Base slots for all players

This is the base number of character slots. Additional slots can be added through:

  • Discord roles
  • Tebex purchases
  • Redeemable codes
  • Admin commands

πŸ“ ESX Prefix#

lua
Config.Prefix = 'char'  -- Character prefix for ESX identifiers

ESX Only: This setting defines the character identifier prefix. Default is char which creates identifiers like char1:license123, char2:license123, etc.


πŸ“Š Logging Configuration#

lua
Config.Logs = {
    status = true,        -- Enable/disable logging
    logger = 'discord',   -- 'discord' or 'ox_lib'
}
OptionTypeValuesDescription
statusbooleantrue/falseEnable or disable all logging
loggerstring'discord', 'ox_lib'Logging system to use

Discord Webhook Setup#

Configure webhooks in server/webhook.lua:

lua
Webhooks = {
    playgame = 'YOUR_WEBHOOK_URL',
    createchar = 'YOUR_WEBHOOK_URL',
    deletechar = 'YOUR_WEBHOOK_URL',
}

🎡 Background Music#

lua
Config.BackgroundMusic = {
    status = true,         -- Enable/disable music
    volume = 0.2,          -- Volume (0.0 to 1.0)
    url = 'bgmusic.mp3',   -- Audio file in web/build/sounds/
}
OptionTypeDefaultDescription
statusbooleantrueEnable background music
volumenumber0.2Music volume (0.0 = mute, 1.0 = max)
urlstring'bgmusic.mp3'Audio filename

Using Custom Music#

  1. Place your audio file in web/build/sounds/
  2. Update url with your filename
  3. Supported formats: .mp3, .ogg, .wav

Keep music files under 5MB for faster loading.


πŸŽ›οΈ Complete Config Example#

lua
-- config/config.lua

local Config = {}

-- Developer Settings
Config.Debug = false
Config.DeveloperMode = false

-- General Settings
Config.Locale = 'en'
Config.HideRadar = true
Config.Prefix = 'char'
Config.DefaultCharacterSlots = 2
Config.SkipWarning = false
Config.DisableDeleteCharacter = true

-- Logging
Config.Logs = {
    status = true,
    logger = 'discord',
}

-- Background Music
Config.BackgroundMusic = {
    status = true,
    volume = 0.15,
    url = 'bgmusic.mp3',
}

return Config

➑️ Next Steps#