Skip to main content
This guide will help you get started with Dietrich Development RedM scripts, from basic setup to initial usage.
If you are new to RedM scripting or our products, we recommend starting here before moving to the Installation & Configuration guide.

​
1. Understanding our scripts

All of our RedM scripts follow a similar structure:
  • A main script folder containing client.lua, server.lua, and configuration files
  • A frameworkBridge (frameworkBridge.lua) to ensure compatibility with multiple frameworks (VORP, RSG, or custom)
  • Optional dependencies such as UI components, props, or maps
The frameworkBridge is included with every script to unify framework-specific logic. If you use a custom framework, you can adapt the bridge to match your own events and data structure.

​
2. Prerequisites

Before installing:
  • Ensure your RedM server is running the latest stable build
  • Confirm you have a database set up (MySQL or MariaDB) if the script requires persistence
  • Install any required frameworks (VORP, RSG, etc.)
  • Have access to your server.cfg to add ensure commands

​
3. Basic workflow

The general process for adding any of our scripts is:
  1. Download the script from our Tebex Store
  2. Unpack it into your resources folder
  3. Configure it via config.lua
  4. Ensure it in your server.cfg
  5. Test the functionality in-game

​
4. Framework setup

The frameworkBridge detects your framework automatically:
  • VORP → Detected if vorp_core is running
  • RSG → Detected if rsg-core is running
  • Custom → Set manually in config.lua:
Config.Framework = 'custom'
When using custom, you will need to implement the required player and inventory functions in frameworkBridge.lua.

​
5. Database integration

If a script stores persistent data, it will use oxmysql by default: 
local result = MySQL.query.await('SELECT * FROM my_table WHERE id = ?', { id })
Update, insert, and delete operations follow the same pattern with .update.await and .insert.await. Ensure that your database connection is configured in your server’s server.cfg: 
set mysql_connection_string "mysql://user:password@host/database"

​
6. First run

After installation and configuration:
  1. Start the server
  2. Watch the console for confirmation messages
  3. Join the server and test key features
  4. Check for errors or missing dependencies

​
7. Where to go next

Installation & Configuration

Detailed setup and configuration instructions.

Snippets & Examples

Ready-to-use examples for customization.
⌘I