# Home
Official Documentation for Tworst Scripts - Premium FiveM Resources
Welcome to Tworst Scripts Documentation
Explore our comprehensive resources, including installation guides, configuration options, and support materials, to confidently set up and customize your FiveM server.
### Get Started
Getting Started
Quick setup guide to get your first Tworst Script running on your server.
{% hint style="info" %}
**Need Help?** Can't find what you're looking for? Join our [Discord server](https://discord.gg/tworst) and open a support ticket.
{% endhint %}
# Installation Guide
This guide covers the general installation process for all Tworst Scripts.
## Downloading Your Script
After purchasing a script from [tworst.com](https://tworst.com), follow these steps to download it:
### Step 1: Go to Cfx.re Portal
Visit [portal.cfx.re](https://portal.cfx.re) and log in with your Cfx.re account (the same account linked to your Tebex purchase).
### Step 2: Navigate to Your Assets
1. Click on **"Granted Assets"** in the left sidebar
2. You will see a list of all scripts you have purchased
### Step 3: Download the Script
1. Find the script you want to download
2. Click the **"Download"** button next to it
3. The script will be downloaded as a `.zip` file
{% hint style="info" %}
**Can't see your purchase?** Make sure you're logged in with the same Cfx.re account that was linked during checkout on tworst.com. If you still have issues, open a ticket on our [Discord](https://discord.gg/tworst).
{% endhint %}
***
## Prerequisites
Before installing any Tworst Script, make sure you have:
* A working FiveM server
* ESX, QBCore, or vRP framework installed
* One of the following database resources:
* **oxmysql** (Recommended)
* mysql-async
* ghmattimysql
* **PolyZone** resource (required for all scripts)
***
## Installing the Script
### Step 1: Extract Files
Extract the downloaded `.zip` file to your server's `resources` folder:
```
resources/
โโโ tw-scriptname/
โโโ fxmanifest.lua
โโโ insert.sql
โโโ config/
โ โโโ config.lua
โ โโโ coordinate.lua
โ โโโ GetCore.lua
โโโ client/
โโโ server/
โโโ locales/
โโโ html/
```
### Step 2: Database Setup
{% hint style="success" %}
**Automatic Setup:** All Tworst Scripts automatically create the required database tables when the script starts for the first time. In most cases, you don't need to manually import anything!
{% endhint %}
**Manual Installation (Optional):**
If automatic table creation fails or you prefer manual setup, you can import the `insert.sql` file:
**HeidiSQL:**
1. Connect to your database
2. Select your database
3. File โ Run SQL file
4. Select the `insert.sql` file
5. Execute
**phpMyAdmin:**
1. Login to phpMyAdmin
2. Select your database
3. Go to "Import" tab
4. Choose the `insert.sql` file
5. Click "Go"
{% hint style="warning" %}
Always backup your database before importing new tables manually.
{% endhint %}
### Step 3: Configure the Script
Open `config/config.lua` and adjust settings to match your server:
```lua
-- Framework Selection
Config.Framework = 'qb' -- Options: 'esx', 'oldesx', 'qb', 'oldqb', 'vrp'
-- Language
Config.Locale = 'en' -- Options: 'en', 'tr', 'de', 'fr', 'pt', 'ru', 'ar'
-- Database Resource
Config.SQL = "oxmysql" -- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
-- Inventory System
Config.Inventory = "qb_inventory" -- Options: 'esx_inventory', 'ox_inventory', 'qs_inventory', 'qb_inventory'
-- Interaction System
Config.InteractionHandler = 'drawtext' -- Options: 'qb-target', 'ox-target', 'drawtext'
```
{% hint style="info" %}
Each script has additional configuration options. Check the specific script documentation for details.
{% endhint %}
### Step 4: Add to Server Config
Add the following lines to your `server.cfg`:
```cfg
# Dependencies (must be started first)
ensure oxmysql
ensure es_extended # or qb-core
ensure PolyZone
# Tworst Scripts
ensure tw-scriptname
```
{% hint style="warning" %}
Make sure to start the script **after** your framework, database, and PolyZone resources.
{% endhint %}
### Step 5: Start the Server
Restart your server or use the console commands:
```
refresh
ensure tw-scriptname
```
***
## Supported Systems
All Tworst Scripts support the following systems:
### Frameworks
| Framework | Config Value | Notes |
| ----------------------- | -------------- | --------------------- |
| QBCore | `'qb'` | |
| QBCore (older versions) | `'oldqb'` | |
| QBox | `'qb'` | Use `'qb'` for QBox |
| ESX Legacy | `'esx'` | |
| ESX (older versions) | `'oldesx'` | |
| vRP | `'vrp'` | |
| Standalone | `'standalone'` | No framework required |
{% hint style="info" %}
**QBox Users:** QBox is fully compatible with our scripts. Simply set `Config.Framework = 'qb'` to use QBox.
{% endhint %}
### Inventory Systems
| Inventory | Config Value |
| ---------------- | ----------------- |
| QBCore Inventory | `'qb_inventory'` |
| ESX Inventory | `'esx_inventory'` |
| ox\_inventory | `'ox_inventory'` |
| qs-inventory | `'qs_inventory'` |
### Target Systems
| Target System | Config Value |
| -------------------- | ------------- |
| DrawText (no target) | `'drawtext'` |
| qb-target | `'qb-target'` |
| ox\_target | `'ox-target'` |
### Vehicle Key Systems
| System | Config Value |
| --------------- | ------------------- |
| qb-vehiclekeys | `'qb-vehiclekeys'` |
| qbx-vehiclekeys | `'qbx-vehiclekeys'` |
| qs-vehiclekeys | `'qs-vehiclekeys'` |
| wasabi-carlock | `'wasabi-carlock'` |
| cd\_garage | `'cd_garage'` |
### Fuel Systems
| System | Config Value |
| ---------- | -------------- |
| LegacyFuel | `'LegacyFuel'` |
| ox\_fuel | `'ox_fuel'` |
| cdn-fuel | `'cdn-fuel'` |
| ps-fuel | `'ps-fuel'` |
| x-fuel | `'x-fuel'` |
### Clothing Systems
| System | Config Value |
| ------------------- | ----------------------- |
| qb-clothing | `'qb-clothing'` |
| illenium-appearance | `'illenium-appearance'` |
| fivem-appearance | `'fivem-appearance'` |
| esx\_skin | `'esx_skin'` |
{% hint style="info" %}
**Custom Support:** The clothing system is fully open-source. You can easily add support for other clothing scripts by modifying the code.
{% endhint %}
***
## Verification
After installation, check your server console. If you see errors:
1. Check config syntax (missing comma or bracket)
2. Verify framework detection in `Config.Framework`
3. Ensure all dependencies are started before the script
4. Check the [Troubleshooting](/guides/troubleshooting) page
***
## Need Help?
{% hint style="info" %}
Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Script name and version
* Framework (ESX/QBCore)
* Full error message
* Steps to reproduce
{% endhint %}
# Framework Support
Tworst Scripts support multiple frameworks to ensure compatibility with your server setup.
## Supported Frameworks
| Framework | Config Value | Support Level | Notes |
| ----------------------- | -------------- | ------------- | ------------------- |
| QBCore | `'qb'` | โ Full | |
| QBCore (older versions) | `'oldqb'` | โ Full | |
| QBox | `'qb'` | โ Full | Use `'qb'` for QBox |
| ESX Legacy | `'esx'` | โ Full | |
| ESX (older versions) | `'oldesx'` | โ Full | |
| vRP | `'vrp'` | โ Full | |
| vRP2 | `'vrp2'` | โ Full | |
| Standalone | `'standalone'` | โ Full | |
***
## Framework Support by Script
Not all scripts support every framework. Here's the compatibility matrix:
### Job Scripts (Full Support)
All multiplayer job scripts support **all frameworks**:
| Script | QB | QBox | ESX | vRP | Standalone |
| --------------- | :-: | :--: | :-: | :-: | :--------: |
| Gardener Job | โ | โ | โ | โ | โ |
| Scrapyard Job | โ | โ | โ | โ | โ |
| Transport Job | โ | โ | โ | โ | โ |
| Electrician Job | โ | โ | โ | โ | โ |
| Plumber Job | โ | โ | โ | โ | โ |
| Garbage Job | โ | โ | โ | โ | โ |
| Diving Job | โ | โ | โ | โ | โ |
| Fashion Job | โ | โ | โ | โ | โ |
### Other Scripts (Limited Support)
| Script | QB | QBox | ESX | vRP | Standalone |
| --------- | :-: | :--: | :-: | :-: | :--------: |
| Boss Menu | โ | โ | โ | โ | โ |
| Garage | โ | โ | โ | โ | โ |
***
## Configuration
### Setting Your Framework
Open `config/config.lua` and set your framework:
```lua
-- Framework Selection
Config.Framework = 'qb' -- Options: 'qb', 'oldqb', 'qbox', 'esx', 'oldesx', 'vrp', 'standalone'
```
### QBCore Configuration
```lua
Config.Framework = 'qb'
-- or for older QBCore versions:
Config.Framework = 'oldqb'
```
### QBox Configuration
```lua
Config.Framework = 'qb' -- QBox uses 'qb' config value
```
{% hint style="info" %}
**QBox Users:** QBox is fully compatible with our scripts. Simply set `Config.Framework = 'qb'` to use QBox.
{% endhint %}
### ESX Configuration
```lua
Config.Framework = 'esx'
-- or for older ESX versions:
Config.Framework = 'oldesx'
```
### vRP Configuration
```lua
Config.Framework = 'vrp'
```
### Standalone Configuration
```lua
Config.Framework = 'standalone'
```
{% hint style="info" %}
Standalone mode runs without any framework dependency. Player data management is handled internally by the script.
{% endhint %}
***
## Database Compatibility
All Tworst Scripts support these database resources:
| Database Resource | Config Value | Notes |
| ----------------- | ---------------- | -------------- |
| oxmysql | `'oxmysql'` | Recommended |
| mysql-async | `'mysql-async'` | Legacy support |
| ghmattimysql | `'ghmattimysql'` | Legacy support |
```lua
Config.SQL = "oxmysql" -- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
```
***
## Inventory Systems
| Inventory | Config Value |
| ---------------- | -------------------- |
| QBCore Inventory | `'qb_inventory'` |
| ESX Inventory | `'esx_inventory'` |
| ox\_inventory | `'ox_inventory'` |
| qs-inventory | `'qs_inventory'` |
| tgiann-inventory | `'tgiann-inventory'` |
| codem-inventory | `'codem-inventory'` |
```lua
Config.Inventory = "qb_inventory"
```
{% hint style="info" %}
**Note:** Inventory systems only work with framework modes (not standalone).
{% endhint %}
***
## Target Systems
| Target System | Config Value |
| -------------------- | ------------- |
| DrawText (no target) | `'drawtext'` |
| qb-target | `'qb-target'` |
| ox\_target | `'ox-target'` |
```lua
Config.InteractionHandler = 'drawtext' -- Options: 'drawtext', 'qb-target', 'ox-target'
```
{% hint style="info" %}
If you don't use a target system, set `Config.InteractionHandler = 'drawtext'` to use the built-in interaction system.
{% endhint %}
***
## Vehicle Key Systems
| System | Config Value |
| ------------------- | ----------------------- |
| qb-vehiclekeys | `'qb-vehiclekeys'` |
| qbx-vehiclekeys | `'qbx-vehiclekeys'` |
| qs-vehiclekeys | `'qs-vehiclekeys'` |
| wasabi-carlock | `'wasabi-carlock'` |
| cd\_garage | `'cd_garage'` |
| Renewed-Vehiclekeys | `'Renewed-Vehiclekeys'` |
```lua
Config.Vehiclekey = true
Config.VehicleSystem = "qb-vehiclekeys"
```
***
## Fuel Systems
| System | Config Value |
| ---------- | -------------- |
| LegacyFuel | `'LegacyFuel'` |
| ox\_fuel | `'ox_fuel'` |
| cdn-fuel | `'cdn-fuel'` |
| ps-fuel | `'ps-fuel'` |
| x-fuel | `'x-fuel'` |
```lua
Config.FuelSystem = "LegacyFuel"
```
***
## Clothing Systems
| System | Config Value |
| ------------------- | ----------------------- |
| qb-clothing | `'qb-clothing'` |
| illenium-appearance | `'illenium-appearance'` |
| fivem-appearance | `'fivem-appearance'` |
| esx\_skin | `'esx_skin'` |
| rcore\_clothing | `'rcore_clothing'` |
```lua
Config.ChangeClothesSystem = true
Config.ClothingScript = "qb-clothing"
```
{% hint style="info" %}
**Custom Support:** The clothing system is fully open-source. You can easily add support for other clothing scripts by modifying the code.
{% endhint %}
***
## Need Help?
{% hint style="info" %}
Having compatibility issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket.
{% endhint %}
# FAQ
Common questions and answers about Tworst Scripts.
***
## Purchase & Download
### Where do I download my purchased scripts?
After purchasing from [tworst.com](https://tworst.com), download your scripts from **Cfx.re Portal**:
1. Go to [portal.cfx.re](https://portal.cfx.re)
2. Log in with your Cfx.re account (same account linked during purchase)
3. Click **"Granted Assets"** in the left sidebar
4. Find your script and click **"Download"**
{% hint style="info" %}
**Can't see your purchase?** Make sure you're logged in with the same Cfx.re account that was linked during checkout. If you still have issues, open a ticket on our [Discord](https://discord.gg/tworst).
{% endhint %}
### Do scripts receive updates?
Yes! All Tworst Scripts receive free lifetime updates. Updates are available through the Cfx.re Portal. Join our [Discord](https://discord.gg/tworst) to be notified of new versions.
### Can I use scripts on multiple servers?
Each purchase is licensed for **one server**. For multi-server licensing, contact us on [Discord](https://discord.gg/tworst).
### Can I get a refund?
We offer a **5-day return period** following your purchase. Please note that returns are subject to certain conditions. If you experience any difficulties receiving support within this timeframe, we would be happy to extend the period for you.
For any issues regarding your purchase, please open a support ticket on our [Discord server](https://discord.gg/tworst).
{% hint style="warning" %}
**Note:** Open-source products are not eligible for refund requests.
{% endhint %}
### Is the open-source version fully open?
Yes, our scripts are completely open-source. Only the stream files (assets) are protected under escrow. You can easily view, modify, and adapt the code to your own framework with some modifications.
***
## Installation Issues
### Script won't start / No errors shown
1. Check if the resource is in the correct `resources` folder
2. Verify `ensure tw-scriptname` is in `server.cfg`
3. Check the resource name matches exactly (case-sensitive on Linux)
4. Make sure dependencies start **before** the script:
```cfg
# server.cfg - Correct order
ensure oxmysql
ensure es_extended # or qb-core
ensure PolyZone
ensure tw-scriptname
```
### "attempt to index a nil value (global 'ESX')" or "QBCore not found"
Your framework isn't loading properly. Check your `config/config.lua`:
```lua
-- Make sure this matches your framework
Config.Framework = 'esx' -- For ESX servers
Config.Framework = 'qb' -- For QBCore servers
Config.Framework = 'qbox' -- For QBox servers
Config.Framework = 'vrp' -- For vRP servers
```
### "No such export" error
Missing dependency. Check that you have:
* **PolyZone** - Required for all scripts
* **oxmysql** - Or mysql-async/ghmattimysql
* Your framework (ESX/QBCore/vRP)
### SQL import fails
* Make sure you're importing to the correct database
* Check for existing tables that might conflict
* The SQL file is named `insert.sql` in the script folder
### PolyZone errors
Make sure PolyZone is installed and started before Tworst scripts:
```cfg
ensure PolyZone
ensure tw-scriptname
```
Download PolyZone from: [GitHub](https://github.com/mkafrin/PolyZone)
***
## Configuration Problems
### Changes to config don't apply
1. Save the file
2. Restart the resource: `ensure tw-scriptname`
3. Or restart the entire server
4. Check for syntax errors in config
### "attempt to call a nil value" in config
Syntax error in your config. Check for:
* Missing commas between values
* Unclosed brackets `{}` or parentheses `()`
* Mismatched quotes `"` or `'`
```lua
-- Wrong
Config.Setting = 'value'
Config.Other = true -- Missing comma above!
-- Correct
Config.Setting = 'value',
Config.Other = true,
```
### How do I change the language?
```lua
Config.Locale = 'en' -- English
Config.Locale = 'tr' -- Turkish
Config.Locale = 'de' -- German
Config.Locale = 'fr' -- French
Config.Locale = 'pt' -- Portuguese
Config.Locale = 'ru' -- Russian
Config.Locale = 'ar' -- Arabic
```
Available languages are in the `locales/` folder.
### How do I change the interaction system?
```lua
Config.InteractionHandler = 'drawtext' -- Default (no target needed)
Config.InteractionHandler = 'qb-target' -- For qb-target users
Config.InteractionHandler = 'ox-target' -- For ox_target users
```
### How do I change the inventory system?
```lua
Config.Inventory = 'qb_inventory' -- QBCore Inventory
Config.Inventory = 'ox_inventory' -- ox_inventory
Config.Inventory = 'qs_inventory' -- qs-inventory
Config.Inventory = 'esx_inventory' -- ESX Inventory
```
***
## In-Game Issues
### UI doesn't appear
1. Press **F8** and check the NUI tab for JavaScript errors
2. Clear FiveM cache: Delete `%localappdata%/FiveM/FiveM.app/data/cache`
3. Verify `html/` folder exists in the resource
4. Check if another script is blocking NUI
### Job menu doesn't open
1. Check if you're at the correct location (coordinates in config)
2. Verify your interaction system is configured correctly
3. Enable `Config.Debug = true` to see console messages
4. Check if blips/markers are showing
### Markers/Blips don't show
1. Check coordinates in `config/coordinate.lua`
2. Verify blip settings are enabled
3. Check for coordinate conflicts with other scripts
### Vehicles don't spawn
1. Check vehicle model names are correct
2. Verify vehicle key system is configured:
```lua
Config.Vehiclekey = true
Config.VehicleSystem = "qb-vehiclekeys" -- Your vehicle key resource
```
### Database not saving
1. Check oxmysql/mysql-async is running
2. Verify database credentials in `server.cfg`
3. Check server console for SQL errors
4. Make sure the table was imported from `insert.sql`
***
## Performance
### Script causing lag
1. Set `Config.Debug = false` in production
2. Check for conflicts with other resources
3. Reduce draw distances if configurable
4. Use `resmon` command to check resource usage
### High resource monitor (resmon) usage
Higher usage is normal during:
* Initial script load
* Many players using the script simultaneously
* Debug mode enabled
If usage remains high, check for conflicts or contact support.
***
## Framework Specific
### ESX: Player data not loading
Make sure ESX is exporting correctly:
```lua
Config.Framework = 'esx'
-- For older ESX versions:
Config.Framework = 'oldesx'
```
### QBCore: Functions not working
Make sure QBCore is configured:
```lua
Config.Framework = 'qb'
-- For older QBCore versions:
Config.Framework = 'oldqb'
```
### QBox: Compatibility issues
QBox is fully supported:
```lua
Config.Framework = 'qbox'
```
### vRP: Integration problems
vRP support is available for job scripts:
```lua
Config.Framework = 'vrp'
```
***
## Support
### How can I contact support?
The fastest way to get help is through our [Discord server](https://discord.gg/tworst) where we're available 7 days a week.
**Contact Options:**
* **Discord** - Fastest way to get one-on-one support, 7 days a week
* **Email** - Send us an email at (3-5 business days)
* **YouTube** - Watch video tutorials and installation guides
### The script is not working, what should I do?
1. Check this FAQ and our troubleshooting guides
2. Make sure all dependencies are installed correctly
3. If the issue persists, join our [Discord server](https://discord.gg/tworst) and create a support ticket with your server console errors
### What information should I include in a support ticket?
* **Script name** and version
* **Framework** (ESX/QBCore/QBox/vRP) and version
* **Full error message** from server console (F8)
* **Steps to reproduce** the issue
* **Config changes** you made
* **Screenshots** if applicable
{% hint style="warning" %}
Support tickets without proper information may take longer to resolve. Please provide all relevant details.
{% endhint %}
***
## Still Need Help?
{% hint style="info" %}
Can't find your answer? Join our [Discord server](https://discord.gg/tworst) and open a support ticket. Our team is available 7 days a week!
{% endhint %}
# Configuration Basics
Learn how to configure Tworst Scripts for your server.
## Config File Structure
All Tworst Scripts use a `config/config.lua` file for configuration. Here's the basic structure:
```lua
Config = {}
-- Framework Selection
-- 'standalone' = No framework required, money system only (no inventory script needed)
-- Other options: esx, oldesx, qb, oldqb, vrp, vrp2
Config.Framework = 'qb'
-- Language
Config.Locale = 'en' -- Available: 'en', 'tr', 'de', 'fr', 'pt', 'ru', 'ar'
-- Currency Display
Config.CurrencyUnit = '$' -- Options: '$', 'โฌ', 'โบ'
-- Database Resource
Config.SQL = "oxmysql" -- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
-- Inventory System (only for framework modes)
Config.Inventory = "qb_inventory" -- Options: 'qb_inventory', 'esx_inventory', 'ox_inventory', 'qs_inventory', 'tgiann-inventory', 'codem-inventory'
-- Interaction System
Config.InteractionHandler = 'drawtext' -- Options: 'drawtext', 'ox-target', 'qb-target'
-- Debug Mode
Config.Debug = false -- Set to true for development
```
***
## Framework Settings
### Selecting Your Framework
```lua
-- QBCore
Config.Framework = 'qb'
-- QBCore (older versions)
Config.Framework = 'oldqb'
-- QBox (uses 'qb' config value)
Config.Framework = 'qb'
-- ESX Legacy
Config.Framework = 'esx'
-- ESX (older versions)
Config.Framework = 'oldesx'
-- vRP
Config.Framework = 'vrp'
-- vRP2
Config.Framework = 'vrp2'
-- Standalone (no framework required)
Config.Framework = 'standalone'
```
{% hint style="info" %}
**QBox Users:** QBox is fully compatible with our scripts. Simply set `Config.Framework = 'qb'` to use QBox.
{% endhint %}
{% hint style="info" %}
**Standalone Mode:** In standalone mode, there is no inventory system. Rewards are handled through the money system only.
{% endhint %}
***
## Inventory Settings
```lua
-- Inventory System
Config.Inventory = "qb_inventory"
-- Inventory Image Path (change based on your inventory system)
Config.InventoryImagePath = "nui://qb-inventory/html/images/"
-- Default/fallback image when item image not found
Config.DefaultItemImage = "nui://tw-scriptname/html/img/default.png"
```
### Supported Inventory Systems
| System | Config Value |
| ---------------- | -------------------- |
| QBCore Inventory | `'qb_inventory'` |
| ESX Inventory | `'esx_inventory'` |
| ox\_inventory | `'ox_inventory'` |
| qs-inventory | `'qs_inventory'` |
| tgiann-inventory | `'tgiann-inventory'` |
| codem-inventory | `'codem-inventory'` |
{% hint style="warning" %}
Inventory systems only work with framework modes (not standalone).
{% endhint %}
***
## Interaction Settings
```lua
-- Interaction Handler
Config.InteractionHandler = 'drawtext' -- Options: 'drawtext', 'ox-target', 'qb-target'
```
| System | Config Value | Description |
| ---------- | ------------- | ------------------------------------- |
| DrawText | `'drawtext'` | Built-in text prompts (no dependency) |
| qb-target | `'qb-target'` | QBCore target system |
| ox\_target | `'ox-target'` | Overextended target system |
***
## Clothing System
If your script supports job clothing:
```lua
Config.ChangeClothesSystem = true -- Enable/disable job clothing
Config.ClothingScript = "qb-clothing"
```
### Supported Clothing Scripts
| System | Config Value |
| ------------------- | ----------------------- |
| qb-clothing | `'qb-clothing'` |
| illenium-appearance | `'illenium-appearance'` |
| fivem-appearance | `'fivem-appearance'` |
| esx\_skin | `'esx_skin'` |
| rcore\_clothing | `'rcore_clothing'` |
***
## Vehicle Key System
For scripts that use vehicles:
```lua
Config.Vehiclekey = true -- Enable/disable vehicle key system
```
The script automatically detects your vehicle key system. Supported systems:
| System | Auto-detected |
| ------------------- | ------------- |
| qb-vehiclekeys | โ |
| qbx-vehiclekeys | โ |
| qs-vehiclekeys | โ |
| wasabi-carlock | โ |
| cd\_garage | โ |
| Renewed-Vehiclekeys | โ |
***
## Fuel System
For scripts that spawn vehicles:
```lua
-- The script automatically detects your fuel system
-- Supported: LegacyFuel, x-fuel, ox_fuel, cdn-fuel, ps-fuel
```
***
## Job Settings
Common job-related settings:
```lua
-- Server Name (displayed in UI)
Config.ServerName = "TWORST" -- Max 10 characters
-- Money Settings
Config.MoneyType = "$" -- Currency symbol
Config.MoneyType2 = "bank" -- Payment type: 'bank' or 'cash'
-- Job Cooldown
Config.jobCoolDownHours = 0 -- Hours between jobs (0 = no cooldown)
-- Max Players in Lobby
Config.MaxPlayersInLobby = 4
-- Job Level System
Config.jobLevelCheck = false -- Enable/disable level requirements
```
***
## Debug Settings
```lua
-- Enable debug mode for development
Config.Debug = false
-- Enable debug commands (for testing)
Config.DebugCommands = false
```
{% hint style="warning" %}
Always set `Config.Debug = false` on production servers for better performance.
{% endhint %}
***
## Commands
Most scripts include configurable commands:
```lua
Config.Command = {
jobReset = "jobreset", -- Reset job progress
jobLeave = "jobleave", -- Leave current job
openTutorial = "opentutorial" -- Open tutorial menu
}
```
***
## UI Positions
Some scripts allow you to customize UI element positions:
```lua
Config.DefaultUIPositions = {
teamList = { top = '77.22vh', left = '85.94vw' },
scoreList = { top = '2.64vh', left = '1.61vw' },
notificationDiv = { top = '40.48vh', left = '81.54vw' },
}
```
***
## Best Practices
1. **Always backup** your config before making changes
2. **Test changes** on a development server first
3. **Read comments** in the config file for guidance
4. **Check console** for errors after changes
5. **Use correct config values** - refer to the tables above
{% hint style="warning" %}
After modifying `config.lua`, restart the resource with `ensure [script-name]` or restart the server.
{% endhint %}
***
## Need Help?
{% hint style="info" %}
Having configuration issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket.
{% endhint %}
# Database Setup
Guide for setting up database tables for Tworst Scripts.
***
## Automatic Setup
{% hint style="success" %}
**Good News!** All Tworst Scripts **automatically create** the required database tables when the script starts for the first time. In most cases, you don't need to do anything manually!
{% endhint %}
When you start your server with a Tworst Script for the first time, the script will:
1. Check if the required tables exist
2. Create any missing tables automatically
3. Set up the correct table structure
**You should see a message in your server console confirming the tables were created.**
***
## Prerequisites
Before the automatic setup can work, make sure you have one of these database resources running:
| Database Resource | Config Value | Notes |
| ----------------- | ---------------- | -------------- |
| oxmysql | `'oxmysql'` | Recommended |
| mysql-async | `'mysql-async'` | Legacy support |
| ghmattimysql | `'ghmattimysql'` | Legacy support |
Set your database resource in `config/config.lua`:
```lua
Config.SQL = "oxmysql" -- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
```
{% hint style="warning" %}
Make sure your database resource starts **before** any Tworst Scripts in your `server.cfg`.
{% endhint %}
***
## Manual Setup (Optional)
In rare cases where automatic table creation fails, you can manually import the SQL tables.
### When to Use Manual Setup
* Automatic creation failed due to permission issues
* You prefer to review the table structure before creation
* You're migrating from another script
### How to Import Manually
Each Tworst Script includes an `insert.sql` file in the root folder:
```
tw-scriptname/
โโโ insert.sql โ SQL file for manual import
โโโ fxmanifest.lua
โโโ config/
โโโ ...
```
#### Method 1: HeidiSQL
1. Connect to your database
2. Select your database from the left panel
3. Go to **File โ Run SQL file**
4. Select the `insert.sql` file from the script folder
5. Click **Execute**
#### Method 2: phpMyAdmin
1. Login to phpMyAdmin
2. Select your database from the left panel
3. Go to the **Import** tab
4. Click **Choose File** and select the `insert.sql` file
5. Click **Go**
#### Method 3: Command Line
```bash
mysql -u username -p database_name < insert.sql
```
{% hint style="warning" %}
**Always backup your database** before manually importing tables, especially on production servers.
{% endhint %}
***
## Table Naming Convention
All Tworst Scripts use a consistent naming convention for database tables:
```
tw_[scriptname]_[table]
```
**Examples:**
| Script | Table Name |
| ------------- | ---------------------- |
| Scrapyard Job | `tw_scrapyard_players` |
| Gardener Job | `tw_gardener_players` |
| Transport Job | `tw_transport_players` |
This naming convention helps you:
* Easily identify which tables belong to which script
* Avoid conflicts with other resources
* Manage your database more efficiently
***
## Common Issues
| Error | Cause | Solution |
| -------------------- | ---------------------- | ------------------------------------------------------------- |
| Table already exists | Previous installation | Safe to ignore, or drop existing table if you want fresh data |
| Access denied | Database permissions | Check your database user has CREATE TABLE permissions |
| Unknown database | Database doesn't exist | Create the database first in your MySQL client |
| Connection failed | Wrong credentials | Verify database credentials in your `server.cfg` |
### Checking Database Connection
Make sure your `server.cfg` has the correct database connection string:
```cfg
set mysql_connection_string "mysql://user:password@localhost/database_name?charset=utf8mb4"
```
***
## Resetting Data
If you want to reset all data for a script:
{% hint style="danger" %}
**Warning:** This will delete all player progress and data for that script!
{% endhint %}
1. Stop your server
2. Open your database management tool
3. Find the tables starting with `tw_[scriptname]_`
4. Drop (delete) those tables
5. Start your server - tables will be recreated automatically
***
## Need Help?
{% hint style="info" %}
Having database issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Your database resource (oxmysql, mysql-async, etc.)
* The error message from server console
* Your `Config.SQL` setting
{% endhint %}
# Troubleshooting
Common issues and solutions for Tworst Scripts.
***
## Script Won't Start
### Check Resource Name
Resource names are **case-sensitive** on Linux servers:
```cfg
# Correct
ensure tw-scrapyard
# Wrong (case sensitive on Linux)
ensure TW-Scrapyard
ensure Tw-scrapyard
```
### Check Load Order
Make sure dependencies start **before** Tworst Scripts:
```cfg
# server.cfg - Correct order
ensure oxmysql # Database (must be first)
ensure es_extended # or qb-core (framework)
ensure PolyZone # Required for all Tworst Scripts
ensure tw-scriptname # Tworst Scripts last
```
{% hint style="warning" %}
**PolyZone** is required for all Tworst Scripts. Make sure it's installed and started before the script.
{% endhint %}
### Check Resource Folder
1. Verify the resource is in the correct `resources` folder
2. Check that the folder name matches exactly (no spaces or special characters)
3. Make sure all files were extracted properly
### Check Console for Errors
* Press **F8** in-game to see client console
* Check server console for red error messages
* Look for specific error messages to identify the issue
***
## Framework Issues
### "ESX not found" or "QBCore not found"
Your framework setting doesn't match your server:
```lua
-- config/config.lua
-- For QBCore servers:
Config.Framework = 'qb'
-- For older QBCore versions:
Config.Framework = 'oldqb'
-- For QBox servers (uses 'qb'):
Config.Framework = 'qb'
-- For ESX Legacy servers:
Config.Framework = 'esx'
-- For older ESX versions:
Config.Framework = 'oldesx'
-- For vRP servers:
Config.Framework = 'vrp'
-- For vRP2 servers:
Config.Framework = 'vrp2'
-- For standalone (no framework):
Config.Framework = 'standalone'
```
### "attempt to index a nil value (global 'ESX')"
1. Check if your framework is starting properly
2. Verify the framework resource name in your `server.cfg`
3. Make sure `Config.Framework` matches your actual framework
### "No such export" Error
Missing dependency. Check that you have:
* **PolyZone** - Required for all scripts
* **oxmysql** (or mysql-async/ghmattimysql) - Database resource
* Your framework (ESX/QBCore/vRP)
***
## UI Not Showing
### Step 1: Clear FiveM Cache
Delete the FiveM cache folder:
```
%localappdata%/FiveM/FiveM.app/data/cache
```
Or in FiveM settings, click **"Clear Cache"**.
### Step 2: Check NUI Files
Verify the `html/` folder exists in the resource and contains all files.
### Step 3: Check Browser Console
1. Press **F8** in-game
2. Go to the **NUI** tab
3. Look for JavaScript errors (red text)
### Step 4: Check for Conflicts
Another script might be blocking NUI. Try disabling other UI scripts temporarily.
***
## Database Issues
### Tables Not Creating Automatically
{% hint style="info" %}
Tworst Scripts automatically create database tables on first start. If this fails:
{% endhint %}
1. Check your database resource is running (`oxmysql`, `mysql-async`, or `ghmattimysql`)
2. Verify `Config.SQL` matches your database resource
3. Check database connection in `server.cfg`
4. Manually import `insert.sql` as a last resort
### "Table doesn't exist"
If automatic creation failed:
1. Find the `insert.sql` file in the script folder
2. Import it using HeidiSQL, phpMyAdmin, or command line
3. Restart the server
### "Connection refused" / "Access denied"
Check your database connection string in `server.cfg`:
```cfg
set mysql_connection_string "mysql://user:password@localhost/database_name?charset=utf8mb4"
```
Make sure:
* Username and password are correct
* Database exists
* User has proper permissions
***
## In-Game Issues
### Job Menu Doesn't Open
1. Check if you're at the correct location (see `config/coordinate.lua`)
2. Verify your interaction system is configured correctly:
```lua
Config.InteractionHandler = 'drawtext' -- or 'ox-target', 'qb-target'
```
3. Enable debug mode to see console messages:
```lua
Config.Debug = true
```
4. Check if blips/markers are showing on the map
### Markers/Blips Don't Show
1. Check coordinates in `config/coordinate.lua`
2. Verify blip settings are enabled in config
3. Check for coordinate conflicts with other scripts
### Vehicles Don't Spawn
1. Check vehicle model names are correct in config
2. Verify vehicle key system is configured:
```lua
Config.Vehiclekey = true
```
3. The script auto-detects your vehicle key system
### Items Not Given / Inventory Issues
1. Check `Config.Inventory` matches your inventory system:
```lua
Config.Inventory = "qb_inventory" -- or 'ox_inventory', 'esx_inventory', etc.
```
2. Make sure items exist in your inventory system
3. Check `Config.InventoryImagePath` for correct image paths
***
## Config Syntax Errors
### "attempt to call a nil value" in config
You have a syntax error. Check for:
* Missing commas between values
* Unclosed brackets `{}` or parentheses `()`
* Mismatched quotes `"` or `'`
```lua
-- Wrong (missing comma)
Config.Setting = 'value'
Config.Other = true
-- Correct
Config.Setting = 'value',
Config.Other = true,
```
### Changes to Config Don't Apply
1. **Save the file** (Ctrl+S)
2. **Restart the resource**: `ensure tw-scriptname`
3. Or restart the entire server
4. Check for syntax errors preventing load
***
## Performance Issues
### High Resource Usage (resmon)
1. **Disable debug mode** in production:
```lua
Config.Debug = false
Config.DebugCommands = false
```
2. Check for conflicts with other resources
3. Reduce draw distances if configurable
### Lag Spikes
1. Check database query efficiency
2. Monitor with `resmon` command in F8 console
3. Ensure database resource is optimized
{% hint style="info" %}
Some higher usage is normal during:
* Initial script load
* Many players using the script simultaneously
* Debug mode enabled
{% endhint %}
***
## Common Error Messages
| Error Message | Cause | Solution |
| ------------------------------------------------ | ---------------------- | ------------------------------------------------ |
| `attempt to index a nil value (global 'ESX')` | Framework not detected | Check `Config.Framework` setting |
| `attempt to index a nil value (global 'QBCore')` | Framework not detected | Check `Config.Framework` setting |
| `No such export` | Missing dependency | Install required resource (PolyZone, etc.) |
| `SCRIPT ERROR: @tw-...` | Script error | Check full error message, report to support |
| `Table 'tw_...' doesn't exist` | Database issue | Import `insert.sql` or check database connection |
***
## Debug Mode
Enable debug mode to get more information about issues:
```lua
Config.Debug = true
Config.DebugCommands = true -- Enables debug commands
```
Debug mode will show:
* Console messages for each action
* Coordinate information
* State changes
{% hint style="warning" %}
**Remember:** Always disable debug mode on production servers for better performance.
{% endhint %}
***
## Still Need Help?
{% hint style="info" %}
Can't solve your issue? Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* **Script name** and version
* **Framework** (ESX/QBCore/QBox/vRP) and version
* **Full error message** from server console (F8)
* **Steps to reproduce** the issue
* **Config changes** you made
* **Screenshots** if applicable
Our team is available **7 days a week**!
{% endhint %}
# Tworst Admin Menu
## Overview
**Tworst Admin Menu** is an all-in-one administration suite for FiveM. It combines a powerful in-game NUI menu with an optional cloud web panel and an optional self-hosted Discord bot โ giving your staff complete control over players, vehicles, and the server from anywhere.
{% hint style="success" %}
**Three ways to manage your server, one system:** the in-game menu, the **Tworst Cloud** web panel, and a **Discord bot** โ all sharing the same roles, permissions, and data.
{% endhint %}
***
## The Three Components
| Component | What it is | Where it runs |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| **Admin Menu (script)** | The in-game NUI admin panel โ the core product you install on your server. | Your FiveM server (`tw-adminmenu`) |
| **Tworst Cloud (web panel)** | A cloud-hosted browser panel that mirrors the in-game menu for remote management. Hosted by Tworst โ nothing to deploy. Also available as a **Discord Activity** to open right inside Discord. | [panel.tworst.com](https://panel.tworst.com) |
| **Discord Bot** | An open-source bot you self-host and connect to your own Discord application โ run admin actions and receive logs from Discord. | Your own hosting |
They all share the **same roles and permissions** โ a staff member's in-game role determines what they can do in the panel, in the Discord Activity, and from the bot.
```
โโโโโโโโโโโโโโโโโโโโโโโ
In-game menu โโโโถโ โ
Web panel โโโโโโโถโ Your FiveM server โ"""
Discord bot โโโโโถโ (tw-adminmenu) โ
โโโโโโโโโโโโโโโโโโโโโโโ
all share roles ยท permissions ยท logs
```
***
## Feature Highlights
### Player Management
* Kick, warn, jail, community service, ban (temp/perm), blacklist, unban
* Teleport / bring / goto, freeze, handcuff, mute, heal, kill, strip weapons
* Spectate, **Live View** (WebRTC screen watch with proximity audio), screenshots
* Give items, edit inventory, set cash/bank/dirty money, set model, edit identity
* Player records, notes, and full per-player action history
### Vehicle Management
* Spawn with custom plate + auto keys, repair, edit/wipe mods, change plate
* Transfer to garage, impound, delete, vehicle notes, vehicle inventory explorer
### Server Management
* Live console + command execution, graceful restart/stop, whitelist toggle
* Real-time metrics (FPS, CPU, RAM, per-resource usage), resource manager
### Monitoring & Tools
* Live player monitor, spectate, Live View, replay clips (auto on death/gunfire)
* Discord mugshots, dashboard with system metrics & history
### Staff, Logs & Data
* Role-based staff management with custom roles
* Comprehensive audit logging (60+ event types) with per-category Discord webhooks
* Data explorers: items, rich list, bans, jail list, community service, whitelist, player profiles
### Engagement & Admin Extras
* Tickets (with voice notes), announcements, polls, events calendar, blips, jobs & grades, teams, invoices
* **Quick Actions** โ 17 toggles (noclip, godmode, invisibility, super jump, infinite ammo, and more)
* **Troll Menu** โ 39 fun actions for events and moderation
***
## Requirements
| Resource | Required | Notes |
| --------- | -------- | -------------------------------------------------- |
| oxmysql | โ Yes | Database driver โ must start before `tw-adminmenu` |
| Framework | โ Yes | QBCore or ESX |
{% hint style="info" %}
The Admin Menu auto-detects most of your server's other systems (inventory, garages, fuel, vehicle keys, clothing, jail, etc.) โ no manual wiring needed in most cases.
{% endhint %}
***
## Supported Systems
### Frameworks
| Framework | Config Value |
| --------- | ------------ |
| QBCore | `"QBCore"` |
| ESX | `"ESX"` |
### Auto-Detected Integrations
| Category | Supported (auto-detected) |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Inventory | qb-inventory, ox\_inventory, qs-inventory, codem-inventory, tgiann-inventory, origen\_inventory, core\_inventory, chezza-inventory, ak47\_inventory, esx |
| Garage | qb-garages, okokGarage, cd\_garage, jg-advancedgarages, qs-advancedgarages, codem-garage, op-garages, esx\_garage, tgiann-realparking |
| Fuel | LegacyFuel, ox\_fuel, cdn-fuel, ti\_fuel, okokGasStation, qs-fuelstations, bigDaddy-Fuel, x-fuel, ps-fuel, Renewed-Fuel, lc\_fuel, qb-fuel |
| Vehicle Keys | qb-vehiclekeys, wasabi\_carlock, MrNewbVehicleKeys |
| Clothing | illenium-appearance, fivem-appearance, qb-clothing, esx\_skin, tgiann-clothing, 0r-clothingv2, rcore\_clothing, ak47\_qb\_clothing, crm-appearance |
| Jail | qb-prison, DHS-PrisonSim, pickle\_prisons, rcore\_prison |
| Revive / Ambulance | framework native, wasabi\_ambulance, 0r-ambulancejob |
| Community Service | savana-communityservice, qb-communityservice, randol |
| Invoices / Billing | qb-phone, g-billing, esx\_billing, codem-billing, codem-billing v2, codem-mphone, wasabi\_billing, bablo-billing, okokBilling |
| Phone Number | metadata, qs-smartphone, qs-smartphone-pro, custom |
| Weather/Time | qb-weathersync, cd\_easytime, renewed-weathersync, av\_weather, self (native) |
{% hint style="info" %}
Running something not on the list? **Every bridge has a `custom` adapter** โ set the system to `"custom"` and wire your own integration in the matching `bridge//adapters/custom.lua`.
{% endhint %}
### Languages
13 languages included: **EN, TR, DE, FR, ES, PT, RU, PL, NL, IT, RO, AR, TH (เนเธเธข)**
{% hint style="info" %}
**Add your own language:** You can add a custom language to the panel **without editing the UI or rebuilding** โ copy `locales/en.json`, translate the values, and register it in `locales/custom_languages.json`. Full steps: [Adding a Custom Language](/admin-menu/admin-menu/configuration#adding-a-custom-language).
{% endhint %}
***
## Quick Links
***
## Purchase
{% hint style="info" %}
Purchase Tworst Admin Menu from our [Tebex Store](https://tworst.tebex.io) or [CFX Store](https://tworst.com).
{% endhint %}
# Installation
Step-by-step guide to install the **Tworst Admin Menu** in-game resource on your FiveM server.
{% hint style="info" %}
This page covers the **in-game script** only. To use the cloud panel, see [Web Panel (Tworst Cloud)](/admin-menu/admin-menu/web-panel). To set up the Discord bot, see [Discord Bot](/admin-menu/admin-menu/discord-bot).
{% endhint %}
***
## Prerequisites
Before installing, make sure you have:
| Requirement | Description |
| ---------------- | ------------------------------------------- |
| **Framework** | QBCore or ESX |
| **oxmysql** | Required โ must start before `tw-adminmenu` |
| **FiveM Server** | Recent artifact build recommended |
***
## Step 1: Download the Script
### From Cfx.re Portal (Recommended)
1. Go to [portal.cfx.re](https://portal.cfx.re)
2. Navigate to **Granted Assets**
3. Find **tw-adminmenu** in your purchased assets
4. Click **Download** to get the latest version
***
## Step 2: Extract Files
1. Extract the downloaded archive
2. Place the **`tw-adminmenu`** folder in your server's `resources` directory
***
## Step 3: Database Setup
{% hint style="success" %}
**Automatic Setup:** With `TW.AutoSql = true` (default), the script automatically creates and migrates all required database tables on first start. No manual SQL import needed.
{% endhint %}
If you prefer a manual import (or disabled auto-migration), run the included `sql/install.sql` against your database.
***
## Step 4: Configure the Framework
Open `shared/config.lua` and set your framework and language:
```lua
TW.Framework = "QBCore" -- "QBCore" or "ESX"
TW.Locale = "en" -- en, tr, de, fr, es, pt, ru, pl, nl, it, ro, ar
TW.AutoSql = true -- Auto-create/migrate database tables
```
{% hint style="info" %}
**QBox users:** set `TW.Framework = "QBCore"` โ QBox is QBCore-compatible.
{% endhint %}
{% hint style="info" %}
Most other integrations (inventory, garage, fuel, vehicle keys, clothing, jail, etc.) are left on `"auto"` and detected automatically. See [Configuration](/admin-menu/admin-menu/configuration) for all options.
{% endhint %}
***
## Step 5: Grant First (God) Access
Before anyone can use the menu, give yourself **God** access so you can manage staff and roles in-game.
In `shared/config.lua`:
```lua
TW.GodRole = "owner" -- The top-tier role name
TW.GodIdentifiers = {
"fivem:1234567", -- your fivem: id
"discord:123456789012345", -- and/or your discord: id
}
```
{% hint style="warning" %}
Add **your own** identifier here first. Anyone listed in `TW.GodIdentifiers` is automatically provisioned with the God role and full access on join.
{% endhint %}
***
## Step 6: Discord Token & Webhooks
For full functionality, configure your Discord integrations in `shared/server_config.lua` and `shared/webhooks.lua`.
### Discord Bot Token
Set your Discord bot token so the panel can resolve Discord avatars and member/role info:
```lua
-- shared/server_config.lua
TW_Server.DiscordBotToken = "YOUR_DISCORD_BOT_TOKEN"
```
{% hint style="warning" %}
Without a valid `DiscordBotToken`, Discord avatars and role/member lookups won't work. The token must belong to a bot that is **in your Discord server**.
{% endhint %}
### Logging Webhooks
Open `shared/webhooks.lua` and fill in a webhook URL for **every** log category you want recorded. Anything left blank falls back to `default` โ and if `default` is also empty, those logs are **not sent anywhere**.
```lua
-- shared/webhooks.lua
TW_Webhooks.enabled = true
TW_Webhooks.urls = {
punishments = "https://discord.com/api/webhooks/...",
player = "https://discord.com/api/webhooks/...",
inventory = "https://discord.com/api/webhooks/...",
economy = "https://discord.com/api/webhooks/...",
vehicles = "https://discord.com/api/webhooks/...",
staff = "https://discord.com/api/webhooks/...",
server = "https://discord.com/api/webhooks/...",
world = "https://discord.com/api/webhooks/...",
tickets = "https://discord.com/api/webhooks/...",
spectate = "https://discord.com/api/webhooks/...",
notes = "https://discord.com/api/webhooks/...",
troll = "https://discord.com/api/webhooks/...",
security = "https://discord.com/api/webhooks/...",
default = "https://discord.com/api/webhooks/...", -- catch-all fallback
}
```
{% hint style="danger" %}
**Don't skip this.** If you leave webhooks empty, admin actions in those categories won't be logged to Discord and you'll have gaps in your audit trail. At minimum, set the `default` webhook so nothing is lost.
{% endhint %}
{% hint style="info" %}
A quick way to cover everything: set `default` first, then add dedicated channels for the categories you care most about (e.g. `punishments`, `economy`, `security`). See the full reference in [Configuration โ webhooks](/admin-menu/admin-menu/configuration#shared-webhooks-lua).
{% endhint %}
***
## Step 7: Add to server.cfg
Add the following to your `server.cfg`:
```cfg
# Dependencies (must start before tw-adminmenu)
ensure oxmysql
ensure qb-core # or es_extended (your framework)
# Tworst Admin Menu
ensure tw-adminmenu
# Required ACE permissions (for server commands & profiler)
add_ace resource.tw-adminmenu command allow
add_ace resource.tw-adminmenu command.profiler allow
```
{% hint style="warning" %}
**Load Order:** `oxmysql` and your framework must start **before** `tw-adminmenu`.
{% endhint %}
{% hint style="info" %}
The `add_ace` lines let the Admin Menu run server commands and the profiler (used by the dashboard/console features). Add them or those tools won't work.
{% endhint %}
***
## Step 8: Restart & Open the Menu
1. Save all configuration changes
2. Restart your server completely
3. Join the server with an account listed in `TW.GodIdentifiers`
4. Open the admin menu (use your configured keybind/command โ you can also bind a key in the FiveM **Settings โ Key Bindings โ FiveM** menu)
{% hint style="success" %}
On first open, the built-in **onboarding tour** (`TW.Onboarding`) walks you through the panel and initial setup.
{% endhint %}
***
## Verification
After starting the server, verify the installation:
### Check Console
* Database tables created successfully (first run only)
* No error messages related to `tw-adminmenu`
### In-Game Test
1. Open the admin menu as a God user
2. Confirm the dashboard loads with live server stats
3. Open the **Online Players** page and confirm players are listed
4. Open **Admin โ Staff/Roles** and add your first staff member
***
## Troubleshooting
### Menu won't open / "No access"
* Confirm your `fivem:` or `discord:` identifier is in `TW.GodIdentifiers`
* Make sure you restarted the server after editing the config
### Database errors
* Verify oxmysql is started **before** `tw-adminmenu`
* Confirm your database connection string in `server.cfg` is correct
### Framework not detected
* Make sure `TW.Framework` matches your framework (`"QBCore"` or `"ESX"`)
* Verify the framework resource starts before `tw-adminmenu`
***
## Need Help?
{% hint style="info" %}
Having installation issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Server console errors
* Your `TW.Framework` setting
* Screenshots of any issues
{% endhint %}
# Configuration
The Admin Menu is configured through four files in the `shared/` folder:
| File | Purpose |
| --------------------------- | ------------------------------------------------------------------- |
| `shared/config.lua` | Framework, appearance, access, economy, integrations, features |
| `shared/server_config.lua` | API keys, exports, Live View, Tworst Cloud uplink |
| `shared/webhooks.lua` | Discord webhook logging routes |
| `shared/open_functions.lua` | Integration hooks (vehicle keys, spectate, noclip, custom clothing) |
{% hint style="info" %}
Defaults are sensible โ in most cases you only need to set your framework, locale, god access, the Discord token, and your webhooks to get started.
{% endhint %}
***
## shared/config.lua
### Framework & General
```lua
TW.Framework = "QBCore" -- "QBCore" or "ESX"
TW.Locale = "en" -- en, tr, de, fr, es, pt, ru, pl, nl, it, ro, ar, th
TW.AutoSql = true -- Auto-create/migrate database tables on start
```
| Setting | What it does |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `TW.Framework` | Your server framework. Use `"QBCore"` for **both QBCore and QBox** (QBox is QBCore-compatible), or `"ESX"` for ESX. |
| `TW.Locale` | Panel language. 13 languages are built in: en, tr, de, fr, es, pt, ru, pl, nl, it, ro, ar, th (เนเธเธข). Want another? See [Adding a Custom Language](#adding-a-custom-language). |
| `TW.AutoSql` | When `true`, all database tables are created/migrated automatically on start. Set `false` only if you import `sql/install.sql` manually. |
### Adding a Custom Language
The panel ships with 13 built-in languages. You can add your own **without editing the UI or rebuilding** โ just two files inside the resource's `locales/` folder.
#### Step 1 โ Create the translation file
Copy `locales/en.json` and rename it to your language code (ISO 639-1, e.g. `hu` for Hungarian):
```
locales/hu.json
```
Open it and translate the **values only** โ never change the keys (the text on the left):
```json
{
"header.hi": "Szia,",
"header.onDuty": "Szolgรกlatban",
"header.offDuty": "Szolgรกlaton kรญvรผl"
}
```
{% hint style="info" %}
Keep every key. Any value you leave in English simply shows in English โ nothing breaks.
{% endhint %}
#### Step 2 โ Register the language
Open `locales/custom_languages.json` and add an entry to the list so it appears in the picker:
```json
[
{ "code": "hu", "name": "Magyar" }
]
```
* `code` โ must match your JSON filename (`hu` โ `hu.json`)
* `name` โ the label shown in the language menu (write it in the language itself)
Add more the same way:
```json
[
{ "code": "hu", "name": "Magyar" },
{ "code": "cs", "name": "ฤeลกtina" }
]
```
{% hint style="warning" %}
* **Don't list the built-in languages here** โ they're always available.
* Only add a language whose `.json` file exists, otherwise it shows up empty (falls back to English).
* Lines starting with `//` in that file are comments and are ignored.
{% endhint %}
#### Step 3 โ Apply
Restart `tw-adminmenu`, then open **Panel โ Settings โ Language** โ your language is now selectable.
### Appearance
```lua
TW.DefaultTheme = "dark" -- "dark" | "gray" | "light"
TW.DefaultPrimaryColor = "#4189e5" -- accent color (hex)
```
The **default** theme and accent color applied the first time an admin opens the panel. If an admin later changes them in **Settings โ Appearance**, their personal choice (saved in their browser) overrides these defaults.
### Onboarding
```lua
TW.Onboarding = { enabled = true }
```
A short first-open setup (language + theme) and feature tour, shown **once per admin**. Set `enabled = false` to disable it entirely (everyone is treated as already onboarded).
### Access & Duty
```lua
TW.GodRole = "owner" -- role assigned to god identifiers
TW.GodIdentifiers = { } -- 'fivem:xxx' / 'discord:xxx' get full access automatically
TW.DefaultOnDuty = false -- admins join off-duty (recommended)
TW.OffDutyAccess = "full" -- "full" | "readonly" | "duty"
```
| Setting | What it does |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `TW.GodRole` | The top-tier role granted to god identifiers. |
| `TW.GodIdentifiers` | Identifiers that always get full access on join โ your owners/devs. |
| `TW.DefaultOnDuty` | `false` = admins must turn duty on manually (recommended); `true` = on-duty the moment they connect. |
| `TW.OffDutyAccess` | What an off-duty admin can do โ `full` (everything, just shows offline), `readonly` (view only, no actions), or `duty` (nothing until on-duty). |
See [Permissions & Roles](/admin-menu/admin-menu/permissions) for the full role system.
### Whitelist
```lua
TW.WhitelistDefaultEnabled = false
TW.WhitelistKickReason = "This server is in whitelist mode. You are not authorized to join."
```
| Setting | What it does |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `TW.WhitelistDefaultEnabled` | Whether whitelist mode is active on server boot. The in-game toggle is one-shot โ a restart reverts to this value. |
| `TW.WhitelistKickReason` | Message shown to non-whitelisted players when they're blocked at connect. |
### Player Display
```lua
TW.PlayerNameMode = "fivem" -- "fivem" | "character"
TW.HandcuffAllowWalk = true
TW.NotifyTargetOnAction = true
```
| Setting | What it does |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `TW.PlayerNameMode` | How names show on the Online Players page โ `character` (character name first, FiveM name in parentheses) or `fivem` (the reverse). |
| `TW.HandcuffAllowWalk` | `true` = handcuffed players can walk slowly (no sprint/attack); `false` = fully locked in place. |
| `TW.NotifyTargetOnAction` | `true` = the target player gets a pop-up when an admin acts on them (heal, freeze, jail, etc.); `false` = silent admin actions. |
### Avatars & Phone
```lua
TW.AvatarSource = "discord" -- "discord" | "steam" | "custom" | "none"
TW.PhoneSource = "metadata" -- "metadata" | "custom" | "none"
TW.PhoneMetadataKey = "phone"
```
| Setting | What it does |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `TW.AvatarSource` | Where player avatars come from. The chosen source is tried first, then falls back (e.g. `discord` โ steam โ placeholder). `discord`/`steam` need the matching API key/token set in `server_config.lua`. |
| `TW.AvatarCustom` | Only used when `AvatarSource = "custom"` โ an SQL table/column to read an avatar URL from. |
| `TW.PhoneSource` | How the player's phone number is resolved โ `metadata` (reads framework metadata, works for ESX/qb-phone), `custom` (SQL lookup for gksphone/lb-phone/etc.), or `none` (hidden). |
| `TW.PhoneMetadataKey` | The metadata key the phone number is stored under (default `phone`). |
***
### Economy
The economy block tells the panel **how your server stores money** so that balances display correctly and "set money" actions write to the right place. Configure it to match your framework/inventory.
```lua
TW.Currency = "$" -- "$" | "โฌ" | "โบ" | "ยฃ" | "ยฅ" | "โฝ" | "โน"
```
`TW.Currency` is just the symbol shown before every amount across the UI (PlayerDetail, RichList, invoices, set-money, etc.).
#### Cash & Dirty Money
```lua
TW.Cash = {
mode = "account", -- "account" | "item" | "disabled"
accountNames = { "cash", "money" },
itemName = "cash",
}
TW.DirtyMoney = {
mode = "account",
accountNames = { "crypto", "black_money" },
itemName = "black_money",
}
```
**Choosing `mode`:**
| Mode | When to use it |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account` | **Most servers.** Money is a standard framework account (QBCore `PlayerData.money`, ESX `accounts`). This is the default. |
| `item` | Your server tracks money as an **inventory item** (e.g. ox\_inventory item-as-cash, Renewed-Cash, marked bills). The panel reads/writes the item count via your inventory. |
| `disabled` | Hide this money type from the panel entirely. |
**`accountNames` (for `mode = "account"`):** the panel uses the **first matching name** in the list. Defaults cover QBCore and ESX out of the box (`cash`/`money`, `crypto`/`black_money`). If your server renamed the account, **put your custom name first** โ e.g. `accountNames = { "dirty_money", "black_money" }`.
**`itemName` (for `mode = "item"`):** the inventory item name to read/write. Works automatically with whichever inventory system is active.
{% hint style="info" %}
**Quick guide:** Standard QBCore/ESX server? Leave everything on `account` โ it just works. Using an item-based cash system? Switch `mode = "item"` and set `itemName`. Don't use dirty money at all? Set `TW.DirtyMoney.mode = "disabled"`.
{% endhint %}
***
### Integration Bridges (Auto-Detected)
Compatibility bridges for your other resources. Leave each on `"auto"` to detect the running script automatically, or pin an exact key to force a specific provider.
```lua
TW.InventorySystem = "auto" -- qb-inventory | ox_inventory | qs-inventory | codem-inventory | tgiann-inventory | origen_inventory | core_inventory | ps-inventory | chezza-inventory | esx
TW.WeatherSystem = "auto"
TW.VehicleKeysSystem = "auto"
TW.GarageSystem = "auto"
TW.InvoicesSystem = "auto" -- qb-phone | g-billing | esx_billing | codem-billing | codem-billingv2 | codem-mphone | wasabi_billing | bablo-billing | okokBilling
TW.FuelSystem = "auto"
TW.JailSystem = "auto"
TW.ClothingSystem = "auto"
TW.CommunityServiceSystem = "savana-communityservice"
```
{% hint style="warning" %}
For `"auto"` to work, the integration resource must start **before** `tw-adminmenu` in your `server.cfg`. If it starts after, pin the exact key here instead. (This is why `CommunityServiceSystem` is pinned by default โ auto-detect would otherwise miss it.)
{% endhint %}
{% hint style="info" %}
**Custom adapters:** every bridge accepts `"custom"` โ set it (e.g. `TW.JailSystem = "custom"`) and implement your own integration in the matching `bridge//adapters/custom.lua`.
{% endhint %}
See the [supported systems table](/admin-menu/admin-menu#supported-systems) for every detectable provider.
### Garage, Dimensions & Dashboard
```lua
TW.GarageConfig = {
defaultGarage = "pillboxgarage", -- where "Send to Garage" puts vehicles
impoundLot = "impoundlot", -- where "Impound" sends vehicles
depotPrice = 500, -- impound retrieval fee
perSystem = { --[[ per-garage-script overrides ]] },
}
```
The garage IDs **must match what your garage script actually uses**, or admin "Send to Garage / Impound" actions will assign vehicles to a garage that doesn't exist. The flat values are fallbacks; `perSystem` overrides them for specific garage scripts. Copy the real IDs from your garage script's own config if you renamed them.
```lua
TW.DimensionPresets = {
{ label = "Default World", value = 0 },
{ label = "Admin World", value = 999 },
{ label = "Staff Area", value = 500 },
}
```
Named routing buckets (dimensions) selectable in the player actions menu โ handy for private staff areas or events.
```lua
TW.Dashboard = {
serverJoinUrl = "cfx.re/join/abc123", -- shown on the dashboard
enableSystemMetrics = true, -- CPU/RAM/tick monitoring
historyRetentionDays = 30, -- how long metric history is kept
pushIntervalMs = 5000, -- how often live stats refresh
}
```
### Tickets, Chat, Noclip, Replay, Troll
```lua
TW.Chat.retentionDays = 7 -- how long chat history is stored
TW.Tickets.maxActivePerPlayer = 3 -- max open tickets a player can have
TW.Noclip.Speeds = { 15.0, 45.0, 100.0, 220.0, 450.0 } -- noclip speed tiers (m/s)
TW.Noclip.SnapToGroundOnExit = true -- drop to ground when leaving noclip
TW.Replay = {
enabled = true,
durationSec = 8, -- clip length
cooldownSec = 90, -- min time between auto-clips
autoCapture = true, -- auto-record on triggers below
triggers = { shooting = true, death = true },
}
TW.Troll.LocalSpawns = true -- spawn troll entities only on the target's screen (anticheat-safe)
TW.Troll.SpawnTimeoutMs = 30000 -- auto-delete spawned entities after 30s
```
***
## shared/server\_config.lua
### API Keys
```lua
TW_Server.DiscordBotToken = "" -- enables Discord avatars + member/role lookups
TW_Server.SteamApiKey = "" -- enables Steam avatars/profile data
```
{% hint style="warning" %}
Set `DiscordBotToken` for Discord avatars and role/member info to work. The token must belong to a bot that is a member of your Discord server. (This is separate from the standalone Discord bot โ see [Discord Bot](/admin-menu/admin-menu/discord-bot).)
{% endhint %}
### File Exports
```lua
TW_Server.exportPublicHost = "http://YOUR_SERVER_IP:30120"
TW_Server.exportTtlSec = 300 -- download link validity (seconds)
TW_Server.exportViaCloud = true -- serve exports via Tworst cloud CDN
```
Controls the temporary download links the panel generates for data exports (player data, logs, etc.).
### Mugshots & Voice
```lua
TW_Server.mugshotWebhook = "" -- Discord webhook for mugshots
TW_Server.ticketVoiceWebhook = "" -- Discord webhook for ticket voice notes
```
### Live View (WebRTC Screen Watching)
```lua
TW_Server.liveViewDefaultPreset = "medium" -- low | medium | high | extra | source
TW_Server.liveViewAudio = {
enabled = true, -- false = disable player listening entirely
radiusMeters = 15.0, -- proximity voice mix radius
}
```
`liveViewDefaultPreset` sets the starting stream quality (480p โ native 60fps). `liveViewAudio` mixes in nearby in-game voices so you can hear what's happening around the player you're watching.
{% hint style="info" %}
Set `liveViewAudio.enabled = false` to **disable listening server-wide** โ players are no longer prompted for mic access and admins see a "disabled" notice instead.
{% endhint %}
### Auto Web Permissions
```lua
-- Kept ABOVE the Cloud block on purpose so re-pairing (which replaces the Cloud
-- block) never wipes this setting.
TW_Server.autoWebPermissions = false -- default false (opt-in)
```
When `true`, granting someone **in-game** staff (who has a Discord identifier) also gives them **web-panel access** with the same role โ and editing/removing their in-game staff mirrors to the web. The link key is the Discord ID, and it's self-healing (existing admins are back-filled on their next connection). Manual web-only grants you added by hand in the panel are never touched. See [Web Panel โ Invite Your Staff](/admin-menu/admin-menu/web-panel#step-3-invite-your-staff).
### Tworst Cloud Uplink
```lua
TW_Server.Cloud = {
enabled = false, -- enable remote web panel access
url = "wss://panel.tworst.com/agent",
tenantId = "", -- from the panel's pairing snippet
serverId = "",
secret = "",
}
```
{% hint style="info" %}
Get `tenantId`, `serverId`, and `secret` from the pairing snippet in the web panel. Full steps in [Web Panel (Tworst Cloud)](/admin-menu/admin-menu/web-panel).
{% endhint %}
***
## shared/webhooks.lua
Route in-game admin logs to Discord. **Fill a webhook for every category you want logged** โ anything blank falls back to `default`, and if `default` is also blank those logs go nowhere.
```lua
TW_Webhooks.enabled = true
TW_Webhooks.botName = "TW Admin Logs"
TW_Webhooks.botAvatar = ""
TW_Webhooks.urls = {
punishments = "", -- kicks, warns, jails, bans, CS, blacklist
player = "", -- heal, freeze, teleport, model changes
inventory = "", -- item give/remove, metadata edits
economy = "", -- money changes
vehicles = "", -- spawn, delete, repair, mods
staff = "", -- role changes, job assignments, duty toggles
server = "", -- exports, dashboard actions
world = "", -- weather, time, freeze
tickets = "", -- ticket create/claim/close
ticketsOpen = "", -- (optional) ticket OPEN events only
ticketsClose= "", -- (optional) ticket CLOSE events only (with transcript link)
spectate = "", -- Live View, screenshots, spectate
notes = "", -- player/vehicle notes
troll = "", -- troll menu actions
security = "", -- denied RPC / permission failures
default = "", -- catch-all fallback
}
```
{% hint style="danger" %}
Leaving webhooks empty means those actions won't be logged. At minimum, set the `default` webhook so nothing is lost โ then add dedicated channels for the categories you care most about (e.g. `punishments`, `economy`, `security`).
{% endhint %}
{% hint style="success" %}
Logs are posted as rich Discord embeds with color coding, timestamps, and actor/target details.
{% endhint %}
{% hint style="info" %}
**Ticket logging (no bot required):** Ticket open & close events โ including a transcript link on close โ post straight to Discord via these webhooks. Leave everything under `tickets` for one channel, or split them into two channels with `ticketsOpen` and `ticketsClose`.
{% endhint %}
***
## shared/open\_functions.lua
This file holds **integration hooks** โ small functions that run at key moments so you can wire the Admin Menu into your server's other systems. Edit the function bodies; leave the signatures as they are.
### `AfterVehicleSpawn(vehicle, plate)`
Runs on the client right after an admin spawns a vehicle. Use it to hand the vehicle keys to your key system (or any post-spawn logic).
```lua
function TW.OpenFunctions.AfterVehicleSpawn(vehicle, plate)
-- qb-vehiclekeys:
TriggerEvent('vehiclekeys:client:SetOwner', plate)
-- qs-vehiclekeys: exports['qs-vehiclekeys']:GiveKeys(plate)
-- wasabi_carlock: exports.wasabi_carlock:GiveKey(plate)
end
```
### `OnSpectateStart(targetServerId)` / `OnSpectateStop(targetServerId)`
Run on the spectating admin's machine when spectate starts/stops โ e.g. to hide a HUD or notify scripts while spectating.
```lua
function TW.OpenFunctions.OnSpectateStart(targetServerId)
TriggerEvent('myhud:disable')
end
function TW.OpenFunctions.OnSpectateStop(targetServerId)
TriggerEvent('myhud:enable')
end
```
### `OnNoclipStart()` / `OnNoclipStop()`
Run on the admin's machine when noclip is toggled โ useful for whitelisting them in your anticheat or bypassing collision/zone scripts.
```lua
function TW.OpenFunctions.OnNoclipStart()
exports['my-anticheat']:Whitelist(true)
end
function TW.OpenFunctions.OnNoclipStop()
exports['my-anticheat']:Whitelist(false)
end
```
### `OpenClothingMenu(ped)`
Only used when `TW.ClothingSystem = "custom"`. Called when the Quick Action **Clothing** button is clicked, so you can open your own appearance script. (In the built-in modes โ illenium/fivem/qb/esx โ the bridge handles this and the hook is ignored.)
```lua
function TW.OpenFunctions.OpenClothingMenu(ped)
exports.rcore_clothing:openClothing()
end
```
{% hint style="info" %}
The same spectate/noclip state can be read by other resources via exports/events โ see [Features โ Exports & Events](/admin-menu/admin-menu/features#exports-events).
{% endhint %}
# Permissions & Roles
The Admin Menu uses a **role-based permission system**. Each staff member has a role, and that role defines exactly what they can see and do โ in-game, in the web panel, and from the Discord bot.
{% hint style="success" %}
Roles and permissions are shared across all three components. A "moderator" has the same powers whether they act in-game, on the web panel, or via Discord.
{% endhint %}
***
## Built-in Roles
The Admin Menu ships with 5 ready-to-use roles, ordered from highest to lowest rank:
| Role | Rank | Color | Scope |
| ------------- | ------- | ------ | ---------------------------------------------------- |
| **owner** | Highest | Red | Full access โ manage staff, roles, and every feature |
| **admin** | High | Purple | Most features โ can manage staff |
| **moderator** | Medium | Blue | Moderate players, view data |
| **support** | Low | Green | Support & tickets focused |
| **trial** | Lowest | Yellow | View-only, no actions |
### Role Priority (Ranking)
Each role has a **priority** that determines its rank โ a higher-priority role outranks a lower one (e.g. an admin can manage a moderator, but not the other way around).
{% hint style="info" %}
You don't edit priority numbers by hand. On the in-game **Admin โ Roles** page, simply **drag roles up or down** to reorder them โ the higher a role sits in the list, the higher its rank. The order applies everywhere (in-game, web panel, Discord bot).
{% endhint %}
{% hint style="info" %}
Built-in roles are **protected** โ they can't be deleted, but you can reorder them and create custom roles alongside them.
{% endhint %}
***
## God Access
God access bypasses the role system entirely and grants full control โ use it for owners and lead developers.
```lua
TW.GodRole = "owner" -- The role assigned to god users
TW.GodIdentifiers = {
"fivem:1234567",
"discord:123456789012345",
}
```
Anyone whose `fivem:` or `discord:` identifier is listed in `TW.GodIdentifiers` is automatically provisioned with the God role and full access when they join.
{% hint style="warning" %}
Set up at least one god identifier during installation โ it's how you bootstrap the first admin and start adding staff.
{% endhint %}
***
## Permission Groups
Permissions are organized into groups. A role grants any combination of permissions across these groups:
| Group | Covers |
| ----------------------------------- | ------------------------------------------------------------------------- |
| **home** | Dashboard access |
| **player** | All player actions (kick, ban, teleport, heal, money, etc.) |
| **vehicle** | Vehicle spawn, repair, mods, impound, delete |
| **server** | Console, commands, restart, stop, database backup |
| **admin** | Staff & role management |
| **resources** | View & manage server resources |
| **logs** | View/delete logs, force duty |
| **data** | Items, rich list, ban list, jail list, whitelist, exports, replays |
| **tickets** | Ticket handling |
| **world** | Weather, time, world flags |
| **events / polls / announcements** | Engagement tools |
| **blips / jobs / teams / invoices** | Map markers, jobs, groups, billing |
| **troll** | Troll menu actions |
| **quick menu** | Which Quick Actions / self-toggles (noclip, godmode, etc.) a role may use |
| **dashboard** | Server metrics & history |
***
## High-Risk Permissions
Certain permissions are flagged as **high-risk** and are always written to the audit log when used โ for example: `command`, `ban`, `ip_ban`, `give_item`, `wipe_inventory`, `kill`, `set_money`, `edit_identity`, `live_view`, `restart`, `stop`, `manage_staff`, `manage_roles`, and `delete`.
{% hint style="info" %}
**`player.ip_ban`** is a separate permission from `ban`. Assign it to let a staff member optionally ban a player's **IP** alongside the normal ban.
{% endhint %}
{% hint style="info" %}
High-risk actions can also be routed to a dedicated Discord webhook channel โ see [Configuration โ webhooks](/admin-menu/admin-menu/configuration#shared-webhooks-lua).
{% endhint %}
***
{% hint style="info" %}
**Quick Menu permissions (auto-filled on update):** when this feature was added, existing roles were back-filled automatically โ roles that already had risky permissions (ban, console, etc.) got the full Quick Menu set, others got a safe subset (coords, names, clothing, etc.). Adjust any of it in the role editor; **no manual SQL needed.**
{% endhint %}
## Custom Roles
From the in-game **Admin โ Roles** page (or the web panel), users with `manage_roles` can:
* **Create** a new role with a custom permission matrix
* **Edit** a role's name, color, and permissions
* **Reorder** roles by dragging them up/down to set their rank
* **Delete** custom roles (built-in roles are protected)
Then, on the **Admin โ Staff** page, assign roles to staff by identifier and optionally grant or revoke individual permissions to override the role.
***
## Off-Duty Access
Control what admins can do while off-duty:
```lua
TW.DefaultOnDuty = false -- New admins start off-duty
TW.OffDutyAccess = "full" -- "full" | "readonly" | "duty"
```
| Mode | Behavior off-duty |
| ---------- | ----------------------------------------------- |
| `full` | Full access regardless of duty status |
| `readonly` | Can view everything, but cannot perform actions |
| `duty` | Must go on-duty before using the menu |
# Features
A complete reference of everything the Admin Menu can do. Every feature respects the [role permissions](/admin-menu/admin-menu/permissions) of the staff member using it.
***
## Dashboard
* Server status summary (online players, uptime)
* Real-time FPS, CPU, RAM, and event-loop metrics
* Recent logs feed with filtering
* Active staff list with duty status
* Quick server actions (restart, stop, toggle whitelist)
***
## Player Management
### Player Info
* Name, ID, identifiers (license, discord, steam, citizenid)
* Playtime, job & grade, first joined / last seen
* Avatar (Discord / Steam / custom) and phone number
### Actions
* **Punishment:** kick, warn, jail, community service, ban (temp/perm, optional IP ban), blacklist, unban, lift punishment
* **Movement:** teleport, bring, goto, dimension/bucket
* **Observation:** spectate, Live View (WebRTC), screenshots
* **Inventory:** give item, remove item, clear inventory, edit metadata
* **State:** heal, kill, freeze, handcuff, mute, strip weapons, reset stats, slap, explode
* **Appearance:** set model, reset skin, open clothing menu, edit identity
* **Economy:** set cash, set bank, set dirty money
* **Vehicle:** give vehicle keys
* **Records:** notes, warnings, full per-player action history
### Quick Actions (Hotbar)
Heal ยท Kill ยท Kick ยท Handcuff ยท Freeze ยท Strip Weapons ยท Teleport ยท Give Item ยท Open Clothing
***
## Vehicle Management
* Spawn any vehicle with custom plate + automatic keys
* Repair (engine, body, doors, windows, tires)
* Edit mods / wipe all mods
* Change plate, transfer to garage, impound, delete
* Vehicle notes & vehicle inventory explorer
* **Offline vehicle management** โ grant or remove vehicles for a player even while they're offline (writes to their database record) via the Player Detail โ Vehicles page
***
## Server Management
* Live console output + execute server commands
* Graceful restart / stop (with kick message)
* Enable/disable whitelist mode
* System metrics: live FPS, CPU %, RAM, per-resource CPU & memory
* Resource manager (view / start / stop / restart resources)
* **Database Backup** โ take a full compressed backup on demand from the Server page, or schedule it to run automatically (guarded by its own permission)
***
## Staff, Logs & Data
### Staff & Roles
* Manage staff (add, change role, grant/revoke permissions, suspend, remove)
* Create & edit custom roles with priority and color
### Logs & Audit
* Comprehensive audit log (60+ event types) with search & filters
* Per-player and per-admin action history
* Duty-force logs
### Data Explorers
* **Item Explorer** โ searchable item catalog (with live images from your inventory system) plus **Players / Vehicles / Storages** tabs showing exactly who or what holds an item, and a **Wipe from all** action
* **Rich List** โ daily wealth snapshots & top players
* **Ban List** โ active/expired, reason, appeals, evidence
* **Jail List** โ currently jailed, release timers, bulk release
* **Community Service** โ active assignments, bulk complete
* **Whitelist** โ manage entries & toggle whitelist mode
* **Player Profiles** โ searchable catalog of everyone who's joined
***
## Engagement Tools
* **Tickets** โ categories, priority, claim/assign, internal notes, voice notes (open the ticket admin view with `/ticketadmin`)
* **Announcements** โ broadcast info/warning/critical messages
* **Polls** โ multi-option voting with live results
* **Events** โ calendar with assignments and recurrence
* **Blips** โ custom map markers (sprite, color, display mode)
* **Jobs & Grades** โ view jobs, manage grades/salaries, assign jobs (Unemployed is assignable too)
* **Teams** โ create groups, manage members, team notes
* **Invoices** โ view/create invoices (qb-phone / g-billing)
***
## Monitoring & Observation
* **Live Player Monitor** โ real-time player list with coordinates & filters; players on the same spot group into a single map marker
* **Spectate** โ follow a player and see their view (toggle player ID/name tags with **N**)
* **Live View** โ WebRTC screen watching with quality presets (480p โ native 60fps) and proximity voice audio
* **Screenshots** โ capture player screens (saved server-side / to Discord)
* **Mugshots** โ Discord-posted mugshots
* **Replay Clips** โ auto-record on death/gunfire (configurable), plus manual `/adminclip`
***
## Quick Actions (Self Toggles)
17 self toggles for admins:
Noclip (5 speed tiers) ยท Godmode ยท Invisibility ยท Show Names ยท Super Jump ยท Infinite Stamina ยท Fast Run ยท Auto Heal ยท Head Lights ยท Show Coords ยท Show Hitbox ยท Night Vision ยท No Ragdoll ยท Infinite Ammo ยท Entity Inspector ยท Duty Toggle
***
## Troll Menu
A collection of **39 fun actions** for events and light moderation, grouped below. Spawned entities can be kept local to the target's screen for safety.
| Type | Examples |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **One-click pranks** | Ragdoll, screen shake, launch to sky, set on fire, flip vehicle, strip clothes, slow motion, super speed, confetti, nuke siren, break wheel, shockwave, ghost, clone circle, UFO kidnap, fart sounds |
| **Composite** | Force control (forward/back/jump), change model, attach prop, spawn animals, player size (shrink/enlarge) |
| **Toggles** | Drunk mode, magnet mode, upside-down cam, mirror controls, snow weather, ultra fog, disable lights, low gravity, random time, door spam, FOV oscillator, flicker invisible, ultra slow walk, low poly, fake lag, clone follow, 2D game mode |
```lua
TW.Troll.LocalSpawns = true -- Spawn entities only on the target's screen (anticheat-safe)
TW.Troll.SpawnTimeoutMs = 30000 -- Auto-clean spawned entities after 30s
```
{% hint style="warning" %}
Troll actions are powerful and visible to players. Restrict the `troll` permission group to trusted staff and keep `LocalSpawns` enabled to avoid anticheat issues.
{% endhint %}
***
## Exports & Events
The script exposes a few client exports/events for integration:
```lua
exports['tw-adminmenu']:IsSpectating() -- boolean
exports['tw-adminmenu']:GetSpectateTarget() -- targetServerId | nil
exports['tw-adminmenu']:IsNoclipping() -- boolean
```
Events: `tw-admin:spectate:started` ยท `tw-admin:spectate:stopped` ยท `tw-admin:noclip:started` ยท `tw-admin:noclip:stopped`
# Web Panel (Tworst Cloud)
**Tworst Cloud** is a cloud-hosted web panel that mirrors your in-game Admin Menu in the browser. Manage your server from anywhere โ the same players, bans, logs, tickets, and tools you have in-game, in real time.
{% hint style="success" %}
Nothing to host or deploy. Tworst Cloud runs at [panel.tworst.com](https://panel.tworst.com) โ you simply pair your server and log in.
{% endhint %}
{% hint style="info" %}
Prefer to work without leaving Discord? The same panel is available as a [**Discord Activity**](/admin-menu/admin-menu/discord-activity) โ open it right inside a voice channel.
{% endhint %}
***
## How It Works
The panel connects to your FiveM server through a secure uplink built into the `tw-adminmenu` resource. Once paired:
* Your server pushes live state (players, stats, logs) to the panel
* Admin actions you take in the browser are sent back to your server and executed
* Everything respects the **same roles and permissions** as the in-game menu
***
## Step 1: Pair Your Server
1. Log in to [panel.tworst.com](https://panel.tworst.com) with **Discord**
2. Click **Add Server** โ the panel generates a pairing snippet containing your `tenantId`, `serverId`, and `secret`
3. Open `shared/server_config.lua` on your server and paste the values into the Cloud block:
```lua
TW_Server.Cloud = {
enabled = true, -- turn the uplink on
url = "wss://panel.tworst.com/agent",
tenantId = "your-tenant-id", -- from the pairing snippet
serverId = "your-server-id",
secret = "your-pairing-secret",
}
```
4. Restart `tw-adminmenu` (or your server)
5. Back on the panel, your server should now show as **connected**
{% hint style="warning" %}
The pairing **secret** is shown only once. Keep it private โ treat it like a password. If you lose it, generate a new one from the panel.
{% endhint %}
***
## Step 2: Log In
Tworst Cloud uses **Discord login**. Sign in with the Discord account you want to own the workspace โ you'll land on your dashboard with your paired server(s).
***
## Step 3: Invite Your Staff
1. In the panel, open **Staff**
2. Invite a team member by their **Discord ID**
3. Assign them a role (or custom permissions)
When that person logs in with Discord, they get exactly the access their role allows โ the same permissions they'd have in-game.
{% hint style="success" %}
**Auto web permissions (opt-in):** Set `TW_Server.autoWebPermissions = true` and anyone you make **in-game** staff (with a Discord ID) automatically gets matching web-panel access โ no need to add them here by hand. Editing/removing their in-game staff mirrors to the web too. Manual grants you add in the panel are always preserved. See [Configuration โ Auto Web Permissions](/admin-menu/admin-menu/configuration#auto-web-permissions).
{% endhint %}
The **Staff** list shows each admin's web-access state at a glance: ๐ข has access & has signed in ยท ๐ก granted but not yet signed in ยท โช no web access.
{% hint style="info" %}
Staff roles and permissions are shared between the in-game menu, the web panel, and the Discord bot. Manage them once; they apply everywhere.
{% endhint %}
***
## What You Can Do in the Panel
The web panel mirrors the in-game menu. Main sections include:
| Section | Description |
| ----------------- | ---------------------------------------------------- |
| **Dashboard** | Live server stats, uptime, resource health |
| **Players** | Online players + actions (kick, ban, spectate, etc.) |
| **Player Detail** | Per-player info, inventory, jobs, records |
| **Vehicles** | Spawned vehicles & details |
| **Bans** | Ban management (revoke, edit, blacklist) |
| **Logs** | Searchable server audit logs |
| **Tickets** | Support ticket queue |
| **Staff** | Manage admins, roles & permissions |
| **Monitor** | Real-time player activity |
| **Live View** | In-game camera / spectate feed |
| **Console** | Execute commands (if permitted) |
| **Announcements** | Broadcast messages to the server |
| **Polls** | Create in-game polls |
| **Blips** | Manage map markers |
| **Rich List** | Player wealth rankings |
| **Jobs** | Active jobs & grades |
| **Teams** | Factions / groups |
| **Events** | Event calendar |
| **Whitelist** | Whitelist management |
| **Replays** | Incident recordings |
{% hint style="success" %}
**Real-time:** Every connected admin sees the same live data instantly. Actions taken in the browser apply on the server within moments.
{% endhint %}
***
## Multi-Server
You can pair more than one server to the same workspace and switch between them in the panel โ useful if you run multiple servers or a test environment.
***
## Need Help?
{% hint style="info" %}
Pairing trouble or panel questions? Join our [Discord server](https://discord.gg/tworst) and open a support ticket. Make sure `TW_Server.Cloud.enabled = true` and your `tenantId` / `serverId` / `secret` match the pairing snippet exactly.
{% endhint %}
# Discord Activity
The **Tworst Admin Discord Activity** lets you open the full Tworst Admin web panel **directly inside Discord** โ right in a voice channel, no browser needed. It's the same panel as [panel.tworst.com](https://panel.tworst.com), embedded in Discord, so you can moderate and manage your FiveM server without leaving your voice call.
{% hint style="success" %}
Same panel, same permissions โ just launched inside Discord. You sign in automatically with your Discord account; no password is shared.
{% endhint %}
***
## Requirements
Before using the Activity, make sure:
* You own an active Tworst Admin license and your FiveM server is **connected to the panel** (see [Web Panel (Tworst Cloud)](/admin-menu/admin-menu/web-panel)).
* You have signed in to [panel.tworst.com](https://panel.tworst.com) **with Discord** at least once โ the Activity logs you in using that same Discord account. If your Discord account isn't a registered Tworst account with access to a server, the Activity won't load your panel.
* You have the **Manage Server** permission in the Discord server (needed to add the app the first time).
* You're on Discord **desktop, mobile, or web** (Activities are supported on all three).
***
## Step 1: Add the Activity to Your Discord Server
1. Open this install link:
```
https://discord.com/oauth2/authorize?client_id=1508572621007093912
```
2. Choose **Add to Server** and select the Discord server you want.
3. Confirm/authorize. The **Tworst Admin** app is added to that server.
{% hint style="info" %}
You only need to do this **once per server**. The app is public โ everyone uses the same install link.
{% endhint %}
***
## Step 2: Launch the Activity
1. Join any **voice channel** in that server.
2. Open the **Activity launcher** (the rocket / "Activities" icon in the voice channel controls).
3. Find and select **Tworst Admin Menu**.
4. The panel opens inside Discord.
***
## Step 3: Sign In (Automatic)
* The first time, Discord asks you to authorize the app โ tap **Authorize**.
* The Activity then signs you in automatically with your Discord account and loads your dashboard. **No password needed.**
* If you have access to more than one server, pick the one you want to manage from the built-in server picker.
***
## Using the Panel
Once loaded, you get the full admin panel โ player moderation, server monitoring, teams, whitelist, and every other tool โ scoped to the server you selected. It behaves exactly like [panel.tworst.com](/admin-menu/admin-menu/web-panel), and respects the [same roles and permissions](/admin-menu/admin-menu/permissions) as the in-game menu.
***
## Troubleshooting
### The Activity isn't in the launcher
Make sure the app was **added to the server** (Step 1) and that you're **inside a voice channel**. Try reopening the activity launcher.
### It loads but won't log me in / shows no server
Your Discord account must be a **registered Tworst account with server access**. Sign in to [panel.tworst.com](https://panel.tworst.com) with Discord first, and make sure you have a license (or are added as staff on a server).
### Blank screen or stuck loading
Close the Activity and relaunch it.
### Wrong server shown
Use the **server picker** inside the Activity to switch servers.
***
## Notes
* The Activity is the same secure panel as the browser version โ your session stays inside Discord and no password is shared.
* Works on Discord **Desktop, Web, and Mobile**.
{% hint style="info" %}
Need help? Join our [Discord server](https://discord.gg/tworst) and open a support ticket.
{% endhint %}
# Discord Bot
The **Tworst Admin Bot** lets your staff run admin actions and receive live logs directly from Discord. It connects to your server through Tworst Cloud and enforces the **same roles and permissions** as the in-game menu.
{% hint style="info" %}
The bot is **open-source and self-hosted** โ you run it on your own machine/VPS and connect it to **your own** Discord bot application. You're in full control of the token and hosting.
{% endhint %}
***
## What It Does
* **Remote player admin** โ kick, ban, warn, jail, freeze, heal, revive, give items/money, and more (via slash commands)
* **Server info** โ live status, online player list
* **Announcements** โ broadcast to the server from Discord
* **Bans & whitelist** โ manage bans and whitelist entries
* **Event logging** โ post event announcements to your channels
* **Role sync (optional)** โ mirror in-game staff roles to Discord roles, bidirectionally
* **5 languages** โ EN, TR, DE, FR, ES
{% hint style="info" %}
**Ticket logging** is handled in-game via Discord webhooks (Admin Menu v1.0.3+), not by the bot. See [Admin Menu โ Configuration](/admin-menu/admin-menu/configuration#shared-webhooks-lua).
{% endhint %}
***
## How It Connects
```
Discord โโโถ Tworst Admin Bot โโโถ Tworst Cloud โโโถ Your FiveM server
(tw-adminmenu)
```
The bot talks to your server through the same Tworst Cloud uplink the web panel uses. Every action carries the Discord user's identity, so the server enforces **that user's in-game staff permissions** โ there's no separate permission list to maintain.
***
## Prerequisites
| Requirement | Notes |
| -------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Node.js 20+** | Required to run the bot |
| **A Discord application** | Your own bot token (free, created at the Discord Developer Portal) |
| **A paired Tworst Cloud server** | The bot uses your cloud credentials โ set up the [Web Panel](/admin-menu/admin-menu/web-panel) first |
| **Hosting** | Any machine/VPS that can stay online 24/7 |
{% hint style="info" %}
You download the bot's source code from its GitHub repository: [github.com/tworst46/twadminmenu\_bot](https://github.com/tworst46/twadminmenu_bot)
{% endhint %}
***
## Quick Links
# Setup
A step-by-step guide to self-host the Tworst Admin Bot and connect it to your server.
{% hint style="info" %}
Set up the [Web Panel (Tworst Cloud)](/admin-menu/admin-menu/web-panel) first โ you'll need your cloud credentials (`tenantId`, `serverId`, bot `secret`) to connect the bot.
{% endhint %}
***
## Step 1: Create a Discord Application & Bot
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications)
2. Click **New Application**, give it a name (e.g. "TW Admin Bot")
3. Open the **Bot** tab โ **Reset/Copy Token** โ this is your `DISCORD_BOT_TOKEN`
4. Copy the **Application ID** from the **General Information** tab โ this is your `DISCORD_BOT_CLIENT_ID`
***
## Step 2: Invite the Bot to Your Server
1. In the application, open **OAuth2 โ URL Generator**
2. Select scopes: **`bot`** and **`applications.commands`**
3. Select bot permissions: **Manage Roles**, **Manage Channels**, **Send Messages**, **Embed Links**, **Read Message History**, **Mention @everyone, @here, and All Roles**
4. Open the generated URL, pick your Discord server, and authorize
{% hint style="info" %}
**Manage Roles / Manage Channels** are only needed if you plan to use role sync and the event/ticket logging features. You can grant a narrower set if you don't.
{% endhint %}
***
## Step 3: Get Your Tworst Cloud Credentials
From [panel.tworst.com](https://panel.tworst.com), open your server's settings and note:
* **Tenant ID** (`BOT_TENANT_ID`)
* **Server ID** / slug (`BOT_SERVER_ID`)
* **Bot Secret** (`BOT_SECRET`)
***
## Step 4: Download & Install
```bash
git clone https://github.com/tworst46/twadminmenu_bot
cd twadminmenu_bot
npm install
```
***
## Step 5: Configure `.env`
Copy the example and fill in your values:
```bash
cp .env.example .env
```
At minimum, set:
```
DISCORD_BOT_TOKEN=your-bot-token
DISCORD_BOT_CLIENT_ID=your-application-id
BOT_AGENT_URL=wss://panel.tworst.com/bot
BOT_SECRET=your-cloud-bot-secret
BOT_TENANT_ID=your-tenant-id
BOT_SERVER_ID=your-server-slug
```
See [Configuration](/admin-menu/admin-menu/discord-bot/configuration) for every available option (role sync, event/ticket channels, language, etc.).
***
## Step 6: Register Slash Commands
```bash
npm run deploy-commands
```
This registers all `/` commands with Discord. Guild-scoped commands appear instantly.
***
## Step 7: Start the Bot
```bash
npm start
```
You should see output similar to:
```
[bot] tw-adminmenu Discord Bot starting...
[bot] Agent bridge connecting...
[bot] Discord ready as YourBotName#0000
[bot] Bot is running. Press Ctrl+C to stop.
```
Test it by running **`/status`** in your Discord server โ you should see your server's live status.
***
## Step 8 (Optional): Channels & Role Sync
* **Event announcements:** create a channel, then run `/event-channel set #events`
* **Role sync:** set `BOT_ROLE_SYNC=1` and `BOT_GUILD_ID` in `.env`, restart, then run `/sync`
{% hint style="info" %}
**Ticket logs** are configured in-game, not via the bot โ set the ticket webhooks in `shared/webhooks.lua`. See [Admin Menu โ Configuration](/admin-menu/admin-menu/configuration#shared-webhooks-lua).
{% endhint %}
***
## Hosting Tips
{% hint style="info" %}
The bot must stay running 24/7. For production, run it on a VPS with a process manager (e.g. `pm2`) so it restarts automatically. Running it on your PC only works while that PC is on.
{% endhint %}
***
## Troubleshooting
### Bot won't start
* Confirm `.env` is in the project root with all required fields filled in
* Check Node.js version: `node --version` (must be 20+)
* Make sure `npm install` finished without errors
### Bot online but commands fail / "not connected"
* Double-check `BOT_SECRET`, `BOT_TENANT_ID`, `BOT_SERVER_ID`
* Confirm your server is paired and **connected** in the web panel
* Set `BOT_DEBUG_BRIDGE=1` for verbose connection logs
### Slash commands don't appear
* Run `npm run deploy-commands` again
* Global commands can take up to an hour to propagate; guild-scoped are instant
### Role sync not working
* Ensure `BOT_ROLE_SYNC=1` and `BOT_GUILD_ID` are set, then restart
* Make sure the bot has **Manage Roles** permission and its role is high enough in the Discord role list
* Run `/sync` to trigger a manual sync
***
## Need Help?
{% hint style="info" %}
Join our [Discord server](https://discord.gg/tworst) and open a support ticket with your console output (enable `BOT_DEBUG_BRIDGE=1` first).
{% endhint %}
# Configuration
The bot is configured through a `.env` file in the project root. Some settings can also be changed at runtime with slash commands (they persist to the `data/` folder).
***
## Environment Variables
### Required
| Variable | Description |
| ----------------------- | ------------------------------------------------------------ |
| `DISCORD_BOT_TOKEN` | Your Discord bot token (Developer Portal โ Bot) |
| `DISCORD_BOT_CLIENT_ID` | Your Discord application ID (for registering slash commands) |
| `BOT_AGENT_URL` | Tworst Cloud bot endpoint โ `wss://panel.tworst.com/bot` |
| `BOT_SECRET` | Bot secret from your Tworst Cloud server settings |
| `BOT_TENANT_ID` | Your tenant ID from the dashboard |
| `BOT_SERVER_ID` | Your server slug (set when you created the server) |
### Role / Staff Sync (Optional)
| Variable | Default | Description |
| ----------------- | ------- | --------------------------------------------------------------------------------------- |
| `BOT_ROLE_SYNC` | `0` | `1` enables bidirectional role mirroring + `/sync`, `/teamsync`, `/setrole`, `/unstaff` |
| `BOT_GUILD_ID` | โ | Discord server ID where roles are synced (required when sync is on) |
| `BOT_ROLE_PREFIX` | `TW \|` | Prefix for synced roles (e.g. "TW \| Admin") |
### Events (Optional)
| Variable | Default | Description |
| --------------------------- | ------- | ------------------------------------------------------------- |
| `BOT_EVENT_CHANNEL_ID` | โ | Channel for event announcements (or set via `/event-channel`) |
| `BOT_EVENT_MENTION_ROLE_ID` | โ | Role to mention on event posts |
| `BOT_EVENT_DM_STAFF` | `1` | `0` = DM each staff member on events, `1` = channel-only |
{% hint style="info" %}
**Ticket logging is no longer handled by the bot.** As of Admin Menu v1.0.3, ticket open/close logs are posted directly from the game via `shared/webhooks.lua` (`tickets` / `ticketsOpen` / `ticketsClose`) โ no bot required. See [Configuration โ webhooks](/admin-menu/admin-menu/configuration#shared-webhooks-lua).
{% endhint %}
### Other (Optional)
| Variable | Default | Description |
| ------------------ | ------- | ---------------------------------------------------------------------- |
| `BOT_LOCALE` | `en` | Bot language: `en`, `tr`, `de`, `fr`, `es` (or change via `/language`) |
| `BOT_DEBUG_BRIDGE` | `0` | `1` = verbose WebSocket logging (troubleshooting only) |
***
## Role Sync Explained
By default (`BOT_ROLE_SYNC=0`) the bot only provides moderation/info commands. Setting **`BOT_ROLE_SYNC=1`** unlocks:
* **Bidirectional mirroring** โ assign an in-game staff role and the matching Discord role is applied automatically, and vice-versa
* **`/sync`** โ perform a full role sync and view current mappings
* **`/teamsync`** โ sync Discord team members with in-game teams
* **`/setrole`** / **`/unstaff`** โ manage in-game staff directly from Discord
Synced Discord roles are named using `BOT_ROLE_PREFIX` (e.g. `TW | Admin`). Leave sync off if you don't want Discord to control in-game staff.
***
## Runtime Configuration
These settings are stored in the `data/` folder and can be changed without editing `.env`:
| File | Set via | Stores |
| ------------------------ | ---------------- | -------------------------------- |
| `data/bot-config.json` | `/language set` | Bot language |
| `data/event-config.json` | `/event-channel` | Event channel + mention role |
| `data/role-mapping.json` | auto (role sync) | Game role โ Discord role mapping |
These files are created automatically on first use. Delete them to reset to your `.env` defaults.
***
## Permissions Model
{% hint style="success" %}
The bot does **not** use a separate allowlist. Action commands are authorized by the **in-game staff role** of the Discord user who runs them. If a user isn't staff (or lacks the permission) in-game, the action is denied.
{% endhint %}
The only exceptions are the configuration commands (`/language`, `/event-channel`), which require the Discord **Manage Server** permission.
***
## `.env.example` Reference
```env
# --- Discord Bot ---
DISCORD_BOT_TOKEN=
DISCORD_BOT_CLIENT_ID=
# --- Tworst Cloud Connection ---
BOT_AGENT_URL=wss://panel.tworst.com/bot
BOT_SECRET=
BOT_TENANT_ID=
BOT_SERVER_ID=
# --- Role / Staff Sync (optional, off by default) ---
BOT_ROLE_SYNC=0
BOT_GUILD_ID=
BOT_ROLE_PREFIX=TW |
# --- Events (optional) ---
BOT_EVENT_CHANNEL_ID=
BOT_EVENT_MENTION_ROLE_ID=
BOT_EVENT_DM_STAFF=1
# --- Bot Language (optional) ---
BOT_LOCALE=en
# --- Debug (optional) ---
BOT_DEBUG_BRIDGE=0
```
# Commands
All slash commands provided by the Tworst Admin Bot, grouped by category.
{% hint style="info" %}
Every action command is authorized by the Discord user's **in-game staff role**. If a user lacks the permission in-game, the command is denied. Commands marked **(role sync)** require `BOT_ROLE_SYNC=1`.
{% endhint %}
***
## Server
| Command | Description |
| ---------------------------- | ---------------------------------------------------- |
| `/status` | Show server status (player count, uptime, health) |
| `/players` | List online players (name, ID, ping) |
| `/announce [type]` | Send a server announcement (banner / popup / toast) |
| `/sync` | Sync game roles & staff with Discord **(role sync)** |
***
## Player Moderation
| Command | Description |
| ----------------------------------- | -------------------------------- |
| `/kick [reason]` | Kick a player |
| `/ban [duration]` | Ban a player (temp or permanent) |
| `/unban [reason]` | Unban a player |
| `/warn ` | Warn a player |
| `/jail [time]` | Jail a player |
| `/unjail ` | Release a jailed player |
| `/freeze ` | Freeze a player |
| `/unfreeze ` | Unfreeze a player |
| `/stripweapons ` | Remove all weapons from a player |
***
## Player Actions
| Command | Description |
| ------------------------------------- | ---------------------------------- |
| `/heal ` | Heal a player to full HP |
| `/revive ` | Revive a downed/dead player |
| `/kill ` | Kill a player |
| `/slap [force]` | Slap a player (knockback) |
| `/explode ` | Explode a player |
| `/giveitem [count]` | Give an inventory item |
| `/givemoney [type]` | Give cash or bank money |
| `/givemodel ` | Change a player's model/appearance |
***
## Vehicle
| Command | Description |
| -------------------------------- | ------------------------------- |
| `/spawnvehicle ` | Spawn a vehicle for a player |
| `/vlookup ` | Look up a vehicle by model name |
***
## Information
| Command | Description |
| ------------------ | ------------------------------------- |
| `/banlist [limit]` | Show recent bans (default 10, max 25) |
| `/lookup ` | Fetch detailed player information |
***
## Teams
| Command | Description |
| ------------------------------ | ------------------------------------------------------------ |
| `/teamlist` | List all active teams with stats |
| `/teaminfo ` | Show detailed team info |
| `/teamadd ` | Add a Discord user to a team |
| `/teamremove ` | Remove a Discord user from a team |
| `/teamsync` | Sync Discord team members with in-game teams **(role sync)** |
***
## Whitelist
| Command | Description |
| ----------------------------------------------------------- | ------------------------------------ |
| `/whitelistadd [identifier] [discord_user] [name] [reason]` | Add to whitelist |
| `/whitelistlist [limit]` | Show whitelisted identifiers |
| `/whitelistremove ` | Remove from whitelist |
| `/whitelistmode ` | Enable/disable whitelist enforcement |
***
## Events
| Command | Description |
| --------------------------------- | ------------------------------------------------------- |
| `/events [status]` | List events (upcoming / active / completed / cancelled) |
| `/event-detail ` | Show detailed event info |
| `/event-channel ` | Configure the event announcement channel |
***
## System
| Command | Description |
| ----------------------- | --------------------------------------------------- |
| `/language ` | Change or display the bot language (en/tr/de/fr/es) |
***
## Staff Management (role sync)
| Command | Description |
| ------------------------ | -------------------------------------------------------------- |
| `/setrole ` | Assign an in-game staff role to a Discord user **(role sync)** |
| `/unstaff ` | Remove a Discord user from staff **(role sync)** |
{% hint style="info" %}
`/language` and `/event-channel` require the Discord **Manage Server** permission. All other commands rely on your in-game staff permissions.
{% endhint %}
{% hint style="info" %}
**Ticket logging** is handled in-game via Discord webhooks (Admin Menu v1.0.3+), not by the bot โ the `/ticket-channel` command was removed. See [Admin Menu โ Configuration](/admin-menu/admin-menu/configuration#shared-webhooks-lua).
{% endhint %}
# Changelog
Version history and updates for the Tworst Admin Menu.
***
## Current Version: 1.1.3
{% hint style="success" %}
You are using the latest version of Tworst Admin Menu.
{% endhint %}
***
## Update Instructions
### Automatic Updates
Scripts purchased through Cfx.re automatically receive updates:
1. Go to [portal.cfx.re](https://portal.cfx.re)
2. Navigate to **Granted Assets**
3. Find **tw-adminmenu**
4. Click **Download** to get the latest version
### Manual Update Process
1. **Backup your current files**
* Save your `shared/config.lua`
* Save your `shared/server_config.lua`
* Save your `shared/webhooks.lua`
2. **Download the new version**
3. **Extract and replace files**
* Replace all files except your config files
* Or compare and merge changes carefully
4. **Check for new config options**
* Compare your config with the new default
* Add any new settings that were added
5. **Restart your server**
{% hint style="warning" %}
**Important:** Always backup your configuration files before updating! New versions may add new config options that need to be added to your existing config.
{% endhint %}
***
## Reporting Issues
Found a bug or have a suggestion?
{% hint style="info" %}
Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Current script version
* Detailed description of the issue
* Steps to reproduce
* Server console errors (if any)
* Screenshots or videos (if applicable)
{% endhint %}
# v1.1.3
## New
* **Custom integration adapters for every bridge** โ set any system to `"custom"` and write your own in `bridge//adapters/custom.lua`.
* **Quick Menu permissions** โ control which Quick Actions each role may use.
* Item Explorer โ **"Wipe from all"**.
* **okokBilling** and **rcore\_prison** support.
* qs-inventory: vehicle trunk & glovebox editing.
* Map: players on the same spot now group into one marker.
* Spectate: player ID/name tags (toggle with **N**).
* Unemployed is now assignable.
## Fixes
* qs-advancedgarages send to garage / impound.
* Admin menu double-press after spectate.
* General hardening.
{% hint style="info" %}
**Quick Menu permissions are auto-filled on update.** Roles that already had risky permissions (ban, console, etc.) get the full set; others get a safe subset (coords, names, clothing, etc.). Adjust in the role editor โ **no manual SQL needed.**
{% endhint %}
{% hint style="warning" %}
**Keep your own `shared/server_config.lua`, `shared/config.lua` & `shared/webhooks.lua`** when updating. Replace the whole `ui/dist/` folder and the other changed files.
{% endhint %}
## Changed Files
* **New:** `bridge/*/adapters/custom.lua` (all domains), `bridge/inventory/custom.lua`
* **New:** `bridge/invoices/adapters/okokbilling.lua`, `bridge/jail/adapters/rcore-prison.lua`
* **New:** `sql/migrations/006_add_quickmenu_perms.sql`
* `fxmanifest.lua`, `shared/config.lua`, `shared/permissions.lua`, `sql/install.sql`
* `bridge/registry.lua`, `bridge/garage/providers.lua`, `bridge/inventory/qs-inventory.lua`
* `bridge/clothing/adapters/custom.lua`, `bridge/revive/system.lua`
* `client/main.lua`, `client/quickActions.lua`, `client/spectate.lua`
* `server/helpers.lua`, `server/auth/manager.lua`, `server/cloud/handlers.lua`
* `server/core/{qbcore,esx}/jobs.lua`
* `server/data/items/{system,handlers}.lua`, `server/data/playerblips/handlers.lua`, `server/data/quick_actions/defaults.lua`
* `locales/*.json` (all 13)
* `ui/dist/**` (replace the whole folder)
# v1.1.2
## New
* **QBox** support.
* `/ticketadmin` command.
## Fixes
* ox\_inventory: Item Explorer, Give Item and item lookups fixed.
* Admin menu double-press after spectate.
* General hardening.
{% hint style="warning" %}
**Keep your own `shared/server_config.lua`, `shared/config.lua` & `shared/webhooks.lua`** when updating. Replace the whole `ui/dist/` folder and the other changed files.
{% endhint %}
## Changed Files
* `fxmanifest.lua`
* `bridge/inventory/ox-inventory.lua`
* `client/main.lua`, `client/spectate.lua`
* `server/auth/handlers.lua`, `server/auth/helpers.lua`
* `server/cloud/handlers.lua`
* `server/core/qbcore/jobs.lua`
* `server/data/console/handlers.lua`
* `server/data/export/system.lua`
* `server/data/tickets/transcript.lua`
* `ui/dist/**` (replace the whole folder)
# v1.1.1
## New
* **IP ban** โ optionally ban a player's IP too (permission-gated: `player.ip_ban`).
* **Live View listening can be disabled per-server** (config) โ when off, players aren't prompted for mic access and admins get a "disabled" notice.
## Fixes & Improvements
* Live View "target offline" on busy servers โ players now resolve reliably.
* Live View relay hardening (fewer black screens on strict networks).
* Localization updates across all 13 languages.
{% hint style="warning" %}
**Keep your own `shared/server_config.lua`, `shared/config.lua` & `shared/webhooks.lua`** when updating. Replace the whole `ui/dist/` folder (rebuilt) and the other changed files.
{% endhint %}
## Config
* `server_config.lua` โ `liveViewAudio.enabled = false` to disable player listening.
* **AddBan:** new `player.ip_ban` permission โ assign it in-game to allow IP bans.
## Changed Files
* `fxmanifest.lua`, `shared/permissions.lua`
* `client/liveview.lua`
* `server/ban/{handlers,system}.lua`
* `server/cloud/handlers.lua`
* `server/core/{esx,qbcore}/player.lua`
* `server/data/liveview/system.lua`
* `locales/*.json` (all 13)
* `ui/dist/**` (rebuilt โ replace the whole `ui/dist` folder)
# v1.1.0
## New
* **Auto web-panel access** โ grant staff in-game, they get panel access automatically (opt-in, `TW_Server.autoWebPermissions`).
* Staff list shows each admin's web-access status at a glance (๐ข signed in ยท ๐ก granted, not signed in ยท โช none).
* New integrations: **AV Weather** ยท **Randol** community service ยท **Bablo** billing.
* **Offline vehicle management** โ grant/remove vehicles for offline players.
* Item Explorer: storage view + cleaner large-number formatting.
## Fixes & Improvements
* Ticket alerts: no duplicates, correct ticket number, richer info on web.
* Codem inventory: vehicle trunk/glovebox items now shown.
* Jail, garage & several framework bridges hardened.
* Thai language + updates across all 13 locales.
{% hint style="warning" %}
**Keep your own `shared/server_config.lua` & `shared/config.lua`** when updating. Replace `ui/dist/**` (rebuilt) and the other changed files.
{% endhint %}
## Config
`shared/server_config.lua` gained `TW_Server.autoWebPermissions` (default `false`), placed **above** the `Cloud` block so re-pairing the cloud no longer wipes it.
## Changed Files
* **New:** `bridge/communityservice/adapters/randol_service.lua`, `randol_service_client.lua`
* **New:** `bridge/invoices/adapters/bablo-billing.lua`
* **New:** `bridge/world/adapters/av_weather.lua`
* `fxmanifest.lua`, `bridge/registry.lua`
* `bridge/clothing/adapters/illenium-appearance.lua`
* `bridge/communityservice/{handlers,system}.lua`
* `bridge/garage/{facade,providers}.lua`
* `bridge/inventory/codem-inventory.lua`
* `bridge/jail/**` (pickle-prisons, qb-prison, client, handlers, system)
* `client/{trollDefaults,vehicles}.lua`
* `server/auth/handlers.lua`, `server/cloud/{handlers,uplink}.lua`
* `server/core/**` (esx/vehicles, qbcore/{queries,sync\_hooks,vehicles})
* `server/data/{tickets,vehicles}/handlers.lua`, `server/player/actions.lua`
* `locales/*.json` (all 13)
* `ui/dist/**` (rebuilt โ replace)
# v1.0.9
## Added
* **Database Backup** โ take a full backup from the panel (Server page), or let it run automatically. Compressed, with its own permission.
* **Item Explorer: new "Storages" tab** โ see which stashes hold an item, next to Players and Vehicles.
* **Custom languages** โ add your own language without touching the UI (see `locales/custom_languages.json`).
* **Revive support** โ 0r-ambulancejob.
## Fixed
* codem-inventory: vehicle trunk & glovebox items now show up everywhere.
* Item Explorer performance and loading improvements.
* Item images and large item counts display correctly.
* Owner accounts no longer miss newly added panel features.
## Changed Files
* `server/backup/*` โข `server/bridge/db_backup.js` โข `server/cloud/handlers.lua` โข `server/log/formatters/server.lua` โข `bridge/inventory/*` โข `bridge/revive/*` โข `shared/config.lua` โข `shared/permissions.lua` โข `locales/*` โข `ui/dist/*` โข `fxmanifest.lua`
# v1.0.8
## Added
* **Custom languages** โ add your own language to the panel without editing the UI (see `locales/custom_languages.json`).
* **Revive support** โ 0r-ambulancejob.
* **codem-inventory** โ full vehicle trunk & glovebox support in the Item Explorer.
## Fixed
* Fixed panel actions occasionally failing with "target offline" for online players.
* Panel item images now load reliably and match your in-game inventory.
* Item Explorer: fixed large item counts overflowing, and made vehicle rows clickable.
* Various performance and stability improvements.
## Changed Files
* `bridge/inventory/*` โข `bridge/revive/*` โข `bridge/registry.lua` โข `server/cloud/handlers.lua` โข `server/core/*` โข `shared/config.lua` โข `locales/*` โข `ui/dist/*` โข `fxmanifest.lua`
# v1.0.7
## Added
* **Live item images** โ the web panel now shows the exact item images from your own inventory resource.
* **Inventory support** โ ak47\_inventory.
* **Jail support** โ pickle\_prisons.
* **Clothing support** โ ak47\_qb\_clothing, crm-appearance.
## Fixed
* Web panel "Set Job" now lists the server's real jobs.
## Changed Files
* `bridge/inventory/*` โข `bridge/jail/*` โข `bridge/clothing/*` โข `bridge/registry.lua` โข `server/cloud/handlers.lua` โข `server/player/actions.lua` โข `server/data/quick_actions/defaults.lua` โข `shared/config.lua` โข `fxmanifest.lua`
# v1.0.6
## Added
* **New language** โ เนเธเธข (Thai). 13 languages total.
* **Revive support** โ wasabi\_ambulance.
* **Jail support** โ DHS-PrisonSim.
* **Invoice support** โ wasabi\_billing.
* **Vehicle key support** โ MrNewbVehicleKeys.
* **Clothing support** โ rcore\_clothing.
* **Phone number support** โ qs-smartphone / qs-smartphone-pro.
## Fixed
* Fixed panel actions occasionally failing with "target offline" for players who were online.
* Item Explorer now includes offline players' items on more inventory setups.
* Minor inventory and billing compatibility improvements.
## Changed Files
* `bridge/revive/*` โข `bridge/jail/*` โข `bridge/invoices/*` โข `bridge/vehiclekeys/*` โข `bridge/clothing/*` โข `bridge/inventory/*` โข `bridge/registry.lua` โข `server/core/*` โข `server/cloud/handlers.lua` โข `shared/config.lua` โข `fxmanifest.lua` โข `ui/dist/*` โข `locales/*`
# v1.0.5
## Fixed
* Live View issues fixed and improved.
* Fixed "Send to Impound" deleting the vehicle without impounding it on some garage systems.
* Fixed item actions failing on some inventory setups.
## Changed Files
* `bridge/garage/providers.lua` โข `bridge/inventory/chezza-inventory.lua` โข `server/core/esx/vehicles.lua` โข `server/core/qbcore/vehicles.lua` โข `server/data/liveview/system.lua` โข `server/cloud/handlers.lua` โข `fxmanifest.lua` โข `ui/dist/*` โข `locales/*`
# v1.0.4
## Added
* **Inventory support** โ chezza-inventory.
## Fixed
* Fixed the Give Item picker showing no results on some inventory setups.
* Fixed garage actions (send to garage / impound) on some garage systems.
* Fixed staff removal not applying immediately.
* Minor localization improvements.
## Changed Files
* `bridge/inventory/*` โข `bridge/garage/*` โข `bridge/registry.lua` โข `server/auth/handlers.lua` โข `server/helpers.lua` โข `ui/dist/*` โข `locales/*`
# v1.0.3
## Added
* **Ticket logging via Discord webhook** โ ticket open & close events (with a transcript link) now post straight to a Discord channel you set in `shared/webhooks.lua`. **No bot required.** Split them into separate channels with `ticketsOpen` / `ticketsClose`.
* **Inventory support** โ tgiann-inventory.
* **Garage support** โ tgiann-realparking (vehicle state, read-only).
* **Invoice support** โ codem-mphone (mPhone v2 newbilling).
## Fixed
* `/ticket` โ players without admin permission now open the player ticket menu instead of an empty screen.
* **Dashboard** โ removed leftover placeholder text on the Online Players card.
## Changed Files
* `server/data/tickets/transcript.lua` โข `server/data/tickets/system.lua` โข `server/cloud/handlers.lua` โข `shared/webhooks.lua` โข `bridge/inventory/tgiann-inventory.lua` โข `bridge/inventory/_export_provider.lua` โข `bridge/garage/adapters/tgiann-realparking.lua` โข `bridge/invoices/adapters/codem-mphone.lua` โข `bridge/invoices/handlers.lua` โข `bridge/registry.lua` โข `shared/config.lua` โข `fxmanifest.lua` โข `ui/dist/*` โข `locales/*`
# v1.0.2
## Fixed
* Fixed staff assignment related issues.
## Changed Files
* `server/auth/helpers.lua` โข `server/auth/handlers.lua` โข `server/auth/manager.lua` โข `server/player/profile.lua`
# v1.0.1
## Added
* **Billing / Invoices** โ new provider support: **ESX Billing**, **Codem Billing** & **Codem Billing v2** (on top of qb-phone & g-billing). View and manage player invoices from the panel across all of them.
* **Auto-detect** โ the compatibility bridge picks up the active billing resource automatically (`TW.InvoicesSystem`).
## Changed Files
* `bridge/invoices/adapters/*` (esx\_billing, codem-billing, codem-billingv2 โ new)
* `bridge/registry.lua`
* `fxmanifest.lua`
* `shared/config.lua`
# v1.0
Initial release.
**Includes:**
* In-game NUI admin menu (QBCore, QBox & ESX) with auto-detected integrations
* Role-based permissions with 5 built-in roles + custom roles
* Player, vehicle, and server management
* Monitoring: live monitor, spectate, Live View (WebRTC + proximity audio), replay clips, mugshots
* Tickets, announcements, polls, events, blips, jobs, teams, invoices
* Quick Actions (17 self toggles) and Troll Menu (39 actions)
* Comprehensive audit logging with per-category Discord webhooks
* Tworst Cloud web panel uplink
* Companion Discord bot support
* 13 languages
# Multiplayer Scrapyard Job
## Overview
**TW Scrapyard Job** is a fully immersive multiplayer scrapyard job system where players can collect, process, and sell scrap materials. Work alone or team up with up to 4 players to complete missions, earn money, and level up your scrapyard career.
{% hint style="success" %}
**Multiplayer Support:** Up to 4 players can work together in a lobby, sharing tasks and rewards!
{% endhint %}
***
## Features
### Core Features
* **Multiplayer Lobby System** - Work with up to 4 players in cooperative gameplay
* **Vehicle Rental System** - Rent work vehicles to collect and transport scrap
* **Scrap Collection** - Pick up various scrap objects from designated areas
* **Press Machine** - Compress collected scrap into compact forms
* **Shredding System** - Break down compressed scrap into smaller pieces
* **Furnace & Melting** - Melt shredded materials into molten metal
* **Rail System** - Advanced bucket and rail mechanism for material transport
* **Crafting Tables** - Pour molten metal into molds to create items
### Additional Features
* **Level & XP System** - Progress through 70 levels with increasing rewards
* **Daily Missions** - Complete daily tasks for bonus rewards
* **Illegal Weapon Crafting** - Craft weapons from scrap parts (configurable)
* **Legal Item Crafting** - Create legitimate items for sale
* **Sell NPCs** - Legal and illegal buyers for your products
* **Reconnection System** - Players can reconnect to lobbies after disconnection
* **Tutorial System** - In-game video tutorials for new players
* **Multi-language Support** - 7 languages included (EN, TR, DE, FR, PT, RU, AR)
***
## How It Works
### Step 1: Start a Lobby
Go to the scrapyard NPC and open the job menu. Create a lobby and invite other players (optional).
### Step 2: Rent a Vehicle
Rent a work vehicle from the designated area. The vehicle is used to transport collected scrap.
### Step 3: Collect Scrap
Travel to the scrap collection area and pick up various scrap objects (microwaves, TVs, washing machines, etc.).
### Step 4: Process the Scrap
1. **Press** - Place scrap in the press machine to compress it
2. **Shred** - Put compressed scrap into the shredder
3. **Melt** - Pour shredded material into the furnace
4. **Pour** - Use the rail system to collect molten metal and pour into molds
### Step 5: Collect Rewards
Sell your crafted items to NPCs or complete missions for money and XP rewards.
***
## Requirements
| Resource | Required | Notes |
| --------- | -------- | --------------------------------------------------- |
| Framework | โ Yes | QBCore, QBox, ESX, vRP, or Standalone |
| Database | โ Yes | oxmysql (recommended), mysql-async, or ghmattimysql |
| PolyZone | โ Yes | Required for all Tworst Scripts |
### Optional Dependencies
| Resource | Purpose |
| ---------------------- | --------------------------------- |
| qb-target / ox\_target | Target interaction system |
| Vehicle Keys Script | Automatic vehicle key integration |
| Clothing Script | Job uniform system |
***
## Supported Systems
### Frameworks
| Framework | Config Value |
| ---------- | ------------------ |
| QBCore | `'qb'` |
| QBox | `'qb'` |
| ESX Legacy | `'esx'` |
| vRP / vRP2 | `'vrp'` / `'vrp2'` |
| Standalone | `'standalone'` |
### Inventory Systems
| System | Config Value |
| ---------------- | ----------------- |
| QBCore Inventory | `'qb_inventory'` |
| ESX Inventory | `'esx_inventory'` |
| ox\_inventory | `'ox_inventory'` |
| qs-inventory | `'qs_inventory'` |
### Vehicle Key Systems (Auto-detected)
* qb-vehiclekeys
* qbx-vehiclekeys
* qs-vehiclekeys
* wasabi-carlock
* cd\_garage
* Renewed-Vehiclekeys
### Fuel Systems (Auto-detected)
* LegacyFuel
* ox\_fuel
* cdn-fuel
* ps-fuel
* x-fuel
***
## Commands
| Command | Description |
| ------------------------ | ----------------------- |
| `/jobresetscrapyard` | Reset your current job |
| `/jobleavescrapyard` | Leave the current lobby |
| `/openTutorialscrapyard` | Open the tutorial menu |
***
## Items
The script includes the following items that need to be added to your inventory system:
| Item | Label | Description |
| -------------- | ------------- | -------------------------- |
| `iron` | Iron | Processed metal from scrap |
| `gold_dust` | Gold Dust | Rare material from scrap |
| `pistol_part1` | Pistol Part 1 | Weapon component |
| `pistol_part2` | Pistol Part 2 | Weapon component |
| `pistol_part3` | Pistol Part 3 | Weapon component |
| `pistol_part4` | Pistol Part 4 | Weapon component |
{% hint style="info" %}
Item definitions for QBCore and ox\_inventory are included in the `ITEM/` folder.
{% endhint %}
***
## Quick Links
***
## Purchase
{% hint style="info" %}
Purchase Multiplayer Diving Job from our [Tebex Store](https://tworst.tebex.io) or [CFX Store](https://tworst.com).
{% endhint %}
# Installation
Step-by-step guide to install the Multiplayer Diving Job on your FiveM server.
***
## Prerequisites
Before installing, make sure you have:
| Requirement | Description |
| --------------------- | --------------------------------------------------- |
| **Framework** | QBCore, QBox, ESX, vRP, or Standalone |
| **Database Resource** | oxmysql (recommended), mysql-async, or ghmattimysql |
| **PolyZone** | Required for all Tworst Scripts |
| **FiveM Server** | Build 2802 or higher recommended |
***
## Step 1: Download the Script
### From Cfx.re Portal (Recommended)
1. Go to [portal.cfx.re](https://portal.cfx.re)
2. Navigate to **Granted Assets**
3. Find **tw-diving** in your purchased scripts
4. Click **Download** to get the latest version
### From Tebex
1. Log in to your Tebex account
2. Go to your purchases
3. Download the script package
***
## Step 2: Extract Files
1. Extract the downloaded archive
2. You will find **two folders**:
* `tw-diving` - Main script
* `Liftbag-model` - Stream assets (diving island, underwater props, boat)
3. Place **both folders** in your server's `resources` directory
```
resources/
โโโ [standalone]/
โโโ [qb]/
โโโ tw-diving/ โ Main script
โ โโโ config/
โ โ โโโ config.lua
โ โ โโโ coordinate.lua
โ โ โโโ GetCore.lua
โ โโโ client/
โ โโโ server/
โ โโโ locales/
โ โโโ html/
โ โโโ fxmanifest.lua
โโโ Liftbag-model/ โ Stream assets (REQUIRED)
โโโ stream/
โ โโโ *.ydr
โ โโโ *.yft
โ โโโ *.ytd
โ โโโ ...
โโโ fxmanifest.lua
```
{% hint style="danger" %}
**Important:** The stream folder contains the diving island map, underwater coral props, treasure boxes, and boat models. Without it, the job location and underwater elements won't appear!
{% endhint %}
***
## Step 3: Database Setup
{% hint style="success" %}
**Automatic Setup:** The script automatically creates the required database tables when it starts for the first time. No manual SQL import needed!
{% endhint %}
***
## Step 4: Configure the Script
Open `config/config.lua` and set your framework:
```lua
-- Framework Selection
Config.Framework = 'qb' -- Options: 'qb', 'oldqb', 'esx', 'oldesx', 'vrp', 'vrp2', 'standalone'
-- Database Resource
Config.SQL = "oxmysql" -- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
-- Inventory System
Config.Inventory = "qb_inventory" -- Options: 'qb_inventory', 'esx_inventory', 'ox_inventory', 'qs_inventory'
-- Interaction System
Config.InteractionHandler = 'drawtext' -- Options: 'drawtext', 'ox-target'
```
{% hint style="info" %}
**QBox Users:** Set `Config.Framework = 'qb'` - QBox is fully compatible with the 'qb' setting.
{% endhint %}
See the [Configuration](/scripts/diving-job/configuration) page for all available options.
***
## Step 5: Add to server.cfg
Add the following to your `server.cfg`:
```cfg
# Dependencies (must start before tw-diving)
ensure oxmysql # or mysql-async
ensure es_extended # or qb-core (your framework)
ensure PolyZone
# Tworst Scripts - Stream files must be loaded!
ensure Liftbag-model
ensure tw-diving
```
{% hint style="warning" %}
**Load Order:**
* Dependencies must start **before** the script
* Stream resource (`Liftbag-model`) must be started **before or with** the main script
{% endhint %}
***
## Step 6: Restart Server
1. Save all configuration changes
2. Restart your server completely
3. Check the server console for any errors
***
## Verification
After starting the server, verify the installation:
### Check Console
Look for these messages in your server console:
* Database tables created successfully (first run only)
* No error messages related to tw-diving
### In-Game Test
1. Go to the diving job location
2. Look for the job blip on the map
3. Interact with the NPC to open the job menu
4. Purchase diving equipment
5. Take a boat and test diving mechanics
***
## Troubleshooting
### Script Won't Start
1. Check resource name matches exactly (case-sensitive on Linux)
2. Verify all dependencies are started before the script
3. Check for syntax errors in config files
### Missing Props / Island Not Loading
1. Make sure the stream folder is in your resources folder
2. Verify it's started in your `server.cfg`
3. Check the server console for streaming errors
4. The diving island should be visible when you approach the area
### Database Errors
1. Verify database connection string in `server.cfg`
2. Check that your database resource is starting properly
3. Ensure `Config.SQL` matches your database resource
### Framework Not Detected
1. Make sure `Config.Framework` matches your framework
2. Verify framework resource is starting before tw-diving
3. Check framework resource name matches expected names
***
## Need Help?
{% hint style="info" %}
Having installation issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Server console errors
* Your `Config.Framework` and `Config.SQL` settings
* Screenshots of any issues
{% endhint %}
# Configuration
{% hint style="info" %}
Configuration guide will be added soon.
{% endhint %}
# Changelog
Version history and updates for the Multiplayer Diving Job.
***
## Current Version: 1.6.8
{% hint style="success" %}
You are using the latest version of Multiplayer Diving Job.
{% endhint %}
***
## Update Instructions
### Automatic Updates
Scripts purchased through Cfx.re automatically receive updates:
1. Go to [portal.cfx.re](https://portal.cfx.re)
2. Navigate to **Granted Assets**
3. Find **tw-diving**
4. Click **Download** to get the latest version
### Manual Update Process
1. **Backup your current files**
* Save your `config/config.lua`
* Save your `config/coordinate.lua` (if modified)
2. **Download the new version**
3. **Extract and replace files**
* Replace all files except your config files
* Or compare and merge changes carefully
4. **Check for new config options**
* Compare your config with the new default
* Add any new settings that were added
5. **Restart your server**
{% hint style="warning" %}
**Important:** Always backup your configuration files before updating! New versions may add new config options that need to be added to your existing config.
{% endhint %}
***
## Reporting Issues
Found a bug or have a suggestion?
{% hint style="info" %}
Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Current script version
* Detailed description of the issue
* Steps to reproduce
* Server console errors (if any)
* Screenshots or videos (if applicable)
{% endhint %}
# v1.6.8
**Changes:**
* Switched to ox\_inventory with multi-framework support
* Added coral items (Antipatharia & Dendrogyra) with images
* Fixed gear cleanup on job restart โ entities now properly detach & delete
* Updated vehicle key system priority (qbx-vehiclekeys first)
* Improved usable item registration for qs-inventory
* Code formatting & consistency improvements
**Changed Files:**
`client/main.lua` โข `server/editable.lua` โข `config/config.lua` โข `fxmanifest.lua`
**New Files:**
`ITEM-IMG/antipatharia_coral.png` โข `ITEM-IMG/dendrogyra_coral.png` โข `ox-item.txt` โข `qb-item.txt`
# v1.6.7
**Changes:**
* Fixed `/deletegear` command not properly removing scuba tank and mask from world โ replaced with force detach implementation
* Added entity existence checks (DoesEntityExist) before deletion to prevent null reference errors
* Enhanced scuba gear cleanup with sequential deletion and wait intervals for reliable entity removal across all players
* Fixed number formatting displaying incorrect values for large amounts by adding Math.round() rounding
* Improved oxygen system stability with proper tank cleanup on oxygen depletion
* Added success notification when scuba gear is removed
* Fixed UI responsive issues across different screen resolutions
**Changed Files:**
`client/main.lua` โข `html/js/app.js` โข `html/main.css`
# v1.6.6
Initial documented release.
# Multiplayer Transport Job
## Overview
**TW Transport Job** is a comprehensive multiplayer logistics and transport system where players work as delivery drivers. Load cargo with forklifts, transport goods with trucks and trailers, and deliver to various locations across the city. Includes legal and illegal delivery missions with police integration.
{% hint style="success" %}
**Multiplayer Support:** Up to 4 players can work together in a lobby, sharing tasks and rewards!
{% endhint %}
***
## Features
### Core Features
* **Multiplayer Lobby System** - Work with up to 4 players in cooperative gameplay
* **Truck & Trailer System** - Drive transport trucks with attachable trailers
* **Forklift Operations** - Load and unload cargo using forklifts
* **Box Loading** - Load boxes onto trailers at warehouses
* **Delivery System** - Transport and deliver goods to destinations
* **Furniture Delivery** - Unpack and deliver furniture items
### Additional Features
* **Level & XP System** - Progress through 70 levels with increasing rewards
* **4 Work Regions** - Progressive difficulty including illegal missions
* **Police Alert System** - Risk of police encounters on illegal missions
* **Police Search Mechanic** - Officers can search your cargo
* **Forklift Attachment** - Attach forklifts to trucks for transport
* **Tutorial System** - 6 in-game video tutorials for new players
* **Multi-language Support** - 7 languages included (EN, TR, DE, FR, PT, RU, AR)
***
## How It Works
### Step 1: Start a Lobby
Go to the transport job NPC and open the job menu. Create a lobby and invite other players (optional).
### Step 2: Get Your Vehicles
Rent a transport truck with trailer and a forklift for loading operations.
### Step 3: Complete Tasks
Travel to marked locations and complete various transport tasks:
1. **Box Loading** - Use forklift to load boxes onto trailer (2-8 boxes)
2. **Truck Delivery** - Drive truck to delivery location
3. **Box Opening** - Open boxes at destination
4. **Furniture Delivery** - Deliver items to final locations
### Step 4: Watch for Police (Illegal Missions)
On Region 4 illegal missions, police may be alerted:
* 75% chance of police alert
* Officers may search your cargo
* 65% chance of finding illegal items
### Step 5: Collect Rewards
Complete all tasks in a region to earn money, XP, and unlock higher-level regions.
***
## Requirements
| Resource | Required | Notes |
| --------- | -------- | --------------------------------------------------- |
| Framework | Yes | QBCore, QBox, ESX, vRP, or Standalone |
| Database | Yes | oxmysql (recommended), mysql-async, or ghmattimysql |
| PolyZone | Yes | Required for all Tworst Scripts |
### Optional Dependencies
| Resource | Purpose |
| ---------------------- | --------------------------------- |
| qb-target / ox\_target | Target interaction system |
| Vehicle Keys Script | Automatic vehicle key integration |
| Clothing Script | Job uniform system |
| Police Dispatch | Alert system integration |
***
## Supported Systems
### Frameworks
| Framework | Config Value |
| ---------- | ------------------ |
| QBCore | `'qb'` |
| QBox | `'qb'` |
| ESX Legacy | `'esx'` |
| vRP / vRP2 | `'vrp'` / `'vrp2'` |
| Standalone | `'standalone'` |
### Inventory Systems
| System | Config Value |
| ---------------- | ----------------- |
| QBCore Inventory | `'qb_inventory'` |
| ESX Inventory | `'esx_inventory'` |
| ox\_inventory | `'ox_inventory'` |
| qs-inventory | `'qs_inventory'` |
### Vehicle Key Systems (Auto-detected)
* qb-vehiclekeys
* qbx-vehiclekeys
* qs-vehiclekeys
* wasabi-carlock
* cd\_garage
* Renewed-Vehiclekeys
### Fuel Systems (Auto-detected)
* LegacyFuel
* ox\_fuel
* cdn-fuel
* ps-fuel
* x-fuel
### Police Dispatch Systems
* ps-dispatch
* ls-dispatch
* fl-dispatch
* bixbi\_dispatch
* cd\_dispatch
* linden\_outlawalert
***
## Commands
| Command | Description |
| ------------------------ | ----------------------- |
| `/jobresettransport` | Reset your current job |
| `/jobleavetransport` | Leave the current lobby |
| `/openTutorialtransport` | Open the tutorial menu |
***
## Rewards by Region
| Region | Level | Type | Money | XP |
| -------- | ----- | ------- | ------- | ------ |
| Region 1 | 0 | Legal | $5,000 | 1,000 |
| Region 2 | 2 | Legal | $10,000 | 3,000 |
| Region 3 | 4 | Legal | $15,000 | 5,000 |
| Region 4 | 6 | Illegal | $25,000 | 10,000 |
***
## Daily Missions
| Task | Requirement | XP | Money |
| ------ | --------------------------------- | ----- | ------ |
| Task 1 | Complete 50 transport tasks | 2,500 | $1,000 |
| Task 2 | Complete 10 missions | 1,000 | $3,000 |
| Task 3 | Earn $10,000 | 2,000 | $3,000 |
| Task 4 | Complete 20 missions with friends | 2,000 | $3,000 |
***
## Police System
### Alert Settings
* **Alert Chance:** 75% on illegal missions
* **Cooldown:** 2 minutes between alerts
### Alert Types
| Type | Code | Priority |
| ------------------- | ----- | -------- |
| Suspicious Activity | 10-66 | 2 |
| Illegal Transport | 10-71 | 3 |
| Speeding Vehicle | 10-11 | 1 |
### Search Mechanic
* Search time: 8 seconds
* Illegal items chance: 65%
* Search distance: 4.0 units
***
## Quick Links
***
## Purchase
{% hint style="info" %}
Purchase Lite Jobs Pack from our [Tebex Store](https://tworst.tebex.io) or [CFX Store](https://tworst.com).
{% endhint %}
# Installation
Step-by-step guide to install the Lite Jobs Pack on your FiveM server.
***
## Prerequisites
Before installing, make sure you have:
| Requirement | Description |
| --------------------- | --------------------------------------------------- |
| **Framework** | QBCore, QBox, ESX, vRP, or Standalone |
| **Database Resource** | oxmysql (recommended), mysql-async, or ghmattimysql |
| **FiveM Server** | Build 2802 or higher recommended |
***
## Step 1: Download the Script
### From Cfx.re Portal (Recommended)
1. Go to [portal.cfx.re](https://portal.cfx.re)
2. Navigate to **Granted Assets**
3. Find **tw-litejobpack** in your purchased scripts
4. Click **Download** to get the latest version
### From Tebex
1. Log in to your Tebex account
2. Go to your purchases
3. Download the script package
***
## Step 2: Extract Files
1. Extract the downloaded archive
2. You will find **three folders**:
* `tw-litejobpack` - Main script (23 jobs, UI, configs)
* `tw-litejobpack-stream` - Stream assets (custom props, tools, weapons, vehicles)
* `tw-litejobpack-map` - Map assets (warehouse interior and crate models)
3. Place **all three folders** in your server's `resources` directory
```
resources/
โโโ [standalone]/
โโโ [qb]/
โโโ tw-litejobpack/ โ Main script
โ โโโ shared/
โ โ โโโ config.lua โ Main configuration
โ โ โโโ jobs/ โ 23 job definition files
โ โโโ client/
โ โโโ server/
โ โโโ locales/
โ โโโ html/
โ โโโ img/
โ โโโ fxmanifest.lua
โโโ tw-litejobpack-stream/ โ Stream assets (REQUIRED)
โ โโโ metas/
โ โ โโโ powerwash/ โ Pressure washer weapon meta
โ โ โโโ utillitruck/ โ Utility truck vehicle meta
โ โโโ stream/
โ โ โโโ baskul/ โ Processing scale props
โ โ โโโ cuttree/ โ Tree cutting props
โ โ โโโ plumber/ โ Plumber pipes & toilet props
โ โ โโโ powerwash/ โ Pressure washer weapon model
โ โ โโโ tool/ โ Pickaxes, axes, ores, crops (29 props)
โ โ โโโ utillitruck/ โ Utility truck model
โ โโโ fxmanifest.lua
โโโ tw-litejobpack-map/ โ Map assets (REQUIRED)
โโโ stream/
โ โโโ yusufwarehouse.ymap โ Warehouse interior map
โ โโโ *.ydr, *.yft, *.ytd โ Warehouse & crate models
โโโ fxmanifest.lua
```
{% hint style="danger" %}
**Important:** Both asset folders are required! The **stream** folder contains custom props (ores, tools, crops, vehicles, weapons) and the **map** folder contains the warehouse interior used by the Warehouse and Forklift jobs. Without them, many jobs will not function correctly!
{% endhint %}
***
## Step 3: Database Setup
{% hint style="success" %}
**Automatic Setup:** The script automatically creates the required database tables when it starts for the first time. No manual SQL import needed!
{% endhint %}
The following tables are created automatically:
* Player job progress & XP/levels
* Statistics & leaderboard data
* Achievement tracking
* Session management
***
## Step 4: Configure the Script
Open `shared/config.lua` and set your framework:
```lua
-- Framework Selection
Config.Framework = "qb" -- Options: 'qb', 'esx', 'vrp', 'vrp2', 'standalone'
-- Database Resource
Config.SQL = "oxmysql" -- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
-- Inventory System
Config.Inventory = "qb_inventory" -- Options: 'qb_inventory', 'esx_inventory', 'ox_inventory', 'qs_inventory'
-- Language
Config.Locale = "en" -- Options: 'en', 'tr', 'de', 'fr', 'pt', 'ru', 'es', 'nl'
```
{% hint style="info" %}
**QBox Users:** Set `Config.Framework = 'qb'` - QBox is fully compatible with the 'qb' setting.
{% endhint %}
See the [Configuration](/scripts/lite-jobs-pack/configuration) page for all available options.
***
## Step 5: Add Items & Weapons
Several jobs require inventory items or weapon definitions to be added to your framework.
### Newspaper Job โ WEAPON\_ACIDPACKAGE (Required)
{% hint style="danger" %}
**Critical:** The Newspaper Delivery job uses `WEAPON_ACIDPACKAGE` to throw newspapers. This weapon is **not** included in GTA V by default. You **must** define it in your framework, or the Newspaper job will not work!
{% endhint %}
**QB-Core** โ Add to `qb-core/shared/weapons.lua`:
```lua
['weapon_acidpackage'] = {
['name'] = 'weapon_acidpackage',
['label'] = 'News Paper',
['weight'] = 1000,
['type'] = 'weapon',
['ammotype'] = 'ammo-acid',
['image'] = 'weapon_acidpackage.png',
['unique'] = true,
['useable'] = true,
['description'] = 'News paper'
},
```
**ox\_inventory** โ Add to `ox_inventory/data/weapons.lua`:
```lua
['WEAPON_ACIDPACKAGE'] = {
label = 'Newspaper',
weight = 0,
throwable = true
},
```
**ESX** โ Add the weapon definition to your ESX weapons configuration.
{% hint style="info" %}
This weapon is given via native `GiveWeaponToPed`, not through inventory. However, your framework still needs to recognize it.
{% endhint %}
### Pressure Washer & Car Detailer โ WEAPON\_PRESSURE1 (ox\_inventory Users)
If you are using **ox\_inventory**, the Pressure Washer and Car Detailer jobs use `WEAPON_PRESSURE1` as a work tool. This weapon is given natively (not through inventory), but ox\_inventory's weapon mismatch system will detect it as unauthorized and remove it from the player.
To prevent this, you need to add `WEAPON_PRESSURE1` to the ignore list.
**Step 1** โ Add to `ox_inventory/data/weapons.lua`:
```lua
['WEAPON_PRESSURE1'] = {
label = 'Pressure Washer',
weight = 0,
},
```
**Step 2** โ Add to ignoreweapons in `ox.cfg`:
File: Your server's `ox.cfg` (usually located in your server root or txData base folder)
Find the line:
```
setr inventory:ignoreweapons []
```
Change it to:
```
setr inventory:ignoreweapons ["WEAPON_PRESSURE1"]
```
If you already have other weapons in the list, add it with a comma:
```
setr inventory:ignoreweapons ["WEAPON_HANDCUFFS", "WEAPON_PRESSURE1"]
```
{% hint style="info" %}
This setting tells ox\_inventory to skip the weapon mismatch check for `WEAPON_PRESSURE1`. Without this, ox\_inventory will repeatedly strip the pressure washer from the player's hands during the job.
{% endhint %}
{% hint style="info" %}
**Why is this different from the Newspaper job?**
The Newspaper job (`WEAPON_ACIDPACKAGE`) is a throwable weapon โ each throw consumes one item from inventory, so it must be managed through ox\_inventory's item system with `throwable = true`.
The Pressure Washer (`WEAPON_PRESSURE1`) is a held tool โ it stays in the player's hands during work and is removed when the tool is returned to the trunk. It does not need to exist in the inventory, only to be ignored by the mismatch system.
{% endhint %}
### Fishing Items (18 items)
**Fish (9 types):**
| Item Name | Label |
| ---------------- | --------- |
| `fish_anchovy` | Anchovy |
| `fish_trout` | Trout |
| `fish_mackerel` | Mackerel |
| `fish_salmon` | Salmon |
| `fish_snapper` | Snapper |
| `fish_tuna` | Tuna |
| `fish_grouper` | Grouper |
| `fish_swordfish` | Swordfish |
| `fish_shark` | Shark |
**Fishing Rods (3 types):**
| Item Name | Label |
| ------------- | ------------ |
| `standartrod` | Standard Rod |
| `carbonrod` | Carbon Rod |
| `prorod` | Pro Rod |
**Baits (6 types):**
| Item Name | Label |
| ------------ | ---------------- |
| `basicbait` | Basic Bait |
| `spoonlure` | Spoon Lure |
| `threesided` | Three-Sided Lure |
| `tailfish` | Tail Fish Lure |
| `doublehook` | Double Hook |
| `triplehook` | Triple Hook |
### Diving Items (2 items)
| Item Name | Label |
| -------------------- | ------------ |
| `dendrogyra_coral` | Pillar Coral |
| `antipatharia_coral` | Black Coral |
{% hint style="warning" %}
**Note:** Refer to the `ITEMS.md` file included with the script for ready-to-copy item definitions for your framework.
{% endhint %}
***
## Step 6: Add to server.cfg
Add the following to your `server.cfg`:
```cfg
# Dependencies (must start before tw-litejobpack)
ensure oxmysql # or mysql-async
ensure es_extended # or qb-core (your framework)
# ensure ox_lib # optional
# Tworst Scripts - Asset files must be loaded first!
ensure tw-litejobpack-map
ensure tw-litejobpack-stream
ensure tw-litejobpack
```
{% hint style="warning" %}
**Load Order:**
* Dependencies must start **before** the script
* Map resource (`tw-litejobpack-map`) and stream resource (`tw-litejobpack-stream`) must be started **before** the main script
{% endhint %}
***
## Step 7: Restart Server
1. Save all configuration changes
2. Restart your server completely
3. Check the server console for any errors
***
## Verification
After starting the server, verify the installation:
### Check Console
Look for these messages in your server console:
* Database tables created successfully (first run only)
* No error messages related to tw-litejobpack
### In-Game Test
1. Open the map and look for job blips
2. Go to any job NPC location
3. Interact with the NPC to open the job menu
4. Select a job, create a lobby, and test the gameplay
5. Verify XP and payment are working correctly
***
## Troubleshooting
### Script Won't Start
1. Check resource name matches exactly (case-sensitive on Linux)
2. Verify all dependencies are started before the script
3. Check for syntax errors in config files
### Missing Props / Custom Models Not Loading
1. Make sure both `tw-litejobpack-stream` and `tw-litejobpack-map` are in your resources folder
2. Verify they are started in your `server.cfg` before the main script
3. Check the server console for streaming errors
### Warehouse / Forklift Jobs Not Working
1. Make sure `tw-litejobpack-map` resource is started โ it contains the warehouse interior
2. Verify the map resource loads without errors in the server console
3. The warehouse map includes custom crate models required for the Forklift and Warehouse jobs
### Items Not Found (Fishing/Diving)
1. Ensure you've added all required items to your framework
2. Check item names match exactly (case-sensitive)
3. Refer to the `ITEMS.md` file for correct item definitions
### Database Errors
1. Verify database connection string in `server.cfg`
2. Check that your database resource is starting properly
3. Ensure `Config.SQL` matches your database resource
### Changing Station Door Not Visible
If the door at the changing station is invisible, add the following to your `server.cfg`:
```
setr game_enableDynamicDoorCreation true
```
This enables dynamic door creation in FiveM, which is required for the changing station door to render properly.
### Framework Not Detected
1. Make sure `Config.Framework` matches your framework
2. Verify framework resource is starting before tw-litejobpack
3. Check framework resource name matches expected names
***
## Need Help?
{% hint style="info" %}
Having installation issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket with:
* Server console errors
* Your `Config.Framework` and `Config.SQL` settings
* Screenshots of any issues
{% endhint %}
# Configuration
Complete configuration reference for the Lite Jobs Pack.
***
## Configuration Files
The script uses configuration files located in the `shared/` folder:
| File | Purpose |
| --------------------- | -------------------------------------------------- |
| `shared/config.lua` | Main configuration (framework, features, systems) |
| `shared/jobs/*.lua` | Individual job settings (NPC, payment, XP, routes) |
| `server/editable.lua` | Discord webhook settings |
***
## Basic Settings
### Framework & Core
```lua
-- Framework Selection
-- Options: 'qb', 'esx', 'vrp', 'vrp2', 'standalone'
Config.Framework = "qb"
-- Database Resource
-- Options: 'oxmysql', 'mysql-async', 'ghmattimysql'
Config.SQL = "oxmysql"
-- Inventory System
-- Options: 'qb_inventory', 'esx_inventory', 'ox_inventory', 'qs_inventory'
Config.Inventory = "qb_inventory"
-- Language (Available: 'en', 'tr', 'de', 'fr', 'pt', 'ru', 'es', 'nl')
Config.Locale = "en"
-- Currency Display Symbol
Config.CurrencySymbol = "$"
-- Event Prefix (used for internal events)
Config.EventPrefix = "tw-litejobpack"
```
{% hint style="info" %}
**QBox Users:** QBox is fully compatible. Set `Config.Framework = 'qb'` for QBox servers.
{% endhint %}
***
## Debug Settings
```lua
-- Development Mode (enables extra logging)
Config.DevMode = false
-- Debug Mode (shows console messages)
Config.Debug = false
-- Test Mode (enables test commands)
Config.Test = false
```
{% hint style="warning" %}
**Production Servers:** Always set `Config.DevMode`, `Config.Debug`, and `Config.Test` to `false` for better performance!
{% endhint %}
***
## Lobby Settings
```lua
Config.Lobby = {
maxPlayers = 3, -- Maximum players per lobby (1-3)
inviteRadius = 8.0, -- Radius to detect nearby players for invite
inviteTimeout = 30, -- Seconds before invite expires
kickCooldown = 5, -- Cooldown between kicks (seconds)
inviteCooldown = 10, -- Cooldown between invites (seconds)
}
```
***
## Target System
```lua
Config.TargetSystem = {
enabled = false, -- Enable/disable target interaction
resource = "auto", -- "auto", "ox_target", "qb-target"
icon = "fas fa-briefcase", -- Icon for job interactions
jobCenterIcon = "fas fa-building", -- Icon for job center NPC
}
```
***
## NPC Camera
```lua
Config.NPCCamera = {
enabled = true, -- Enable camera zoom on NPC interaction
hidePlayer = true, -- Hide player model during camera
distance = 2.3, -- Camera distance from NPC
sideOffset = 0.0, -- Horizontal offset
height = 0.3, -- Camera height offset
fov = 25.0, -- Field of view
pitch = 5.0, -- Camera pitch angle
transitionMs = 500, -- Transition duration in milliseconds
}
```
***
## Feature Toggles
### Quality System
Adds tiered loot quality with level-based bonuses.
```lua
Config.QualitySystem = {
enabled = false,
levelChanceBonus = 0.5, -- Bonus chance per level
levelPayBonus = 0.02, -- Bonus pay multiplier per level
defaultTiers = {
{ name = "Common", chance = 55, multiplier = 1.0 },
{ name = "Uncommon", chance = 25, multiplier = 1.3 },
{ name = "Rare", chance = 13, multiplier = 1.8 },
{ name = "Legendary", chance = 7, multiplier = 2.5 },
},
}
```
### Dynamic Economy
Supply and demand system that adjusts item prices automatically.
```lua
Config.Economy = {
enabled = false,
recoveryInterval = 10, -- Stock recovery interval (minutes)
MinMultiplier = 0.5, -- Minimum price multiplier
MaxMultiplier = 2.0, -- Maximum price multiplier
BaseStocks = {
['coal_ore'] = 2000,
['iron_ore'] = 1000,
['gold_ore'] = 500,
['emerald_ore'] = 300,
['diamond_ore'] = 200,
['wood_log'] = 1500,
['metal_scrap'] = 2000,
['meat'] = 3000,
-- ... more items
}
}
```
### Global Events
Server-wide special events with collective goals and rewards.
```lua
Config.GlobalEvents = {
enabled = false,
events = {
{
id = "clean_city",
jobId = "cleanup",
title = "City Cleanup Initiative",
description = "The mayor has ordered a city-wide cleanup!",
target = 500,
reward = { money = 5000, xp = 1000 }
},
}
}
```
### Job Cooldown
Prevents players from spamming jobs.
```lua
Config.JobCooldown = {
enabled = false,
mode = "perJob", -- "perJob" or "global"
duration = 120, -- Cooldown in seconds
}
```
### Coop Payment
Configure team payment bonuses.
```lua
Config.CoopPayment = {
enabled = false,
mode = "full", -- "full" (everyone gets full pay) or "split"
bonus = 1.2, -- 1.2x bonus for coop play
}
```
### Daily Bonus
Random daily bonus jobs with increased pay.
```lua
Config.DailyBonus = {
enabled = false,
bonusJobCount = { min = 1, max = 3 }, -- Number of bonus jobs per day
bonusRange = { min = 1.25, max = 1.50 }, -- Pay multiplier range
excludeJobs = {}, -- Job IDs to exclude
}
```
### Coop Leaderboard
Team-based rankings visible in the UI.
```lua
Config.CoopLeaderboard = {
enabled = true,
broadcastInterval = 5000, -- Update interval in milliseconds
}
```
### Weather Impact
Adjust job payments based on in-game weather.
```lua
Config.WeatherImpact = {
enabled = false,
reportInterval = 60000, -- Weather check interval (ms)
rules = {
RAIN = { default = 1.0, cleaner = 0.85, farmer = 1.20, landscaping = 1.20 },
THUNDER = { default = 1.0, miner = 1.15, lumberjack = 1.15, scrapyard = 1.15 },
FOGGY = { default = 1.0, delivery = 1.15, trucker = 1.15, newspaper = 1.15 },
SNOW = { default = 1.0, powerlines = 1.20, fishing = 0.80, diving = 0.80 },
CLEAR = {},
EXTRASUNNY = { default = 1.0, farmer = 1.10, fruitpicker = 1.10 },
},
}
```
### Shift System
Time-based payment multipliers.
```lua
Config.ShiftSystem = {
enabled = false,
shifts = {
morning = { label = "Morning Shift", hours = { 6, 12 }, rules = { default = 0.90 } },
afternoon = { label = "Afternoon Shift", hours = { 12, 18 }, rules = { default = 1.00 } },
evening = { label = "Evening Shift", hours = { 18, 24 }, rules = { default = 1.15 } },
night = { label = "Night Shift", hours = { 0, 6 }, rules = { default = 1.30, diving = 0.80 } },
},
}
```
### Referral Bonus
Reward players for inviting others to jobs.
```lua
Config.ReferralBonus = {
enabled = false,
xpReward = 150, -- XP reward for referral
maxBonusesPerDay = 5, -- Daily limit
}
```
### Achievements
Track player milestones with Discord webhook support.
```lua
Config.Achievements = {
enabled = true,
discordWebhook = true,
list = {
{ id = "miner_lv5", label = "Master Miner", jobId = "miner", type = "level", target = 5, xpReward = 500 },
{ id = "miner_lv10", label = "Mining Legend", jobId = "miner", type = "level", target = 10, xpReward = 2000 },
{ id = "fishing_lv5", label = "Expert Angler", jobId = "fishing", type = "level", target = 5, xpReward = 500 },
{ id = "trucker_lv5", label = "Road King", jobId = "trucker", type = "level", target = 5, xpReward = 500 },
-- ... more achievements for each job
}
}
```
***
## UI Positioning
Customize UI element positions. Players can also drag panels in-game.
```lua
Config.DefaultUIPositionsVersion = 2
Config.DefaultUIPositions = {
jobProgressPanel = { bottom = '12.00vh', right = '1.00vw', locked = false },
coopLeaderboardPanel = { top = '12.00vh', right = '1.00vw', locked = false },
drawTextContainer = { top = '47.65vh', right = '1.80vw', locked = false },
actionProgressContainer = { bottom = '18.00vh', left = '48.54vw', locked = false },
finishJobModal = { top = '35.00vh', right = '8.00vw', locked = false },
}
```
* `locked = true` โ Panel stays at the configured position, player cannot move it
* `locked = false` โ Player can drag and save a custom position
* Increment `DefaultUIPositionsVersion` when changing positions to reset player overrides
{% hint style="info" %}
Players can adjust UI positions in-game through the settings menu!
{% endhint %}
***
## Disabling / Enabling Individual Jobs
Each job can be toggled on or off in its own config file (`shared/jobs/.lua`):
```lua
enabled = true, -- Set to false to disable this job completely
```
When disabled:
* The job NPC will **not** spawn
* The job blip will **not** appear on the map
* Players **cannot** start the job
{% hint style="info" %}
You can also disable/enable jobs at runtime through the Admin Panel's Job Editor without restarting the server.
{% endhint %}
***
## Miscellaneous Settings
```lua
-- Prevent entering vehicles while holding a job tool
Config.PreventVehicleWithTool = true
-- Force first-person view during break sessions
Config.BreakSessionFirstPerson = false
-- Require a specific job to access the pack
Config.RequireSelectedJob = false
Config.RealJob = 'none'
```
***
## Admin Panel
The Lite Jobs Pack includes a powerful admin panel for managing jobs, players, and the economy at runtime.
### Access Configuration
```lua
Config.AdminPanel = {
acePermission = "admin", -- ACE permission required
identifierWhitelist = { -- Or whitelist specific identifiers
-- "steam:xxxxxxxxxxxxx",
},
}
```
Access the admin panel with the `/jobadmin` command (configurable).
### Dashboard
The admin dashboard provides real-time statistics:
* **Economy Overview** โ Total money and XP earned (today, this week, all-time)
* **Job Breakdown** โ Revenue and unique player counts per job
* **Active Lobbies** โ Current coop sessions with player lists
* **Market Prices** โ Live supply/demand multipliers for all items
* **Online Players** โ Current player count
### Player Management
* **Search Players** โ Find by name or identifier (online and offline)
* **Player Statistics** โ View job levels, total XP, recent job history (last 20 jobs)
* **Set Player Level** โ Manually adjust a player's job level (1 to max)
* **Set Perk Points** โ Adjust a player's perk point balance
### Economy Management
* **View Pay Rates** โ See payment modes, item prices, quality tiers for every job
* **Set Market Multipliers** โ Adjust supply/demand pricing per item
* **Reset Market** โ Reset individual items or all market prices to base values
* **Save Economy Config** โ Persist changes directly to job config files
{% hint style="info" %}
Economy changes are validated before saving โ values must be within 0-100,000 range and quality tier chances must sum to 100%.
{% endhint %}
### Job Editor (Runtime)
Admins can edit job configurations at runtime without server restart:
* **NPC Settings** โ Model, scenario, coordinates, interaction distance, blip label
* **Vehicle Settings** โ Model, plate, colors, spawn locations
* **Location Coordinates** โ Processing station, work clothes, finish area
* **Spawn Points** โ Rock spawns, tree spawns, area spots
* **Job State** โ Enable/disable individual jobs
{% hint style="warning" %}
The Job Editor requires `Config.DevMode = true` or admin permission. Changes are saved directly to the job config files.
{% endhint %}
### Discord Logging
Configure Discord webhooks for admin action logging in `server/editable.lua`:
```lua
DiscordLogConfig = {
enabled = true,
botName = "tw-litejobpack",
botToken = "", -- Your Discord bot token
webhooks = {
jobFinish = "", -- Webhook for job completions
jobLog = "", -- Webhook for admin actions
achievement = "", -- Webhook for achievements
},
}
```
***
## Individual Job Configuration
Each job has its own configuration file in `shared/jobs/`. Every job file follows a consistent structure:
### Job Metadata
```lua
{
id = "miner",
name = "Miner",
subtitle = "Underground Mining Operations",
enabled = true, -- Toggle job on/off
icon = "./img/jobs/miner_icon.svg",
image = "./img/jobs/miner_bg.png",
video = "https://...", -- Promotional video URL
}
```
### NPC Configuration
```lua
npc = {
enabled = true,
coords = vector4(2944.13, 2743.39, 43.3, 349.75),
model = "s_m_y_construct_02",
scenario = "WORLD_HUMAN_CLIPBOARD",
interaction = {
distance = 2.0,
key = 38,
keyLabel = "[E]",
text = "Start Mining Job",
},
blip = {
enabled = true,
sprite = 618,
color = 28,
scale = 0.8,
label = "Mining Job",
},
}
```
### Payment Modes
Jobs use one of four payment modes:
| Mode | Description | Example Jobs |
| ------------ | ---------------------------------------------- | ------------------------- |
| `"onJobEnd"` | Pay on job completion based on items collected | Miner, Farmer, Scrapyard |
| `"distance"` | Pay based on distance traveled | Trucker, Taxi, Dog Walker |
| `"custom"` | Custom payment logic per action | Fishing, Powerlines |
| Per-item | Pay per individual task completed | Cleaner, Delivery |
```lua
-- Example: On Job End (Miner)
payment = {
mode = "onJobEnd",
completionBonus = 0,
coopMode = "full",
}
-- Example: Distance-based (Trucker)
payment = {
mode = "distance",
perHundredMeters = 10,
illegalMultiplier = 2.0,
maxDamageDeduction = 0.5,
coopMode = "full",
}
-- Example: Custom (Fishing)
payment = {
mode = "custom",
deliveryBonus = 150,
completionBonus = 0,
coopMode = "full",
}
```
### XP Rewards
```lua
xprewards = {
oreExtracted = 25, -- XP per ore extracted
jobCompleted = 500, -- XP on job completion
}
```
### Vehicle Configuration
```lua
runtime = {
vehicle = {
model = "bison",
plate = "MINER",
fuelOnSpawn = 100.0,
color = { primary = 6, secondary = 0 },
spawnLocations = {
vector4(2952.47, 2748.95, 43.50, 278.43),
vector4(2953.36, 2743.02, 43.50, 278.43),
},
trunkDoors = { 5 },
toolPositions = { ... },
cargoPositions = { ... },
},
}
```
### Quality Tiers (Per-Job Override)
Individual jobs can override the global quality system:
```lua
qualityTiers = {
{ name = "Common", chance = 55, multiplier = 1.0 },
{ name = "Uncommon", chance = 25, multiplier = 1.3 },
{ name = "Rare", chance = 13, multiplier = 1.8 },
{ name = "Legendary", chance = 7, multiplier = 2.5 },
},
levelPayBonus = 0.02, -- +2% pay per level
levelChanceBonus = 0.5, -- Better tier chance per level
```
### Clothes (Work Uniform)
```lua
clothes = {
male = {
tshirt_1 = 59, tshirt_2 = 1,
torso_1 = 38, torso_2 = 0,
pants_1 = 40, pants_2 = 0,
shoes_1 = 24, shoes_2 = 0,
-- ... more components
},
female = { ... },
}
```
### Preview System
Each job has a multi-step preview with camera angles:
```lua
preview = {
playerPosition = vector3(x, y, z),
steps = {
{
title = "Welcome to Mining",
description = { "Step description line 1", "Line 2" },
camCoord = vector3(x, y, z),
camTarget = vector3(x, y, z),
entities = { ... },
},
-- ... more steps
},
}
```
***
## Need Help?
{% hint style="info" %}
Having configuration issues? Join our [Discord server](https://discord.gg/tworst) and open a support ticket.
{% endhint %}
# Jobs Guide
Detailed guide for all 23 jobs included in the Lite Jobs Pack. Each job has unique mechanics, payment systems, and progression.
***
## Disabling / Enabling Jobs
You can enable or disable any individual job by editing its config file in `shared/jobs/.lua`:
```lua
enabled = true, -- Set to false to disable this job
```
When a job is disabled, its NPC and blip will not appear on the map and players cannot start it.
***
## Reward Items (All Jobs)
Every job can optionally give bonus items upon mission completion. This feature is configurable per-job in the `missioncompletedItems` section:
```lua
missioncompletedItems = {
giveItemPlayer = false, -- Set to true to enable reward items
dropMode = "weightedPool",
itemList = {
{ item = "sandwich", count = 1, chance = 50 },
{ item = "water_bottle", count = 1, chance = 30 },
},
}
```
| Item | Default Chance |
| -------------- | -------------- |
| `sandwich` | 50% |
| `water_bottle` | 30% |
| No item | 20% |
{% hint style="info" %}
Reward items are **disabled by default** (`giveItemPlayer = false`). To enable, set it to `true` and make sure the items are defined in your framework's inventory.
{% endhint %}
***
## 1. Miner
**Extract valuable ores from underground mines.**
### How It Works
1. Talk to the mining NPC and start the job
2. Travel to the mine entrance (Alamo Sea area or K4MB1 Cave)
3. Use your pickaxe to extract ores from rock formations
4. Collect the ores and deliver them to the processing station
### Ore Types
| Ore | Rarity |
| ------- | --------- |
| Coal | Common |
| Iron | Uncommon |
| Gold | Rare |
| Emerald | Very Rare |
| Diamond | Legendary |
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ----------------------------- |
| Extract ore | 25 XP | Per item (varies by ore type) |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 5 custom ore rock props (requires stream resource)
* 2 pickaxe tiers (Rusty Pickaxe, Carbon Pickaxe)
* Processing scale with DUI display
* Full coop support
***
## 2. Lumberjack
**Cut down trees across forests and deliver logs.**
### How It Works
1. Start the lumberjack job from the NPC
2. Travel to the forest area
3. Cut down trees with your hatchet/axe
4. Collect logs and deliver to the lumber yard
### Tree Tiers
| Tier | Tree | Level Required | Health | XP per Tree | Respawn Time |
| ---- | ----- | -------------- | ------ | ----------- | ------------ |
| 1 | Pine | 0 | 100 | 30 XP | 30 seconds |
| 2 | Oak | 3 | 200 | 50 XP | 45 seconds |
| 3 | Maple | 7 | 300 | 75 XP | 60 seconds |
### Payment & XP
| Action | XP | Payment |
| -------------- | --------------------- | ----------------- |
| Cut tree | 30-75 XP (tier-based) | Per log delivered |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 30 spawn locations across the map
* 3 tree tiers with increasing health and XP rewards
* Tree respawn: 30-60 seconds (tier-dependent)
* Level-based drop quality
***
## 3. Farmer
**Harvest vegetables and deliver crates.**
### How It Works
1. Start the farmer job from the NPC
2. Go to the farm area with planted crops
3. Harvest vegetables from the fields
4. Load crates and deliver to the buyer
### Crop Types
| Crop | Weight |
| ---------- | ------ |
| Lettuce | Light |
| Pumpkin | Medium |
| Melon | Heavy |
| Watermelon | Heavy |
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ------------------- |
| Harvest plant | 20 XP | Per crate delivered |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 4 custom crop props
* Crate system with weight/slot requirements
* Full coop support
***
## 4. Fruit Picker
**Pick fruits from trees.**
### How It Works
1. Start the fruit picker job
2. Travel to the orchard area
3. Pick oranges and apples from trees
4. Deliver harvested fruits
### Produce Types
| Fruit | XP |
| ------ | ----- |
| Orange | 25 XP |
| Apple | 25 XP |
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ----------------------- |
| Pick fruit | 25 XP | Per item (weight-based) |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 20+ tree locations mapped
* Tree-based harvesting animations
***
## 5. Cleaner
**Clean dirt stains across city streets.**
### How It Works
1. Start the cleaner job from the NPC
2. Select a route from the available options
3. Travel to marked stain locations
4. Clean each stain to earn payment
### Routes
| Route | Area | Level Required |
| ------- | -------------- | -------------- |
| Route 1 | Pillbox Hill | 0 |
| Route 2 | La Mesa | Varies |
| Route 3 | Textile City | Varies |
| Route 4 | Vinewood Hills | Varies |
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Clean stain | 30 XP | $75 per stain |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 4 different routes with level-locked progression
* Marker-based stain detection system
***
## 6. Power Washer
**Pressure wash dirty surfaces around the city.**
### How It Works
1. Start the power washer job
2. Get your pressure washer equipment
3. Travel to marked dirty surfaces
4. Spray each surface (8 hits required per stain)
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Clean stain | 35 XP | $100 per stain |
| Job completion | 600 XP | Completion bonus |
### Special Features
* Raycast-based surface detection
* Route system similar to cleaner job
* 8 spray hits per stain for realistic feel
***
## 7. Window Cleaner
**Clean windows on city buildings.**
### How It Works
1. Start the window cleaner job
2. Select your route
3. Travel to buildings with dirty windows
4. Clean each window (8 hits per window)
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Clean window | 30 XP | $80 per window |
| Job completion | 500 XP | Completion bonus |
### Special Features
* Multiple routes with different buildings
* Break session minigame system
* Full coop support
***
## 8. Car Detailer
**Wash and polish customer vehicles.**
### How It Works
1. Start the car detailer job
2. Find a customer vehicle at the marked location
3. **Phase 1: Spray Wash** โ Spray the vehicle (6 hits)
4. **Phase 2: Polish** โ Polish 3 points on the vehicle
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Spray wash | 40 XP | $80 per wash |
| Polish | 25 XP | $50 per polish |
| Job completion | 500 XP | Completion bonus |
### Special Features
* Two-phase detailing process
* Decal stain system on vehicles
* Customer location detection
***
## 9. Scrapyard
**Dismantle junk vehicles and collect scrap metal.**
### How It Works
1. Start the scrapyard job
2. Go to the scrapyard area
3. Use a crowbar to dismantle vehicles
4. Collect metal components
5. Weigh and sell the scrap
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ------------------------- |
| Collect scrap | 20 XP | $15 per kg (weight-based) |
| Job completion | 400 XP | Completion bonus |
### Special Features
* 17 custom spawn locations
* Multiple junk vehicle models
* Weight-based payment system
***
## 10. Hunting
**Hunt animals in the wilderness.**
### How It Works
1. Start the hunting job from the NPC
2. Get your weapon from the available tiers
3. Hunt animals (boar, rabbits, coyotes, etc.)
4. Load carcasses into your vehicle
5. Deliver to the processing station for weighing and selling
### Weapon Tiers
| Tier | Weapon | Level Required | Ammo | Damage Multiplier |
| ---- | ---------------------------------------- | -------------- | ---- | ----------------- |
| 1 | Hunting Rifle (`weapon_musket`) | 0 | 30 | 1.0x |
| 2 | Bolt-Action Rifle (`weapon_sniperrifle`) | 3 | 40 | 1.3x |
| 3 | Heavy Sniper (`weapon_heavysniper`) | 7 | 50 | 1.6x |
### Payment & XP
| Action | XP | Payment |
| --------------- | ------ | ---------------- |
| Kill animal | 15 XP | โ |
| Deliver carcass | 50 XP | $15 per kg |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 3 weapon tiers unlocked by level with increasing damage multipliers
* Disabled friendly fire during hunting
* Weighing system at processing station
***
## 11. Newspaper Delivery
**Deliver newspapers by bicycle.**
{% hint style="danger" %}
**Required:** This job uses `WEAPON_ACIDPACKAGE` for throwing newspapers. You must define this weapon in your framework or the job will not work. See the [Installation](/scripts/lite-jobs-pack/installation) page for setup instructions.
{% endhint %}
### How It Works
1. Start the newspaper delivery job
2. Get on your bicycle
3. Pick up newspapers from the depot
4. Ride to marked houses and throw newspapers using the newspaper bundle weapon
### Routes
| Route | Difficulty | Payment |
| ---------- | ---------- | ------- |
| Restaurant | Easy | $200 |
| Easy Route | Easy | $300 |
| Hard Route | Hard | $700 |
### Payment & XP
| Action | XP | Payment |
| ----------------- | ------ | ---------------------- |
| Deliver newspaper | 50 XP | Route-based ($200-700) |
| Job completion | 300 XP | โ |
### Special Features
* Bicycle-based delivery mechanics
* Newspaper throwing physics
* Multiple routes with varying difficulty
***
## 12. Cleanup Collector
**Collect garbage from bins and dumpsters.**
### How It Works
1. Start the cleanup collector job
2. Drive the sanitation truck to marked areas
3. Collect garbage bags from bins/dumpsters (27+ bin model types detected)
4. Load bags onto the truck
5. Deliver to the dump when full
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Collect bag | 10 XP | $50 per bag |
| Truck delivery | 100 XP | $200 bonus |
| Job completion | 500 XP | Completion bonus |
### Special Features
* 27+ dumpster/bin model detection
* Truck capacity system
* Full coop support
***
## 13. Truck Driver
**Long-haul trucking with trailers.**
### How It Works
1. Start the truck driver job
2. Pick up your truck and attach a trailer
3. Drive to the delivery destination
4. Payment is calculated based on distance driven
### Payment & XP
| Action | XP | Payment |
| -------------------------- | ----- | ----------------- |
| Per 100m driven | 10 XP | $10 per 100m |
| Illegal route (20% chance) | Same | 2x pay multiplier |
### Special Features
* Distance-based payment system
* 20% chance of high-paying illegal routes
* Police alert mechanics on illegal deliveries
* Trailer attach/detach system
* Queue management for truck assignments
{% hint style="warning" %}
**Illegal Routes:** There is a 20% chance of receiving an illegal delivery with double pay. Police may be alerted โ higher levels reduce alert chance!
{% endhint %}
***
## 14. Treasure Hunter
**Underwater treasure hunting (multiplayer encouraged).**
### How It Works
1. Start the treasure hunter job
2. Board a boat with your team
3. Use the tracker/beacon to locate underwater treasures
4. Dive to the treasure location and collect chests
5. Return to the surface and sell your finds
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ------------------- |
| Find treasure | 50 XP | Custom per treasure |
| Job completion | 500 XP | 1.2x coop bonus |
### Special Features
* 25 underwater treasure locations
* Shared treasure system for teams
* Tracker/beacon mechanics
* Multiplayer cooperation encouraged โ coop bonus for team play
***
## 15. Dog Walker
**Walk dogs for wealthy clients.**
### How It Works
1. Start the dog walker job
2. Pick up the dog from the client
3. Walk the dog along the route (leash mechanics)
4. Handle poop cleanup when needed
5. Return the dog to the client
### Payment & XP
| Action | XP | Payment |
| --------------- | ------ | ---------------- |
| Per 100m walked | 15 XP | $10 per 100m |
| Poop cleanup | 10 XP | $5 bonus |
| Job completion | 100 XP | Completion bonus |
### Special Features
* Leash mechanics with movement restrictions
* Poop management system (random intervals)
* Walking animation sequences
***
## 16. Powerlines
**Repair electrical panels and phone pole wiring.**
### How It Works
1. Start the powerlines job
2. Select a route
3. **Panel Repairs** โ Go to houses and fix electrical panels (grid matching minigame)
4. **Pole Repairs** โ Use a bucket truck to reach phone poles (welding minigame)
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Repair panel | 50 XP | $525 per panel |
| Repair pole | 100 XP | $525 per pole |
| Job completion | 300 XP | Completion bonus |
### Special Features
* Two different repair types with unique minigames
* Bucket truck mechanics for pole access
* Route system with varying panel/pole counts
***
## 17. Delivery
**Package delivery service.**
### How It Works
1. Start the delivery job
2. Go to the depot and load packages into your van
3. Drive to delivery locations (60+ location pool)
4. Hand packages to customer NPCs
### Payment & XP
| Action | XP | Payment |
| ------------------------------- | ----- | ----------------- |
| Deliver package | 50 XP | $225 per delivery |
| Multi-box delivery (30% chance) | 50 XP | $225 per box |
### Special Features
* 60+ delivery location pool
* 30% chance of multi-box deliveries
* Vehicle trunk/cargo system
* Customer NPC interaction
***
## 18. Warehouse
**Freight and logistics operations.**
### How It Works
1. Start the warehouse job
2. Go to the warehouse facility
3. Load boxes by hand or use a forklift for pallets
4. Place cargo onto the delivery truck
5. NPC truck driver takes the loaded truck
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Load box | 15 XP | $50 per box |
| Load pallet | 50 XP | $200 per pallet |
| Job completion | 100 XP | Completion bonus |
### Special Features
* Forklift or hand-carry mechanics
* NPC truck driver system
* Multiple truck orders to fulfill
* Truck capacity limits
***
## 19. Landscaping
**Garden maintenance and landscaping.**
### How It Works
1. Start the landscaping job
2. Pick up equipment from your work truck (trimmer + shovel)
3. Travel to the route locations
4. Trim overgrown bushes with the trimmer
5. Dig up weeds with the shovel
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | ---------------- |
| Trim bush | 30 XP | $50 per bush |
| Dig lawn/weed | 20 XP | $30 per lawn |
| Job completion | 500 XP | Completion bonus |
### Special Features
* Two types of tasks (trimming + digging)
* Equipment pickup from work truck
* Multiple routes with different task counts
* Tool management system
***
## 20. Fishing
**Professional fishing with rod tiers and minigame.**
### How It Works
1. Start the fishing job
2. Select your fishing rod and bait
3. Cast your line into the water
4. Complete the fishing minigame to catch fish
5. Deliver your catch for payment
### Fishing Rods
| Rod | Level Required |
| ------------ | -------------- |
| Standard Rod | 0 |
| Carbon Rod | Mid-level |
| Pro Rod | High-level |
### Fish Types (9)
| Fish | Difficulty |
| --------- | ---------- |
| Anchovy | Easy |
| Trout | Easy |
| Mackerel | Easy |
| Salmon | Medium |
| Snapper | Medium |
| Tuna | Medium |
| Grouper | Hard |
| Swordfish | Hard |
| Shark | Hard |
### Payment & XP
| Action | XP | Payment |
| -------------- | ------ | -------------------- |
| Catch fish | 20 XP | Custom per fish type |
| Deliver catch | 40 XP | $150 delivery bonus |
| Job completion | 400 XP | Completion bonus |
### Special Features
* 3 fishing rod tiers with level unlocks
* 6 bait types affecting catch rates
* Fishing minigame with difficulty levels
* Free mode option (fish without starting a job)
{% hint style="warning" %}
**Required Items:** Fishing requires 18 inventory items (fish, rods, baits). See the [Installation](/scripts/lite-jobs-pack/installation) page for item setup.
{% endhint %}
***
## 21. Diving
**Underwater diving for treasures and corals.**
### How It Works
1. Start the diving job
2. Board the dive boat
3. Sail to the dive location and drop anchor
4. Dive underwater and complete tasks
5. Collect corals and treasures
6. Surface and sell your finds
### Collectibles
| Item | Payment |
| -------------------------- | ------- |
| Dendrogyra Coral (Pillar) | $1,500 |
| Antipatharia Coral (Black) | $1,500 |
### Payment & XP
| Action | XP | Payment |
| ------------------------ | ------ | ---------------- |
| Complete underwater task | 25 XP | โ |
| Sell item | 50 XP | $1,500 per coral |
| Job completion | 500 XP | Completion bonus |
### Special Features
* Boat mechanics with anchor system
* Underwater task system
* 2 coral types to collect
{% hint style="warning" %}
**Required Items:** Diving requires 2 inventory items (corals). See the [Installation](/scripts/lite-jobs-pack/installation) page for item setup.
{% endhint %}
***
## 22. Forklift Operator
**Underground logistics and crate sorting.**
### How It Works
1. Start the forklift operator job
2. Enter the underground depot
3. Get on the forklift
4. Pick up crates and transport to the conveyor belt
5. Sort crates by category
### Crate Categories
| Category | Value |
| --------- | ----- |
| Jewellery | $200 |
| Antiques | $150 |
| Tobacco | $100 |
| Hazard | $75 |
| Fake | $50 |
### Payment & XP
| Action | XP | Payment |
| -------------- | -------- | --------------------- |
| Sort crate | Variable | Per crate value |
| Job completion | โ | $600 completion bonus |
### Special Features
* 5 crate categories with 3 variants each (15 total crate props)
* Forklift mechanics (raise/lower forks)
* Categorization and sorting system
* Conveyor belt delivery
***
## 23. Tire Technician
**Roadside tire repair service.**
### How It Works
1. Start the tire technician job
2. Get your tools (jack, wrench)
3. Drive to the stranded vehicle location
4. Jack up the vehicle
5. Remove the flat tire
6. Install the new tire
7. Lower the vehicle
### Payment & XP
| Action | XP | Payment |
| --------------- | ------ | ---------------- |
| Complete repair | 70 XP | $115 per repair |
| Job completion | 350 XP | Completion bonus |
### Special Features
* Multi-step realistic repair process
* Jack and tool mechanics
* 6 repair locations across the map
* Multiple vehicle models for service
***
## Need Help?
{% hint style="info" %}
Having questions about a specific job? Join our [Discord server](https://discord.gg/tworst) and open a support ticket.
{% endhint %}
---
[Next Page](/llms-full.txt/1)
