Requirements
On this page5
What must be on your server before you install 5code-adminpanel, and what is optional.
Required
| What | Why |
|---|---|
| oxmysql | The panel keeps all its data in your database. oxmysql must start before the panel. |
| A MySQL or MariaDB database | The one oxmysql already uses. The script creates its own tables. See Database. |
| A framework | QBCore, Qbox or ESX (see the table below). |
| OneSync | On. The server reads player positions and uses private dimensions for go to, bring, sits, spectating and the jail. |
Framework
| Framework | Resource name | Status |
|---|---|---|
| QBCore | qb-core | Supported |
| Qbox | qbx_core | Supported |
| ESX | es_extended | Supported |
Config.Framework = 'auto' finds your framework when the panel starts. It looks for qbx_core first, then
es_extended, and uses qb-core when it finds neither of them.
Optional
Each line switches on one thing. The panel works without all of them.
| What | You get | Without it |
|---|---|---|
ox_inventory | The Inventory button opens a player's inventory. | Staff read: "Opening an inventory works with ox_inventory only." |
screenshot-basic | The Screenshot button shows what a player sees. | Staff read: "screenshot-basic is not running on this server." |
| A prison script | Police prison as a second choice next to the admin jail. qb-prison and xt-prison are Supported. Any other prison script is Stub / snippet: you fill in the marked places in bridge/jail.lua. | The panel hides Police prison. The admin jail is built in and always there. |
| A weather / time sync script | The panel tells that script about weather, time and blackout. qb-weathersync and Renewed-Weathersync are Supported. Any other one is Stub / snippet in bridge/world.lua. | The panel sets weather, time and blackout itself for every player. |
| An ambulance script | Revive tells it that the player is up again. qb-ambulancejob, qbx_medical (Qbox), esx_ambulancejob and esx_death (ESX 1.16 and newer) are Supported. Any other one is Stub / snippet in bridge/ambulance.lua. | Revive still brings the character back to life with full health. |
| A clothing script | Reset look gives a player their own saved character back. illenium-appearance, qb-clothing, and ESX skinchanger with esx_skin are Supported. Any other one is Stub / snippet in bridge/appearance.lua. | Reset look changes nothing. The player reads: "No clothing script was found to load your character." |
| A FairShield API key | The FairShield lookup: it checks a player's Discord account against FairShield's list of cheat servers. The key is free in the FairShieldAC Discord (opens in a new tab). | Staff read: "FairShield lookup is not configured. Ask the server owner for an API key in the FairShield Discord." |
| Discord webhooks | A copy of bans, warns, kicks, staff actions, tickets, joins and leaves in your Discord channels. | Nothing is missing. Everything is on the Logs page of the panel, for as long as Config.LogKeepDays keeps it (90 days by default). |
More about each one: Prison scripts · Notifications, chat and weather · Bridge files · FairShield · Webhooks
Inventory and notifications
Two settings in config.lua must match your server. You set them during the Installation.
| Setting | Choices | Used for |
|---|---|---|
Config.InventorySystem | 'qb-inventory', 'ox_inventory', 'codem-inventory' | Give Item on a player. Another inventory is Stub / snippet in bridge/inventory.lua. |
Config.NotifySystem | 'qb', 'ox_lib', 'codem-notification', 'esx' | Every notice a player or a staff member gets from the panel. |
The full list is on the Compatibility page.