| Option | What it does |
|---|---|
MaxDistance |
How far the laser reaches and how far away scenes can be read |
MaxScenes |
Scenes one player can have at a time |
MaxDuration |
Longest lifetime a player can pick, in hours |
AdminOnly |
Only admins can place scenes |
AdminDeleteAll |
Admins can delete any scene |
NeverExpire, NeverExpireAdmin |
Show a never-expire switch, and limit it to admins |
CheckForCollisions |
Hide scenes behind walls |
AuditInterval |
Minutes between full database checks |
ExpiryCheck |
Seconds between in-memory expiry checks |
ActionCooldown |
Milliseconds between create or delete requests per player |
BlockedWords |
List of words players cannot use in scene text. Empty by default, there is no other text moderation, so fill it in for public servers |
AddonFonts, UseSceneTextures |
Extra fonts and sprite backgrounds, see Fonts and backgrounds |
Item, ItemBreakChance |
Usable item and the chance it breaks |
Command, Radial, EnableKeybind, KeybindKey |
Ways to open the laser |
Backgrounds |
Background sprites players can pick |
Debug |
Extra server console output |
Text is in locales/en.json. To add a language copy it to locales/<code>.json, translate the values and set setr ox:locale <code>.
Fonts and backgrounds#
The package ships with the built-in GTA fonts and plain coloured backgrounds. To add your own fonts:
- Copy the font's
.gfxfile intostream/(make the folder if it is missing). - Add a line to
Config.AddonFontsinconfig.lua:{ 'FileName', 'Label in the editor', 'Group' }. The file name has no.gfx. - Restart the resource.
Check the licence of every font you add. Sprite backgrounds need a scenes.ytd in stream/ with sprites named as in Config.Backgrounds. Set Config.UseSceneTextures = true once you have one.
Configuration reference#
These settings come from the inspected package. Tables contain nested fields; edit them using the examples in the supplied file. Keep secrets in server-only configuration.
config.lua defaults#
| Setting | Default / editing guidance |
|---|---|
Config.MaxDistance |
10 |
Config.Log |
true |
Config.MaxScenes |
30 |
Config.Radial |
false |
Config.AdminOnly |
false |
Config.AdminDeleteAll |
true |
Config.AceGroup |
'admin' |
Config.EnableKeybind |
false |
Config.KeybindKey |
"K" |
Config.MaxDuration |
24 |
Config.NeverExpire |
false |
Config.NeverExpireAdmin |
true |
Config.CheckForCollisions |
true |
Config.AuditInterval |
15 |
Config.Item |
'marker' |
Config.ItemBreakChance |
10 |
Config.Command |
'scene' |
Config.Debug |
false |
Config.MaxFontId |
64 |
Config.ExpiryCheck |
30 |
Config.ActionCooldown |
1000 |
Config.PlaceMargin |
8.0 |
Config.BlockedWords |
Table; fields and examples are in the supplied configuration file. |
Config.UseSceneTextures |
false |
Config.AddonFonts |
Table; fields and examples are in the supplied configuration file. |
Config.Backgrounds |
Table; fields and examples are in the supplied configuration file. |
Stuck on a step?Ask in the Discord →