Installation

Every Ripex resource follows the same installation shape. This page covers the parts that are common to all of them; each resource then has its own guide for the dependencies, permissions, and first-run checks specific to it.

Requirements vary by resource. Check the resource’s own installation page before you start, since some need a framework, a database, or an inventory item that must exist first.

1. Extract into resources

Extract the complete resource into your server’s resources directory, keeping the folder intact. Interfaces load their stylesheets, scripts, and images from paths inside the resource, so moving or splitting subfolders breaks them.

Note the folder name you end up with. You will need it exactly as-is in the next step.

2. Add it to server.cfg

Add an ensure line using that folder name:

ensure resource-folder-name

If you renamed the folder, the ensure line must match your name, not the one in the guide.

3. Get the start order right

Order matters more than anything else in this list. Resources that integrate with a framework detect it when they start, so anything they depend on must already be running:

ensure oxmysql
ensure qb-core
ensure ripex-resource

The rule is simple: databases first, then your framework, then the resource. A resource started before its framework behaves as though no framework is present, which usually looks like missing player data rather than an obvious error.

4. Configure it

Open config.lua and work through the resource’s configuration guide. At minimum, check:

The framework value, if the resource does not detect one automatically.
Any item name that must match your inventory.
Any job name used for permissions or alerts.
Placeholder values such as example links, test items, or testing durations.

5. Restart and verify

Restart the resource and test it in game. Each installation guide ends with a verification list; work through it rather than assuming a clean console means everything works.

If something does not respond, enable the resource’s debug flag to see which check is failing, then disable it again once you have your answer.

Common mistakes

Problem	Cause
Resource never starts	The `ensure` line does not match the actual folder name.
Player data is missing	The resource started before the framework.
Config change has no effect	The resource was not restarted, or the client is still connected with old values.
An interaction never triggers	An item or job name in the config does not exist on your server.
Duplicate interface elements	Two resources doing the same job, such as a HUD alongside `qb-hud`.
Works in testing, breaks on launch	Placeholder or testing values were left in the config.

That last one is worth a second pass. Several resources ship with deliberately short cooldowns, example job names, or placeholder links so the flow can be tested quickly. Each resource’s guide flags its own; the RedM overview also collects them in one table.

Next steps

Pick your platform and open the resource you are installing:

FiveM overview for the FiveM resources and what each one supports.
RedM overview for the RedM resources and the conventions specific to RedM.