All resources

rsg-adminmenu: developer and server owner docs#

Contents#

  1. Architecture
  2. Data formats
  3. Exports and shared server functions
  4. Events and callbacks
  5. Integration examples
  6. Persistence
  7. Security model
  8. Database schema
  9. Server owner how-tos
  10. Troubleshooting

Architecture#

FilePurpose
fxmanifest.luaLoads @rsg-core/shared/locale.lua, config, client/server files and the NUI
shared/config.luaClient-safe options (downloaded by every player)
server/sv_config.luaServer-only secrets: Discord bot token and webhook URLs
server/server_database.luaCreates/upgrades every table when Config.AutoDatabase is on; exposes OnDatabaseReady
server/server.luapermissions table, shared helpers, player actions, item catalog, self tools, /adminmenu, /report
server/server_admins.luaRole labels/levels, rank hierarchy (CanActOn, ChangeAdminRole), Admins page
server/server_history.luaPunishment history (admin_player_history), GetPlayerRole, CanManageHistory
server/server_logs.luaLogAdminAction, Discord embeds, Logs page
server/server_finances.luaGive/remove money, finance data
server/server_reports.luaReport tickets, replies, staff status changes, report webhooks
server/server_whitelist.luaWhitelist CRUD and optional enforcement
server/server_stats.luaPlaytime tracking, activity sampling, dashboard and statistics data
server/server_world.luaTeleport locations, staff blips, spawner, clear area
server/server_devtools.luaClose server, kick all, refresh, announcements, time/weather/wind/timescale, resource list
server/server_masteradmin.luaWebhook settings, replay of custom items stored by older versions
server/server_adminchat.luaStaff chat
server/versionchecker.luaVersion check against the Rexshack-RedM repo
client/nui.luaNUI open/close, focus, notebook scenario, locale hand-off
client/client.luaOpen panel, player list/info, player action relays, self tools, spectate, Page Up keymap
client/client_playeractions.luaRemaining action relays and the target-side effects (kill, ragdoll, drunk, ...)
client/client_troll.luaWild animal attack and set on fire (run on the target's client)
client/client_world.luaCoords, teleports, blips, spawner, clear area
client/client_devtools.luaServer settings relays and applying world settings
client/client_doorid.luaDoor ID overlay (DoorIds global)
client/client_reports.lua, client_admins.lua, client_whitelist.lua, client_finances.luaNUI 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:

FunctionReturnsPurpose
HasAdminPermission(src, action)booleanChecks permissions[action] or the god ACE
CanActOn(src, target)booleantrue for yourself, anyone of a lower rank, or anything for the Owner
ChangeAdminRole(src, citizenid, targetSrc?, role?, name?)ok, messageGrants (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)stringHighest configured ACE group the player holds, or 'user'
LabelForRole(role)stringLocalised role name
NotifyPlayer(src, title, description, type, duration?)—rsg-core notification
SanitizeText(value, maxLength)string | nilTrim 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#

EventPayload
rsg-adminmenu:client:newreportnotification{ id, reporter_name, report_type } (report_type = 'response' for a reply)
rsg-adminmenu:client:reportreplynotification{ reportId, adminName }
rsg-adminmenu:client:applyworldsettingsworld 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#

DataWhere
Staff rolesadmin_roles, re-applied as ACE on connect
Bansrsg-core's bans table (expire = 2524608000 means permanent)
Kick/ban/warn historyadmin_player_history
Admin action logadmin_logs
Reports, replies, nearby playersadmin_reports, admin_report_messages, admin_report_nearby_players
Whitelistadmin_whitelist
Playtime / activity samplesplayer_playtime (every minute), admin_activity_log (every 15 minutes)
Teleports / blipsadminmenu_teleports, adminmenu_blips
Webhook overridesadminmenu_settings (and written into server/sv_config.lua)
Custom items from older versionsadminmenu_custom_items, re-registered with rsg-core on start
Closed-server flag, world settings, freeze statememory 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); CanAddItem is checked before AddItem, and RemoveMoney'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.god in server.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.lua or 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 RegisterRawKeymap call at the bottom of client/client.lua (0x21 is the raw key code).
  • Replace the jump scare: drop jumpscare.png / jumpscare.mp3 into web/public and rebuild.

Troubleshooting#

ProblemFix
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 consoleCheck oxmysql's connection string; or set Config.AutoDatabase = false and import install.sql
Refresh Resources failsAdd 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 logoBot token missing/invalid in server/sv_config.lua
Webhooks don't postURLs must start with https://discord.com/api/webhooks/ (or discordapp.com)
Give item says the inventory is fullThe target lacks weight or slots; CanAddItem refused it
Time/weather keeps resettingA frozen setting is re-applied every 5 s; untick Freeze, or let rsg-weather manage it
Weather set in rsg-weather not showingFixed: 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 rejectedOnly 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#

OptionDefaultNotes
Config.AutoDatabasetruecreate/upgrade the database tables on start; set false to import install.sql manually
Config.EnablePlayerBlipstrue
Config.Whitelisttable
Config.Enforcefalse
Config.Reportstable(server only). Never put them here: this file is downloaded by every client.
Config.Discordtable
Config.WebhookColorstable
Config.NearbyDistance50.0
Config.Cooldown60
Config.DoorHashestablehttps://raw.githubusercontent.com/femga/rdr3_discoveries/master/doorHashes/doorhashes.lua

Callbacks#

CallbackSideArgumentsFile
rsg-adminmenu:server:getplayersserversource, cbserver/server.lua
rsg-adminmenu:server:getbotlogoserversource, cbserver/server.lua
rsg-adminmenu:server:getallplayersmanagedserversource, cbserver/server.lua
rsg-adminmenu:server:unbanplayerserversource, cb, dataserver/server.lua
rsg-adminmenu:server:getplayerinfoserversource, cb, playerserver/server.lua
rsg-adminmenu:server:getallitemsserversource, cbserver/server.lua
rsg-adminmenu:server:removeplayeritemserversource, cb, dataserver/server.lua
rsg-adminmenu:server:selftoolserversource, cb, dataserver/server.lua
rsg-adminmenu:server:selfreviveserversource, cbserver/server.lua
rsg-adminmenu:server:createadminchatmessageserversource, cb, dataserver/server_adminchat.lua
rsg-adminmenu:server:getadminchatmessagesserversource, cbserver/server_adminchat.lua
rsg-adminmenu:server:getroleconfigserversource, cbserver/server_admins.lua
rsg-adminmenu:server:getadminsserversource, cbserver/server_admins.lua
rsg-adminmenu:server:addadminserversource, cb, dataserver/server_admins.lua
rsg-adminmenu:server:changeadminroleserversource, cb, dataserver/server_admins.lua
rsg-adminmenu:server:removeadminserversource, cb, dataserver/server_admins.lua
rsg-adminmenu:server:getserverstateserversource, cbserver/server_devtools.lua
rsg-adminmenu:server:togglecloseserverserversource, cbserver/server_devtools.lua
rsg-adminmenu:server:kickallplayersserversource, cbserver/server_devtools.lua
rsg-adminmenu:server:refreshresourcesserversource, cbserver/server_devtools.lua
rsg-adminmenu:server:sendannouncementserversource, cb, dataserver/server_devtools.lua
rsg-adminmenu:server:getworldsettingsserversource, cbserver/server_devtools.lua
rsg-adminmenu:server:getresourcesserversource, cbserver/server_devtools.lua
rsg-adminmenu:server:getPlayerDataserversource, cb, playerserver/server_finances.lua
rsg-adminmenu:server:getplayerhistoryserversource, cb, dataserver/server_history.lua
rsg-adminmenu:server:deletehistoryentryserversource, cb, dataserver/server_history.lua
rsg-adminmenu:server:getlogsserversource, cb, dataserver/server_logs.lua
rsg-adminmenu:server:sendlogtodiscordserversource, cb, dataserver/server_logs.lua
rsg-adminmenu:server:getwebhooksettingsserversource, cbserver/server_masteradmin.lua
rsg-adminmenu:server:savewebhooksettingsserversource, cb, dataserver/server_masteradmin.lua
rsg-adminmenu:server:getmyreportsserversource, cbserver/server_reports.lua
rsg-adminmenu:server:getallreportsserversource, cbserver/server_reports.lua
rsg-adminmenu:server:getreportdetailsserversource, cb, reportIdserver/server_reports.lua
rsg-adminmenu:server:getdashboardstatsserversource, cbserver/server_stats.lua
rsg-adminmenu:server:getstatisticsserversource, cbserver/server_stats.lua
rsg-adminmenu:server:getwhitelistserversource, cbserver/server_whitelist.lua
rsg-adminmenu:server:addwhitelistserversource, cb, dataserver/server_whitelist.lua
rsg-adminmenu:server:setwhiteliststatusserversource, cb, dataserver/server_whitelist.lua
rsg-adminmenu:server:removewhitelistserversource, cb, dataserver/server_whitelist.lua
rsg-adminmenu:server:getteleportlocationsserversource, cbserver/server_world.lua
rsg-adminmenu:server:addteleportlocationserversource, cb, dataserver/server_world.lua
rsg-adminmenu:server:deleteteleportlocationserversource, cb, dataserver/server_world.lua
rsg-adminmenu:server:getblipsserversource, cbserver/server_world.lua
rsg-adminmenu:server:addblipserversource, cb, dataserver/server_world.lua
rsg-adminmenu:server:updateblipserversource, cb, dataserver/server_world.lua
rsg-adminmenu:server:deleteblipserversource, cb, dataserver/server_world.lua
rsg-adminmenu:server:spawnentityserversource, cb, dataserver/server_world.lua
rsg-adminmenu:server:clearareaserversource, cb, dataserver/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.

EventSideArgumentsFile
rsg-adminmenu:client:openadminmenuclientdataclient/client.lua
rsg-adminmenu:client:forcecloseclient``client/client.lua
rsg-adminmenu:client:spectateplayerclienttargetServerId, targetCoordsclient/client.lua
rsg-adminmenu:client:adminchatmessageclientpayloadclient/client_admins.lua
rsg-adminmenu:client:applyworldsettingsclientsettingsclient/client_devtools.lua
rsg-adminmenu:client:killplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:ragdollplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:lightningplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:drainstaminaplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:drunkplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:clearweaponsclient``client/client_playeractions.lua
rsg-adminmenu:client:jumpscareplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:horsebuckplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:hauntedplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:everyoneattackplayerclient``client/client_playeractions.lua
rsg-adminmenu:client:openreportmenuclient``client/client_reports.lua
rsg-adminmenu:client:newreportnotificationclientreportDataclient/client_reports.lua
rsg-adminmenu:client:reportreplynotificationclientreportDataclient/client_reports.lua
rsg-adminmenu:client:wildattackclient``client/client_troll.lua
rsg-adminmenu:client:playerfireclient``client/client_troll.lua
rsg-adminmenu:client:syncblipsclientblipsclient/client_world.lua
rsg-adminmenu:client:spawnentitycliententityType, hashclient/client_world.lua
rsg-adminmenu:client:clearareaclientradiusclient/client_world.lua
rsg-adminmenu:server:server``server/server.lua
rsg-adminmenu:server:financeaddserverplayer, moneyType, amountserver/server_finances.lua
rsg-adminmenu:server:financeremoveserverplayer, moneyType, amountserver/server_finances.lua
rsg-adminmenu:server:createreportserverreportDataserver/server_reports.lua
rsg-adminmenu:server:claimreportserverdataserver/server_reports.lua
rsg-adminmenu:server:releasereportserverdataserver/server_reports.lua
rsg-adminmenu:server:resolvereportserverdataserver/server_reports.lua
rsg-adminmenu:server:deletereportserverreportId, reasonserver/server_reports.lua
rsg-adminmenu:server:replyreportserverreportId, messageserver/server_reports.lua
-- from a client script
TriggerServerEvent('rsg-adminmenu:server:')
-- from a server script
TriggerClientEvent('rsg-adminmenu:client:openadminmenu', source, data)

Commands#

CommandNotesFile
/adminmenulocale('sv_100')server/server.lua
/reportlocale('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".

<!-- END AUTO-REFERENCE -->