Browse docs

Inventory items

Set up DOJ document, law-book and portable case-container items, their icons and the optional printer supplies.

Items used by DOJ

Default itemPurposeRequirement
doj_documentA physical printed DOJ document with its own copy metadataRequired for printed document delivery and reading
job_documentA printed register certificate or shared job documentRequired for registry certificate printing; supplied by Sky Jobs Base
doj_law_bookA readable law-book item with an archived editionRequired when using inventory law books
sky_briefcaseAn inventory-backed briefcase for carrying case materialOptional; supplied by Sky Jobs Base
sky_case_folderAn inventory-backed folder for case files and loose documentsOptional; supplied by Sky Jobs Base
printer_paperPaper refill itemRequired only when the configured printer consumes paper
printer_inkInk refill itemRequired only when the configured shared printer settings consume ink

The resource registers its DOJ item definitions and usable actions through the Sky inventory adapter while preserving existing definitions. Verify that your selected inventory supports the required metadata and has the expected items and icons. A pre-existing definition can still need correction.

ox_inventory

Merge the entries from the package's inventory/items_ox.lua into ox_inventory/data/items.lua. Do not replace the inventory's entire item catalog.

Copy the included images using these destination names:

Package imageInventory destination
inventory/doj_document-v2.pngox_inventory/web/images/doj_document.png
inventory/doj_law_book.pngox_inventory/web/images/doj_law_book.png

The supplied definitions use non-stackable, non-consuming items. doj_document has a default weight of 10 and doj_law_book has a default weight of 500. Keep the unique document metadata when moving or transferring items.

Printer supplies belong to the Jobs Base package. Merge the definitions from sky_jobs_base/config/inventory/items_ox.lua and copy printer_paper.png and printer_ink.png from that directory into the inventory image folder. Both items are stackable and use consume = 0; Sky consumes one only after the refill minigame succeeds. Custom supply names must match the job's printer settings.

For register certificates, also merge job_document from that Jobs Base file and copy job_document.png into ox_inventory/web/images/. It is a separate item from doj_document; keep the printer-issued metadata on both.

Portable case containers also belong to Jobs Base. Merge the sky_briefcase and sky_case_folder definitions from that same file and copy sky_briefcase.png and sky_case_folder.png into the inventory image folder. Both are non-stackable and keep their own contents through transfers. The briefcase can be shown or hidden on the player's right hand through the Jobs Base custom actions; the case folder is an inventory-only container. See the shared Jobs Base inventory items reference for capacities, provider bridges and the rename/show/hide exports.

Renaming items

Config.PrintedDocuments.item selects the printed-document item and Config.PrintedDocuments.weight supplies its registration weight. Config.LegalCodes.item selects the law-book item. Printer refill names are configured separately in the job's printer settings and shared Jobs Base printer configuration.

Changing a name does not automatically migrate items already held by players. Coordinate any rename with inventory data and stored copies, and test the resulting usable item before distributing it.

Metadata matters

A printed document is not just an item name: it refers to an issued copy. A generic administrator-created item without valid copy metadata cannot display a real case document. Create a test copy through Print and collect it from the printer.

Law books keep an archived edition rather than silently changing an already issued book whenever a law is edited. The inventory must preserve the edition metadata. Use the supported law-book workflow and check the edition shown in the reader.

An item added to a shop or inventory does not grant tablet access, access to the original case file or permission to sign documents.