Rarx Doors

Overview#

RARX Doors is a modular door-lock system for FiveM. Lock any door on the map in seconds through an in-game admin panel, restrict access by job/grade, gang/organization, or required items, and integrate seamlessly with the most popular lockpick minigames. All changes are persisted to the database and broadcast live to every connected client — no restarts, no SQL editing.

Framework, inventory, lockpick and gang systems are auto-detected at startup, so the script works on a wide range of stacks out of the box.

Features#

Requirements#

• Framework: QBCore, QBox, or ESX (auto-detected)
• ox_lib
• oxmysql

Installation#

1. Download & Extract

   Download the latest version from your Keymaster and extract it into your server's resources folder.

2. Import Database

   The required table is created automatically on first start. No SQL import is needed.

3. Add to server.cfg

   server.cfgCopy

   ensure rarx_doors

   Make sure ox_lib and oxmysql are started before this resource.

4. Configure

   Edit config/config.lua to set the language, admin groups, command name and Discord webhook URLs. Door definitions live in the database and are managed through the in-game panel.

Framework-Specific Notes#

Configuration#

General Settings#

Config.Language = 'es'           -- 'es' | 'en' (matches translates/*.lua)
Config.Debug    = false          -- Verbose logging in F8

Config.Commands = 'doors'        -- Admin panel command
Config.Drawtext = 'ox_lib'       -- Drawtext backend (currently delegated to ox_lib)
Config.Input    = 'qb-input'     -- Input prompt backend

Admin Permissions#

-- Groups that can open the management panel and create / edit / delete doors.
-- qb-core / qbx_core typical groups: 'god', 'admin'
-- esx typical groups: 'admin', 'superadmin', 'mod'
-- Mix groups from both frameworks; only the ones matching the active framework
-- are actually checked at runtime.
Config.GroupPermissions = {
    'god',
    'admin',
    'superadmin',
}

Discord Webhooks#

Config.Logs = {
    CreateDoor = '',  -- Fired when an admin creates a new door
    DeleteDoor = '',  -- Fired when a door is removed
    DoorsUsage = '',  -- Fired on every lock / unlock by a player
}

Leave any URL empty to disable that channel.

Door Management#

All doors are created and managed through the in-game admin panel, accessible with /doors (or your configured command).

Creating a Door#

1. Run the management command (default: /doors).
2. Aim at the door you want to lock and use the Create action — the model, coords and heading are filled in automatically.
3. Set the lock state, optionally add job/gang/item restrictions.
4. Save. The new door is broadcast to every connected client instantly.

Restriction Types#

Restrictions are combined with AND logic when multiple are set on the same door (e.g. police grade 2 and keycard item).

Auto-Detected Integrations#

The script logs what it detects when it starts:

[rarx_doors]
* Framework: qb-core
* Inventory: ox_inventory
* Gangs/Orgs: origen_ilegalv2
* Lockpick: qb-lockpick
* Language: es

If the script can't find one of these (other than a framework), it prints a yellow warning and falls back gracefully — gang-restricted doors won't enforce gangs, lockpick-only doors won't be pickable, etc.

Localization#

Translation files live in config/translations/. Supported out of the box:

• English (en.lua)
• Spanish (es.lua)

Set the language with Config.Language in config/config.lua.

Exports & Events API#

Client Exports#

exports.rarx_doors:openManagement()

Client Events#

Listen — fired by rarx_doors#

AddEventHandler("rarx_doors:client:onPlayerLoad", function()
    -- doors are now registered locally
end)

Server Callbacks#

These are registered with lib.callback.register and consumed by the admin panel UI. They're listed here for advanced integrations:

Server Events#

Usage Examples#

Open the admin panel from your custom HUD#

-- Client-side
exports.rarx_doors:openManagement()

Wait for doors to be ready before drawing your own UI overlays#

AddEventHandler("rarx_doors:client:onPlayerLoad", function()
    -- safe to spawn locally-attached interaction prompts here
end)

Send a one-off notification through the doors notify pipeline#

-- Server-side
TriggerClientEvent("rarx_doors:client:Notify", source, "Acceso denegado", "error", 3000)

Troubleshooting#

Compatibility#

The auto-detection in init.lua is the easiest extension point. To add support for a new inventory, lockpick or gang system, append your resource name to the corresponding list in init.lua and implement the matching branch in server/door.lua (GetItems callback) or client/door.lua (gang check block). No core code changes are required.