Documentation
Using Admin Menu: staff roles and permissions, player moderation, spectate and screen watch, noclip, fast actions, vehicles, bans, reports, logs, console, code editor, queue and admin tags.
Admin Menu has three interfaces. Staff use the first two; every player can use the third.
Window | Opened with | What it is for |
|---|---|---|
The Admin Panel |
| Everything: players, bans, reports, logs, vehicles, resources, the console, the code editor, the queue, roles and the world. |
Fast Actions |
DELETE
A compact keyboard-only panel for your own powers and quick world actions, without opening the panel. |
The Report Center |
| Players report a player, a bug or a staff member, and follow what happened to their reports. |
The F5 key only answers framework admins and approved accounts, so it never reveals the menu to a regular player. Somebody registering for the first time types /adminmenu. ESC closes whatever is on top.
The panel opens on Admin Authentication, with a Login and a Register tab. After a successful login the menu remembers you and signs you in silently the next time it opens, until you log out from your Profile. Forgot which username you used? Forgot password? My accounts lists every account registered from your identifier, and a click signs you into it.
Each page appears only to staff whose role holds its permission. A role with * — every framework admin, and the OWNER and SUPERADMIN roles — sees all of them.
Page | Permission | What is there |
|---|---|---|
Dashboard |
| Players online, capacity, resources, uptime, CPU and memory, and who of your staff is online. |
Control Center | any | Your powers, announcements, world tools, traffic density and the weather. |
Admins |
| Staff activity: online and on-duty time per admin. |
Players |
| Everybody online, as a list or on a live map, and every action on a player. |
Live View |
| A grid of live player screens, with voice listening. |
Vehicles |
| The vehicle catalogue, giving cars, and player garages. |
Resources |
| Start, stop, restart and ensure resources. |
Queue |
| The connection queue, its whitelist and priority tiers. |
Live Console |
| The server console, live, and whitelisted commands. |
Logs |
| Every staff action and game event, searchable and live. |
Reports |
| Player reports: triage, assign, reply and close. |
Bans |
| Every ban, offline bans by identifier, and unbans. |
Approvals |
| Staff accounts waiting to be let in. |
Roles |
| Roles, their permissions, and who holds each one. |
Code Editor |
| Edit a resource's Lua and JSON files in game and reload it. |
The gear icon in the header opens your Profile: avatar, password, shortcuts, the Fast Actions position, admin tag styles and staff labels.
Every staff member has an account, every account has one role, and a role is a list of permissions. Permissions are edited in the panel and saved in the database — nothing about a staff member's rights lives in a file.
A new account waits on the Approvals page with its username, identifier and role. Approve lets them in; Reject keeps them out — a rejected player may register again to reapply, and a rejected account can still be Re-approved. Framework admins skip this step entirely.
Four roles ship with the script. Each has a priority, and it is what decides who may act on whom: a staff member can never ban, revoke or re-rank somebody whose role is equal to or above their own.
Role | Priority | Starts with |
|---|---|---|
OWNER | 1000 | Every permission. Given to framework admins when they register. |
SUPERADMIN | 900 | Every permission. |
ADMIN | 700 | Everything except voice listening and unbanning — the list in |
MODERATOR (MOD) | 400 | Dashboard, players, warn, kick, spectate, logs, queue, profile, staff list, and reading and commenting reports. The default role of every new account. |
On the Roles page, + creates a role with a name, a display label and a priority, and the permission checkboxes below are grouped by area, each with a description. Assign Role to Accounts moves people between roles, and Revoke Access logs somebody out on the spot and sends them back to Approvals. The four built-in roles cannot be deleted; a role you made can, and its members are left without one.
The default permissions are given to each built-in role once, on the first start. Untick something on a built-in role and it stays unticked through every restart and update. A permission added by a new version is handed to the roles that would logically have it, and to nobody else.
players.view · players.kick · players.warn · players.ban · players.goto · players.bring · players.spectate · players.liveview · players.liveview.voice · players.freeze · players.invisible · players.giveItem · players.giveMoney · players.setJob · players.changeSkin · players.openInventory · players.revive · players.heal · players.maxNeeds · players.reviveAll · players.kickAll
players.spectate also covers Screen Watch.
self.view · self.godmode · self.noclip · self.superJump · self.invisible · self.infiniteAmmo · self.adminTag · self.revive · self.vehicle · self.repairVehicle · self.skin · self.announce · self.clearVehicles · self.clearPeds · self.clearObjects · self.copyCoords · self.teleportCoords · self.tpm
vehicles.view · vehicles.giveCar · vehicles.manage · vehicles.garage.view · vehicles.garage.spawn · vehicles.garage.delete
dashboard.view · resources.view · resources.start · resources.stop · resources.restart · resources.ensure · resources.refresh · console.view · console.execute · console.clear · console.export · editor.view · editor.edit · editor.reload · queue.view · queue.manage · entity.view · entity.manage · weather.view · weather.manage
logs.view · logs.export · logs.clear · reports.view · reports.manage · reports.comment · reports.close · reports.create · reports.export · bans.view · bans.unban
auth.approve · auth.manage · roles.view · roles.manage · profile.view · profile.edit · admins.view
By default an account belongs to the player's Rockstar license, so all their characters share it. Set Config.MulticharacterAdmin = true to give each character its own account instead. Switching modes means existing accounts no longer match, and staff register again.
The Dashboard shows players online against capacity, running resources, uptime, the server's CPU and memory, and an Admin List of every staff account, online or offline, searchable and filterable by role.
The Admins page tracks two clocks per staff member and keeps them across restarts: active time, time spent on the server, and duty time, time spent signed into the panel. Cards add up who is online and on duty, and a chart compares duty against active hours for every admin — the quickest way to see who actually moderates.
Everyone online, with ping, job and playtime, searchable by name, server id, identifier or job. Switch to Live Map to see them as blips on the GTA map, with a heat map of where players gather; click a blip to select that player. The detail panel shows their id, identifier, job and grade, cash and bank, each copyable with a click.
Group | Actions |
|---|---|
Moderation | Warn and Kick with a reason, Ban with a reason and a duration, Freeze, Make invisible, Spectate, Watch Screen. |
Teleport | Go To, Bring. |
Economy | Give Item from a searchable list of your inventory's items, Give Money to cash or bank, Set Job and grade, Give Ped from a picker with previews, Open Inventory. |
Health | Revive, Heal, Max Food & Drink — through your medical script when one runs. |
A warned, kicked or banned player sees a full-screen notice with the reason before the action lands, so nobody is dropped without knowing why. Bans offer 1 hour, 1 day, 3 days, 7 days, 30 days, permanent, or a custom length from 1 minute to 10 years. An empty reason is recorded as Admin action.
The menu closes and the camera follows the player while you stay hidden and invincible above them. Press ESC, F5 or X to stop — or Exit Spectate from the bar in the panel. It also ends by itself if the player leaves.
Watch Screen streams what a player sees into a floating window you can drag, resize and keep open after closing the menu. Live View puts many of them on one grid, filtered by name, job or gang; tiles connect as they scroll into view, and a click opens the full window. With players.liveview.voice, Listen to voice lets you hear one player at a time while they cannot hear you.
The video travels directly between the two players' games; the server only introduces them. That works out of the box on most connections — for players behind strict routers, add a TURN server as described in Integrations.
Your own powers and the world, in one page. Each card needs self.view plus its own permission.
Section | What it does |
|---|---|
Server Announcement | A full-screen broadcast to every player: Info, Warning or Success, an optional title and up to 240 characters. |
Powers | Godmode, Noclip, Super Jump, Invisibility, Infinite Ammo and your Admin Tag, each a toggle. |
Health and vehicle | Revive Self, Revive All, Spawn Vehicle by model (with keys and a full tank), Repair Vehicle, Change Skin. |
World | Delete all vehicles, peds or objects around you; Copy Coordinates as vec3, vector3, vec4, vector4 or a table; Teleport to coordinates in any of those formats; Teleport to your waypoint; Kick Everyone but you. |
Entity Control | Sliders for ped, traffic, parked, random-vehicle and scenario density, and switches that stop cops, military, animals, gangs and emergency services from spawning. Applied to every player, kept after a restart. |
Weather | Weather type, a snow override (Snow, Blizzard, Xmas), the hour and minute, freeze time and blackout — sent through your weather script. |
PAGE DOWN toggles it anywhere, menu open or not. Turning noclip off always works, even when a duty rule would block turning it on.
Key | Does |
|---|---|
| Fly where the camera looks. |
| Up and down. |
| Raise or lower the base speed · reset it. |
| Hold for twice the speed · four times · a quarter. |
DELETE opens a small side panel driven entirely from the keyboard — powers, health, vehicle, appearance, economy and world actions, the same ones as the Control Center, showing only what your role allows. A strip lists the powers you currently have on.
Key | Does |
|---|---|
| Move through the actions. Hold to scroll. |
| Switch category. |
| Run it, flip a toggle, or open its small form. |
| Close. |
Each staff member chooses where it sits — any corner or the middle of either side — in their Profile.
The catalogue lists every vehicle your framework knows, by category, as a grid or a list. Spawn puts one under you; Give registers it permanently to a player with a fresh ADM plate, their keys, and the default garage from Config.DefaultGarage.
With vehicles.manage, Manage lets you add addon vehicles your framework does not list, rename a model, move it to another category, set its brand and price, or hide it. These are overrides kept by the menu — your framework's own vehicle files are never changed, and Restore undoes them.
Player Garage opens any online player's owned vehicles with plate, state, fuel, engine and body. Spawn one that is in the garage, or delete one for good.
A ban saves every identifier the player has — license, license2, FiveM, Discord, Steam, Xbox — and their hardware tokens. A connection is refused if any of them matches. When a banned player returns on a new Rockstar account from the same PC, the token catches them, and the new account's identifiers are added to the same ban so it stays banned too.
The page lists bans as Active, Expired, Unbanned or All, searchable by name, identifier, reason, admin or #id. Each ban shows who placed it, when it ends, and every identifier it covers, tagged ID or HW. Ban by identifier bans somebody who is offline — up to 20 identifiers, one per line — and drops them at once if they happen to be online. Unban needs bans.unban and keeps a note of who lifted it and why.
The banned player sees the reason, the expiry, the ban number and — if you set Config.Bans.AppealUrl — where to appeal.
Setting | Default | What it does |
|---|---|---|
| all seven | Which identifier types are stored and checked. |
| true | Hardware tokens. Keep it on. |
| false | IP addresses. Off on purpose: housemates, mobile carriers and VPNs share an IP. |
| true | Add an alt's identifiers to the ban that caught it. |
| empty | A Discord invite or form shown on the ban screen. |
/report opens the Report Center. A player picks a type — Player, Bug or Staff — a category, the server id of whoever they are reporting, a subject and a description. My Reports lists what they sent, where each one stands, and every public reply from staff.
Type | Default categories |
|---|---|
Player | cheat · rdm · vdm · harassment · exploit · other |
Bug | ui · gameplay · economy · vehicle · inventory · other |
Staff | abuse · inactivity · misconduct · favoritism · other |
A player may have three open reports at once and send one every 30 seconds. Types, categories, limits and lengths are all in Config.Reports.
Every online staff member whose role can read reports gets a toast, a sound and a [REPORT] chat line the moment one is filed — whether or not they have the panel open. The Reports page opens with the open queue, totals, average resolution time and charts by type and status, and filters by type, status, priority, Open queue only and Assigned to me. New and changed reports appear live.
A report's window shows the reporter and the target with Go To, Bring and Spectate buttons, the full timeline, and — with reports.manage — Claim, Assign to another admin, change status with a note, and comment either as an internal note or a public reply the player can read.
Statuses: Open → Triaged → Assigned → In Progress → Waiting Player → Resolved / Closed / Rejected. Closing or rejecting needs reports.close or reports.manage. Closed reports are kept 180 days, then purged automatically.
Every staff action — kicks, bans, money, items, noclip, resource restarts, console commands, file saves, weather — and every notable game event — joins, leaves, chat, deaths, explosions, suspicious weapon damage — is written to the database and shown here. Filter by category and event, search message, source and target, and leave Live on to see new entries arrive at the top. Each entry opens to its full details.
Export downloads the current filter as CSV; Purge deletes logs immediately and without asking. Logs older than 30 days are removed automatically. Which events are kept, shown and posted to Discord is set per event in Config.Logs.Events.
Every resource with its state, filterable by Started, Stopped or Starting, with Start, Stop, Restart and Ensure per row and Refresh All in the header. Admin Menu itself and the core resources — sessionmanager, mapmanager, chat, spawnmanager, baseevents, hardcap, ox_lib, oxmysql — are protected and cannot be stopped or restarted from here. Config.Resources.AllowedResources, when filled, limits the page to the resources you list.
The server console in real time, with FiveM colour codes, a search box, level filters (Info, Warning, Error, Command, Debug), auto-scroll, export to a text file and clear. Below it, a command box with templates, autocomplete for commands and resource names, up to 16 favourites and a history you walk with ↑ ↓. Ctrl+K focuses the command box, Ctrl+L clears the output.
Pick a resource, browse its files in a folder tree, open several in tabs with Lua and JSON highlighting, save with Ctrl+S, and Reload Resource to apply the change. Only .lua and .json files up to 256 KB can be opened. If somebody else saved the same file since you opened it, your save is refused rather than overwriting their work. Config.Editor sets the extensions, the size limit, and — with AllowedResources — which resources may be edited at all.
When the server is full, new players wait in a queue instead of being refused, and see their position, tier and wait time on the connecting screen. Players with a higher tier (0–1000) go ahead of lower ones — a donor or staff priority. Whitelisted players skip the queue entirely, and Whitelist only turns the server private: anyone not on the list sees your reject message.
The page shows the live queue and edits everything — on/off, maximum players, the three messages, the whitelist and the tiers — by identifier (license:…, discord:…) with a note. Messages accept {position}, {total}, {tier} and {seconds}.
Config.Queueonly seeds the very first start. After that the queue settings live in the database, and the Queue page is where they are changed.
The gear icon opens your Profile: your avatar (a URL, an image, or Capture Mugshot from your own character), a new password, and Log out.
Shortcuts rebinds your own three keys — open the menu, noclip and Fast Actions — to PAGE DOWN, DELETE or F5–F10. Each staff member's choice is saved on their own PC; Config.Shortcuts is the default for everyone who has not changed it.
Staff can float a styled nametag over their head with the Admin Tag power: role, name and avatar, visible to every player who can see them. Tags hide when the staff member is invisible or off screen. Framework admins design the styles in the Profile: a label, the role it belongs to, accent, name and glow colours, an optional gradient, and an animation — none, shimmer, pulse, gradient or rainbow — with a live preview. Six styles ship: one per built-in role, one for framework admins, and a default.
Staff Labels (roles.manage) renames how each role reads on tags and in the staff list — MOD for MODERATOR, say — without renaming the role.
If your server has a duty system, the menu, noclip and Fast Actions can be limited to staff who are on duty:
-- config/main.lua
Config.RequireDuty = {
enabled = true,
menu = true, -- the panel (command and key)
noclip = true, -- noclip (key and button)
fastAction = true, -- Fast Actions
}Whether somebody is on duty is answered by IsAdminOnDuty in custom/server.lua — see Integrations. Turning noclip off is never blocked, so nobody is left stuck flying.