Configuration
On this page
Everything is in config.lua. Framework and inventory hooks are in bridge/, covered in
Custom servers.
Framework and inventory
| Option | Default | What it does |
|---|---|---|
Config.Framework | 'auto' | 'auto', 'qbx', 'qb', 'esx', 'nd', 'ox' or 'standalone' |
Config.Inventory | 'auto' | 'auto', 'ox_inventory', 'qb-inventory', 'ps-inventory', 'lj-inventory', 'qs-inventory', 'codem-inventory', 'core_inventory', 'tgiann-inventory', 'jaksam_inventory', 'origen_inventory', 'framework' or 'none' |
'framework' reads items on the ESX or QBCore player. 'none' means no items are needed. Set these by hand
if you renamed a resource.
Staff
| Option | Default | What it does |
|---|---|---|
Config.StaffAce | 'scenes.staff' | ACE for staff: permanent and locked scenes, longer view distance, remove anyone's scene |
Config.StaffGroups | admin, superadmin, god, mod | Framework groups that also count as staff (ESX groups, QBCore permissions, ACE group.<name>) |
Commands and messages
| Option | Default | What it does |
|---|---|---|
Config.NotifyTitle | 'Scenes' | Title on notifications |
Config.Command | 'scene' | Opens the editor |
Config.ToggleCommand | 'scenes' | Shows or hides every scene on your own screen |
Limits
| Option | Default | What it does |
|---|---|---|
Config.MaxText | 160 | Characters in a normal scene |
Config.MaxGraffiti | 28 | Characters in a spray tag |
Config.MaxPerPlayer | 6 | Scenes one player can have up at once. Staff ignore this |
Config.CooldownSeconds | 4 | Seconds between placing scenes |
Config.MaxDistance | 30.0 | Furthest view distance a player can pick. Staff can pick up to 80 |
Config.PlaceReach | 12.0 | How far you can aim when placing |
Config.Slots | 10 | How many scenes can be drawn at once. Each uses one small browser texture |
Expiry
| Option | Default | What it does |
|---|---|---|
Config.Expiry | { 5, 15, 30, 60, 180, 360, 1440, 0 } | Choices in minutes. 0 is permanent, staff only |
Config.DefaultExpiry | 60 | Choice selected when the editor opens |
Fonts
Fonts ship with the resource in ui/fonts/, so every player sees the same thing. All are under the SIL Open
Font License.
| Option | Default | What it does |
|---|---|---|
Config.Fonts | 7 fonts | Barlow, Oswald, Archivo Black, Roboto Slab, IBM Plex Mono, Permanent Marker, Caveat |
Config.LegacyFonts | system fonts | Fonts older scenes were made with. Still accepted, so editing an old scene doesn't change its look |
Spray tags
| Option | Default | What it does |
|---|---|---|
Config.SprayItem | 'spray_can' | Item needed to place a tag |
Config.CleanItem | 'cleaning_rag' | Item needed to wipe one off |
Config.CleanSeconds | 6 | How long cleaning takes |
Text filter
Text is compared lower case with look-alike characters folded (1 to i, 3 to e, 0 to o, @ to a,
$ to s), so simple swaps don't get past it.
| Option | Default | What it does |
|---|---|---|
Config.BlockedWords | {} | Your own words to block |
Config.BlockPatterns | links and invites | Lua patterns that are always blocked |
Lua
Config.BlockedWords = { 'badword', 'anotherone' }
Config.BlockPatterns = { 'http', 'www%.', '%.com', '%.gg', 'discord%.' }Links and Discord invites are always blocked by the default patterns.
Discord log
| Option | Default | What it does |
|---|---|---|
Config.Webhook | '' | A Discord webhook link to log every scene placed and removed. '' turns it off |
Rendering fixes
| Option | Default | What it does |
|---|---|---|
Config.FlipWinding | false | Flip this if a panel shows up mirrored or not at all on a wall |
Config.MirrorU | false | Flip this together with FlipWinding if the text reads backwards |