RoughHades Core Framework

Prerequisites

• A recent cerulean-branch FXServer build.
• A MySQL-compatible database (e.g. via oxmysql or mysql-async) already running and reachable from your server.

Installation

1. Download the resource from the Cfx.re portal (see "Getting your files" on the main docs page) and extract it into your server's resources directory.
2. Rename the extracted folder to REPLACE_ME_resource_folder_name if it isn't already.
3. Add it to your server.cfg, above every other RoughHades resource:

ensure REPLACE_ME_resource_folder_name

4. Open config.lua and set your database connection details and any server-specific options.
5. Restart your server (or run refresh then ensure REPLACE_ME_resource_folder_name from the server console).

Verifying it's working

On a successful start, the server console should print a RoughHades Core startup banner with no errors. If a player can connect and spawn in normally, the framework initialized correctly.

Updating

1. Stop the resource: stop REPLACE_ME_resource_folder_name.
2. Replace the resource folder with the new version, keeping your existing config.lua (don't overwrite your own settings).
3. ensure REPLACE_ME_resource_folder_name again.

Troubleshooting

• Server won't start / console spam on boot: almost always a database connection issue -- double check config.lua's connection string and that the database user has permission to create tables.
• Other RoughHades resources error on start: make sure Core Framework's ensure line in server.cfg comes before every resource that depends on it.

Still stuck? The fastest way to get help is Discord.