Skip to the content
Docs

General

On this page4

The basic settings: which framework, language, inventory and notice system the panel uses, the commands and keys that open it, and how long log lines are kept. All keys are in config.lua.

Frameworks and systems

KeyDefaultAllowedWhat it changes in game
Config.Framework'auto''auto' · 'qb-core' · 'qbx_core' · 'esx'Which framework the panel talks to: character names, jobs, money and the offline player search. 'auto' looks for a running qbx_core first, then es_extended. If neither runs, it uses QBCore.
Config.Locale'en'The name of a file in locales/, without .luaThe language of the notices and messages the game shows. A language or a line that is missing is shown in English.
Config.InventorySystem'qb-inventory''qb-inventory' · 'ox_inventory' · 'codem-inventory'Which inventory the Give Item button puts items into.
Config.NotifySystem'qb''qb' · 'ox_lib' · 'codem-notification' · 'esx'Which script draws the small notices on screen, for example "You were frozen by staff."
  • A value that is not in the list counts as QBCore (Config.Framework) or as 'qb' (Config.NotifySystem). Check the spelling.
  • If the inventory you named is not running, the panel uses the one of the three that is running.
  • An ESX server that runs none of the three keeps the default 'qb-inventory'. Give Item then uses ESX's own inventory.
  • The Inventory button (look into a player's inventory) works with ox_inventory only. With another inventory staff read: "Opening an inventory works with ox_inventory only."
  • Another inventory or notice script: your developer adds it in the open files bridge/inventory.lua and bridge/notify.lua. See Bridge Files.
  • The locale file holds the texts that come from the game: notices, chat lines and messages. The page names and buttons of the panel are English. See Localization.

More about each system: Frameworks & Inventories and Notifications, Chat & Weather.

Commands

KeyDefaultAllowedWhat it changes in game
Config.DashboardCommand'admin'A command name without /The command that opens the full panel: /admin.
Config.MiniMenuCommand'adminmenu'A command name without /The command that opens the quick menu: /adminmenu.
  • Both commands are for staff. Anybody without a rank reads: "You do not have permission to do that."
  • The commands for players are on Tickets & Sits: /report (Config.ReportCommand) and /ticket (Config.TicketCommand).
  • The full list: Commands.

Keys

KeyDefaultAllowedWhat it changes in game
Config.DashboardKey''A FiveM key name, for example 'F6' · '' = no keyThe default key that opens the full panel.
Config.MiniMenuKey''A FiveM key name, for example 'F9' · '' = no keyThe default key that opens the quick menu.
lua
Config.DashboardKey = 'F6'
Config.MiniMenuKey  = 'F9'

A key you set here is only the default. Every staff member can change it for themselves in the game: Settings → Key Bindings → FiveM. The two entries are named Open admin dashboard and Open admin quick menu.

SettingResult
'' (default)No key, and no entry in the key settings. Staff use the command.
A key nameThe key opens the panel. Each person can move it to another key in the key settings.
  • To let staff choose their own key, set any default key here. Without one there is nothing to rebind.
  • A key press runs the command, so the rank check is the same.
  • The key exists for every player. Somebody without a rank who presses it reads: "You do not have permission to do that."

The key for the player's ticket chat (Config.TicketKey) is on Tickets & Sits.

Logs

KeyDefaultAllowedWhat it changes
Config.LogKeepDays90A number of days · 0 = keep everythingLog lines older than this many days are deleted.
lua
Config.LogKeepDays = 90
FactDetail
When the clean-up runsShortly after every start of the resource (about one minute), then once a day.
What is deletedLines of the Logs page only. That includes the log lines about a ban, a warn or a kick.
What is never deletedThe bans, warns and tickets themselves. They stay on the Bans, Warns and Reports pages.
0Nothing is deleted. A value below 1, or a value that is not a number, counts as 0.
The line is missingAn older config.lua without this line counts as 90.
In the console[5code-adminpanel] logs: 1250 line(s) older than 90 day(s) deleted. (the numbers differ). No line when there was nothing to delete.

Reading the log: Logs.

Related: Installation · Quick Menu.