Configuration

config.lua

The general settings in config.lua and a map of which file holds which setting.

config.lua holds the general settings. Every app or topic has its own file in configs/, loaded right after it. config_server.lua holds keys and webhooks and stays on the server.

config.lua and the files in configs/ are shared with every client. Never put keys or webhooks in them.

Defaults on these pages are the values in the shipped files.

#Which file holds which key

File Keys Page
config.lua Debug, VersionCheck, Locale, Locales, NameChange, Framework, OpenKey, OpenCommand, WalkWhileOpen, MovementGuard, FaceId, Item, Inventory, Voice, Screenshot, AutoSchema, Time, Number, Currency This page
configs/config_apps.lua Apps, HomeScreen, CustomApps, BundledApps Apps
configs/config_appearance.lua Prop, Animation, Scale, Variation, Wallpapers Appearance and sound
configs/config_sound.lua Sound, Ringtones, NotificationSounds Appearance and sound
configs/config_calls.lua SpeakerBystanders, SpeakerRange, SpeakerFalloff, Calls, Voicemail, Video Calls
configs/config_camera.lua Camera, Media Camera
configs/config_sim.lua Sim, SecondSim, Anon SIM
configs/config_battery.lua Battery, Signal Battery and signal
configs/config_bank.lua Bank, Crypto, Coins Bank and invoices
configs/config_invoices.lua Invoices Bank and invoices
configs/config_services.lua Companies, Services Services
configs/config_shop.lua PhoneShop Shop and cases
configs/config_cases.lua Cases, Accessories Shop and cases
configs/config_migration.lua Migration Shop and cases
configs/config_live.lua Live Live and social
configs/config_social.lua Social, Dating Live and social
configs/config_wallet.lua Wallet Wallet, Wisp and Health
configs/config_wisp.lua Wisp Wallet, Wisp and Health
configs/config_health.lua Health Wallet, Wisp and Health
configs/config_retention.lua Retention, Limits Other settings
One file each Admin, Airdrop, Arcade, Calendar, Darkchat, Mail, Map3D (config_map.lua), Marketplace, News, Pets, VoiceMemos, Weather Other settings
config_server.lua Upload, Logs, NumberGenerate, IbanGenerate, Gif, Video, Crypto, Social, console commands config_server.lua

#General

Setting Type Default What it does
Config.Debug boolean false Prints debug lines and missing locale keys to the console
Config.VersionCheck boolean true Checks for a newer release on start
Config.Locale string 'tr' Language of new phones, and of console and log text unless ServerConfig.Logs.Locale is set
Config.Locales string list { 'en', 'tr' } Languages players can pick in Settings. Each needs locales/<code>.json
Config.NameChange boolean true Players may change the owner name shown on their phone. When false the character name is always used. The admin tablet can override it
Config.Framework string 'auto' 'auto', 'qbcore', 'qbox', 'esx', 'standalone' or 'custom'. A named framework that is not running falls back to auto with a warning
Config.AutoSchema boolean true Creates and updates the database tables on start. Turn off only if you import setup/install.sql yourself

#Opening and movement

Setting Type Default What it does
Config.OpenKey string 'F1' Default key for the open command. Only applies to players who never changed the binding
Config.OpenCommand string 'phone' Command that opens and closes the phone
Config.WalkWhileOpen boolean true Players can walk while the phone is open. Left Alt releases the mouse to look around
Config.MovementGuard boolean true Stops the character when a movement key is up but the game still believes it is held

See Opening the phone.

#Face ID

Setting Type Default What it does
Config.FaceId.Enabled boolean true Face ID in Settings > Face ID & Passcode: unlocks the phone without the passcode when its owner looks at it. It needs a passcode, and turning it on or off asks for that passcode
Config.FaceId.MaskBlocks boolean true A mask on the face is not recognised and the passcode is asked instead
Config.FaceId.FreeMasks number list {} Mask drawables (ped component 1) that leave the face visible and do not block Face ID

#Item, inventory, voice, screenshot

Setting Type Default What it does
Config.Item string or false 'phone' Item required to use the phone. false: everyone can use it without an item
Config.Inventory string 'auto' 'auto', 'ox_inventory', 'qb-inventory' or 'standalone'. See Inventory
Config.Voice string 'auto' 'auto', 'pma-voice', 'mumble-voip' or 'saltychat'. Auto prefers them in that order. See Voice
Config.Screenshot string 'auto' 'auto', 'screenshot-basic' or 'utk_render'. The camera captures inside the phone's own page; this resource is only the fallback when the in-phone capture is unavailable

#Time and numbers

Setting Type Default What it does
Config.Time.Format number 24 24 or 12 hour clock by default
Config.Time.RealTime boolean true true shows the server's real time, false the in-game clock
Config.Number.Length number 7 Digits generated after the prefix
Config.Number.Prefix string '' Digits put in front, for example '555'

Numbers are digits only, 3 to 15 long in total. Number and IBAN generation can be replaced in config_server.lua (NumberGenerate, IbanGenerate).

#Currency

Setting Type Default What it does
Config.Currency.Code string 'USD' Currency code
Config.Currency.Symbol string '$' Symbol shown next to amounts
Config.Currency.Locale string 'en-US' How amounts are formatted: thousands separator, decimal mark, symbol position

A server that uses Turkish lira sets { Code = 'TRY', Symbol = '₺', Locale = 'tr-TR' }.