Customer documentation
TenX Admin Menu
Installation, permissions, staff terminal features and configuration for the TenX Admin Menu.
1. Introduction
TenX Admin Menu is an advanced staff management resource for FiveM servers.
It provides a centralized Staff Terminal for managing players, reviewing server activity, controlling the game world, handling refunds and managing administrative permissions.
### Main Features
- Modern Staff Terminal interface
- Player management and administrative actions
- Live player map
- Weather and time controls
- Vehicle, object and NPC cleanup
- Server audit logs
- Economy monitoring
- Refund codes for online and offline players
- Risk alerts and sanctions
- Offline bans
- Staff roles and permissions
- Discord profile integration
- Personal and developer menus
- English and Italian localization
Some features depend on the selected framework, inventory system and server configuration.
2. Requirements
Before installation, make sure your server has:
- A working FiveM server
- A supported framework: ESX or QBCore
- A MySQL-compatible database
- `oxmysql`
- A compatible inventory and vehicle ownership setup for the features you intend to use
**Important:** Database and framework dependencies must be started before TenX Admin Menu.
3. Installation
### Step 1 — Extract the resource
Download your purchased package and extract the `tenx_admin` folder.
Place it inside your FiveM server resources directory:
```text
resources/
└── [tenx]/
└── tenx_admin/
├── client/
├── server/
├── config/
├── html/
├── locales/
├── sql/
└── fxmanifest.lua
```
Do not rename the resource folder unless the release explicitly supports a different name.
### Step 2 — Configure the database
Open the `sql` folder and import:
```text
sql/schema.sql
```
Use your preferred MySQL database administration tool.
For existing installations, check the included migration files before upgrading. Back up your database before importing migrations.
### Step 3 — Update server.cfg
Add the following resources in the correct order:
```cfg
ensure oxmysql
ensure es_extended
ensure tenx_admin
```
For QBCore servers, use `ensure qb-core` instead of `ensure es_extended`.
Make sure your database connection is configured correctly before starting the resource.
### Step 4 — Restart
Restart the FiveM server or start the resource from the server console:
```text
ensure tenx_admin
```
Check the FXServer console for startup errors.
4. Basic Configuration
Open:
```text
tenx_admin/config/server.lua
```
This file contains the main resource settings.
### Language
```lua
Config.Locale = 'en'
```
Available languages:
- `en` — English
- `it` — Italian
### Admin Menu Command
```lua
Config.OpenCommand = 'serverlog'
```
Default command:
```text
/serverlog
```
You can change the command name in the configuration.
### Framework Detection
```lua
Config.Framework = 'auto'
```
The resource attempts to detect the running framework automatically.
### Inventory Detection
```lua
Config.Inventory = 'auto'
```
The resource attempts to use the configured inventory integration.
Test inventory operations on your framework before using them on a production server.
5. Staff Permissions
TenX Admin Menu uses a role-based permission system.
Default roles include:
| Role | Description |
|---|---|
| Owner | Full administrative access |
| Admin | Advanced management access |
| Moderator | Moderation and player management |
| Support | Basic player assistance and reports |
### Framework Group Mapping
Example:
```lua
Config.GroupRoles = {
esx = {
superadmin = 'owner',
admin = 'admin',
moderator = 'moderator',
support = 'support'
},
qb = {
god = 'owner',
admin = 'admin',
moderator = 'moderator',
support = 'support'
}
}
```
These are example mappings. Adapt them to the actual groups used by your server.
### Permissions
The `Config.Permissions` table defines which functions each role can access.
For example:
```lua
Config.Permissions = {
owner = {'*'},
support = {'panel', 'players', 'logs', 'dm', 'reports'}
}
```
The `*` permission grants full access.
Avoid assigning sensitive permissions to untrusted staff members.
### Hierarchy Protection
```lua
Config.Hierarchy = {
enabled = true,
protectSameRank = true
}
```
This setting controls protection between administrative ranks.
6. Admin Commands
| Command | Purpose |
|---|---|
| `/serverlog` | Opens the Staff Terminal by default |
| `/refund CODE` | Redeems an issued refund code |
| `/report` | Opens or submits a player report through the configured workflow |
| `/tenxpersonal` | Requests the personal staff menu |
| `/tenxdev` | Requests the developer menu |
| `/tenxcheck` | Checks resource access and startup status |
| `/tenxuihide` | Closes the NUI locally |
| `/tenxdiag` | Runs resource diagnostics |
The admin, refund and report command names can be customized where supported by the configuration.
Some diagnostic commands are intended for administrators or technical support only.
7. Refund System
The refund system allows authorized staff members to create redeemable codes containing items or vehicles.
### Creating a Refund
1. Open the Staff Terminal.
2. Navigate to **Refunds**.
3. Start creating a new refund.
4. Choose the refund mode that does not require selecting a player.
5. Enter a reason or ticket reference.
6. Add the items and quantities to deliver.
7. Add any supported vehicles.
8. Generate the unique refund code.
9. Send the code privately to the intended player.
### Redeeming a Refund
The player joins the server and enters:
```text
/refund TX-123456
```
`TX-123456` is an example, not a valid issued code.
The system validates the code and attempts to deliver the configured rewards.
### Refund Statuses
| Status | Meaning |
|---|---|
| Pending | Waiting to be redeemed |
| Processing | Delivery is being processed |
| Claimed | Refund has been redeemed |
| Review | Requires administrative review |
### Refund Configuration
```lua
Config.Refund = {
command = 'refund',
codePrefix = 'TX',
maxLines = 20,
maxItemQuantity = 1000,
allowedVehicles = {
sultan = true,
adder = true,
bati = true,
blista = true
}
}
```
Only configure vehicles supported by your server.
**Security:** Unassigned refund codes should be treated as sensitive. Anyone receiving a valid unclaimed code may be able to redeem it, so share codes privately.
Test item and vehicle delivery, including error recovery, before using the refund system commercially.
8. Operations Dashboard
The Operations Dashboard provides access to frequently used server controls.
### Weather & Time
Authorized staff can select supported GTA V weather presets and change the in-game time.
Example configuration:
```lua
Config.Weather = {
enabled = true,
default = 'EXTRASUNNY'
}
```
### Live Map
The Live Map section is intended to display the positions of online players.
```lua
Config.LiveMap = {
enabled = true
}
```
Availability and update behavior depend on the running server environment.
### Cleanup Tools
The dashboard includes controls for:
- Empty vehicle cleanup
- Object cleanup
- NPC cleanup
- Cleanup radius selection
Example configuration:
```lua
Config.WorldCleanup = {
enabled = true,
maxRadius = 1000,
maxEntities = 2500,
cooldownSeconds = 5
}
```
Use cleanup tools carefully on live roleplay servers, particularly when players are interacting with vehicles or world objects.
9. Player Management
The Players section provides authorized staff with administrative tools.
Depending on permissions and framework integration, these may include:
- Viewing player information
- Teleporting to players
- Bringing players
- Freezing players
- Healing and reviving
- Spectating
- Viewing or managing inventory
- Reviewing vehicles
- Administrative sanctions
- Character management
Sensitive actions should be restricted to trusted roles.
10. Audit Logs & Risk Alerts
TenX Admin Menu includes a logging system for administrative and selected gameplay events.
Example configuration:
```lua
Config.Logging = {
enabled = true,
death = true,
queueLimit = 800
}
```
Log categories can be enabled or disabled through the logging configuration.
The Risk Alerts section is intended to help staff investigate suspicious events. It should not be treated as a replacement for a dedicated anti-cheat system.
### Webhooks
```lua
Config.Webhook = ''
```
Configure the appropriate Discord webhook URL if you want supported events forwarded externally.
Keep webhook URLs private.
11. Discord Integration
TenX Admin Menu supports Discord profile information for the Staff Terminal.
Open `config/server.lua`:
```lua
Config.Discord = {
botToken = '',
cacheSeconds = 600
}
```
You may also configure the bot token through `server.cfg`:
```cfg
set tenx_discord_bot_token "YOUR_BOT_TOKEN"
```
Never publish your Discord bot token.
For Discord profile information to appear, the player must have an available Discord identifier and the server must be able to retrieve the profile from Discord.
If the profile cannot be retrieved, the menu may display fallback player information.
12. Branding
The resource includes basic branding configuration:
```lua
Config.Branding = {
name = 'TENX STAFF',
logo = 'logo.png'
}
```
The default logo file is located at:
```text
tenx_admin/html/logo.png
```
Replace it with your permitted custom image while keeping the expected filename and format.
13. Reports
The report system allows players to submit issues for staff review.
Default categories include:
- Player reports
- Bug reports
- Other issues
Example configuration:
```lua
Config.Reports = {
command = 'report',
categories = {'player', 'bug', 'other'},
cooldownSeconds = 30,
maxLength = 800
}
```
Configure staff permissions so the appropriate team members can access reports.
14. Troubleshooting
### The Admin Menu Does Not Open
Check that:
1. `tenx_admin` is started.
2. `oxmysql` and your framework started successfully.
3. Your framework group is mapped correctly.
4. Your role has the `panel` permission.
5. The configured command is being used.
Try:
```text
/tenxcheck
```
Check the FXServer console for detailed errors.
### Database Errors
Verify that:
- The database connection is valid.
- `oxmysql` is running.
- `sql/schema.sql` was imported.
- Any necessary migrations have been applied.
### Discord Avatar Is Missing
Verify that:
- The bot token is valid.
- The player has a Discord identifier.
- The server can access Discord's API.
- The Discord configuration has been loaded.
### Refund Cannot Be Redeemed
Check that:
- The code exists.
- The code has not already been claimed.
- The required item or vehicle is valid.
- The inventory or garage integration is functioning.
- The refund database tables exist.
### NUI Is Stuck on Screen
Try:
```text
/tenxuihide
```
If the issue persists, check the FiveM F8 console for NUI errors.
15. Updates
Before updating:
1. Stop the resource.
2. Back up `config/server.lua`.
3. Back up any customized localization or branding files.
4. Back up the database.
5. Replace the resource files with the updated release.
6. Review database migrations and configuration changes.
7. Restart and test the resource.
Do not overwrite customer configuration files without reviewing changes between versions.
16. Support
For installation assistance, configuration questions or bug reports, contact TenX Studios.
**Website:** https://tenxstudios.dev/
**Discord:** https://discord.com/invite/TENXSTUDIOS
**Documentation:** https://tenxstudios.dev/docs
When reporting a problem, include the resource version, framework, relevant console errors and steps to reproduce the issue.
---
**TenX Admin Menu**
*One Terminal. Total Control.*
© TenX Studios. All rights reserved.