How To Install VORP Framework on Your RedM Server

VORP (Versatile Old Red Platform) is one of the most popular roleplay frameworks for RedM. It provides a foundation for character systems, jobs, inventory, economy, and more.

Prerequisites

Before installing VORP, make sure you have:

• A running RedM server (XGamingServer panel or self-hosted)
• A MySQL/MariaDB database ready — see Set Up a Database
• oxmysql resource installed (covered below)

Step 1 — Install oxmysql

VORP uses oxmysql as its database connector. Download the latest release from GitHub.

Upload the oxmysql folder to your resources directory.

Add it to the top of your server.cfg, before any framework resources:

ensure oxmysql

Set your database connection string in server.cfg:

set mysql_connection_string "mysql://youruser:yourpassword@your-db-host/redm?charset=utf8mb4"

💡 Tip: If using XGamingServer's database feature, find your connection details in the Databases tab of your panel.

Step 2 — Download VORP Core

Download the latest VORP Core release from the VORP GitHub.

Step 3 — Upload VORP Core

Via XGamingServer Panel

1. Log in to the XGamingServer Panel
2. Stop your server
3. Click Files in the sidebar
4. Navigate to the resources folder
5. Upload the VORP Core ZIP and click Unarchive

Via SFTP / SSH

cd ~/redm/server-data/resources
# Upload and extract the VORP zip
unzip vorp_core.zip

Step 4 — Import the Database Schema

VORP requires several database tables. Import the SQL file that comes with VORP Core:

Via HeidiSQL (recommended for remote DB)

1. Connect to your database using HeidiSQL
2. Select your database
3. Go to File → Run SQL file
4. Select the .sql file from the VORP Core package

Via command line

mysql -u youruser -p redm < /path/to/vorp_core.sql

Step 5 — Configure VORP

Open resources/vorp_core/config.lua and review the key settings:

Config = {}

-- Server name shown in character selection
Config.ServerName = "My RedM Server"

-- Max characters per player
Config.MaxCharacters = 2

-- Starting money
Config.StartMoney = 50

-- Starting gold
Config.StartGold = 5

Adjust values to fit your server's economy and rules.

Step 6 — Add VORP to server.cfg

In your server.cfg, ensure VORP loads after oxmysql:

ensure oxmysql
ensure vorp_core

⚠️ Warning: Load order matters. oxmysql must start before vorp_core. Any VORP plugins must load after vorp_core.

Step 7 — Start Your Server

Start your server and check the console for any errors. A successful VORP load will show:

[vorp_core] VORP Core started successfully

If you see database errors, double-check your connection string and make sure the SQL schema was imported correctly.

Installing VORP Plugins

VORP has a large plugin ecosystem. Common plugins include:

Each plugin follows the same install pattern: upload to resources, import SQL (if any), add ensure plugin-name to server.cfg after vorp_core.

💡 Tip: Browse community VORP resources on the cfx.re community forum and the VORP Discord.

Troubleshooting

"Database connection failed" — Check your mysql_connection_string value. Make sure MariaDB is running and port 3306 is open.

"vorp_core failed to start" — Make sure oxmysql is loading first and the SQL schema is fully imported.

"No character menu appears" — Make sure vorp_character plugin is installed and listed after vorp_core in server.cfg.

Need help? Join our Discord for server setup support.

Next Steps

• Install Resources
• Configure Your Server
• Adding Admins