VORP Core or RSG Core: install a RedM framework on your server

VORP Core and RSG Core are two open source roleplay frameworks for RedM, written in Lua. They handle characters, money, jobs and inventory, and every RP script states which one it is made for. This guide shows how to install a RedM framework on your server, with each project's official txAdmin recipe or by hand.

Your server, ordered from our RedM server hosting plans, must already start with its Cfx.re key. The guide How to make a RedM server: license key, server.cfg and txAdmin shows how.

---

Choose between VORP Core and RSG Core

Both frameworks cover the same needs. The differences lie mostly in the installation and in the scripts available.

	VORP Core	RSG Core
Database	MySQL or MariaDB, through oxmysql	MySQL or MariaDB, through oxmysql
txAdmin recipe	In the Popular Recipes list, or by its address	By its address, with Remote URL Template
Players' Steam account	Required by the recipe	Not required by the recipe
Documentation	docs.vorp-core.com	rsgcore.com/docs
Source code	github.com/VORPCORE	github.com/Rexshack-RedM

Choose before you buy scripts. A VORP script does not run as is on RSG, and the reverse is also true. RedEM:RP, an older framework, is not covered here.

---

Create the database

VORP and RSG store characters and the economy in a MySQL database. Create it first in OuiPanel.

1. In the side menu, click Databases, then Create database.

2. In Database name, type for example vorp or rsg, then click Create database.

3. Open the database's Information window and note the host, port, name, username and password.

The panel adds a prefix to the name. The vorp database becomes for example s123_vorp. The guide How to create and manage a MySQL database on OuiPanel covers each screen.

The OuiPanel "Insert MySQL connection" button only exists for FiveM. On RedM, the txAdmin recipe writes the connection for you. By hand, you write it in server.cfg.

---

Install VORP Core with txAdmin

According to VORP, its official recipe installs the framework, its main resources, oxmysql and the database tables. Run it during the first txAdmin setup. If txAdmin is already set up, the reset option is under Settings › FXServer.

1. In the txAdmin wizard, name the server, then choose Popular Recipes and VORP Core. You can also choose Remote URL Template and paste the recipe address below.

2. Keep the folder suggested by txAdmin and go to the next step.

3. Review the recipe, then click Next.

4. Paste your key into Server Registration Key.

5. Click Show/Hide Database options (advanced). Fill in Database Host, Database Port, Database Username and Database Password with the values noted in OuiPanel.

6. In Database Name, type the full name of your database, prefix included. Leave Delete Database unchecked.

7. Click Run Recipe and let the deployment finish.

8. Review the suggested server.cfg, then click Save & Run Server.

https://raw.githubusercontent.com/VORPCORE/VORP_txAdmin/main/vorp_recipe.yaml

The VORP documentation suggests naming the database vorpv2. At OuiHeberg, keep the name of the database created in OuiPanel.

In its current version, the VORP recipe sets sv_enforceSteamAuth to true. Each player must then link a Steam account to their Cfx.re account to join. This setting needs FXServer 38004 or later.

---

Install RSG Core with txAdmin

The RSG documentation describes the txAdmin installation with its own recipe. According to it, the recipe installs RSG Core, its resources and the database tables.

1. In the txAdmin wizard, name the server, choose Remote URL Template and paste the address below.

2. Keep the suggested folder, review the recipe, then click Next.

3. Fill in Server Registration Key and the database options as for VORP, with the full name of your database.

4. Click Run Recipe, then Save & Run Server.

https://raw.githubusercontent.com/Rexshack-RedM/txAdminRecipe/refs/heads/main/rsgcore.yaml

---

Install a framework by hand

Without txAdmin, or to pick each resource yourself, you install the framework like a script. The guide RedM scripts: how to install resources on your server covers the file upload.

1. Download the latest oxmysql release from GitHub, then the framework resources from the project's official GitHub.

2. Put them in resources and name the folders as the project asks, for example vorp_core or rsg-core.

3. Import the tables with PhpMyAdmin. For RSG, rsg-core needs the players and bans tables. For VORP, the MariaDB.sql file of the VORP_txAdmin repository holds the recipe's tables.

4. Write the database connection in server.cfg, then the ensure lines in order.

The database connection

oxmysql reads this line. Put it before the ensure lines and replace the values with those from OuiPanel.

set mysql_connection_string "mysql://u123_AbCdEf:your_password@mysql-xxx.ouiheberg.com:3306/s123_vorp?charset=utf8mb4"

The start order

These lines follow the start of the server.cfg in the official recipes. Here are the VORP Core ones.

ensure oxmysql
ensure vorp_menu
ensure vorp_lib
ensure vorp_core
ensure vorp_inputs
ensure vorp_progressbar
ensure vorp_inventory
ensure vorp_character

And the RSG Core ones.

ensure oxmysql
ensure ox_lib
ensure rsg-core

Then add the framework's other resources, and your scripts. The RSG manual installation page and the VORP Core repository give the full list.

---

Become a framework admin

The txAdmin recipes add the identifiers of your Cfx.re account, the one linked to txAdmin, to the FXServer group.admin group. Each framework also has its own ranks.

On VORP Core

According to the VORP FAQ, add the admin in server.cfg and in vorp_admin/vorp_perms.cfg, following the examples in those files. Then set the group column of your player to admin in the users and characters tables, with PhpMyAdmin.

On RSG Core

add_principal identifier.license:xxxxxxxx rsgcore.god

Replace xxxxxxxx with your Rockstar license identifier. A god admin can then grant a rank in game with /addpermission, among god, developer, headadmin, admin, mod and helper.

The identifiers and the add_principal syntax are the same as on FiveM. The guide Permissions ACE on FiveM explains them.

---

If the framework does not start

Message or symptom	Fix
Could not find dependency oxmysql for resource vorp_core.	oxmysql is missing, or its ensure line comes after the framework's
Access denied for user	Check the user and password in mysql_connection_string
Unknown database	The database name is written without its prefix
Couldn't find resource vorp_core.	The folder has the wrong name, for example with the -main suffix
The game asks to link a Steam account	That is the effect of sv_enforceSteamAuth true. The player links Steam to their Cfx.re account, then reconnects

For how a framework works internally, its official documentation remains the reference.

---

Need help?

Open a ticket from Tickets › Open a Ticket, or from the Contact support tile at the bottom of your server's page in the client area. You can also ask your question on the OuiHeberg Discord.

Open a ticketDiscord