rsg-adminmenu: developer and server owner docs#
Contents#
- Architecture
- Data formats
- Exports and shared server functions
- Events and callbacks
- Integration examples
- Persistence
- Security model
- Database schema
- Server owner how-tos
- Troubleshooting
Architecture#
| File | Purpose |
|---|---|
fxmanifest.lua | Loads @rsg-core/shared/locale.lua, config, client/server files and the NUI |
shared/config.lua | Client-safe options (downloaded by every player) |
server/sv_config.lua | Server-only secrets: Discord bot token and webhook URLs |
server/server_database.lua | Creates/upgrades every table when Config.AutoDatabase is on; exposes OnDatabaseReady |
server/server.lua | permissions table, shared helpers, player actions, item catalog, self tools, /adminmenu, /report |
server/server_admins.lua | Role labels/levels, rank hierarchy (CanActOn, ChangeAdminRole), Admins page |
server/server_history.lua | Punishment history (admin_player_history), GetPlayerRole, CanManageHistory |
server/server_logs.lua | LogAdminAction, Discord embeds, Logs page |
server/server_finances.lua | Give/remove money, finance data |
server/server_reports.lua | Report tickets, replies, staff status changes, report webhooks |
server/server_whitelist.lua | Whitelist CRUD and optional enforcement |
server/server_stats.lua | Playtime tracking, activity sampling, dashboard and statistics data |
server/server_world.lua | Teleport locations, staff blips, spawner, clear area |
server/server_devtools.lua | Close server, kick all, refresh, announcements, time/weather/wind/timescale, resource list |
server/server_masteradmin.lua | Webhook settings, replay of custom items stored by older versions |
server/server_adminchat.lua | Staff chat |
server/versionchecker.lua | Version check against the Rexshack-RedM repo |
client/nui.lua | NUI open/close, focus, notebook scenario, locale hand-off |
client/client.lua | Open panel, player list/info, player action relays, self tools, spectate, Page Up keymap |
client/client_playeractions.lua | Remaining action relays and the target-side effects (kill, ragdoll, drunk, ...) |
client/client_troll.lua | Wild animal attack and set on fire (run on the target's client) |
client/client_world.lua | Coords, teleports, blips, spawner, clear area |
client/client_devtools.lua | Server settings relays and applying world settings |
client/client_doorid.lua | Door ID overlay (DoorIds global) |
client/client_reports.lua, client_admins.lua, client_whitelist.lua, client_finances.lua | NUI callback relays |
web/ | React + Vite source; web/dist is the built UI that ships |
Data formats#
permissions (server/server.lua): action name → ACE group (string) or list of groups. 'god' ACE always passes.
Role levels: taken from RSGCore.Config.Server.Permissions; the first entry is the highest. Non-staff are level 0.
World settings (sent to clients in rsg-adminmenu:client:applyworldsettings): only sections an admin has set are present.
{
time = { day = 'Monday' | nil, hour, minute, second, transition, freeze },
weather = { type = 'SUNNY', transition, freeze, snow },
timescale = 1.0,
wind = { direction = 0-360, speed = 0-100, freeze },
}
XP is stored in PlayerData.metadata.xp.
Exports and shared server functions#
The resource registers no exports(...). These globals are shared between its own server files and can be used by anything that runs inside this resource:
| Function | Returns | Purpose |
|---|---|---|
HasAdminPermission(src, action) | boolean | Checks permissions[action] or the god ACE |
CanActOn(src, target) | boolean | true for yourself, anyone of a lower rank, or anything for the Owner |
ChangeAdminRole(src, citizenid, targetSrc?, role?, name?) | ok, message | Grants (role) or removes (nil) a staff role with hierarchy checks |
LogAdminAction(category, severity, src?, action, details?, targetName?, targetSrc?) | — | Writes admin_logs and posts the category's webhook |
LogPlayerHistory(citizenid, action, reason, adminName, durationSeconds?, severity?) | — | Writes admin_player_history |
GetPlayerRole(src) | string | Highest configured ACE group the player holds, or 'user' |
LabelForRole(role) | string | Localised role name |
NotifyPlayer(src, title, description, type, duration?) | — | rsg-core notification |
SanitizeText(value, maxLength) | string | nil | Trim and cap free text, nil when empty |
OnDatabaseReady(fn) | — | Runs fn once the tables exist |
Log categories: admin_action, player_action, economy, security, server_event, system. Severities: low, medium, high.
Events and callbacks#
Client events other resources may listen to#
| Event | Payload |
|---|---|
rsg-adminmenu:client:newreportnotification | { id, reporter_name, report_type } (report_type = 'response' for a reply) |
rsg-adminmenu:client:reportreplynotification | { reportId, adminName } |
rsg-adminmenu:client:applyworldsettings | world settings table (see above) |
Server net events (fired by the NUI, all permission-checked)#
playerrevive, healplayer, openinventory, kickplayer, banplayer, gotoplayer, bringplayer, freezeplayer, spectateplayer, giveitem, killplayer, ragdollplayer, lightningplayer, toheavenplayer, drainstaminaplayer, drunkplayer, jumpscareplayer, horsebuckplayer, hauntedplayer, everyoneattackplayer, wildattack, playerfire, handcuffplayer, warnplayer, setpermission, setjob, setcharfield, adjustxp, clearweapons, clearitems, financeadd, financeremove, createreport, claimreport, releasereport, resolvereport, deletereport, replyreport (all prefixed rsg-adminmenu:server:).
Callbacks (rsg-core CreateCallback)#
All prefixed rsg-adminmenu:server: and permission-checked: getplayers, getplayerinfo, getallplayersmanaged, unbanplayer, getbotlogo, getallitems, removeplayeritem, selftool, selfrevive, getadmins, getroleconfig, addadmin, changeadminrole, removeadmin, getlogs, sendlogtodiscord, getplayerhistory, deletehistoryentry, getPlayerData, getdashboardstats, getstatistics, getwhitelist, addwhitelist, setwhiteliststatus, removewhitelist, getmyreports, getallreports, getreportdetails, getteleportlocations, addteleportlocation, deleteteleportlocation, getblips, addblip, updateblip, deleteblip, spawnentity, cleararea, getserverstate, togglecloseserver, kickallplayers, refreshresources, sendannouncement, getworldsettings, settimesettings, setweathersettings, settimescale, setwindsettings, getresources, getwebhooksettings, savewebhooksettings, createadminchatmessage, getadminchatmessages.
Integration examples#
Show a toast to staff when your own resource raises an alert, using the same notification the panel uses:
-- server, in another resource
local RSGCore = exports['rsg-core']:GetCoreObject()
for _, id in ipairs(RSGCore.Functions.GetPlayers()) do
if RSGCore.Functions.HasPermission(id, 'helper') or IsPlayerAceAllowed(id, 'god') then
TriggerClientEvent('RSGCore:Client:Notify', id, { title = 'Alert', description = 'Something happened', type = 'warning' })
end
end
Make a ban action require Head Admin instead of Admin (server/server.lua):
['ban'] = 'headadmin',
Persistence#
| Data | Where |
|---|---|
| Staff roles | admin_roles, re-applied as ACE on connect |
| Bans | rsg-core's bans table (expire = 2524608000 means permanent) |
| Kick/ban/warn history | admin_player_history |
| Admin action log | admin_logs |
| Reports, replies, nearby players | admin_reports, admin_report_messages, admin_report_nearby_players |
| Whitelist | admin_whitelist |
| Playtime / activity samples | player_playtime (every minute), admin_activity_log (every 15 minutes) |
| Teleports / blips | adminmenu_teleports, adminmenu_blips |
| Webhook overrides | adminmenu_settings (and written into server/sv_config.lua) |
| Custom items from older versions | adminmenu_custom_items, re-registered with rsg-core on start |
| Closed-server flag, world settings, freeze state | memory only (reset on restart) |
Security model#
What the script checks on the server:
- Every net event and callback checks
HasAdminPermission. An unauthorised net event bans the sender; an unauthorised callback just returns empty data. - Targets must be online; punitive actions also require
CanActOn(no acting on equal/higher staff, except the Owner). - Role changes can't grant a role at or above your own, or change someone at or above your rank (yourself included). A demoted admin's panel is force-closed.
- All client input is validated: item exists and amount 1-1000, money type and positive amount, job/grade via rsg-core
SetJob, text length caps, numeric ids, coord ranges, weather names, time/wind/timescale ranges, webhook URLs (Discord only). - Cash and bloodmoney items can't be given as items (use Finances so rsg-core's money stays in sync);
CanAddItemis checked beforeAddItem, andRemoveMoney's result is checked. - Reports: server-side cooldown per license, type/severity allow-lists, length caps, exact-host image allow-list, 3 s reply cooldown, no replies to closed reports, reporter notifications only go to the same license.
- Webhook URLs and the bot token are never sent to clients; webhook changes are logged with masked URLs.
What other resources must check themselves: anything they trigger on behalf of a player. This resource exposes no exports that skip its checks.
Database schema#
The full schema is in install.sql and is identical to server/server_database.lua. Columns added after the first release (admin_reports.severity, admin_reports.reporter_steam, admin_player_history.severity, admin_chat_messages.sender_discord_name, admin_chat_messages.sender_discord_avatar_url, admin_activity_log.total_money) are added automatically if missing.
Server owner how-tos#
- Add the first owner:
add_principal identifier.license:YOUR_LICENSE group.godinserver.cfg, restart, then manage everyone else from the Admins page. - Enable Discord names/avatars: put a bot token in
server/sv_config.lua(Config.DiscordBot.Token). - Route logs to Discord: set the webhook URLs in
server/sv_config.luaor in game under Master Actions. - Enforce the whitelist: add characters on the Whitelist page, then set
Config.Whitelist.Enforce = true. - Let Refresh Resources work:
add_ace resource.rsg-adminmenu command.refresh allow. - Change the Page Up key: edit the
RegisterRawKeymapcall at the bottom ofclient/client.lua(0x21is the raw key code). - Replace the jump scare: drop
jumpscare.png/jumpscare.mp3intoweb/publicand rebuild.
Troubleshooting#
| Problem | Fix |
|---|---|
| Panel says "Not Allowed" | Your ACE group isn't in RSGConfig.Server.Permissions, or you need add_principal ... group.god |
| Red "database setup failed" in console | Check oxmysql's connection string; or set Config.AutoDatabase = false and import install.sql |
| Refresh Resources fails | Add add_ace resource.rsg-adminmenu command.refresh allow to server.cfg |
| "You cannot do that to staff of the same or higher rank" | Working as intended; ask someone of a higher rank or the Owner |
| No Discord names or bot logo | Bot token missing/invalid in server/sv_config.lua |
| Webhooks don't post | URLs must start with https://discord.com/api/webhooks/ (or discordapp.com) |
| Give item says the inventory is full | The target lacks weight or slots; CanAddItem refused it |
| Time/weather keeps resetting | A frozen setting is re-applied every 5 s; untick Freeze, or let rsg-weather manage it |
| Weather set in rsg-weather not showing | Fixed: when rsg-weather is started, the panel's time/weather/wind are sent through exports['rsg-weather'] (setWeather/setTime/setWind) and are no longer applied natively or re-forced, so the two can't fight. Timescale (game speed) is still applied by the admin menu |
| Report image rejected | Only Imgur, Discord CDN, Gyazo and prnt.sc links are accepted |
Support the Project : https://rexshack.tebex.store/
<!-- BEGIN AUTO-REFERENCE (generated from the code; re-run the generator instead of editing by hand) -->Technical reference#
Generated from the source of rsg-adminmenu 3.1.2. Names, arguments and defaults below are read straight from the code.
Dependencies#
rsg-core, rsg-inventory, oxmysql
Database#
Tables: admin_roles, admin_logs, admin_player_history, admin_chat_messages, admin_reports, admin_report_messages, admin_report_nearby_players, admin_whitelist, player_playtime, admin_activity_log, adminmenu_teleports, adminmenu_blips, adminmenu_settings, adminmenu_custom_items.
Tables are created automatically on start while Config.AutoDatabase = true (default). Nothing is ever dropped or overwritten.
For a manual install set Config.AutoDatabase = false and import install.sql once.
-- shared/config.lua
Config.AutoDatabase = true -- false = import the SQL file yourself
Configuration#
| Option | Default | Notes |
|---|---|---|
Config.AutoDatabase | true | create/upgrade the database tables on start; set false to import install.sql manually |
Config.EnablePlayerBlips | true | |
Config.Whitelist | table | |
Config.Enforce | false | |
Config.Reports | table | (server only). Never put them here: this file is downloaded by every client. |
Config.Discord | table | |
Config.WebhookColors | table | |
Config.NearbyDistance | 50.0 | |
Config.Cooldown | 60 | |
Config.DoorHashes | table | https://raw.githubusercontent.com/femga/rdr3_discoveries/master/doorHashes/doorhashes.lua |
Callbacks#
| Callback | Side | Arguments | File |
|---|---|---|---|
rsg-adminmenu:server:getplayers | server | source, cb | server/server.lua |
rsg-adminmenu:server:getbotlogo | server | source, cb | server/server.lua |
rsg-adminmenu:server:getallplayersmanaged | server | source, cb | server/server.lua |
rsg-adminmenu:server:unbanplayer | server | source, cb, data | server/server.lua |
rsg-adminmenu:server:getplayerinfo | server | source, cb, player | server/server.lua |
rsg-adminmenu:server:getallitems | server | source, cb | server/server.lua |
rsg-adminmenu:server:removeplayeritem | server | source, cb, data | server/server.lua |
rsg-adminmenu:server:selftool | server | source, cb, data | server/server.lua |
rsg-adminmenu:server:selfrevive | server | source, cb | server/server.lua |
rsg-adminmenu:server:createadminchatmessage | server | source, cb, data | server/server_adminchat.lua |
rsg-adminmenu:server:getadminchatmessages | server | source, cb | server/server_adminchat.lua |
rsg-adminmenu:server:getroleconfig | server | source, cb | server/server_admins.lua |
rsg-adminmenu:server:getadmins | server | source, cb | server/server_admins.lua |
rsg-adminmenu:server:addadmin | server | source, cb, data | server/server_admins.lua |
rsg-adminmenu:server:changeadminrole | server | source, cb, data | server/server_admins.lua |
rsg-adminmenu:server:removeadmin | server | source, cb, data | server/server_admins.lua |
rsg-adminmenu:server:getserverstate | server | source, cb | server/server_devtools.lua |
rsg-adminmenu:server:togglecloseserver | server | source, cb | server/server_devtools.lua |
rsg-adminmenu:server:kickallplayers | server | source, cb | server/server_devtools.lua |
rsg-adminmenu:server:refreshresources | server | source, cb | server/server_devtools.lua |
rsg-adminmenu:server:sendannouncement | server | source, cb, data | server/server_devtools.lua |
rsg-adminmenu:server:getworldsettings | server | source, cb | server/server_devtools.lua |
rsg-adminmenu:server:getresources | server | source, cb | server/server_devtools.lua |
rsg-adminmenu:server:getPlayerData | server | source, cb, player | server/server_finances.lua |
rsg-adminmenu:server:getplayerhistory | server | source, cb, data | server/server_history.lua |
rsg-adminmenu:server:deletehistoryentry | server | source, cb, data | server/server_history.lua |
rsg-adminmenu:server:getlogs | server | source, cb, data | server/server_logs.lua |
rsg-adminmenu:server:sendlogtodiscord | server | source, cb, data | server/server_logs.lua |
rsg-adminmenu:server:getwebhooksettings | server | source, cb | server/server_masteradmin.lua |
rsg-adminmenu:server:savewebhooksettings | server | source, cb, data | server/server_masteradmin.lua |
rsg-adminmenu:server:getmyreports | server | source, cb | server/server_reports.lua |
rsg-adminmenu:server:getallreports | server | source, cb | server/server_reports.lua |
rsg-adminmenu:server:getreportdetails | server | source, cb, reportId | server/server_reports.lua |
rsg-adminmenu:server:getdashboardstats | server | source, cb | server/server_stats.lua |
rsg-adminmenu:server:getstatistics | server | source, cb | server/server_stats.lua |
rsg-adminmenu:server:getwhitelist | server | source, cb | server/server_whitelist.lua |
rsg-adminmenu:server:addwhitelist | server | source, cb, data | server/server_whitelist.lua |
rsg-adminmenu:server:setwhiteliststatus | server | source, cb, data | server/server_whitelist.lua |
rsg-adminmenu:server:removewhitelist | server | source, cb, data | server/server_whitelist.lua |
rsg-adminmenu:server:getteleportlocations | server | source, cb | server/server_world.lua |
rsg-adminmenu:server:addteleportlocation | server | source, cb, data | server/server_world.lua |
rsg-adminmenu:server:deleteteleportlocation | server | source, cb, data | server/server_world.lua |
rsg-adminmenu:server:getblips | server | source, cb | server/server_world.lua |
rsg-adminmenu:server:addblip | server | source, cb, data | server/server_world.lua |
rsg-adminmenu:server:updateblip | server | source, cb, data | server/server_world.lua |
rsg-adminmenu:server:deleteblip | server | source, cb, data | server/server_world.lua |
rsg-adminmenu:server:spawnentity | server | source, cb, data | server/server_world.lua |
rsg-adminmenu:server:cleararea | server | source, cb, data | server/server_world.lua |
-- client side
RSGCore.Functions.TriggerCallback('rsg-adminmenu:server:getplayers', function(result)
-- use result
end)
Events#
Server events can be fired by any client, so every handler re-validates the player, the arguments and any permission, distance or cooldown on the server. Never add a reward to a handler without those checks.
| Event | Side | Arguments | File |
|---|---|---|---|
rsg-adminmenu:client:openadminmenu | client | data | client/client.lua |
rsg-adminmenu:client:forceclose | client | `` | client/client.lua |
rsg-adminmenu:client:spectateplayer | client | targetServerId, targetCoords | client/client.lua |
rsg-adminmenu:client:adminchatmessage | client | payload | client/client_admins.lua |
rsg-adminmenu:client:applyworldsettings | client | settings | client/client_devtools.lua |
rsg-adminmenu:client:killplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:ragdollplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:lightningplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:drainstaminaplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:drunkplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:clearweapons | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:jumpscareplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:horsebuckplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:hauntedplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:everyoneattackplayer | client | `` | client/client_playeractions.lua |
rsg-adminmenu:client:openreportmenu | client | `` | client/client_reports.lua |
rsg-adminmenu:client:newreportnotification | client | reportData | client/client_reports.lua |
rsg-adminmenu:client:reportreplynotification | client | reportData | client/client_reports.lua |
rsg-adminmenu:client:wildattack | client | `` | client/client_troll.lua |
rsg-adminmenu:client:playerfire | client | `` | client/client_troll.lua |
rsg-adminmenu:client:syncblips | client | blips | client/client_world.lua |
rsg-adminmenu:client:spawnentity | client | entityType, hash | client/client_world.lua |
rsg-adminmenu:client:cleararea | client | radius | client/client_world.lua |
rsg-adminmenu:server: | server | `` | server/server.lua |
rsg-adminmenu:server:financeadd | server | player, moneyType, amount | server/server_finances.lua |
rsg-adminmenu:server:financeremove | server | player, moneyType, amount | server/server_finances.lua |
rsg-adminmenu:server:createreport | server | reportData | server/server_reports.lua |
rsg-adminmenu:server:claimreport | server | data | server/server_reports.lua |
rsg-adminmenu:server:releasereport | server | data | server/server_reports.lua |
rsg-adminmenu:server:resolvereport | server | data | server/server_reports.lua |
rsg-adminmenu:server:deletereport | server | reportId, reason | server/server_reports.lua |
rsg-adminmenu:server:replyreport | server | reportId, message | server/server_reports.lua |
-- from a client script
TriggerServerEvent('rsg-adminmenu:server:')
-- from a server script
TriggerClientEvent('rsg-adminmenu:client:openadminmenu', source, data)
Commands#
| Command | Notes | File |
|---|---|---|
/adminmenu | locale('sv_100') | server/server.lua |
/report | locale('sv_report_command_desc') | server/server.lua |
Locales#
Language files in locales/: de, el, en, es, fr, ja, nl, pl, pt-br, ro, ru. Set the language with setr rsg:locale "en".