> For the complete documentation index, see [llms.txt](https://dirkscripts.gitbook.io/dirkscripts-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources.md).

# Resources

- [Library](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib.md): A universal FiveM/RedM framework bridge and utility library. Provides a unified API for inventory, targeting, player data, UI, and more — regardless of which framework or resources you run.
- [Getting Started](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/getting-started.md)
- [Cache](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/cache.md): Source-accurate reference for dirk\_lib client cache keys, value formats, and cache change listeners.
- [Modules](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules.md)
- [addCommand](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/addcommand.md): Register chat commands with parameter parsing and ACL restrictions
- [addKeybind](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/addkeybind.md): Register rebindable keybindings with press and release callbacks
- [await](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/await.md): A small module containing a simple time based await for function callback
- [blip](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/blip.md): Used for GTA map location blips, for example a fuel station location
- [callback](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/callback.md): Use to easily communicate between both client and server
- [class](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/class.md): OOP class system with inheritance, private fields, and type checking
- [closest](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/closest.md): Find the closest entity (player, ped, vehicle, object) to a position
- [disableControls](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/disablecontrols.md): Disable player controls with reference counting
- [dui](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/dui.md): Create and manage DUI (Direct UI) browser textures on in-game objects
- [file](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/file.md): Server-side JSON file I/O
- [game](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/game.md): Time & weather sync bridged across supported resources
- [gizmo](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/gizmo.md): 3D entity manipulation gizmo for translation, rotation, and scale
- [interact](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/interact.md): Used to register and control any player interaction
- [inventory](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/inventory.md): Bridged inventory API for client and server
- [locale](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/locale.md): Localisation and translation system
- [logger](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/logger.md): Server-side logging to external services
- [math](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/math.md): Extended math utilities
- [objects](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/objects.md): Used to register and remove object spawning, from peds to vehicles.
- [player](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/player.md): Player data and utility functions for client and server
- [Client](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/player/client.md): Client-side player data functions bridged across all supported frameworks
- [Server](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/player/server.md): Helpful functions for the player data structure and functions
- [print](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/print.md): Simple dev tool for printing information and warnings to console
- [raycast](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/raycast.md): Raycasting utilities for shape tests
- [registerTebexHook](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/registertebexhook.md): Tebex store webhook integration
- [request](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/request.md): Used to request and load game assets with automatic timeout and cleanup
- [require](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/require.md): Module loading and dependency system
- [scriptConfig](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/scriptconfig.md): Schema-driven script config with database persistence, admin UI, live watchers, change history, and optimistic concurrency — the Lua engine behind every DirkScripts in-game config panel.
- [string](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/string.md): Random string generation
- [table](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/table.md): Table utility functions for cloning, searching, merging and more
- [target](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/target.md): Used to create target zones (Third Eye)
- [validate](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/validate.md): Fluent data validation chain
- [vehicle](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/vehicle.md): Bridged vehicle API for client and server
- [zones](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/zones.md): Used to create and manage polyzones
- [ui](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui.md): Built-in UI components split into dedicated pages
- [Notify](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/notify.md): Notification UI
- [Text UI](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/text-ui.md): Persistent text UI
- [Context](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/context.md): Context menu system
- [Dialog](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/dialog.md): Dialog system
- [Progress](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/progress.md): Progress bar and progress circle UI
- [Input](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/input.md): Input dialog UI
- [Status](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/status.md): Status info indicators
- [Quiz](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/quiz.md): Quiz system for client and server
- [Key Prompts](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/key-prompts.md): Contextual key prompt overlays
- [Utilities](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/ui/utilities.md): Miscellaneous UI helper functions
- [groups](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/modules/groups.md): Group creation and management for coordinated player tasks.
- [DevTools](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-lib/devtools.md): Developer tools for position copying, entity placement, and polygon creation
- [Fishing Sim](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing.md): A complete fishing overhaul for FiveM — realistic casting physics, 32 bespoke 3D fish, gear progression, fishing zones, traps, daily challenges, and a fully live in-game configurator. v2 is a ground-u
- [Getting Started](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/getting-started.md)
- [Live Script Configurator](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/configuration.md): All configuration for dirk\_fishing v2 is managed through the in-game Live Script Configurator. Settings save to the database and apply live — no resource restart required.
- [Features](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features.md): A tour of every system in dirk\_fishing v2.
- [Core Fishing](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/core-fishing.md): The aim → cast → fight loop, the rope physics and the cinematic catch camera.
- [Gear & Progression](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/gear-and-progression.md): Rod loadouts, the XP curve, and the permit system.
- [World & Exploration](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/world-and-exploration.md): Fishing zones, grid-based fish populations and the Fish Finder.
- [Interactive Guidebook](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/guidebook.md): A standalone in-game book item with six tabs of dashboards and reference.
- [Daily Challenges](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/daily-challenges.md): Random daily objectives that reset every 24 hours.
- [Traps (Crab Pots)](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/traps.md): Place baited crab pots and come back later for a passive haul.
- [Bait & Gutting](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/bait-and-gutting.md): Dig for worms, gut your catches.
- [Stores & Markets](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/features/stores-and-markets.md): Equipment shops, fish markets and a dedicated bait market.
- [Changelog](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-fishing/changelog.md)
- [Project Cars](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/project-cars.md)
- [Getting Started](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/project-cars/installation.md): Please follow these instructions carefully if you do so you should have no issues, if you do still experience issues after reading through all of this then please make a ticket in discord.
- [Types](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/project-cars/types.md)
- [Tool Item](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/project-cars/types/tools.md): Each tool is defined as a key in the tools table with a structured value. Here's a breakdown of the expected fields:
- [Part Item](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/project-cars/types/parts.md): Each part is defined as an entry in your parts table with configurable fields for how it behaves during installation, usage, and interaction with vehicles.
- [Commands](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/project-cars/commands.md): Some useful commands that are locked to admin only by default. All of these commands will list the arguments required if you type them in the chat.
- [Multicharacter](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar.md): A modern, fully-configurable multicharacter selector for FiveM — character creation flow, cinematic selection scene, lifestyles, backstories, VIP slots, configurable character states, and a fully live
- [Getting Started](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/getting-started.md)
- [Live Script Configurator](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/configuration.md): All configuration for dirk\_multichar v1.5+ is managed through the in-game Live Script Configurator. Settings save to the database and apply live — no resource restart required.
- [Features](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/features.md)
- [Character Selection](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/features/character-selection.md): The cinematic character selection scene, camera atmosphere and scene positions.
- [Backstories](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/features/backstories.md): Admin-built character archetypes with their own intro scenes, starter items and access gates.
- [Character States](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/features/character-states.md): Visual states (icon + colour + message) that can disable a character or display status.
- [Spawn Locations](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/features/spawn-locations.md): Admin-defined spawn points with FontAwesome icons + framework group gating.
- [VIP Roles](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/features/vip-roles.md): Extra character slots granted via Discord roles or ESX's native slots table.
- [Commands](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/commands.md): Built-in slash commands shipped with dirk\_multichar.
- [Exports](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/exports.md): Lua exports exposed by dirk\_multichar for use from other resources.
- [Changelog](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-multichar/changelog.md)
- [Stores](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores.md)
- [Getting Started](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/getting-started.md)
- [Types](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/types.md)
- [Store](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/types/store.md): This defines the structure for creating a store, either via your config or dynamically through an export. Stores support job/role restrictions, time-based spawning, custom themes, and more.
- [Category](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/types/category.md): These are all the properties available per category for your store, you can disable categories for a store by removing the categories table entirely.
- [Stock](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/types/stock.md): All the properties of a stock item within your stock table for a store.
- [Exports](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/exports.md)
- [Changelog](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/stores/changelog.md)
- [Drug Labs v2](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/drug-labs-v2.md)
- [Installation](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/drug-labs-v2/installation.md): Follow this guide to install the resource.
- [Tebex Integration](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/drug-labs-v2/tebex-integration.md)
- [Creating Labs](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/drug-labs-v2/creating-labs.md)
- [Bounty Hunters v2](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/bounty-hunters-v2.md)
- [Installation](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/bounty-hunters-v2/installation.md): Please follow these instructions carefully if you do so you should have no issues, if you do still experience issues after reading through all of this then please make a ticket in discord.
- [Create Bounty](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/bounty-hunters-v2/create-bounty.md): Below is an event you can use to create a bounty via code should you ever need to.
- [Weed Growing](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/weed-growing.md)
- [Common issues and FAQ](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/weed-growing/common-issues-and-faq.md)
- [Dirk CFX React](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-cfx-react.md): A shared React component and utility library for building FiveM/RedM NUI interfaces. Provides the admin panel, form system, settings integration, theming, and reusable UI components used across all Di
- [Getting Started](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-cfx-react/getting-started.md): How to install and start using dirk-cfx-react in a FiveM resource
- [Script Config (React)](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-cfx-react/script-config.md): Complete guide for building an in-game admin settings panel using dirk-cfx-react's SettingsPanel, useForm, and createScriptConfig — connected to dirk\_lib's scriptConfig Lua module.
- [Components](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-cfx-react/components.md): Reusable UI components provided by dirk-cfx-react
- [Hooks & Utilities](https://dirkscripts.gitbook.io/dirkscripts-documentation/resources/dirk-cfx-react/hooks-and-utilities.md): Hooks and utilities exported by dirk-cfx-react