Overview
Britannia_Admin is everything your staff need in one menu.
- My tools: noclip, godmode, invisible, infinite ammo, names and ids over heads, every player on the map, teleport to the map marker or to coordinates, copy your coordinates (vector3, vector4, x y z, heading), heal yourself, food & drink, golden cores, spawn a horse or wagon, delete the horse or wagon you're on (or the nearest), and become any ped or animal (then back to your own character).
- Players: a searchable list. Each player's panel shows their character, job, group, money and identifiers (never IP addresses), with tabs for:
- Actions: go to, bring, spectate (Backspace stops), heal, food & drink, golden cores, revive, freeze, kill.
- Give: items (searchable), weapons, cash and gold.
- Inventory: see what they carry and take items or weapons away.
- Job: set their job and grade.
- Moderation: private message, warn, kick, ban, jail.
- Warnings: every warning on their account, with remove.
- Troll: set on fire, lightning strike, launch into the air, trip, drunk screen, buck off horse, send a cougar.
- Warnings turn the player's whole screen red until they press ESC or I understand.
- Jail: the jailed player sees a countdown, can't leave the jail's area, and is let out at the release spot when the time is up. Time left carries on if they log off.
- Tickets: players type
/reportor/ticket. They choose a script bug, a player (and who) or help, and write what happened. Staff see every ticket in the menu, take it, reply, go to or bring the player, and close it. Both sides are told of every reply, and players see their own tickets and replies in their ticket window. - Staff chat: only staff see it, in the menu or with
/sc <message>. - Staff page: give players a rank from the menu (saved to their account), change or remove it, tick what each rank may do, and give single staff members personal abilities such as trolling.
- Server page: announcements across every screen; heal, feed or revive everyone; restart now or in 1 to 60 minutes with a black and gold countdown on every screen, and cancel it. txAdmin's scheduled restarts show the same countdown.
- Bans: the active ban list with search and unban. Bans use poggy_core's ban list, so they work on every framework and stop the player when they connect.
- Staff log: every staff action, searchable in the menu, printed to the server console and, if you set a webhook, posted to Discord.
- English, Spanish and French.
The Lua is encrypted by Cfx.re; the settings, server settings and text stay editable.
Requirements
- poggy_core (free), version 0.25.0 or newer.
- oxmysql.
- One of VORP, RSG Core or QBCore RedM (poggy_core connects the script to it).
Install
- Download it from portal.cfx.re (Assets, Granted Assets) and put the
Britannia_Adminfolder in your server'sresourcesfolder. - Add this to
server.cfg, after poggy_core and oxmysql: ``ensure Britannia_Admin`` - So the Restart button can restart the server, also add: ``
add_ace resource.Britannia_Admin command.quit allow`` When the countdown ends, everyone is sent off and the server stops; txAdmin (or your host) starts it again. - Give yourself the top rank (see Ranks below) and restart the server.
Its database tables are made on the first start. There are no items to add.
Ranks
Ranks are in Config.Ranks, lowest first: Helper, Moderator, Admin and Owner. Each rank lists what it may do (perms), and the top rank can always do everything. A player gets the highest rank they match, in any of three ways:
- An ace in server.cfg (best for yourself): ``
add_ace identifier.discord:YOUR_DISCORD_ID britannia_admin.owner allow`The rank names arehelper,moderator,adminandowner`. - Your framework's admin group: each rank's
groups(VORP's user or character group, RSG and QBCore permission levels). By default theadmingroup is the Admin rank. - The menu's Staff page: pick someone on the server and a rank. It is saved to their account and works straight away.
On the Staff page you can also tick what each rank may do (or put a rank back to the config's list), and tick Troll for the single staff members you trust with it. Nobody below the top rank can troll unless you tick it for them.
Staff can only kick, ban, jail, freeze, kill or troll players of a lower rank, and only give or change ranks below their own.
Configuration
Everything is in shared/config.lua, and every option is commented:
| Setting | What it does |
|---|---|
Config.Command, Config.Key, Config.NoclipKey | Open the menu (/admin, Page Up) and switch noclip (Page Down) |
Config.Ranks | The ranks, their aces and groups, and what each may do |
Config.PersonalPerms | Abilities given person by person on the Staff page (troll) |
Config.Troll | Which trolls are offered and how strong or long they are |
Config.Revive, Config.Heal | Your medic script's revive and heal events per framework |
Config.Feed | How Food & drink fills hunger and thirst (fx-hud and vorp_metabolism are filled in; add your HUD's call) |
Config.Give | Give limits, the weapon list and items that can never be given |
Config.Spawn, Config.Models | The horses, wagons and models offered, and the delete range |
Config.GoldCores | How long golden cores last, and whether the horse gets them too |
Config.Jail | Jail spot, release spot, radius, longest sentence, and whether time runs while offline |
Config.BanLengths | The ban lengths offered |
Config.Tickets | Commands, ticket kinds, cooldown, open tickets per player |
Config.StaffChat | The /sc command and how many messages are kept |
Config.Restart | Restart choices, warning times, txAdmin restarts, or another restart script |
Config.Blips, Config.Names, Config.Noclip | Map blips, name distance and noclip speeds |
Config.Notify | How messages reach players (Britannia_Notifications, poggy_core's, or your own) |
server/sv_config.lua holds the Discord webhook for the staff log (server only).
Commands and permissions
| Command / key | Who | What it does |
|---|---|---|
/admin or Page Up | Staff | Opens the menu (the key does nothing for other players) |
| Page Down | Staff with noclip | Noclip on and off |
/report, /ticket | Everyone | Opens the ticket window |
/report <text> | Everyone | Sends a help ticket straight away |
/sc <message> | Staff | Staff chat |
Each player can change the keys in Settings → Key Bindings → FiveM.
How it works
Every action is checked on the server against the staff member's rank (and personal abilities) before it happens, and written to the staff log. Your own tools (noclip, spawning, models) run on your PC after the server agrees. Bans go through poggy_core's ban list. Jail and tickets carry on through restarts and log-offs where it makes sense: jail time is saved, tickets last until the server restarts.
Troubleshooting
A button says "That isn't something the menu can do"
The server hasn't loaded every file. In the console run refresh, then restart Britannia_Admin.
Page Up does nothing
Another script or your own saved key binding may use Page Up. Use /admin, or set Staff menu to another key in Settings → Key Bindings → FiveM.
The countdown ends but the server doesn't restart
Add add_ace resource.Britannia_Admin command.quit allow to server.cfg.
Food & drink does nothing
Fill in your HUD's call in Config.Feed.
New items don't show in the give list
The list also reads your items table directly, so new items show without a restart; check the item exists in your framework's item list.
Version history
- 1.0.0: first release.
Still stuck?
Open a ticket on our Discord with your framework, your poggy_core version and what you see, and we'll help you get it running.
Get help on Discord