Getting Started

#🚀 Quick Start

Ensure dirk_lib is started after your framework, inventory, and targeting resources. There is no .cfg file to edit — dirk_lib auto-detects supported resources and exposes everything else through its in-game configurator.

properties
# Example start order
ensure qb-core
ensure ox_inventory
ensure ox_target

ensure dirk_lib

That's it. No convars, no setup file — start the server and configure live in-game.

---

#⚙️ Configuring dirk_lib In-Game

dirk_lib is configured entirely through its in-game Live Script Configurator. Settings save to the dirk_scriptConfig database table and apply live — no resource restart, no SQL edits.

#🔐 Access Control

Two layers control who can edit which scriptConfigs:

• Master ACE permission (convar): the floor — anyone matching this permission can edit any registered scriptConfig (including dirk_lib itself).
• Per-resource overrides (Script Config tab): purely additive grants for non-master ACE groups or specific player identifiers, set per-resource.

properties
# server.cfg — defaults to "group.admin,admin,command" if unset
setr dirk_lib_master_group "group.admin,admin,command"

The convar accepts a comma-separated list of values. Each is passed to IsPlayerAceAllowed in turn — if any one of them allows the player, they're treated as master. The default covers the three permissions most server.cfgs grant to admins, so it works out of the box on stock txAdmin / QB / QBX / ESX setups without configuration.

The convar is the escape hatch: even if a per-resource override save goes wrong, the master still works because it's read from server.cfg before scriptConfig loads. Editing the master from inside the panel would defeat that, so it's intentionally convar-only.

Common values you can put in the list:

• group.admin — principal membership (works when the cfg has add_ace group.admin group.admin allow).
• admin — bare permission (works when the cfg has add_ace group.admin admin allow).
• command — built-in admin permission (default in most txAdmin and framework cfgs).
• mod, command.dirk_config, etc. — any custom permission your cfg grants.

If your server only allows mods (not admins) to edit, replace the default with your own list:

properties
setr dirk_lib_master_group "group.mod"

For per-resource grants beyond the master, see the Script Config tab inside /dirk_lib.

The configurator has seven sections.

---

#🎨 Appearance

Global UI theme used by every dirk_lib-powered NUI. Pick a Mantine palette key (e.g. blue, grape, teal) or use the built-in dirk palette and customise the 10-stop colour palette directly. The shade index (0 lightest → 9 darkest) controls which colour is picked as the primary accent for buttons, borders and highlights.

---

#🏷️ Branding

• Server Name — string shown across NUIs that surface a server name.
• Logo — URL or nui:// path to your server logo, displayed in dirk_lib menus.
• Item Image Path — defaults to auto (resolves from your detected inventory), or override with a full nui:// / CDN URL.

---

#🌐 Localization

• Language — locale code (e.g. en, es, fr, de, pt, nl). This is the global language for every dirk_lib-consuming resource — switching it here changes the locale used by dirk_fishing, your custom scripts, and anything else that calls lib.locale().
• Currency — symbol prefixed to money values rendered by dirk_lib UIs.

---

#🔌 Bridging

This is where dirk_lib decides which third-party resources to talk to. Every resource bridge defaults to auto so you don't normally need to touch anything — install the resources and dirk_lib will detect them.

UI Providers

dirk_lib ships its own UI components but defaults every UI provider to ox_lib — servers running ox_lib get its native UIs out of the box without configuration. Switch any of these to dirk_lib to use the built-in NUI instead.

---

#👥 Groups

Defaults for the dirk_groups system: max members, max invite distance, invite-valid time, log-off kick time.

---

#🛡️ Script Config

Per-resource access overrides for /dirk_config. The master ACE permission (set via the dirk_lib_master_group convar) is shown read-only at the top — that's the floor.

Below it, add per-resource overrides:

• Resource — pick one of the registered scriptConfig resources from the dropdown.
• ACE Groups — extra permission strings checked via IsPlayerAceAllowed. Anything FiveM ACE recognises works (group.mod, dirkscripts.command.druglabs, custom permissions). Press Enter to add a tag.
• Player Identifiers — specific players granted access regardless of group membership. The dropdown shows currently online players; you can also paste a known identifier directly (license:, steam:, discord:, etc.) for offline grants.

Each row's grants are additive — they only add edit access for that resource. They cannot remove access from the master, and dirk_lib itself is master-only by design (so a non-master can never grant themselves master-tier access via the panel).

---

#🔧 Advanced

Manual JSON edit, history / audit log, reset-to-defaults — same controls as every other dirk configurator.

---

#Developers

To use dirk_lib in your own resource, include the shared script in your fxmanifest.lua:

lua
shared_scripts {
  '@dirk_lib/init.lua'
}

You can pre-load specific modules (modules also dynamically import on use):

lua
dirk_libs {
  'math',
  'objects'
}

---

#Supported Resources

dirk_lib supports two kinds of integration:

• Bridge systems — resources with dedicated bridge implementations under dirk_lib/bridge/*
• Autodetected integrations — resources detected from src/autodetect.lua. Both can be auto-selected or forced via the Bridging section in the configurator.

#Bridge Systems

#Other Autodetected Integrations