Skip to main content
This guide expands on the Quickstart and covers advanced configuration, dependency setup, and integration tips for Dietrich Development RedM scripts.
We recommend completing the Quickstart before following this guide.
This page assumes your RedM server is already set up and running.

​
1. Download & prepare

1

Download your script

Get the .zip from the Tebex Store after purchase.
Save it in an accessible location on your machine.
2

Unpack the resource

Extract the .zip and place the folder into your RedM server’s resources directory.Example:
server-data/resources/[custom]/my_script_name
Use a [custom] subfolder for all third-party scripts to keep your structure clean.

​
2. Dependencies

Core RedM server build

Keep your server updated to the latest stable build to ensure compatibility.

Framework

Some scripts may require a framework like VORP, RedEM:RP, or QBR.
Check the script’s Overview page for specific requirements.

Additional resources

Optional: map data, props, or UI components may be needed for full functionality.

Licenses & API keys

If the script uses external APIs or licensing, insert your keys into the config.lua before first start.

​
3. Configuration

Open the config.lua (or equivalent) file in a text editor. Typical sections include:
  • General settings → language, UI preferences, server-side toggles
  • Permissions → roles or identifiers that can access certain features
  • Feature toggles → enable/disable optional features
  • Economy settings → item prices, payouts, fees
  • Integration hooks → links to framework events or other scripts
Always keep a backup of your original config before making major changes.
Example snippet from a config file: 
Config.Locale = "en"
Config.DebugMode = false
Config.AllowedJobs = { "police", "sheriff" }
Config.MaxEntries = 10

​
4. server.cfg entry

Ensure the script is loaded by adding it to your server.cfg: 
ensure my_script_name
Place this line after any required dependency resources.
The order of ensure commands matters — dependencies must be started before the script.

​
5. Testing & validation

After configuration:
  1. Restart the server
  2. Watch the console for [my_script_name] started successfully
  3. Join the server and test all main features
  4. Check logs for any warnings or errors
Example of successful script start in console

​
6. Optional integrations

Some scripts support:
  • Database storage (MySQL, PostgreSQL)
  • Webhook notifications (Discord, Slack)
  • UI frameworks (React, Vue overlays)
  • Economy APIs (linking to existing in-game economy)
Check the script’s Overview page for instructions.

​
7. Troubleshooting

  • Verify the folder name matches the ensure command
  • Check for missing dependencies
  • Run refresh in console before restart my_script_name
  • Save with UTF-8 encoding
  • Clear any cached .meta files
  • Restart the resource, not just the server
  • Disable debug mode in config
  • Reduce tick/update frequencies if available
  • Profile with built-in RedM performance tools

​
Next steps

Snippets & Examples

Ready-to-use code snippets for customization.

Debugging & Troubleshooting

Tools and methods for diagnosing common issues.
⌘I