RSG Framework
Installation

Manual Installation

Install RSG Framework by hand on a fresh RedM server.

Prefer to set things up yourself? This guide walks you through installing RSG Framework manually. If you'd rather automate everything, use the txAdmin recipe instead.

Prerequisites

  • A working RedM server (latest recommended artifacts).
  • A MySQL / MariaDB database and connection details.
  • oxmysql installed as your database wrapper.

1. Download the framework

Clone the core resource into your server's resources folder:

cd resources
git clone https://github.com/Rexshack-RedM/rsg-core.git [rsg]/rsg-core

Keep resources organised

We recommend placing all RSG resources inside a [rsg] folder so they load together and stay easy to manage.

2. Import the database

Import the SQL file shipped with rsg-core into your database:

SOURCE rsg-core.sql;

Then configure your connection string in server.cfg:

set mysql_connection_string "mysql://user:password@localhost/rsg_database?charset=utf8mb4"

3. Configure server.cfg

Add the resources to your server.cfg in the correct order:

# Dependencies
ensure oxmysql

# RSG Framework
ensure rsg-core

# RSG resources
ensure rsg-multicharacter
ensure rsg-spawn
ensure rsg-inventory

Load order matters

oxmysql must start before rsg-core, and rsg-core must start before any resource that depends on it.

4. Start your server

Boot your server and watch the console. You should see rsg-core start without errors.

[    script:rsg-core] RSG Core has started successfully

Next steps

On this page