Black and gold Config first Keymaster ready

Aureus V2

Install and configure the Aureus resource pack.

This page is written for server owners and staff who need to set the resources up without digging through protected source code. It covers only these resources: admin menu, connect, dispatch, garages, MDT, police, radar and UI.

Cfx asset escrow protects implementation files. Customers should configure exposed files like config.lua, shared/config.lua, shared/jobequip_config.lua, SQL files, inventory item files and images. Do not ask buyers to edit protected client/server modules.
Resource What It Does Main Customer Files
Aureus_admin_menuStaff control center, reports, punishments, players, inventory, vehicles, server tools and permissions.config.lua, sql/*.sql, data/*.json
Aureus_connectBridge layer for MDT, dispatch, police, garages, impound, mail, fines, warrants and housing lookups.shared/config.lua
Aureus_dispatchEmergency dispatch tablet, calls, units, BOLOs, quick alerts and ps-dispatch compatible exports.config.lua, locales/*.lua
Aureus_garagesOwned vehicle garages, depot, public garages, fleet spawners and in-game garage editor.config.lua, sql/*.sql, data/*.json
Aureus_mdtPolice and EMS MDT with people, vehicles, cases, warrants, BOLOs, charges and medical records.config.lua, shared/offences.lua, sql/*.sql
Aureus_policePolice job, ranks, evidence, scene investigation, bodycam, K9, tactical tools and equipment.shared/config.lua, shared/jobequip_config.lua, ox_inventory/items.lua, ox_inventory/images/*.png
Aureus_radarPatrol radar and ANPR HUD with BOLO awareness.config.lua
Aureus_uiShared Aureus menu, radial, notification, progress and loading reskin.config.lua

What Customers Can Edit

When assets are encrypted through Cfx/Keymaster, customers still need enough access to install and tune the pack. These docs keep them on safe surfaces.

Safe to editConfigs, SQL files, item definitions, image files, locales, saved JSON data and documentation.
Do not depend onProtected client/server internals, NUI source builds, compiled files or encrypted logic.
Best support ruleIf a buyer needs a behavior change, look for a config value first. If there is no config value, it is a developer update.

Common File Map

-- Admin menu
[DevWork]/Aureus_admin_menu/config.lua

-- Connect bridge
[DevWork]/Aureus_connect/shared/config.lua

-- Dispatch, garages, MDT, radar, UI
[DevWork]/Aureus_dispatch/config.lua
[DevWork]/Aureus_garages/config.lua
[DevWork]/Aureus_mdt/config.lua
[DevWork]/Aureus_radar/config.lua
[DevWork]/Aureus_ui/config.lua

-- Police
[DevWork]/Aureus_police/shared/config.lua
[DevWork]/Aureus_police/shared/jobequip_config.lua
[DevWork]/Aureus_police/ox_inventory/items.lua
[DevWork]/Aureus_police/ox_inventory/images/*.png

Install Order

Start dependencies first, then the UI/bridge layer, then gameplay resources. Keep folder names unchanged unless you also update resource mappings in the configs.

ensure ox_lib
ensure oxmysql
ensure ox_target
ensure ox_inventory

ensure Aureus_ui
ensure Aureus_connect
ensure Aureus_mdt
ensure Aureus_dispatch
ensure Aureus_radar
ensure Aureus_garages
ensure Aureus_police
ensure Aureus_admin_menu
Start Aureus_ui before resources that use the Aureus menu/progress/radial skin. Start Aureus_connect before police, MDT, dispatch and garage integrations.

Framework Setup

Most resources support auto-detection. If the server has multiple framework resources installed, force the correct one in each config.

-- Common values
Config.Framework = 'auto'       -- Detect automatically
Config.Framework = 'qbox'       -- qbx_core
Config.Framework = 'qbcore'     -- qb-core
Config.Framework = 'esx'        -- es_extended
Config.Framework = 'standalone' -- Admin/MDT only where supported
FrameworkWhat To CheckCommon Issue
Qboxqbx_core started, jobs/grades configured, owned vehicles in player_vehicles.Old QBCore event names can still work in some places, but configs should use your real job names.
QBCoreqb-core started, jobs in shared jobs, inventory or ox_inventory selected correctly.Item giving fails when the item is not installed in the active inventory.
ESXes_extended started, jobs and grades exist, database views/tables configured where needed.Custom ESX schemas may need config table/column names checked before launch.

ACE And Owners

Use ACE for first-boot owner access and command gates. Staff permissions inside the admin menu can then control day-to-day access.

# Replace these with the server owner's real identifiers.
add_principal identifier.license:b2d29abf0f03f0411639f54a9c7ceddc5b181319 group.owner
add_principal identifier.license2:b2d29abf0f03f0411639f54a9c7ceddc5b181319 group.owner

add_ace group.owner command allow
add_ace group.owner aureus.admin.open allow
add_ace group.owner aureus.admin.duty allow
add_ace group.owner aureus.admin.quick allow
add_ace group.owner aureus.garages.manage allow
add_ace group.owner aureus.mdt.access allow
Do not give broad command allow or admin ACEs to normal players. Use roles inside Aureus_admin_menu/config.lua for staff tiers.

Resource

Aureus Admin Menu

Staff dashboard for player management, reports, punishments, vehicles, inventory, economy, roles, logs and server tools.

Qbox / QBCore / ESX / Standalone

Customer Editable Files

  • Aureus_admin_menu/config.lua for framework, commands, reports, owners, identity display, role permissions, catalogs and integrations.
  • Aureus_admin_menu/sql/*.sql for manual database import if auto migration is disabled.
  • Aureus_admin_menu/data/*.json for optional manual catalog/fallback data.

First Setup

Config.Framework = 'auto'
Config.Inventory = 'auto'
Config.Database.AutoMigrate = true

Config.OwnerIdentifiers = {
  'license:b2d29abf0f03f0411639f54a9c7ceddc5b181319',
  'discord:332035384705810432',
  'fivem:4353894',
}

Config.Commands = {
  Admin = 'admin',
  Duty = 'adminduty',
  Report = 'report',
  Reply = 'reply',
}

Display IDs

Servers can show normal server IDs, tx/Cfx IDs, primary identifiers or a custom ID system. Use source if you want simple in-game server IDs.

Config.Identity.DisplayMode = 'source' -- source, tx, primary, custom
Config.Identity.DisplayPrefix = 'ID'

-- Custom ID export example:
Config.Identity.DisplayMode = 'custom'
Config.Identity.CustomExport = {
  resource = 'my_id_system',
  export = 'GetDisplayId',
}

Reports

Config.Reports = {
  Enabled = true,
  PlayerCommand = 'report',
  ReplyCommand = 'reply',
  CooldownSeconds = 60,
  SnapshotRadius = 25.0,
  AutoCloseResolved = false,
}

Items And Vehicles

Sale builds should only show real server data. If an item is not installed in the active inventory, the admin menu should not give it.

Config.ItemCatalog.OnlyInstalledServerItems = true
Config.ItemCatalog.PreferOxInventoryImages = true

Config.Spawner.LiveServerVehiclesOnly = true
Config.Spawner.IncludeConfigVehicles = false

Config.VehicleImages = {
  UseOxOrImagePack = true,
  UseAutoShot = true,
  RegularVehicleImageTemplate = '',
}

Quick Test

Open /admin as an owner.
Create a player report with /report.
Check notes save as separate entries.
Give only an installed ox_inventory item.
Change weather/time from World tools.
Confirm low staff roles cannot see restricted tabs.

Resource

Aureus Connect

Central bridge for resource names, feature toggles and shared exports. Configure this once when a server renames a resource.

Bridge layer

Customer Editable Files

  • Aureus_connect/shared/config.lua for resource names and feature toggles.

Resource Name Mapping

Config.Resources = {
  Mdt = 'Aureus_mdt',
  Police = 'Aureus_police',
  Dispatch = 'Aureus_dispatch',
  Garages = 'Aureus_garages',
  Impound = 'auto',
  Housing = 'auto',
}

Feature Toggles

Config.Features = {
  Fines = true,
  Mail = true,
  LicenseSync = true,
  Warrants = true,
  MdtRouting = true,
  DispatchAlerts = true,
  ImpoundBridge = true,
  HousingLookup = true,
}

Export Examples

-- Server-side examples from another resource:
exports.Aureus_connect:SendDispatchAlert({
  title = 'Suspicious Activity',
  message = 'Caller reports suspicious activity near Legion Square.',
  coords = vector3(215.8, -810.1, 30.7),
  jobs = { 'police' }
})

exports.Aureus_connect:OpenEmsMdt(source, 'patients')

exports.Aureus_connect:CreatePoliceImpoundRequest(source, {
  plate = 'AUREUS',
  reason = 'Evidence hold',
  notes = 'Vehicle seized during investigation.'
})

Quick Test

Start only Connect and confirm no hard errors on missing optional resources.
Start MDT/dispatch/police and confirm Connect resource status detects them.
Rename a mapped resource only if the config is updated.
Test one dispatch alert export.

Resource

Aureus Dispatch

Emergency dispatch tablet with units, calls, BOLOs, quick alerts, chat and ps-dispatch style compatibility.

Qbox / QBCore / ESX shim

Customer Editable Files

  • Aureus_dispatch/config.lua for jobs, commands, keybinds, service separation, persistence and alert cooldowns.
  • Aureus_dispatch/locales/en.lua for display text.

Basic Config

Config.Debug = false
Config.OpenCommand = 'opendispatch'
Config.OpenKey = 'period'
Config.OnDutyOnly = true

Config.DispatchJobs = {
  police = true,
  ambulance = true,
}

Config.Jobs = {
  leo = true,
  ems = true,
}

Service Separation

Config.ServiceSeparation = {
  enabled = true,
  police = { 'police', 'sheriff', 'state' },
  ems = { 'ambulance' },
}

Alert Example

-- Client-side quick alert
exports.Aureus_dispatch:CustomAlert({
  dispatchCode = '10-66',
  title = 'Suspicious Vehicle',
  message = 'A caller reported a suspicious vehicle.',
  coords = GetEntityCoords(PlayerPedId()),
  jobs = { 'police' },
  priority = 2,
})

Common Commands

CommandUse
/opendispatchOpen the dispatch tablet.
/911Create an emergency police/EMS report.
/311Create a non-emergency report.
/911replyReply to an active caller where configured.
/callsignSet or update a unit callsign.

Resource

Aureus Garages

Owned vehicle garage system with public garages, depot support, fleet spawners and an in-game garage configurator.

Qbox / QBCore / ESX

Customer Editable Files

  • Aureus_garages/config.lua for garage locations, distances, keys, persistence and configurator permissions.
  • Aureus_garages/sql/*.sql for manual import.
  • Aureus_garages/data/*.json for saved configured garages where file persistence is used.

Configurator Access

Config.ConfiguratorCommand = 'garageconfig'
Config.ConfiguratorAce = 'aureus.garages.manage'
Config.ConfiguratorRequireAce = true
Config.ConfiguratorPermission = 'garages.manage'

Add A Garage

Config.Garages = {
  legion = {
    label = 'Legion Square',
    type = 'public',
    coords = vec3(215.8, -810.1, 30.7),
    spawn = vec4(229.6, -800.1, 30.6, 160.0),
    blip = true,
  },
  mrpd_fleet = {
    label = 'MRPD Fleet',
    type = 'job',
    job = 'police',
    coords = vec3(441.2, -1018.5, 28.6),
    spawn = vec4(446.4, -1024.1, 28.2, 92.0),
  },
}

Vehicle Keys

Config.VehicleKeys = {
  provider = 'auto',
  providerOrder = {
    'qbx_vehiclekeys',
    'qb-vehiclekeys',
    'qs-vehiclekeys',
    'MrNewbVehicleKeys',
    'vehicles_keys',
  },
}

Useful Exports

exports.Aureus_garages:RegisterGarage('event_garage', {
  label = 'Event Garage',
  type = 'public',
  coords = vec3(100.0, 100.0, 30.0),
  spawn = vec4(105.0, 100.0, 30.0, 90.0),
})

local garages = exports.Aureus_garages:GetGarages()
exports.Aureus_garages:UnregisterGarage('event_garage')

Resource

Aureus MDT

Police and EMS data terminal for persons, vehicles, cases, BOLOs, warrants, charges, medical records and reports.

Qbox / QBCore / ESX / Standalone

Customer Editable Files

  • Aureus_mdt/config.lua for framework, commands, jobs, EMS mode, duty rules, fine routing and tracking.
  • Aureus_mdt/shared/offences.lua for charges, fines and categories.
  • Aureus_mdt/sql/*.sql for manual database import.

Basic Setup

Config.Framework = 'auto'
Config.Command = 'mdt'
Config.CommandAliases = { 'policemdt' }
Config.Keybind = 'F7'

Config.PoliceJobs = {
  police = true,
  sheriff = true,
}

Config.EmsJobs = {
  ambulance = true,
}

Config.EnableEmsMdt = true
Config.RequireOnDuty = true
Config.MinGrade = 0

Add Or Edit Charges

-- shared/offences.lua example
return {
  {
    category = 'Traffic',
    title = 'Excessive Speed',
    fine = 750,
    months = 0,
    points = 2,
  },
  {
    category = 'Criminal',
    title = 'Armed Robbery',
    fine = 5000,
    months = 45,
    points = 0,
  },
}

EMS Export Examples

-- Server side
exports.Aureus_mdt:UpsertPatient({
  citizenid = 'ABC123',
  name = 'John Citizen',
  dob = '1996-03-10',
})

exports.Aureus_mdt:UpdateVitals('ABC123', {
  heartRate = 82,
  bloodPressure = '120/80',
  oxygen = 98,
})

exports.Aureus_mdt:CreateMedicalReport({
  patientCid = 'ABC123',
  title = 'Treatment Report',
  summary = 'Patient treated and released.',
})

Open The MDT From Another Resource

-- Client side
exports.Aureus_mdt:OpenMDT()
exports.Aureus_mdt:OpenEmsMDT('patients')

-- Server side
exports.Aureus_mdt:OpenMDT(source, 'cases')

Resource

Aureus Police

Police job suite with ranks, job equipment, arrest tools, court-ready evidence, scene investigation, bodycam/dashcam, K9 and tactical tools.

Qbox / QBCore / ESX

Customer Editable Files

  • Aureus_police/shared/config.lua for jobs, ranks, keybinds, evidence, bodycam, K9, tools, props and integrations.
  • Aureus_police/shared/jobequip_config.lua for job equipment, tiers, divisions and item access.
  • Aureus_police/ox_inventory/items.lua and ox_inventory/images/*.png for inventory setup.
  • Aureus_police/sql/*.sql for manual database import.

Jobs And Six Default Ranks

Config.PoliceJobs = {
  police = true,
  sheriff = true,
  state = true,
}

Config.PoliceGradeLabels = {
  [0] = 'Cadet',
  [1] = 'Officer',
  [2] = 'Senior Officer',
  [3] = 'Sergeant',
  [4] = 'Lieutenant',
  [5] = 'Chief',
}

Config.OrgActionGrades = {
  open = 5,
  manageMembers = 5,
  manageDivisions = 5,
  manageEquipment = 5,
}

Job Equipment Example

-- shared/jobequip_config.lua pattern
JE.AuthorizedJobs = {
  police = 0,
  sheriff = 0,
}

JE.PermissionTiers = {
  patrol = { label = 'Patrol', minGrade = 0 },
  supervisor = { label = 'Supervisor', minGrade = 3 },
  command = { label = 'Command', minGrade = 5 },
}

JE.Items = {
  {
    name = 'police_flashbang',
    label = 'Flashbang',
    minGrade = 2,
    tier = 'supervisor',
    amount = 1,
  },
}

ox_inventory Setup

-- Copy entries from:
Aureus_police/ox_inventory/items.lua

-- Into:
ox_inventory/data/items.lua

-- Copy images from:
Aureus_police/ox_inventory/images/*.png

-- Into:
ox_inventory/web/images
If an item is not installed in ox_inventory/data/items.lua, the admin menu should show it as missing and players cannot use it correctly.

Evidence Chain Of Custody

Config.Evidence.ChainOfCustody = {
  enabled = true,
  requireCaseId = false,
  allowExternalExports = true,
  maxHistory = 100,
}
-- Server-side external evidence log
exports.Aureus_police:RecordEvidenceCustody({
  case_id = 'CASE-2026-001',
  event_type = 'transfer',
  item_name = 'evidence_bag',
  officer = 'Unit 301',
  from_location = 'Scene',
  to_location = 'Evidence Locker',
  metadata = { plate = 'AUREUS' },
})

Scene, Bodycam, K9 And Tactical Tools

Config.SceneInvestigation.enabled = true
Config.Bodycam.enabled = true
Config.K9.enabled = true
Config.TacticalTools.enabled = true

Config.K9.minGrade = 2
Config.K9.attackMinGrade = 4

Config.TacticalTools.flashbang = {
  item = 'police_flashbang',
  consumeItem = true,
}

Common Commands

CommandUse
/orgsOpen organization/division management when the rank config allows it.
/policetoolsOpen tactical tools.
/scenetoolsOpen scene investigation tools.
/k9Open K9 unit controls.
/bcmark labelAdd a bodycam/dashcam marker.
/bcpanicCreate a panic marker and dispatch call when dispatch is running.

Resource

Aureus Radar

Patrol radar and ANPR HUD for law enforcement vehicles with target locking, front/rear modes and BOLO awareness.

Qbox / QBCore / ESX shim

Customer Editable Files

  • Aureus_radar/config.lua for allowed vehicles, jobs, duty checks, keys, speed units, BOLO behavior and colors.

Basic Config

Config.Debug = false
Config.RequireDriver = true
Config.RequireOnDuty = true
Config.SpeedUnit = 'MPH' -- MPH or KMH
Config.MaxDistance = 80.0

Config.AllowedJobs = {
  police = true,
  sheriff = true,
}

Config.AllowedVehicles = {
  police = true,
  police2 = true,
  sheriff = true,
}

Controls

Config.ToggleKey = 'F7'
Config.LockKey = 'F8'
Config.ModeKey = 'F9'
Config.SettingsKey = 'F10'

Config.ShowBoloInfoDefault = true
Config.BoloBeepDefault = true
Config.AutoLockBoloDefault = false

Useful Exports

local target = exports.Aureus_radar:GetLockedTarget()
local front = exports.Aureus_radar:GetLockedTargetForMode('front')
local rear = exports.Aureus_radar:GetLastTargetForMode('rear')

Resource

Aureus UI

Shared UI layer for Aureus menu styling, radial reskin, progress bars, loading circles and salary-style notifications.

Framework agnostic

Customer Editable Files

  • Aureus_ui/config.lua for brand, colors, menu sizing, radial sizing, progress style, notifications and debug commands.

Theme Setup

Config.Brand = 'Aureus'

Config.Theme = {
  background = '#0d0d0f',
  surface = '#141416',
  accent = '#d4af37',
  accentSoft = '#f4d56a',
  text = '#ffffff',
}

Progress And Loading

Config.Progress = {
  useAureusStyle = true,
  transparentPanel = true,
  barColor = '#55c7ff',
  frameColor = '#ffffff',
  textColor = '#ffffff',
}

-- Client-side use
exports.Aureus_ui:progressBar({
  duration = 3500,
  label = 'Running rego check...',
  canCancel = true,
})

Radial Reskin

Config.Radial = {
  radius = 190,
  itemSize = 78,
  centerSize = 58,
  command = 'aureus_radial',
  keybind = 'z',
  bridge = {
    enabled = true,
    autoPatchManifest = true,
  },
}
With the bridge enabled, Aureus_ui can patch supported Qbox/QB radial resources so @Aureus_ui/init.lua loads after @ox_lib/init.lua. If a host blocks manifest writes, set auto patch off and add the shim manually.

Menu Example

exports.Aureus_ui:registerContext({
  id = 'example_menu',
  title = 'Example',
  options = {
    {
      title = 'Run Check',
      description = 'Starts a progress bar.',
      event = 'myresource:runCheck',
    },
  },
})

exports.Aureus_ui:showContext('example_menu')

Reusable Snippets

These snippets are safe examples for customer configs or third-party integrations.

Simple Staff Permission Check

local allowed = exports.Aureus_admin_menu:HasPermission(source, 'players.kick')
if not allowed then
  return
end

Create Dispatch Alert From Police Tool

exports.Aureus_connect:SendDispatchAlert({
  title = 'Officer Panic',
  message = 'An officer pressed their panic button.',
  coords = GetEntityCoords(GetPlayerPed(source)),
  jobs = { 'police' },
  priority = 1,
})

Add Evidence History From Another Script

exports.Aureus_police:RecordEvidenceCustody({
  case_id = 'CASE-001',
  event_type = 'collected',
  item_name = 'shell_casing',
  officer = GetPlayerName(source),
  metadata = { weapon = 'WEAPON_PISTOL' },
})

Troubleshooting

ProblemLikely CauseFix
Admin menu says invalid itemThe item is not installed in the active inventory catalog.Add the item to ox_inventory/data/items.lua, copy the image, restart ox_inventory and admin menu.
Players can see staff tabsRole permissions are too broad or tab visibility config is wrong.Review staff roles in Aureus_admin_menu/config.lua and test with a low-rank account.
Dispatch opens invisibleNUI focus is active but UI resource/files are not loaded or CSS is hidden.Restart dispatch, check F8/NUI console, confirm ui/index.html, JS and CSS are included in the manifest.
Radial menu is still ox_lib defaultRadial bridge did not patch the radial resource or the shim loads too late.Start Aureus_ui before radial scripts or manually add @Aureus_ui/init.lua after @ox_lib/init.lua.
Weather buttons do nothingNo supported weather resource is running or server config points at the wrong provider.Start the weather sync resource or configure the admin world/weather provider.
Police tool item does nothingUsable item was not registered or item name does not match config.Check Aureus_police/ox_inventory/items.lua and item names in shared/config.lua.
MDT opens for wrong jobsPolice/EMS job config does not match framework jobs.Edit Config.PoliceJobs, Config.EmsJobs and duty settings.
Garages do not saveDatabase persistence or SQL import is missing.Import garage SQL or keep auto migration enabled, then restart Aureus_garages.

Delivery Checklist

Only include docs for the listed eight resources on this page.
Keep configs, SQL, locales, item files and images editable through escrow ignore.
Import SQL or verify auto migration completes.
Test framework detection on the target framework.
Open admin menu and confirm permission hiding.
Send a player report and staff reply.
Open MDT as police and EMS.
Create a dispatch alert and attach a unit.
Store and pull a vehicle from garages.
Use police evidence, K9 and tactical tools.
Toggle radar in a configured police vehicle.
Confirm UI progress, radial and menus are Aureus styled.
If a customer asks how to change behavior that is not exposed in these config files, treat it as a custom development request rather than a setup issue.