For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

config/main.lua — setup, notifications, performance, visuals, and per-zone rules.

All server-side settings live in config/main.lua. Per-zone behaviour (weapons, vehicles, blips, job whitelist) is set in the admin UI and stored in data/zones.json.

Open the file in an editor and change only what you need — this page is the short version.


Setup

setup = {
    debug = 1,           -- 1 = errors only; higher = more console output
    checkVersion = true,
    notify = 'auto',     -- or ox_lib, lt-ui, esx_notify, qb-notify, etc.
},
Option
What it does

debug

Console noise. Use 1 on a live server unless you are troubleshooting.

checkVersion

Warns if a newer release exists on startup.

notify

auto picks a notify resource that is running. Override if you run several.


General

Option
Default
Notes

locale

'en'

Also: tr, de, fr, es, pt-br, pl, ru, it — files in locales/

command

'safezonecreator'

Chat command for the admin menu

ace

'command.safezone'

ACE permission for zone management (see Installation)

Notifications

Option
What it does

enabled

Master switch for enter/leave feedback

customNotifications

true = on-screen NUI banner while inside a zone; false = standard notify toasts via LT.Notify

Per-zone Notification in the editor still controls whether that zone triggers enter/leave messages at all.

With customNotifications = true, players see the zone name in the UI overlay. With false, they get classic notify popups when notification is enabled on the zone.


Safezone performance

These values tune how often the client scans entities near zones. Lower milliseconds = more responsive, slightly heavier.

Option
What it does

healIntervalMs

Tick interval for Heal Over Time

zoneScanMargin

Extra meters around the zone box before vehicle/ped scans

vehicleScanMs

How often vehicles inside/near the zone get rule checks

pedCollisionMs

Ped collision disable loop interval

vehicleCollisionMs

Vehicle-vs-player collision disable interval

If you run many large zones and notice client load, raise the *Ms values slightly instead of lowering them.


Visuals

Option
Default
Notes

ghostedEntityAlpha

100.0

Transparency for ghost mode

zoneColor

green, low alpha

Debug border colour when Show Zone Borders is on

zoneDistance

500.0

Max distance (meters) to draw debug borders

Borders only show when the zone has Show Zone Borders enabled and you are within zoneDistance.


Disarming players

When Disable Firearms is on, the script calls disarmPlayer from config:

Extend this if you use another inventory — match the pattern in config/main.lua comments.


Freecam (editor)

Controls how the point-placement camera feels. Most servers can leave defaults; see Editor for in-game keys.


Per-zone settings (admin UI)

Each zone stores its own rules. Whitelisted jobs (see below) skip restrictions for that zone.

Combat & weapons

Setting
Effect

Disable Shooting

Blocks firing

Disable Melee

Blocks melee

Disable Firearms

Disarms via disarmPlayer

Disable Drive-By

No drive-by shooting

Movement

Setting
Effect

Disable Jumping

Jump control disabled

Disable Running

Walk only

Player

Setting
Effect

Invincible Players

Ped cannot take damage

Ghost Mode

Local ghost, no collision with others

Heal On Enter

Full health once on entry

Heal Over Time

Full health on interval (healIntervalMs)

Disable Ragdoll

No ragdoll

Disable Ped Collision

No collision with other peds/vehicles nearby

Disable Idle Cam

Idle camera off

Quiet Footsteps

Reduced footstep volume

Notification

Enter/leave messages for this zone

Vehicles

Setting
Effect

Speed Limit (km/h)

Caps vehicle speed in zone

Invincible Vehicles

Vehicles cannot be damaged

Lock Vehicle Doors

Doors locked while inside

Disable Vehicle Collision

Vehicle-to-vehicle collision off

Whitelisted players driving their own vehicle are exempt from vehicle limits.

Map

Setting
Effect

Show Zone Borders

Debug polygon outline (within zoneDistance)

Blip

Optional map blip (sprite, colour, scale, short range)

Job whitelist

Enable Job Whitelist, add jobs with a minimum grade. Matching players are treated as whitelisted inside that zone — combat, movement, and vehicle rules do not apply to them (their own vehicle is also exempt from vehicle limits).

Job names must match your framework (police, ambulance, etc.).


Locales

Set locale = 'en' (or another code). Edit strings in locales/*.json. UI labels for zone settings live under ui.settings in those files.

Last updated