nCore Inventory – grid inventory with bags, clothing items and a 3D gun bench documentation

This is the reference for server owners and script authors. README.md is the short overview, FEATURES.md the full feature list and INSTALLATION.md the setup guide.

Most settings live in config.lua. Items, stashes, shops and benches have their own files: data/items.lua, data/stashes.lua, modules/shop/shops.lua, modules/craft/benches.lua and modules/gunbench/benches.lua, plus the language packs in locales/. shared/defaults.lua fills in any key your own config.lua does not have, so keep your config.lua when you update and copy the new shared/defaults.lua over the old one. The admin panel's Config tab shows for each setting whether it takes effect at once or after a restart.

1. Where each feature is
2. Item definitions
3. Settings
4. For script authors
5. Admin

1. Where each feature is#

"Target eye" means ox_target or qb-target. Where a row names the target eye and neither of them runs, the same thing is an E prompt. Exceptions: "Give an item" and "Offer a bite / sip" are target eye options only (use drag, the right-click menu or /give instead), ground piles always open with E, and world stashes keep their marker and E prompt next to the target eye.

All built-in E prompts share one key: only the nearest one shows, one press does one thing, and they wait while a request prompt is up, while you place or throw, or while another resource shows its own GTA help text (ncore_character's counter prompts excepted, they run through the inventory's own hints). When another resource's help text makes an E prompt step aside, the client console says so once (info).

Panel and hotbar#

Items and the ground#

Players#

Vehicles and keys#

Weapons#

World#

Automatic systems#

Admin#

2. Item definitions (data/items.lua)#

Items are defined in data/items.lua, or registered from another resource with the server export exports.ncore_inventory:RegisterItem(name, definition), which returns ok, why. A name already in data/items.lua is refused; a resource may register its own item again to replace that definition. Item names are 1 to 64 letters, digits, _ and -. Old or foreign item names belong in data/aliases.lua, where each one resolves to the item it names.

Every definition is checked when it is loaded or registered. A wrong value is ignored or corrected, and the console names the item and the cause.

Basics#

Use, food and decay#

Containers and storage#

Rules: who may do what#

protected, locked and the binding can also be set on one stack with the server export SetItemFlags(inv, slot, { protected, locked, boundTo }) and read with GetItemFlags(inv, slot). Config.Protect.enabled = false turns all three off. Shipped examples: family_heirloom (locked), id_badge (bound to its first holder), quest_parcel (not tradable), case_file (no drop, throw or place), starter_box (bundle), crate_public and crate_gang (public and gang crates; change ballas to your gang).

Weapons, keys and clothing#

A gun or melee weapon item that does not stack gets its own id the first time it is drawn. Give guns unique = true anyway: a serial can only be filed off a gun that already has an id.

Reactions, blueprints and routing to other resources#

A route is skipped for container items, when the framework registers the same item as usable (the framework callback wins), and while Config.Use.routing = false. When the export's resource is not started, the use is refused before anything is spent.

3. Settings#

Every setting below lives in config.lua. The default is the value config.lua ships with. When a key is missing from your config.lua, shared/defaults.lua fills it in with that same value (only the lists Config.Player.tiers, Config.Combine.recipes and Config.Vehicles.loot come back empty), so you can delete what you never change. A setting saved from the admin panel's Config tab is laid over config.lua at every start until you use Reset to file there. Protected settings and prices are changed in config.lua only.

Units: distances are in meters, weights in grams (32000 is 32 kg), and keys that end in Ms are milliseconds. "Target eye" means ox_target or qb-target. A target setting of 'auto' (or true) uses whichever of the two is running and falls back to an E prompt where the feature has one (the give and offer options exist only on the target eye); 'ox_target' or 'qb-target' names one; 'prompt' always uses the E prompt.

config.lua is a shared script, so every player downloads it. Never put a password, a token or a webhook address in it.

Framework, storage and language#

Panel#

Players#

Vehicles and keys#

Stashes#

Food and bags#

Carrying and the ground#

Weapons#

Disposal#

Starter kit#

Modules#

Admin and debug#

Clothing#

Armor#

Hints#

Every key hint of the inventory (the stop key, E prompts, trade and search requests, the item in your hand, camera views, placing and throwing, first-time tips) goes through one owner, so two hints never fight over GTA's single help box. The key caps show the key each player actually bound.

Demo#

All presenter keys are key mappings, so players can rebind them in FiveM's key settings.

Data files#

These files hold the world content. Each one documents its own fields at the top.

modules/shop/shops.lua:

• A shop has id, label, locations (each counter gets its own shelf), blip, job and grade or groups, stock rows { item, price, count } (count per counter), categories and ped (the clerks, one per counter).
• Stock rows may add grade, groups, requires = { item, count, take }, metadata and category. A clothing row may add label and a look.
• sellBack = true makes a shop buy back at value x Config.ModuleSettings.shop.sellRate; stockOnly = true limits that to items the shop sells itself. The hardware store and Binco ship with both.
• type = 'fence' or 'pawn' makes a counter that only buys (buys, illegalOnly, capacity, hours). A fence pays black money, a pawn shop cash.
• openBy = 'export' makes a counter with no locations that only OpenShop opens, like pharmacy and clothing_buyback.
• blip.yieldTo and ped.yieldTo name a resource that marks the same store; while it runs, the shop draws no blip and its clerk stands down. Binco yields to ncore_character.
• enabled = false keeps a shop as a template that is not built.

data/stashes.lua:

• A stash has id, label, coords (one vector3 or a list), slots, maxWeight (grams) and owner: 'shared' (one box), 'player' (one box per player) or 'job' (one box per job).
• job with grade, jobs = { job = grade } and groups = { name = grade } are one gate (groups is read first, then jobs, then job). A field that is set but names no usable job or gang skips the stash with a console error instead of opening it to everyone. A 'shared' stash with no gate is public.
• accepts, rejects and caps limit what goes in; takeGrade is the rank needed to take items out.
• cold = 'fridge' or 'freezer' makes it cold storage (the two Yellow Jack stashes ship that way).
• wardrobe = true adds the Outfits button and needs Config.Clothing.asItems. The shipped wardrobe_store stands at eight clothing stores, one box per player.
• lock = true opens it only for a player carrying a stash key cut for this id.
• enabled = false keeps an entry as an example.

modules/craft/benches.lua:

• A bench has id, label, blip, track (the progress track), locations and recipes.
• A location is a vector3, a vector4 (the heading is ignored) or { coords, prop = { model, heading } }. With a prop the game draws the bench object within 60 m; prop = true uses the default model, and a model the game build lacks falls back to prop_tool_bench02.
• A recipe has item, count, time, costs, tools (with wear), and may add chance, level, blueprint with blueprintMode, and hand = true to craft it anywhere.

4. For script authors#

Every export is called as exports.ncore_inventory:Name(...). Exports are server side unless the heading says client. A call that is refused returns false (or nil, or 0 for a count) plus a reason string; most reasons are keys from locales/en.lua, where the sentence the player would see lives. Item names, stash ids and every other id are the ones in your data files.

Inventory ids and slot numbers#

inv in the tables below is a player's server id. With Config.Compat.containerTargets = true (the default) the item exports also take:

• a registered stash id ('police_locker' or 'stash-police_locker'), or { type = 'stash', id = 'police_locker', owner = ... } for a per-player or per-job stash
• a vehicle part: 'trunkABC123', 'trunk-ABC123', 'gloveABC123', 'glovebox-ABC123', or { type = 'trunk', id = 'ABC123' }; it is loaded from its spawned vehicle, and with no vehicle carrying that plate the call is refused with vehicle_not_loaded
• the id of any loaded container

A stash that is not in memory yet is loaded first; the call waits up to Config.Compat.loadMs (3000) for it. Container kinds listed in Config.Compat.refuseKinds (worn clothing, crafting queues, trade escrow, admin views, shop and bench fixtures and similar) never answer to an id. When a call names something nothing answers to, the console says so once per resource and id form. UseItem takes a player only, and SetSlotMetadata takes the inventory's own container id.

For a player, "what they carry" is the pockets, the worn bags and every container nested in them. Slot numbers from 1 to the pocket slot count are the pockets; higher numbers continue through the worn bags and their nested containers in a fixed order. GetSlot, the slot argument of RemoveItem, SetMetadata, RepairWeapon and SetDurability read slot numbers this way. In Search and the GetSlot*WithItem calls a row from a bag comes back with slot = nil and container = <id>; GetSlot keeps the number you asked for and adds container.

Metadata filters: a string is read as { type = value }. Without strict a stack matches when it carries every key you pass with the same value. With strict it must match exactly, apart from fields the inventory stamps itself (such as uid) that you did not pass.

Item exports#

Search, HasItem, GetItemByName, GetItemsByName and the qb-inventory GetItemCount leave out a door key the player may not use: one cut for another job or a higher grade (IssueKey with job and grade), or one cut before the door was re-keyed with RevokeKeys. Door scripts that check keys through those calls (ox_doorlock, qb-doorlock) then refuse such a key.

Stashes, piles and opening#

Client: OpenStash(id) asks the server to open a stash. A stash that is not per-player and has no coords and no groups is opened by a server script only, unless Config.Stashes.clientOpenUnguarded = true. SetStashTarget(id) makes the next press of the inventory key open that stash (nil clears it); GetStashTarget() reads it.

Players, trades and searches#

Capacity and item flags#

Weapons#

Using, portions and item buttons#

An item can also list buttons in its definition: buttons = { { id = 'inspect', label = 'Inspect', icon = 'inspect' } }. Pressed with no registered handler, such a button fires the server event ncore_inventory:itemButton (source, id, item, ref).

Client: AddItemButton(item, id, label, handler, { group, icon, close }) adds a button that runs handler({ name, slot, container, count, metadata }) on the client. The server is not asked, so do not change items from it. RemoveItemButton(item, id) takes it off.

Clothing#

Premium coins#

These need Config.Premium.enabled = true (it ships off); until then they answer false, 'premium_off'.

Client: GetPremiumCoins() is the balance the server last sent this player.

Vehicles and keys#

exports.ncore_inventory:IssueKey(source, 'vehicle', 'ABC123', { model = GetEntityModel(vehicle) })
exports.ncore_inventory:IssueKey(source, 'door', 'mrpd_front', { item = 'key_job', job = 'police', grade = 2 })

Kinds are 'vehicle' (plate), 'house' (property id), 'door' (door name or id) and 'stash' (stash id). Options: valet = true (a valet key), model (a model name or hash; with Config.Keys.vehicle.matchModel = true, the default, the key only works on that model under that plate), type (a door script's door type; with nil as the target the key opens by type alone, which needs ox_doorlock 1.18.0 or newer), script (the housing resource), address (text on the key, up to 64 characters), houseKey (the housing script's own key id), job and grade (only that job from that grade may use it), item (a specific key item of that kind).

Shops#

local ok, idOrReason = exports.ncore_inventory:RegisterShop('mystore', {
    name = 'My store',
    inventory = { { name = 'water', price = 10 }, { name = 'weapon_pistol', price = 2500, license = 'weapon' } },
    locations = { vector3(25.7, -1347.3, 29.49) },
    groups = { police = 0 },      -- optional
    blip = { id = 52, colour = 2, scale = 0.7 }
})
exports.ncore_inventory:OpenShop(source, 'mystore')

RegisterShop(id, data) takes the ox_inventory shape (a stock row may also carry count, metadata, currency and grade). CreateShop(data) takes the QBCore shape ({ name, label, coords, items = { { name, price, amount, info } } }, or a table of such shops keyed by name). A shop registered while the shop module is still starting is queued, built the moment the module starts, and the call returns true, id. A refusal returns false and a reason, for example shop_runtime_off, shop_bad_id, shop_off, shop_id_taken or shop_bad_spec, and is logged. A shop is removed when the resource that registered it stops. Price and stock edits made in the admin panel are applied again each time that resource registers the shop.

OpenShop(src, id) returns true, containerId or false, reason. With locations, the player must be within Config.ModuleSettings.shop.openDistance plus 1 meter of a counter. A shop registered with no locations opens anywhere, through OpenShop only. ShopList() returns {} while the shop module is off, starting or failed. A gun with a serial bought in a shop is registered to the buyer, unless its row has metadata = { Registered = false }.

Client: OpenShop(id) asks to open a shop; IsShopkeeperPed(ped) says whether a ped is one of the inventory's shopkeepers.

Crafting and benches#

-- server
local ok, wasKnown = exports.ncore_inventory:ForgetCraftRecipe(source, 'workbench:advancedlockpick')
local ok2, result = exports.ncore_inventory:ResetCraftQueue(source, { to = 'pockets', collect = true })

A recipe id is the recipe's own id, or the bench id, a colon and the item it makes ('workbench:advancedlockpick').

The gun bench, the crafting benches and the queue each need their module on. Client: OpenBench(benchId, index) and OpenGunbench(benchId, index) send the request and return true whatever the server decides (false while the module is off).

Hooks: RegisterHook#

local id = exports.ncore_inventory:RegisterHook('take', function(p)
    if p.item == 'evidence_bag' and p.action == 'drop' then return false end
end, { itemFilter = { 'evidence_bag' } })
exports.ncore_inventory:RemoveHooks(id)   -- or RemoveHooks() for all of yours

RegisterHook(event, fn, options) returns a hook id, or nil and unknown_hook_event or not_a_function. event is one of the names below or a list of them. Returning false from fn refuses the action (the player sees refused_by:<your resource>); anything else lets it through. A hook that errors lets the action through and the error is logged; one that takes 100 ms or more is logged as slow. Your hooks are removed when your resource stops.

Options: itemFilter (item names), inventoryFilter (Lua patterns matched against inventory ids; with oxIds = true they are also matched against ox-style ids such as 'police_locker' or 'trunkABC123'), typeFilter (container kinds such as 'player', 'stash', 'drop', 'trunk', or a shop id for buy), actionFilter, print = true (logs each run).

Slot payloads (fromSlot, toSlot) are { name, label, count, slot, metadata, weight }, except a move into an empty slot, where toSlot is the slot number.

Events#

Server events (AddEventHandler on the server):

Client events (AddEventHandler on the player's own client):

Alcohol and drug items also send evidence:client:SetStatus. Food, drink and smoking items that the framework also registers as usable are eaten, drunk and smoked by the inventory while Config.Use.preferPortions = true, and the framework's callback is not called for them; listen to the events above instead.

With Config.Compat.oxEvents = true and no other ox_inventory running, these ox_inventory events are fired as well: ox_inventory:openedInventory, ox_inventory:closedInventory and ox_inventory:usedItem on the server (ox-style ids such as 'police_locker', 'trunkABC123' or 'drop-5'; a player inventory passes the inventory's own id), and ox_inventory:updateInventory, ox_inventory:itemCount, ox_inventory:usedItem, ox_inventory:currentWeapon and ox_inventory:updateWeaponComponent on the client.

Weapon registration: weaponRegistered#

-- server
AddEventHandler('ncore_inventory:weaponRegistered', function(e)
    -- e.source, e.item, e.label, e.serial, e.owner, e.uid, e.container, e.how ('purchase' or 'issued')
end)

It fires when a gun with a serial and a registered owner is bought in a shop ('purchase') or handed out by a script or an admin ('issued'). A gun with no registered owner has a serial but does not fire it. The serial is also sent to an MDT: with Config.Weapons.mdt = 'auto' to ps-mdt when it runs, a resource name sends it to that resource's CreateWeaponInfo export, and false sends nothing.

State bags#

Set by the inventory:

Read by the inventory, set by your scripts on the player:

Other lri_ keys are the inventory's own; do not write them.

Client exports#

With Config.Compat.clientMirror = true the player's pockets are mirrored to their client for the ox-shaped client exports GetPlayerItems, GetPlayerWeight, GetPlayerMaxWeight, GetSlotWithItem, GetSlotIdWithItem, GetSlotsWithItem, GetSlotIdsWithItem, useSlot(slot), useItem(data, cb) and giveItemToTarget(serverId, slot, count).

-- server
local has, item = exports.ncore_inventory:HasPhone(source)
-- client
local has, item = exports.ncore_inventory:HasPhone()
AddEventHandler('ncore_inventory:phoneCarried', function(has, item) end)

Key hints: Hint and HintKey#

local token = exports.ncore_inventory:HintKey(47, 'G')   -- '~INPUT_DETONATE~': the cap shows the key of control 47
CreateThread(function()
    while nearMyThing() do
        local shown = exports.ncore_inventory:Hint('open', token .. ' Open the safe', { lane = 'prompt', d = distance, ttl = 300 })
        if shown and IsControlJustReleased(0, 47) then openSafe() end
        Wait(0)
    end
    exports.ncore_inventory:Hint('open', nil)
end)

With your own key mapping, act in the command and gate it on the last answer, so the cap and the key are always the same binding:

local shown = false
RegisterCommand('my_command', function() if shown then openSafe() end end, false)
RegisterKeyMapping('my_command', 'Open the safe', 'keyboard', 'G')
local token = exports.ncore_inventory:HintKey('cmd:my_command', 'G')   -- '~INPUT_xxxxxxxx~' of your mapping
CreateThread(function()
    while nearMyThing() do
        shown = exports.ncore_inventory:Hint('open', token .. ' Open the safe', { lane = 'prompt', d = distance, ttl = 300 })
        Wait(0)
    end
    shown = false
    exports.ncore_inventory:Hint('open', nil)
end)

• Hint(id, text, opts) shows text (GTA help format: ~INPUT_PICKUP~, ~n~, ~r~/~g~/~y~/~b~/~s~) in the inventory's own hint stack for opts.ttl ms (100 to 10000, default 300): call it again for as long as you want it shown. nil text hides it. The id is private to your resource. It returns shown, active, why: shown is whether it is on screen now (gate your key on it so one press never does two things), active is Config.Hints.enabled, why says why it is not shown (for example 'wait' on the first call, 'lane' when another hint won, 'panel', 'pause', 'hud', 'limit').
• opts: lane is 'prompt' (an E or G style prompt, priority up to 50, default 30), 'action' (what the player is doing, up to 75) or 'notice' (a tip or message, up to 90; the default lane; default priority 20 for both); prio; d (meters, nearer prompts win); tone ('prompt', 'act', 'stop', 'warn' or 'note'); icon ('stop', 'person', 'action', 'inspect', 'alert' or 'use'); rows (1 to 3 lines, default 2); beep = true; tip = true to follow the player's Key hints preference.
• At most 8 hints per resource at once; they all go when your resource stops. Text is cut to 600 characters.
• HintKey(spec, fallback) gives the help-text token for a control index (38), a control name ('PICKUP') or a key mapping ('cmd:<command>', exactly as registered). For a key mapping it is ~INPUT_%08X~ of the command's hash. fallback is the keyboard key shown when the game cannot read the binding. Never mix the two: a cmd: cap with an IsControlJustReleased check shows one key and acts on another after a rebind.

Demo character: DemoPed and ncore_character#

-- server
local ped = exports.ncore_inventory:DemoPed(source)
-- client, for UI only
local ped = exports.ncore_inventory:DemoPed()

Both return nil, 'own', 'mp' or 'gta'; the server value is read from server state only.

While the value is 'mp' or 'gta', ncore_inventory saves no worn clothes back to illenium-appearance, fivem-appearance, skinchanger or qb-clothing, and adopts no external appearance save.

With ncore_character:

• Its server export DemoAware() returns true. nCore Inventory reads it before it lends the MP character; without it, the stop with the MP character keeps the presenter's own character.
• Its items-only clothing store serves MP (freemode) characters only; a GTA character gets app_shop_mp_only.
• While DemoPed is 'mp' or 'gta', ncore_character refuses its counters with app_demo_ped, except that an 'mp' presenter can still use the items-only clothing store, and it never saves or adopts the demo look.

Combine recipes#

Config.Combine.recipes = {
    { a = 'weed_og', b = 'rolling_paper', result = 'joint', count = 1 },
    { a = 'lockpick', b = 'wrench', result = 'advancedlockpick', count = 1, keepB = true }
}

Drag a onto b or the other way round. count is how many results one combination makes, and one drag combines as often as both stacks allow. When the results do not fit, the batch is halved until it does, or the drag is refused with combine_no_room. keepA or keepB = true means that ingredient is not used up (a tool); a kept ingredient is not checked or worn. A spoiled ingredient is refused when Config.Decay.refuseSpoiled = true. Combining fires the craft hook.

Compatibility switches (Config.Compat)#

The bundled ox_inventory folder forwards ox_inventory calls to this resource through OxAddItem, OxRemoveItem, OxOpen, GetOxInventory, OxClientInventory and OxClientCount; call the exports above instead.

Migration: invmigrate#

Server console only, with oxmysql and Config.Database.prefer left at 'auto' or 'mysql' (with 'kvp' or 'none' the command refuses):

invmigrate <metadata|qb|esx|split|kvp> [apply] [merge] [skipunknown]

Without apply it is a dry run that prints what it would import and every item name it does not know. apply writes, only with nobody online, and refuses while names are unknown unless skipunknown is given, which leaves them behind. merge adds to inventories already saved here. The source tables are only read. The command name is Config.Migrate.command.

kvp copies inventory and container rows only, and skips an owner who already has rows in the database (so a player who joined before the import keeps the new inventory and their KVP one is left alone). Premium coin balances are read from KVP until each one is next saved to the database. Old log lines stay in KVP; with Config.Logs.store = 'auto' the Logs tab then reads the database only. Item edits made in the admin panel are always kept in KVP.

5. Admin#

Aces#

add_ace group.admin lri.admin allow grants every admin part below. For smaller staff roles, grant single parts instead, and always include lri.admin.panel: the panel, the shield button and the panel key open only with it, so a role that holds only lri.admin.logs or lri.admin.economy can run that part's commands but cannot reach its tab. The ace names follow Config.Admin.ace (default lri.admin) and Config.Admin.labAce (default lri.lab). A deny entry is respected. A refused admin gets the exact add_ace line as a notification, and the server console prints the matching add_principal line.

The lab runs when Config.Admin.lab.enabled is true, or 'debug' (the default) while Config.Debug.commands is on. Debug mode grants nothing in the panel. The bench commands (invitem, invmoney, invfill and the rest) need Config.Debug.ace (default lri.admin); the server console always passes. With debug mode on, invgive and invkey also take Config.Debug.ace instead of lri.admin.give.

Give and edit#

The two parts that change items are split this way.

lri.admin.give:

• Items tab: the give sheet (item, count, metadata, clothing look) to yourself, a player, a container or the ground, and its "Take back" button.
• Items tab > Kits, and the carry check (can this player carry this many).
• Players tab > Take: moves a chosen stack from an online player into that player's held store. Return needs lri.admin.edit.
• The Demo tab, together with lri.admin.panel. Saving or clearing a stop spot also needs lri.admin.config.
• invgive and invkey while Config.Debug.commands is off.

lri.admin.edit:

• Opening an online player's inventory, or any container, in Edit mode (Read needs only lri.admin.panel).
• The stack editor on the Inventory tab, "Age this stack", slot moves, and the protected, locked and bound flags of a stack.
• Clear (everything except a keep list), Confiscate and Return on the panel, the same Confiscate and Return as invconfiscate and invreturn, and purging a held store.
• Editing an offline inventory and clearing it into a held store (both with lri.admin.storage).
• Deleting a storage (with lri.admin.storage), and opening a stash for editing from the Menus tab (with lri.admin.storage).
• The item editor: editing, creating, retiring and resetting item definitions.
• Changing crafting levels on the Capacity tab (with lri.admin.capacity), and invcraftxp.
• During a demo tour, searching, robbing or looting the presenter.

Revert on a log row needs lri.admin.logs and the part of the original action: give for a give, kit or take row; edit for a stack edit, clear, confiscate or remove row; capacity for a capacity row; config for a config or log switch row.

/invadmin#

/invadmin opens the panel, on the Testing tab the first time and then on the tab you last used. /invadmin <tab> [player id or container id] opens a tab directly: testing, demo, status, players, inventory, items, capacity, storages, shops, menus, economy, logs, config, registry, and while the lab runs scenarios, state, world, serverlab, probes, refusals, ui. /invadmin lab [scenario] opens the Scenarios tab and /invadmin release releases your lab changes; both need lri.lab. In the server console: invadmin status | lab | release <player id>.

The shield button in the inventory header and a key binding (Config.Admin.panelKey, no default key, set under FiveM Settings > Key Bindings) open it too. At start the console prints "Admins: /invadmin opens the panel and the test guide". The command name is Config.Admin.panelCommand; Config.Admin.panel = false removes the command and the button.

The lab tabs show only while the lab runs and the "Developer tools" switch at the bottom of the tab list is on.

Tabs#

• Testing: a guided test of 326 steps in 42 parts, in English and Hungarian. Setup buttons give items and kits, open the right tab or copy a server.cfg line. "Show on map" sets a waypoint and works with the lab off. Buttons that teleport you, put a vehicle next to you, force a state or give money need the lab, and a banner says so while it is off. Works, Broken and Skip marks are saved per inventory owner (the character on multi-character frameworks); a note of up to 240 characters can be added to a Broken mark. A mark belongs to the text of its step, so a step whose English text changes loses its mark. "Start over" clears the marks, and the bug report (broken, skipped and working steps with their text) can be copied.
• Demo: the guided showcase, see "Demo tab" below.
• Server status: version, framework, storage, maintenance state, items, locale parity, containers and the log store, refreshed every 5 seconds. A Platform card shows the framework, each module and whether it opens by ox_target, qb-target or E, the state of ox_lib, ox_target and qb-target, the compatibility folder, and how many hooks, item buttons and runtime shops other resources added. Other cards: an access probe with copyable allow and deny lines, conflicts with other inventories, modules, sibling resources, a framework probe with a test notification, performance and privacy. The maintenance lock (blocks every inventory write with a reason) and Save now need lri.admin.config.
• Players: online players with id, character, job, routing bucket, slots, weight, bags, ping and distance, refreshed every 3 seconds. Open a player Read or Edit; with Config.Admin.tellTarget on (default) the player gets a warning each time an admin opens them in Edit mode (not again while that admin keeps the same player open), and Read is silent. The player drawer has Mirror (your own inventory, read-only), a session inspector, Take, Clear, Confiscate and Return, and the held store (view, or Purge with a typed word). The offline player browser lists saved inventories to open read-only, edit (the player's login waits until you close it or Config.Admin.offlineEditMs runs out, 5 minutes by default) or clear.
• Inventory: the container tree of any player or container id, opening a container Read or Edit, the stack editor (durability, ammo, components, tint, serial, uses, armor, label, look, freshness, age, jammed, oxygen, count and more), "Age this stack" (needs Config.Decay.enabled), slot moves with a preview, a grid audit, a uid and serial lookup, and a memory versus saved comparison.
• Items: the catalog with what every item does on this server (handled here, by another script, a material, or waiting because its setting is off or nothing handles it), the give sheet, kits, and the item editor (label, weight, stack, value, picture, category, sub-class, rarity, English, Hungarian and local descriptions, protected, locked, tradable, bound, uses, per-action bans and crate access). The editor refuses a stack size below any stack that already exists. Simple items can be created, retired (shown behind the Retired filter) or reset to data/items.lua. "Open pose tool" needs lri.admin.pose.
• Capacity: slots, max weight and grid size per player (this session, kept across relogs, or back to the tier default; refused when items would be displaced), tiers, carry strength and a Crafting levels card.
• Storages: stashes, placed stashes, trunks, gloveboxes, bins, ground piles, held stores, offline players, hiding spots and craft queues, with search and paging. Every entry opens; Edit works while it is loaded and needs lri.admin.edit. Locate sets a waypoint for stashes, placed stashes, trunks and gloveboxes of a vehicle that is out, bins, piles and hiding spots. Delete asks for the typed id and is refused for player inventories, held stores, craft queues, bags, worn items, trades and containers inside other containers. invdelstorage <id> confirm does the same from chat or the console.
• Shops: per-row price and stock, adding (with its currency), removing and restoring rows, resetting a shop and restocking it now.
• Menus: open any shop, vending machine, crafting bench, gunsmith bench, stash or ncore_character menu for yourself. Purchases are paid from your own money.
• Economy: the money value of money items, framework accounts (online players by default; Config.Admin.economy.accounts = 'all' reads saved accounts and needs oxmysql and ESX, QBCore or Qbox), holders, storages and a per-item census, cached for 300 seconds. Click an item to see who holds it. The minting report lists which resources created items. A resource is flagged when its last full hour reaches minUnits (50) and more than spikeFactor (5) times its usual hour, the median of its active hours in the previous 168; it is judged only after 6 active hours, and item creation with no named resource (crafting, loot, starter kits) and the inventory's own admin gives are never flagged. A flag is printed, sent to online admins with lri.admin.economy and posted to the log webhook, once per resource per hour (Config.Admin.minting.announce, .notify, .webhook). It needs the creation log channel stored.
• Logs: time range, channel, op, actor, target, item, container, uid and text filters, paging, follow mode and copy as CSV. The Audit preset shows the admin and lab channels. Revert works on capacity, stack edit, give, kit, take, clear, confiscate, remove, config and log switch rows; a give or kit row reverts only while its stacks are in loaded containers. Item history by uid or serial shows the newest 200 rows within Config.Logs.keepDays. Log switches for the creation, destruction, transfers, shop and craft channels need lri.admin.config.
• Config: every setting with when it takes effect (live, client, page, restart, protected, price). A session change of a live setting applies server-wide at once; a session change of a client or page setting reaches only your own client. A saved change applies at every start. Protected settings and prices are changed in config.lua only. Reset to file removes a saved change.
• Registry: what other resources added: items, hooks, item buttons, stashes, benches, shops and modules.

Demo tab#

A guided showcase of the inventory for recording a video: 10 themed stops and 6 bonus stops, defined in data/demo.lua. It needs lri.admin.panel and lri.admin.give, and Config.Admin.demo.enabled (default true).

• Start the tour parks your own items in a held store and remembers your worn clothes, bag and vest. Every stop wipes your pockets and gives that stop's kit, plus its cash, bank money and vehicle where the stop has them (the Car Keys, Trunk & Glovebox stop brings a damaged van with keys). Each stop's kit is also listed under Items tab > Kits as demo.<stop id>.
• End the tour, or your next join after a disconnect, crash or restart, removes the demo items, cleans up the demo's own ground piles, crates and vehicles, and gives everything back, worn clothes, bag and vest included. Crafting jobs queued, outfits saved, recipes learned, crafting XP earned, recipes a stop reset, and hunger and thirst lowered during the tour are put back. The closing card then shows for 14 seconds.
• Briefing: before each stop a full-screen briefing shows its whole script only to you ("Only you see this. It is not in the video."). Enter departs; "Stay here" cancels.
• Travel and look: travel uses the GTA sky camera, or a fade. Each stop sets your local time of day and weather. Every stop turns you into a fitting GTA character, and the Clothing as Items stop makes you the Binco model, a GTA Online character dressed only in clothing items. Your look comes back at the end through your appearance resource, or from a snapshot when there is none. With Config.Admin.demo.timeSync on and qb-weathersync started, the tour sets the whole server's time and weather until it ends (see section 3).
• Cleanup: every demo item carries a hidden tag and is removed from pockets, bags, piles, crates, vehicles, stashes and other players at each stop, at the end and when a new tour starts; a container that was not loaded is cleaned when it loads. Demo items on a craft output shelf are removed too.
• Protection: while a tour runs, nobody without lri.admin.edit can search, rob or loot the presenter or the demo piles.
• Money: cash is the cash item where money is an item; otherwise it is paid into the framework cash account. Paying into the cash or bank account needs the full lri.admin ace. At the end, up to the amount paid is taken back, never below the balance the tour started with.
• Buttons: "Retake this stop" restarts the current stop from the top with a fresh kit (cash and bank money are topped up to the first take's balance, not paid twice). "Give the items again" refills the kit without a wipe. "Back to where I started" takes you home during a tour, or within 15 minutes after a tour wound up on join. "Clean up leftovers" removes demo piles, crates, vehicles and tagged stacks now. Each stop card has "Show on map". "Video intro", "Opening card" and "Closing card" show those overlays.
• Spots: "Save this spot for the stop" stores a corrected stop position on the server, "Use the shipped spot" drops it, and "Copy spots as Lua" copies a -- <stop id> line and a coords = vector4(x, y, z, h), line for each saved stop, to paste over that stop's coords line in data/demo.lua. Saving needs lri.admin.config.
• Options: chips saved in your browser, with defaults from Config.Admin.demo: Fresh pockets at each stop (fresh), Cinematic time of day (clock), Sky camera travel (travel), Arrival camera (introCam), Arrival title card (titleCard, default off), A fitting ped at every stop (autoSkins), Orbit camera in the intro (introOrbit) and Feature callouts (callouts, default off). The script language is auto, en or hu.
• Admin panel at a point: a point with admin = '<tab id>' opens that tab instead of the Demo tab when you open the panel there, so the Demo dashboard never reaches the video.

Presenter keys#

The keys work while a tour stands at a stop, also with the inventory open. They are FiveM key bindings, so each presenter can rebind them under Settings > Key Bindings; the defaults come from Config.Admin.demo.

With callouts = false (default) only the Delete key shows callouts. With true, callouts also fire on their own when their container opens or their cue runs, and the tour.firstOpen callouts show at the tour's first inventory open. Config.Hotbar.slots ships at 5, so 6 and 7 are free; if you raise it above 5, rebind the presenter keys.

Demo stops#

Stops, kits and script text live in data/demo.lua. The file is checked when the Demo tab loads it; a wrong field stops the tour and the console names the stop and the field.

Item rows are { name, count, meta } and may add bag = true (worn on the back; one per stop), ground = true, into = '<item of an earlier row>', ifMissing = true, look and worn. An item the server does not have is left out with a console warning. meta can carry the admin-give keys jammed = true (firearms) and oxygen = 90 (whole seconds of air in diving gear).

• look = { m = { parts }, f = { parts } } gives a clothing item exactly that look for each body. A part is { c = component or a = prop anchor, d = drawable, t = texture, col = collection }; col defaults to '' (the base game). A look the clothing index refuses leaves the row out, with a console warning.
• worn = true puts the piece straight on the Binco model: it needs ped.mp, a look, a count of 1 and one row per area, and it cannot be used on the bag, vest or gloves areas.

The shipped tour needs a second player within 30 m for the Give, Trade & Search stop, the diner's third point and the police station's third point, an on-duty police job of grade 1 or higher for the Police Armory & Forensics stop, and a status system for the diner's first point.

The Clothing as Items stop (ped.mp):

• On arrival the stop builds a GTA Online (freemode) character: a face, hair, eyebrows and the stop's worn items. The body is the presenter's own when they play a freemode character, otherwise Config.Admin.demo.mpSex. During the stop the presenter wears a memory-only stand-in closet, so their own worn clothes are never moved, sold or saved over. Leaving the stop or ending the tour takes the demo pieces off, sends pieces bought at the stop to the pockets, and brings the own closet and character back. With clothing as items off or skins off, the stop keeps the presenter's own ped and gives the worn rows into the pockets.
• With ncore_character running, the Binco model needs ncore_character 1.0.4 or newer (the build with the DemoAware export). With an older build the stop keeps the presenter's own character and puts the worn rows in the pockets, and a one-time console warning names the reason.
• When the own character cannot be confirmed after the tour (also for a tour wound up on join), DemoPed stays gta: appearance saves stay off, ncore_character keeps every counter except the items-only clothing store closed, and a new tour is refused. This lasts until the server sees the presenter's own model again, or the presenter switches character or joins again. Ending the tour while dead at this stop is refused ("You are dead. Get up first.").
• Do not open another appearance script's own clothing menu (illenium-appearance, qb-clothing) at this stop. That menu saves the whole look it shows, the Binco model's face included, as the presenter's own, and the demo cannot stop a save made inside another script.

Demo video fields#

The overlays of the recorded tour (arrival title card, video intro, feature callouts, opening card and closing card) take every word from data/demo.lua; nothing for the video is in the locale files.

• Stop fields: kicker (en and hu), emblem = { item = 'name' } (or { icon }), chips (up to 3 of { icon | item, label, at?, instead? }), intro = { promise, cards } (2 to 4 cards of { icon | item, label, sub, at?, instead? }) and callouts (up to 12 of { at, key = true | cue = 'x' | on = 'trunk|glovebox|stash|container|drop' | stash = 'id', style = 'full|compact|slam', spare?, icon | item, label, sub }). intro = { blurb, points } with 2 to 5 lines is also accepted. A slam callout takes no sub.
• at and instead: at ties a chip or card to a point. When that point's need is missing, the entry is dropped, or replaced by instead. instead may carry its own at: instead = { at = 4, icon | item, label, sub? }; when that point's need is missing too, the entry is dropped (the diner shows "Spoiled Food" only while the spoiled-sandwich point runs).
• Callouts: each takes exactly one trigger: key = true (the Delete key), cue (the cue its point runs), on (that kind of container opens) or stash (that stash opens). A spare = true callout is a key = true callout shown after the others. Over the open inventory a callout is always compact (a slam too) and sits bottom left, or top left when the panel fills that corner; in the 3D gun bench it is compact at the top center.
• Tour fields: tour = { title, outro, brand, tagline, proof, badges, pitch, pills, cta, url, by, firstOpen }. title and outro are required; brand and url are short plain lines; badges and pills hold up to 10 each. The opening card and the closing card read these. The closing card shows cta and url as text.
• tour.firstOpen: up to 3 callouts (compact or full) shown at a tour's first inventory open while automatic callouts are on. A row may carry need = 'grid' (shown only with Config.Grid.enabled = true) or need = 'tabs' (shown only when Config.Categories is exactly items, keys, weapons, clothes, bag), and {key} in a sub line is replaced with Config.Grid.rotateKey. The shipped two name the grid and the five tabs.
• Points: admin = '<tab id>' (lowercase letters, up to 16, for example 'logs' or 'items') opens that admin tab instead of the Demo tab, see "Admin panel at a point" above.
• Checks: icons must be glyphs the page draws, pictures must be items (an unknown item shows a box glyph with a console warning), every at must name an existing point, and a cue callout must sit on the point that runs that cue.

Kits#

Items tab > Kits gives a kit to yourself, another player, a container or the ground (a pile at your feet, in your routing bucket). It needs lri.admin.give. The result has a ticket, and "Take back" undoes it while the server runs. After a restart, Revert on the kit's log row undoes it (needs lri.admin.logs and lri.admin.give), while the given stacks are in loaded containers.

The list shows, in this order:

• Your own kits from Config.Admin.kits (the shipped config has starter).
• Preset kits from data/admin_scenarios.lua: Food and drink, Medical, Tools, Containers, Evidence. Each demo stop's kit (demo.<stop id>) is listed here too.
• Built in: Every firearm, loaded (a full magazine each); One of every stackable item (blueprints included); One of every evidence item; One of every key item; 1000 of each money item; and "Everything for <bench>" for each crafting bench (the materials and tools of all its recipes).

Config.Admin.kits = {
    starter = { label = 'Starter pack', items = { { name = 'water', count = 2 }, { name = 'sandwich', count = 2 }, { name = 'bandage', count = 2 } } },
    patrol = { label = { en = 'Patrol kit', hu = 'Járőr csomag' }, items = { { name = 'weapon_pistol', count = 1 }, { name = 'ammo-9', count = 48 } } }
}

A kit id is up to 64 letters, digits, _, ., : and -. Each row is { name, count, meta }; count defaults to 1. A wrong row is left out with a console warning.

Admin commands#

The commands also run in the server console, except invview, /invslings, /invpose and /invthumbs. The names of invview, invconfiscate and invreturn are Config.Admin.viewCommand, .confiscateCommand and .returnCommand.

/invpose#

Needs lri.admin.pose and Config.Poses.enabled (true, or 'debug' with debug mode on). /invpose [item] opens the pose tool; it also opens from the Items tab and from a key binding with no default key (Config.Poses.key). It edits the pose of an item in the hand, on the ground, in a pile, on the body, as a worn bag and when thrown.

Opened while you throw, place, offer, use or hold an item, it takes that item and pose and gives it back when you leave. "On the body" edits the sling spot your job uses. invposes prints every saved pose as config lines.

/invslings#

Needs lri.admin.panel. Prints in F8 what your own game draws on the body: each slung weapon, its spot and the object budget. It runs in game, not in the server console.

/invthumbs#

Needs lri.admin.config and a started screenshot-basic. It photographs an item's model in game and saves it as web/images/<item>.webp: /invthumbs missing takes items without a picture, /invthumbs item,item the named ones, own also replaces shipped pictures, list only lists, and /invthumbs stop ends a run. Shipped pictures are never replaced without own, and every skipped item is reported with its reason. Close the panel and leave any script camera first. Restart the resource afterwards so players get the new pictures. Config.Debug.thumbs sets size, quality, endpoint (set 'ip:port' when you join through a proxy), height, settleMs and fov.

nCore Development · https://intelnpc.com · support on intelnpc.com, reply within 72 hours