Free script documentation · ESX / QBCore / Qbox / Standalone

TenX Report System

Installation, permissions, report commands, staff actions, and configuration for the TenX Report System.

01 / 24

Overview

TenX Report System is an advanced FiveM report management system for players and staff. Players can submit reports through a clean NUI using /report, while staff can manage active reports using /reports. Supported: - ESX - QBCore - Qbox - Standalone - Discord webhook logs - Custom branding - Multiple languages - Draggable NUI
02 / 24

Installation

1. Download and extract the resource. 2. Place the folder inside your server resources directory: resources/[tenx]/tenx_reports 3. Add the resource to your server.cfg: ensure tenx_reports 4. Restart the server or resource: restart tenx_reports
03 / 24

Framework Configuration

Open: config.lua By default: Config.Framework = 'auto' The resource automatically detects: - ESX - QBCore - Qbox You can also manually specify the framework: Config.Framework = 'esx' or: Config.Framework = 'qb' or: Config.Framework = 'qbox' For standalone: Config.Framework = 'standalone'
04 / 24

Language

Default language: Config.Locale = 'en' Available locales: - English - Italian To use Italian: Config.Locale = 'it' Locale files are located inside: locales/ You can create additional translations by copying an existing locale file.
05 / 24

Commands

Player command /report Opens the report submission interface. Players can select a category and describe their issue. Staff command /reports Opens the staff report management interface. Staff can: - View active reports - Claim reports - View player data - Go to the player - Bring the player - Reply to the player - Close the report
06 / 24

Report Categories

Default categories: Config.Categories = { { id = 'player', label = 'Player Report', icon = 'user' }, { id = 'bug', label = 'Bug Report', icon = 'bug' }, { id = 'other', label = 'Question', icon = 'question' } } You can change the labels directly from config.lua. Example: Config.Categories = { { id = 'player', label = 'Player Report', icon = 'user' }, { id = 'bug', label = 'Technical Issue', icon = 'bug' }, { id = 'other', label = 'General Question', icon = 'question' } }
07 / 24

Staff Permissions

ESX No ACE configuration is required. Staff permissions are based on the player's ESX group. Default allowed groups: Config.ESXGroups = { mod = true, admin = true, superadmin = true } For example, if a player has the admin group through your normal ESX setgroup system, they will be able to use: /reports You can add additional groups: Config.ESXGroups = { helper = true, moderator = true, mod = true, admin = true, superadmin = true } QBCore / Qbox Default permissions: Config.QBCorePermissions = { mod = true, admin = true, god = true } Players with one of these permissions can access /reports.
08 / 24

One Active Report System

By default: Config.OneActiveReportPerPlayer = true This means a player cannot submit another report while their previous report is still active. They must wait until staff closes the current report. The system identifies the player using their license, preventing reconnection from bypassing the restriction. To disable this: Config.OneActiveReportPerPlayer = false
09 / 24

Report Cooldown

Default: Config.ReportCooldown = 30 This prevents report spam. The value is measured in seconds. Example: Config.ReportCooldown = 60
10 / 24

Maximum Report Length

Default: Config.MaxMessageLength = 800 Example: Config.MaxMessageLength = 500
11 / 24

Branding

You can customize the interface directly from: Config.UI Default configuration: Config.UI = { serverName = 'Your Server Name', systemLabel = 'REPORT SYSTEM', logo = '', fallbackInitials = 'YS', showBrandText = true } Server Name Change: serverName = 'Your Server Name' Example: serverName = 'Axel Academy' System Label Default: systemLabel = 'REPORT SYSTEM' Example: systemLabel = 'SUPPORT CENTER' Custom Logo The logo can be loaded using a direct image URL. Example: logo = 'https://your-image-link.com/logo.png' For hosting the logo, FiveManage is recommended. Upload your logo to FiveManage and paste the direct image URL into: Config.UI.logo Example: Config.UI = { serverName = 'Your Server Name', systemLabel = 'REPORT SYSTEM', logo = 'https://your-direct-image-link.png', fallbackInitials = 'YS', showBrandText = true } If the logo cannot be loaded, the resource automatically displays: fallbackInitials = 'YS' Example: fallbackInitials = 'TX'
12 / 24

Discord Webhook

The resource includes Discord logging. Configuration: Config.Webhook = { enabled = true, url = '', username = 'TenX Reports', avatarUrl = '', colorNew = 3447003, colorAction = 16753920, colorClosed = 5763719 } Paste your webhook URL: url = 'YOUR_DISCORD_WEBHOOK' Example: Config.Webhook = { enabled = true, url = 'https://discord.com/api/webhooks/...', username = 'TenX Reports', avatarUrl = '', colorNew = 3447003, colorAction = 16753920, colorClosed = 5763719 } To disable webhook logs: enabled = false
13 / 24

Discord Logs

The webhook records actions such as: - New report - Report claimed - Staff reply - Goto player - Bring player - Report closed New report logs can include: - Player name - Server ID - Category - Job - Ping - Coordinates - Identifiers - Report message
14 / 24

Staff Actions

You can enable or disable individual actions. Config.Actions = { claim = true, gotoPlayer = true, bringPlayer = true, reply = true, close = true } For example, to disable Bring: bringPlayer = false
15 / 24

Claim System

Staff can claim a report. Once claimed, the report status changes from: Open to: Claimed The interface also displays the staff member handling the report. When a staff member claims a report they receive: Report claimed successfully. Other staff members cannot claim the same report while it is already being handled.
16 / 24

Goto Player

The staff member can select: Go to player This teleports the staff member to the reporting player.
17 / 24

Bring Player

The staff member can select: Bring player The reporting player is teleported to the staff member.
18 / 24

Staff Reply

Staff can enter a message inside the report panel and send it directly to the player. The player receives the reply using the notification system supported by their framework.
19 / 24

Closing Reports

When staff selects: Close report the report is removed from the active report list. The player is then allowed to submit another report.
20 / 24

Notifications

The resource automatically uses framework notifications. ESX Uses: ESX.ShowNotification QBCore Uses: QBCore.Functions.Notify Qbox Uses Qbox notifications when available. Fallback If supported, ox_lib can be used as a fallback. Otherwise the resource can fall back to chat notifications.
21 / 24

Draggable Interface

Both interfaces can be moved around the screen. Hold the left mouse button on an empty area of the menu and drag it. Dragging is automatically disabled while interacting with: - Buttons - Input fields - Text areas This prevents accidental movement while typing or clicking.
22 / 24

Default Configuration Example

Config = {} Config.Framework = 'auto' Config.Locale = 'en' Config.PlayerCommand = 'report' Config.StaffCommand = 'reports' Config.ReportCooldown = 30 Config.MaxMessageLength = 800 Config.OneActiveReportPerPlayer = true Config.UI = { serverName = 'Your Server Name', systemLabel = 'REPORT SYSTEM', logo = '', fallbackInitials = 'YS', showBrandText = true } Config.Categories = { { id = 'player', label = 'Player Report', icon = 'user' }, { id = 'bug', label = 'Bug Report', icon = 'bug' }, { id = 'other', label = 'Question', icon = 'question' } } Config.ESXGroups = { mod = true, admin = true, superadmin = true } Config.QBCorePermissions = { mod = true, admin = true, god = true } Config.Webhook = { enabled = true, url = '', username = 'TenX Reports', avatarUrl = '', colorNew = 3447003, colorAction = 16753920, colorClosed = 5763719 } Config.Actions = { claim = true, gotoPlayer = true, bringPlayer = true, reply = true, close = true } Config.NotifyDuration = 5000
23 / 24

Dependencies

No database is required. Supported: - ESX - QBCore - Qbox - Standalone ox_lib is not required.
24 / 24

Support

Before requesting support, verify: - The resource is named correctly - ensure tenx_reports is present - Your framework starts before tenx_reports - Your ESX staff group is included in Config.ESXGroups - The webhook URL is valid - Your logo URL is a direct image link Resource: TenX Report System Developer: TenX Studios Frameworks: ESX • QBCore • Qbox • Standalone
Browse other guides