Super-Admin & Ranks
On this page4
Who has full access, which permissions exist, and which ranks the panel creates by itself. After the
first start, ranks are made and changed in the panel, not in the file. All keys are in config.lua.
Super-admin
| Key | Default | Allowed | What it changes in game |
|---|---|---|---|
Config.SuperAdminAce | '5code-adminpanel.admin' | Any ACE name | The ACE that makes somebody a super-admin. |
Config.Bootstrap | {} | A list of 'license:...' texts | Backup super-admins by game license. They need no ACE. |
Give the ACE in server.cfg, then restart the server:
add_ace group.admin 5code-adminpanel.admin allow
add_principal identifier.license:YOUR_LICENSE_HERE group.adminA backup super-admin in config.lua:
Config.Bootstrap = { 'license:YOUR_LICENSE_HERE' }| A super-admin | |
|---|---|
| Has every permission | Also the ones a later version adds. |
| Stands above every rank | Nobody can act on them. Staff who try read: "That player has the same or a higher rank than you." |
| Is not bound by the rank rules | They can change every rank and give any rank to anybody. |
| Has no rank in the panel | The Staff list on the Ranks & Staff page shows only people who got a rank in the panel. |
Permissions
| Key | Default | Allowed | What it changes in game |
|---|---|---|---|
Config.Permissions | The list in the file | Permission keys | The permissions a rank can hold. Each one is a tick box in the rank editor. |
You normally leave this list alone.
- The panel knows its own permissions even when one is missing from the list. An older
config.luastill shows every tick box. - A key you add yourself shows up in the rank editor in a group named Custom. The panel itself does nothing with it.
'*'in a rank means every permission, also the ones a later version adds.
Every permission, and which default rank has it
The names are the ones staff see in the rank editor. The God rank has *: everything.
General
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Open the panel | panel.open | Basic access: the dashboard and the list of online players. Every staff rank needs it. | ✓ | ✓ | ✓ |
| See logs | logs.view | Read the record of staff actions, bans, warnings, kicks and reports. | ✓ | – | – |
| FairShield lookup | fairshield.lookup | See whether a player's Discord account is in known cheat servers. | ✓ | ✓ | – |
| See statistics | stats.view | See the charts on the dashboard. Without it the dashboard shows only the live numbers. | ✓ | – | – |
Players: quick actions
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Go to player | player.goto | Teleport yourself to a player. | ✓ | ✓ | ✓ |
| Bring player | player.bring | Teleport a player to where you are standing. | ✓ | ✓ | – |
| Spectate | player.spectate | Watch what a player is doing. | ✓ | ✓ | ✓ |
| Freeze / unfreeze | player.freeze | Lock a player in place, and let them move again. | ✓ | ✓ | – |
| Revive | player.revive | Bring a downed or dead player back up. | ✓ | ✓ | – |
| Heal | player.heal | Restore a player to full health. | ✓ | ✓ | – |
| Screenshot | player.screenshot | Take a picture of what a player sees on their screen. Needs screenshot-basic. | ✓ | ✓ | – |
| Open inventory | player.inventory | Open a player's inventory. Needs ox_inventory. | ✓ | – | – |
| Kill | player.kill | Kill a player's character. | ✓ | – | – |
Players: moderation
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Kick | player.kick | Remove a player from the server. They can join again. | ✓ | ✓ | – |
| Ban | player.ban | Ban a player, for a set time or permanently. | ✓ | – | – |
| Jail / release | player.jail | Send a player to admin jail or police prison, and let them out. | ✓ | ✓ | – |
| Warn | player.warn | Give a player a warning that stays on their record. | ✓ | ✓ | – |
| Private message | player.dm | Send a message only that player sees. Also used for the heads-up before a sit. | ✓ | ✓ | ✓ |
Players: give / set
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Give / take money | player.money | Add money to a player's account or take it away. | ✓ | – | – |
| Give items | player.items | Put items into a player's inventory. | ✓ | – | – |
| Set job | player.job | Change a player's job and grade. | ✓ | – | – |
| Set model | player.model | Change what a player's character looks like, or give them their own look back (Set Model and Reset look). | ✓ | – | – |
| Set bucket | player.routing | Move a player to another routing bucket (a separate copy of the world). | ✓ | – | – |
Players: records
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Read notes & alerts | player.notes.view | See the staff notes and alerts on a player's profile. | ✓ | ✓ | ✓ |
| Write notes & alerts | player.notes.manage | Add notes and alerts, clear alerts and delete notes. | ✓ | ✓ | – |
| Offline players | player.offline | Search players who are not connected and open their profile. Also needed to ban or warn them. | ✓ | – | – |
Self tools
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Noclip & super jump | self.noclip | Fly through the map and jump very high. | ✓ | ✓ | – |
| God mode | self.god | Take no damage. | ✓ | – | – |
| Invisible | self.invisible | Hide your own character from other players. | ✓ | – | – |
| Teleport | self.teleport | Teleport yourself to the waypoint on your map or to a saved place, and go back to where you were. | ✓ | ✓ | ✓ |
| Vehicles | self.vehicle | Spawn, repair, flip and delete vehicles for yourself. | ✓ | ✓ | – |
| See names, IDs and blips | self.names | Show every player's name and server ID above their head, and player blips on the map. Only you see them. | ✓ | – | – |
World
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Weather | world.weather | Change the weather for everyone. | ✓ | – | – |
| Time | world.time | Change the time of day for everyone. | ✓ | – | – |
| Blackout | world.blackout | Turn the city lights off and on. | ✓ | – | – |
| PvP | world.pvp | Turn player-versus-player damage on and off. | ✓ | – | – |
| Announcements | world.announce | Send a message to every player on the server. | ✓ | – | – |
| Clear vehicles / area | world.clear | Remove every empty vehicle from the map, or clean up the area around you (empty vehicles and street NPCs). | ✓ | – | – |
| Mass actions | world.mass | Act on every player at once: freeze, bring or kick (Freeze all, Unfreeze all, Bring all, Kick all). | ✓ | – | – |
Bans & warnings
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| See bans | moderation.bans.view | Open the Bans page and read the ban list. Also shows a player's bans in the History of their profile. | ✓ | ✓ | – |
| Revoke bans | moderation.bans.revoke | Lift a ban before it runs out. | ✓ | – | – |
| See warnings | moderation.warns.view | Open the Warns page and read the warning list. Also shows a player's warns in the History of their profile. | ✓ | ✓ | – |
| Revoke warnings | moderation.warns.revoke | Take a warning off a player's record. | ✓ | – | – |
Reports
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| See tickets | reports.view | Open the Reports page, read tickets and get told when a new one comes in. | ✓ | ✓ | ✓ |
| Handle tickets | reports.manage | Claim tickets, answer the player and resolve them. | ✓ | ✓ | – |
| Run sits | reports.sit | Bring the people in a ticket to the sit room and end the sit. | ✓ | ✓ | – |
Ranks & staff
| Permission | Key | What it allows | Admin | Moderator | Helper |
|---|---|---|---|---|---|
| Manage ranks | ranks.manage | Create, edit and delete ranks and choose what each one may do. | – | – | – |
| Assign staff | staff.assign | Give a player a staff rank and take it away. | – | – | – |
Default ranks
| Key | Default | Allowed | What it changes in game |
|---|---|---|---|
Config.DefaultRanks | Four ranks | A list of ranks | The ranks the panel writes into an empty database at the very first start. |
Rank (label) | name | power | Gets |
|---|---|---|---|
| God | god | 100 | Everything (*) |
| Admin | admin | 80 | Everything except Manage ranks and Assign staff |
| Moderator | mod | 50 | See the tables above |
| Helper | helper | 20 | See the tables above |
| Field | Allowed | Meaning |
|---|---|---|
name | Short text, unique | The internal name. Staff never see it. The panel uses it to find a default rank again after an update. |
label | Text | The name staff see. |
power | A number. The panel accepts 0 to 1000. | Orders the ranks. Higher is stronger. |
permissions | A list of keys, or { '*' } | What the rank may do. |
The rank rules
| Rule | What staff read when it stops them |
|---|---|
Staff cannot act on somebody with the same or a higher power. | "That player has the same or a higher rank than you." |
A rank can only be created, changed or deleted below your own power. | "You can only create or change ranks below your own." or "That rank is not below yours." |
| You can only tick permissions you hold yourself. | "You can only give permissions you have yourself." |
| Nobody changes their own rank. | "You cannot change your own rank." |
A super-admin is not bound by these rules. With the default ranks this means: only a super-admin can change the God rank or give it to somebody.
Day-to-day use: Ranks & Staff.
New permissions after an update
An update can bring new permissions. This is how they reach your ranks:
| Rank | What happens |
|---|---|
A rank with * (God) | Has the new permission at once. |
A rank from Config.DefaultRanks that is still in your database | Gets the new permissions its entry in Config.DefaultRanks lists. This happens once, at the first start after the update. |
| A rank you created in the panel | Gets nothing by itself. Tick the new permission in the rank editor. |
- The hand-out happens once. If you untick such a permission later, it stays unticked.
- The tick box for a new permission is always there, with any
config.lua.