Documentation

DEVELOPER DOCS

Everything you need to install, configure, and maintain premium RedM & FiveM scripts.

Try "installation", "VORP", or "config"

INSTALLATION

Get your scripts running in minutes with the correct setup.

01Download & extract

After purchase, download the .zip from your Dashboard → Downloads. Extract the archive into a dedicated folder on your server or development machine. Keep the original folder structure intact; renaming files can break dependencies.

02Drop into resources

Move the extracted script folder into your server resources directory. Ensure the folder name matches the resource name in the fxmanifest.lua or __resource.lua file. For RedM, this is typically resources/[local]/ or resources/[custom]/ for FiveM.

03Ensure in server.cfg

Add the resource to your server.cfg using ensure my_script_name. Place it below your framework resources and any shared dependencies. Order matters for scripts that reference exports or events from other resources.

04First startup check

Start your server and watch the console for errors. A successful install prints a version banner and dependency check. If something is missing, the script will log the exact resource name needed.

CONFIGURATION

Tune every script to fit your server economy and roleplay.

01Config.lua overview

Every script ships with a config.lua or config.js file at the root. This is the single source of truth for prices, locales, keys, item names, and feature toggles. Keep a backup before editing.

02Framework bridges

Set Config.Framework to match your environment. Supported values include VORP, RSG, RedEM, QB-Core, ESX, and Standalone. The script will automatically register the correct inventory, money, and job functions.

03Permissions & jobs

Most scripts use job-restricted access. Add the job names in Config.AllowedJobs exactly as they appear in your framework. Case-sensitive mismatches are the most common configuration error.

04Locales & labels

Language files live in the locales/ directory. Edit the JSON table for your region and update Config.Locale to match the filename. You can create custom locales by copying the en.json template.

UPDATES

Keep scripts current without breaking live server state.

01Check your version

The Dashboard → Downloads page shows the installed version and the latest release for each script. A gold badge appears when a newer version is available for download.

02Backup before updating

Always snapshot your config and database tables before applying an update. Store the previous .zip so you can roll back quickly if the new release changes data structures.

03Apply the update

Download the latest version from your dashboard, replace the resource files, and preserve your config.lua. Read the changelog for migration steps. Restart the resource, not the whole server, if possible.

04Database migrations

Some updates include SQL migration files. Run them in order against your database before starting the resource. Migration filenames include a version number for easy sequencing.

FRAMEWORKS

Compatibility notes and export references for each core.

01VORP (RedM)

VORP is the most widely used RedM framework. Our scripts use VORPcore exports and vorp_inventory:v2 item definitions. Ensure vorp_core starts before any of our resources.

02RSG (RedM)

RSG is a modern VORP fork. Most scripts detect RSG automatically, but a few legacy exports may need the RSG bridge file. Enable Config.UseRSGBridge when available.

03QB-Core (FiveM)

QB-Core scripts expect qb-core, qb-inventory, and qb-target or qb-menu. Set Config.QBTarget to true if you use target interactions; otherwise legacy menus are used.

04ESX (FiveM)

ESX Legacy and ESX 1.9+ are both supported. Specify Config.ESXVersion in config.lua to avoid inventory detection issues. ox_inventory is supported through the ESX bridge.

05Standalone

Standalone mode runs without a framework. You may need to define custom item and money handlers in the bridge file. Useful for custom frameworks or lightweight servers.

TROUBLESHOOTING

Fix common errors and understand the logs.

01Script fails to start

Read the full console error. The most common causes are missing dependencies, incorrect resource names, or a framework value that does not match the server. Ensure all required resources are started before the script.

02Items not found

If the script says an item is missing, verify the item exists in your framework database. Add the item to your inventory or item list, then restart the resource. Case and spelling must match exactly.

03UI does not open

Check the browser console for JavaScript errors. Common issues include a missing NUI image, a conflict with another UI resource, or incorrect keybind mapping. Try pressing the key in a fresh FiveM client instance.

04Performance drops

Use the built-in debug command, usually /scriptname_debug, to view thread times. Disable expensive features like live map blips or particle effects if you are on a small server. Report extreme values to support.

05Still stuck?

Open a ticket on /support or join our Discord. Include your framework version, the exact error message, and a screenshot of your server console. The more detail you provide, the faster we can help.

Need more help?

Our support team is ready to answer your questions.

Visit support