Installation guide

Cipher Admin

A full admin panel with player management, bans, reports, inventory tools, screenshots and entity inspection.

01

Requirements

Required

  • Framework: QBox (qbx_core) or QBCore (qb-core). The bridge auto-detects, so qbx_core is deliberately not listed as a hard dependency in the manifest — a QBCore server would otherwise refuse to start it.
  • ox_lib
  • oxmysql

Optional

  • ox_inventory — enables inventory viewing, editing and transfer.
  • screenshot-basic or screencapture — enables screenshots and Live Watch.
  • Any weathersync resource — makes time and weather changes persist.

Current release is v1.1.0.

02

Installation

  1. Drop the cipher-admin folder into your resources directory.
  2. Import sql/admin.sql into your database. It creates the roles, assignments, bans, warnings, audit log and notes tables. Default roles are seeded on first start.
  3. Add ensure cipher-admin to server.cfg.
  4. Set your own license identifier in Config.Owners — without this nobody can open the panel.
  5. Restart the server, then review the roles in the Permissions panel.
ensure cipher-admin

Finding your license identifier

Run this in the server console while you are connected:

print(GetPlayerIdentifierByType(source, 'license'))

Then paste the result into the config:

Config.Owners = {
    'license:YOURLICENSEHERE',
}
03

Configuration

All options live in config.lua.

-- License identifiers that are always Owner, regardless of database role
Config.Owners = { 'license:...' }

-- Default keybind to open the panel (players can rebind in Settings)
Config.OpenKey = 'F7'

-- Discord webhook for audit entries (kicks, bans, warns)
Config.AuditWebhook = ''

-- 'ox_inventory' | 'qb-inventory' | 'qs-inventory'
Config.InventoryResource = 'ox_inventory'

-- Drives the Self Actions "Clothing" and "Revert Ped" buttons.
-- 'illenium-appearance' | 'fivem-appearance' | 'qb-clothing'
-- | 'rcore_clothing' | 'qbx_core'
Config.AppearanceResource = 'illenium-appearance'

-- Shown in the Server Stats panel
Config.ServerName = 'My FiveM Server'

-- %s = reason, %s = expiry
Config.BanMessage = 'You have been banned...'

Automatic warning actions

Warnings can escalate on their own:

Config.WarningThresholds = {
    { count = 3, action = 'kick',    reason = 'Auto-kick: 3 warnings' },
    { count = 5, action = 'tempban', duration = 86400, reason = 'Auto-ban: 5 warnings' },
}

duration is in seconds, so 86400 is 24 hours.

04

Roles and permissions

Four roles are seeded on first start: Support, Moderator, Admin and Senior Admin. Anyone in Config.Owners bypasses every role check.

Roles and their individual permissions are edited live from the Permissions panel inside the menu — no restart needed. To assign a role, use that panel or write the row directly into the admin_assignments table.

Because owners bypass all checks, treat Config.Owners as the root account list. Give people a Senior Admin role instead of adding them there.

05

What is in the panel

Players

Live list with online time and a notes tooltip. Kick, warn, temp or permanent ban, freeze, revive, heal, clear wanted, teleport to and bring, spectate, screenshot and Live Watch (auto-refreshing every 2.5s), private DM, slap, reset position, give weapon, delete nearest vehicle, and Summon All.

Character lookup

Search by name or CitizenID, online or offline. View and set job and grade, cash and bank balance, add notes, or delete the character from the database.

Inventory

View any player's inventory including offline by CitizenID. Compare Mode puts your inventory beside theirs with one-click transfer in either direction. Give, remove, clear and filter items.

Self Actions

50 actions across seven sections, with a live filter and a favourites bar — right-click any action to pin it.

  • Personal: God Mode, Heal, Revive, Food & Water, Armour Only, Infinite Stamina, Fireproof, No Ragdoll, Clear Wanted, Set Wanted
  • Appearance: Invisible, Ped Model, Random Ped, Revert Ped, Clothing, Walk Style
  • Movement: Noclip, Super Jump, Super Sprint, To Waypoint, To Coords, Save Position, Load Position, Undo Teleport
  • Vehicle: Spawn, Repair, Max Mods, Take Keys, Flip Upright, Refuel, Clean, Vehicle God, Set Plate, Delete
  • World: Weather, Time, Freeze Time, Blackout, Announce, Traffic density, Pedestrian density
  • Area: Clear Area, Clear Vehicles, Clear Peds, Clear Objects, Delete Ped
  • Utility: Copy Vector4, Copy Vector3, Entity Info, Spawn Prop

Entity inspector

Scan nearby vehicles and NPCs within 50, 100, 150 or 250 metres. Shows model, plate, health and distance, and can delete any entity by network ID.

Bans, reports, admin chat and audit

Searchable ban list with unban and preset durations. Player reports with claim, respond and close plus an unread badge. Staff-only in-game chat. Every admin action written to the database and optionally to Discord.

Server and resources

Live player count, uptime, resource counts, OneSync mode and game mode. Any resource can be restarted from the panel.

06

Commands

These are the player-facing commands. Everything staff-facing is in the panel.

/report <message>   Submit a support report
/reply  <message>   Reply to your most recent open report
07

Integrations

Weathersync

Time and weather changes sync automatically with any of these if running: qb-weathersync, renewed-weathersync, rcore_weathersync, cd_easytime. If none are detected, the change is broadcast directly to all clients instead — which works, but will not survive a restart.

Appearance

Config.AppearanceResource has to match the clothing script you actually run, or the Clothing and Revert Ped buttons silently do nothing.

Screenshots

Screenshot and Live Watch need screenshot-basic or screencapture started. Without one, those buttons fail quietly.

08

Before going live

  • Verify every identifier in Config.Owners. They bypass all role checks permanently.
  • Set Config.AuditWebhook if you want a record of staff actions outside the database.
  • Config.InventoryResource and Config.AppearanceResource both default to the ox / illenium options. Change them if you run something else.
  • Review the seeded role permissions before handing out roles — the defaults are a starting point, not a policy.
09

Troubleshooting

The panel will not open

Your identifier is not in Config.Owners and you have no role assigned in admin_assignments. Check the license value matches exactly, including the license: prefix.

Clothing and Revert Ped do nothing

Config.AppearanceResource does not match your actual appearance script.

Screenshots fail silently

Neither screenshot-basic nor screencapture is started.

Inventory panel is empty

Config.InventoryResource does not match the inventory you run, or the target has no character loaded.

Time and weather revert after a restart

No weathersync resource was detected, so the change was only broadcast to connected clients.

10

Updating

  1. Back up the database — this resource owns real data (bans, warnings, audit history, notes).
  2. Keep a copy of your edited config.lua.
  3. Check recent commits for SQL changes and apply any new migrations.
  4. Replace the resource folder, merge your config back, restart.
11

Support

Include your framework (QBox or QBCore), inventory resource, the full console error and the steps that caused it.