Orvix Admin docs

Getting started

Orvix Admin is one resource, orvix_admin. It runs on ESX Legacy or QBCore, creates its own database tables, and gives your staff a 12-page panel in game.

Requirements

Installation

1. Copy the folder

   Put orvix_admin in your resources folder and keep that exact name.

2. Add it to server.cfg

   After your framework, oxmysql and ox_lib:

   server.cfgCopy

   ensure orvix_admin

3. Turn off your old admin menu

   Two admin menus fight over the same keys and commands. Comment out the old one.

4. Make yourself owner

   Add your license to Config.Owners (see the next section).

5. Start the server

   The console shows [orvix_admin] framework: ESX Legacy or QBCore. Join and press F9.

Make yourself owner

Join your server once, then find your license in the server console (or in txAdmin under Players). Put it in config.lua:

Config.Owners = {
  'license:1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b',  -- you
}

Owners can do everything and can't be removed in game. Give everyone else a rank from Staff & ranks in the panel.

Ranks & permissions

There are four ranks out of the box: Helper, Moderator, Admin and Owner. In Staff & ranks, flip switches to decide what each rank can do. Changes apply right away, no restart.

• A lower rank can never warn, kick, ban, freeze or teleport a higher rank.
• Bans longer than 7 days, unbans, giving money and editing ranks are Admin and Owner by default.
• Turn on Discord role sync to give ranks automatically from Discord roles.

Using the panel

Press F9. The sidebar has every page; the top bar has F2 search, staff chat and your own tools (noclip, god mode, invisible, IDs over heads, look-at card).

Commands & keys

Everything in the panel also works as a command. The last column is the permission needed.

Reports

Players type /report [what happened]. On-duty staff get a notification, and the report shows on the Reports page. Claim it, then chat with the player right in the panel. When you close it, the player can rate the help from 1 to 5 stars.

Bans, jail & mute

• Ban: pick an offense and the punishment guide suggests a length based on their record. Turn on Attach a screenshot to save evidence. Bans save every identifier, including hardware tokens.
• Jail: a locked room with a countdown (5 to 60 minutes) or community service (10 to 100 tasks). Relogging doesn't reset it.
• Mute: voice, text chat or both, for a few minutes or until they relog.
• Offline: warn, jail or ban someone who already left; it applies when they join.

Set your server's punishments in Config.Guide:

Config.Guide = {
  { offense = 'RDM',  steps = { 'Warn', 'Jail 15 min', 'Ban 1 day', 'Ban 7 days' } },
  { offense = 'VDM',  steps = { 'Warn', 'Ban 1 day', 'Ban 3 days', 'Ban 7 days' } },
  { offense = 'Cheating', steps = { 'Permanent ban' } },
}

Alerts & staff watch

The server watches for things that shouldn't happen and posts an alert with Spectate, Screenshot, Freeze and Ban buttons. Limits live in Config.Watch and can also be changed on the Alerts page.

Config.Watch = {
  MoneyJump = 100000, MoneyMinutes = 5,   -- alert if money rises this much this fast
  ItemsAtOnce = 100,                     -- one item, this many at once
  StaffEvents = true,                    -- non-staff triggering staff-only events
  StaffSelfGive = true,                  -- staff giving themselves money or items
  MinReasonLength = 12,                  -- flag lazy ban reasons
}
Config.Escalation = { { warns = 3, ban = '1d' }, { warns = 5, ban = '1w' } }

Staff watch is a second tab only owners see. Each flag has Undo it, Ask them and It's fine.

Live map & kill log

The map updates every 2 seconds. Positions are read on the server, so they can't be faked. Trails are kept for Config.Map.TrailDays (7 by default). The kill log records every death with weapon, distance, location and whether the two players talked first, and flags suspicious ones.

Whitelist & queue

With the whitelist on, new players see your application questions when they connect and wait for approval. The queue lets priority players (staff, Discord roles, supporters) skip the line; give priority by hand on the Priority tab with an expiry date.

Discord & screenshots

All optional. Add these to server.cfg. Always use set, never setr.

# staff action logs
set orvix_admin_webhook "https://discord.com/api/webhooks/..."
# Discord role sync (bot in your Discord with the Server Members intent)
set orvix_admin_discord_token "your-bot-token"
set orvix_admin_guild "your-server-id"
# screenshots for bans, alerts and reports
set orvix_admin_fivemanage "your-fivemanage-token"

Configuration

Everything lives in config.lua. Ranks, watch limits and the punishment guide can also be changed in the panel.

Works with

Exports

Let your other scripts check staff, log actions or raise alerts.

exports.orvix_admin:IsStaff(source)                     -- true / false
exports.orvix_admin:GetRank(source)                     -- 'helper' | 'mod' | 'admin' | 'owner' | nil
exports.orvix_admin:HasPermission(source, 'ban')
exports.orvix_admin:AddLog(source, 'money', 'Paid out $5,000 lottery win')
exports.orvix_admin:SendAlert(source, { title = 'Bank exploit?', text = 'Withdrew 3x in 1s', severity = 'high' })
exports.orvix_admin:Ban(target, '1d', 'Exploiting the bank job')

exports.orvix_admin:IsOpen()
exports.orvix_admin:IsNoclipping()

Troubleshooting

FAQ