RedM Overview

Every RedM resource has its own installation and configuration guide. This page lists what is available, which frameworks each one supports, and the conventions the guides share.

Resources

ResourceFrameworksDocumentation
RX Sackhead V1 & V2QBR, VORP, RSGInstallation · Configuration
RX Scenes V1StandaloneInstallation · Configuration
RX Drug Sales V1QBR, VORP, RSGInstallation · Configuration
RX HitchStandaloneInstallation · Configuration
RX ChallengesStandalone, RSG, VORPInstallation · Configuration
RX DoorlockStandalone, RSG, VORPInstallation · Configuration
RX MuralsStandalone, RSG, VORPInstallation · Configuration

RX Scenes is the only resource here that needs a database, and it creates its own tables on the first start. RX Challenges, RX Doorlock, and RX Murals keep their data in files inside the resource, so those folders must stay writable.

Shared conventions

Framework detection is not always automatic

RX Doorlock, RX Challenges, and RX Murals detect the framework themselves and can also run standalone. RX Drug Sales does not detect anything: Config.Framework must be set by hand before the first start, or item checks and payments fail silently.

Controls use input hashes

RedM controls are set as input hashes rather than key names, for example 0x156F7119 for Backspace. When replacing one, use a valid hash and test it alongside targeting, inventory, and any interaction resource that may be active at the same time.

F2 does not work as a keybind in RedM. Use F6, F7, F10, F11, or F12 instead.

Fonts are limited to the built-in set

RedM cannot load custom font files. Anything drawn in the world is limited to the fonts the game already ships, which is why RX Scenes exposes a fixed list rather than a font path.

Restart after editing the config

Configuration is read on start. Changing config.lua while the server is running has no effect until the resource restarts, and a client that is already connected keeps the old values until then.

Debug mode

Every resource ships a debug flag, disabled by default. It is the fastest way to find out why an interaction was refused, since the console shows which check failed. Turn it off again afterwards.

Before going live

Several resources ship with example values that belong to a test server. Check these before opening to players:

SettingResourceWhy
Config.Lockpick.itemDoorlockShips as 'water'. Left alone, anyone carrying water can pick every door.
Config.Law.jobsDoorlockExample law job names. Replace with your own.
Config.Dispatch.policeJobsDrug SalesExample law job names. Replace with your own.
Config.NPCCooldown.durationDrug SalesShips at 8 seconds for testing. Far too short for a live economy.
Config.ItemsMuralsItem mode is on by default. paintkit and rag must exist in your inventory, or nobody can start painting.
Config.AdminIdentifiersScenesMust hold your real identifiers, and the file must stay out of public repositories.