Server config and permissions
The lines FiveStaff needs in server.cfg, what each one is for, and the optional settings that change how it behaves on your server.
On this page
FiveStaff needs very little from your server config: one line to start it and three lines that let it manage resources. This page explains each one and the optional settings you can add.
The lines you need#
ensure fivestaff
add_ace resource.fivestaff command.restart allow
add_ace resource.fivestaff command.start allow
add_ace resource.fivestaff command.stop allow
| Line | What it is for |
|---|---|
ensure fivestaff |
Starts FiveStaff with your server. Put it after your framework and inventory so FiveStaff can find them. |
add_ace … command.restart |
Lets FiveStaff restart itself when an update needs it. Without it, an update waits until you restart the server yourself. |
add_ace … command.start and command.stop |
Let your staff start and stop resources from the Game resources screen. |
If you leave out the three add_ace lines, everything else still works. Updates just wait for your next restart, and the Game resources screen can only look, not act.
How FiveStaff knows who your staff are#
You do not give your staff any in-game permissions for FiveStaff. Your team is the list of people on your server in the panel, and they act from the panel or Discord.
FiveStaff recognises a staff member in game by their Discord account. When someone on your team joins your server with Discord open on their PC, FiveStaff matches them to their panel account. That is how staff are always let in, even when your server is closed to everybody else, and how their profile shows their staff role.
Your framework#
FiveStaff looks at which resources are running and picks your framework by itself: Qbox, QBCore, ESX, vRP or TMC. If it finds none of them, it runs in standalone mode. Everything works there except the screens that read characters, money and inventories.
The server console says which one it picked when FiveStaff starts, and the dashboard's Connection card shows it too.
If it picks the wrong one, for example because you run a renamed core, tell it which one to use:
set fivestaff_framework "qbox"
The values are qbcore, qbox, esx, tmc, vrp, vmenu and standalone. Set it to auto, or remove the line, to go back to detecting it.
Optional settings#
These go in server.cfg above ensure fivestaff. Most servers never need them.
| Setting | What it does |
|---|---|
set fivestaff_server_key "fss_…" |
Uses this key instead of the one in config.lua. Useful if you keep keys out of your resources folder. |
set fivestaff_channel "beta" |
Gets updates a little earlier, before they reach everybody. Leave it out to stay on the normal releases. |
set fivestaff_inventory "ox_inventory" |
Names your inventory resource, if FiveStaff did not find it. |
Running alongside other admin tools#
FiveStaff happily runs next to txAdmin, vMenu, EasyAdmin and anti-cheat resources. It does not replace or switch any of them off. If you are moving from one of them, you can bring your existing bans across with importing bans.