Installation
Requirements
| Requirement | Details |
|---|---|
| Framework | QBCore, QBox Core, or ESX (auto-detected) |
| FiveM Server | Build 4752+ |
| Game Build | 2189+ |
| Lua | 5.4 (enabled automatically) |
F5 Safezones automatically detects your framework at startup — no manual configuration needed. The detection priority is: QBox → QBCore → ESX.
Step by Step
1. Download
Clone or download f5_safezones from GitHub.
cd resources/[f5]
git clone https://github.com/F5-Studio-FiveM/f5_safezones.git
Or download the ZIP and extract it manually.
2. Folder Structure
Place the resource in your server's resources directory:
resources/
[f5]/
f5_safezones/
bridge/
client/
server/
shared/
html/
data/
locales/
config.lua
fxmanifest.lua
3. Server Config
Add to your server.cfg:
- QBCore
- QBox Core
- ESX
ensure qb-core
ensure f5_safezones
ensure qbx_core
ensure ox_lib
ensure f5_safezones
QBox uses ox_lib for notifications. Make sure it starts before f5_safezones.
ensure es_extended
ensure f5_safezones
No SQL import is required. F5 Safezones stores all zone data in JSON files.
4. Configure Admin Permissions
Make sure your admins have the correct ACE permissions. The default configuration recognizes these permissions:
add_ace group.admin safezones.admin allow
See the full list of recognized permissions in the Configuration page.
5. Verify
Restart your server. You should see the startup summary in the server console:
[f5_safezones:bridge:SERVER] Framework detected: qbcore (resource: qb-core) after 1 attempt(s)
[f5_safezones:bridge:SERVER] QBCore server bridge initialized
[f5_safezones] v2.1.0 — Up to date!
The default "Legion Square" safezone is included out of the box.
Next Steps
- Configure zones, markers, and performance
- Understand circle vs polygon zones
- Create your first custom zone
- Exports & Events for integrating with other scripts
- Troubleshooting if something isn't working