# How To Install VORP Framework on Your RedM Server (/docs/redm/install-vorp-framework)



import { Step, Steps } from 'fumadocs-ui/components/steps';

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 [#prerequisites]

Before installing VORP, make sure you have:

* A running RedM server ([XGamingServer panel](https://panel.xgamingserver.com) or self-hosted)
* A MySQL/MariaDB database ready — see [Set Up a Database](/docs/redm/setup-database)
* `oxmysql` resource installed (covered below)

Step 1 — Install oxmysql [#step-1--install-oxmysql]

VORP uses `oxmysql` as its database connector. Download the latest release from [GitHub](https://github.com/overextended/oxmysql/releases).

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 [#step-2--download-vorp-core]

Download the latest VORP Core release from the [VORP GitHub](https://github.com/VORPCORE/vorp-core-lua/releases).

Step 3 — Upload VORP Core [#step-3--upload-vorp-core]

Via XGamingServer Panel [#via-xgamingserver-panel]

1. Log in to the [XGamingServer Panel](https://panel.xgamingserver.com)
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 [#via-sftp--ssh]

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

Step 4 — Import the Database Schema [#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) [#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 [#via-command-line]

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

Step 5 — Configure VORP [#step-5--configure-vorp]

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

```lua
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 [#step-6--add-vorp-to-servercfg]

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 [#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 [#installing-vorp-plugins]

VORP has a large plugin ecosystem. Common plugins include:

| Plugin          | Purpose                         |
| --------------- | ------------------------------- |
| vorp\_inventory | Item inventory system           |
| vorp\_character | Character creation & management |
| vorp\_jobs      | Job system                      |
| vorp\_crafting  | Crafting system                 |
| vorp\_stables   | Horse system                    |

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](https://forum.cfx.re/) and the VORP Discord.

Troubleshooting [#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](https://discord.xgamingserver.com) for server setup support.

Next Steps [#next-steps]

* [Install Resources](/docs/redm/install-resources)
* [Configure Your Server](/docs/redm/configure-your-server)
* [Adding Admins](/docs/redm/adding-admins)