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 Config Studio panel.

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

There is no .cfg file to edit. dirk_lib auto-detects the resources it works with, and everything else is configured in-game through Config Studio, the one panel that every dirk script is edited in.

• /dirk_config — opens the Studio on an overview; pick a script from the rail.
• /<resource_name> — e.g. /dirk_lib, /dirk_fishing. Opens it with that script already selected.

By default only players with the admin ACE permission can run those commands. That is a convar, and it is the one thing worth setting before you start — see below.

---

#🔐 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).
• Granted access (Admins page): purely additive grants made in /dirk_config → Admins — a person or an ACE group, at edit or view level, covering every script or only the ones you choose. Scripts used to carry their own Access tab; those grants are folded into this page automatically.

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

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 two 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: however the granted-access list ends up, the master still works, because it's read from server.cfg and never from the database. The grants live in their own dirk_admins table for the same reason — keeping the access list inside the config it guards would mean a bad write could lock everyone out of the panel that would fix it. Editing the master from inside the panel would defeat the escape hatch, 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 (granted in most txAdmin and framework cfgs). Not in the default list; add it if that is what your cfg grants.
• 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"

#Locked out?

If /dirk_config says you have no access, nothing in the panel can help — you cannot open it to fix it. Set the convar from server.cfg (or the txAdmin console) and restart dirk_lib:

properties
setr dirk_lib_master_group "group.admin,admin,command,mod"

Every value is passed to IsPlayerAceAllowed in turn and any one of them is enough, so adding to the list can only widen access, never narrow it. If you are unsure which permission your server grants, list all the candidates — there is no cost to a value nobody has.

The server console itself always has access (src = 0), so dirk_config typed at the console works even when no player can get in.

---

#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 bridges to, or autodetects, a long list of frameworks, inventories, targeting resources and more — see Bridging for the full tables.