Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apex-services.site/llms.txt

Use this file to discover all available pages before exploring further.

A player report ticketing system for FiveM / ESX with a built-in React admin manager UI. Players press /report to open a compact form (bug / player report / question), admins receive real-time notifications and manage the full lifecycle — take ownership, close, re-open, teleport-mark the reporter on the map.

Features

  • /report command with optional key mapping
  • 3 report types out of the box (bug / player / question), fully configurable
  • Per-player cooldown (default 60s) + min / max message length
  • Coords captured at submission — admin map-mark works even for offline reporters
  • Real-time admin notifications on new reports
  • Status workflow — pending → in_progress → completed
  • Two permission tiers — view/assign/close vs. delete
  • Automatic SQL table creation
  • en/de localization

Requirements

Required

es_extended, ox_lib, oxmysql

Configuration

config.lua
Config.ReportCommand       = 'report'
Config.ReportKeyMapping    = ''
Config.ManagerCommand      = 'reportmanager'
Config.AllowedGroups       = { 'admin', 'projektleitung', 'founder', 'frakverwaltung' }
Config.DeleteAllowedGroups = { 'projektleitung', 'teamverwaltung' }
Config.CooldownSeconds     = 60
Config.MinMessageLength    = 10
Config.MaxMessageLength    = 200
Config.ReportTypes         = {
    { id = 'BUG',      icon = 'bug' },
    { id = 'PLAYER',   icon = 'user-xmark' },
    { id = 'QUESTION', icon = 'circle-question' },
}
Add new report types by extending Config.ReportTypes and adding locale keys.

Hooks

See Hooks reference / Reports. Key hooks: Hooks.OnPlayerNotify, Hooks.OnAdminNotify, Hooks.GetAdminsForNotification, Hooks.HasManagerPermission, Hooks.CanDeleteReports.

Resource info

Code accessible: config.lua, hooks.lua, locales/*, web/*. Approximately 800 lines of Lua + React UI. English + German.