Documentation

Please read the documentation clearly to prevent asking for help for an issue that is explained here. If you follow the steps on these pages your script will work providing you have all dependencies.

Further Support

If for example you still cannot use your script after following all the instructions listed here please make a ticket in our discord. You will find the discord to the left at the bottom.

Keymaster

After purchasing one of our scripts you will need to head over to keymaster.fivem.net this is where all of your purchased products go. You will see this page after you login. Select the following option:

Then you can select download for the item you just purchased.

Installation

First you will want to go to the readme.md file within the resource itself and make sure there are no specific instructions for this resource. Otherwise just check the dependency list in the readme make sure you have everything installed. Then simply drag your resource into your resources folder and ensure it in your server.cfg.

lib.await

Used to add a timed delay to the defined callback

lib.await(func, timeout)

lib.callback.await

Call and await for a response of a server callback

-- Client
lib.callback.await(event, ...)
-- Server
lib.callback.await(event, playerId, ...)

lib.callback.register

Register a client callback, this can be used to easily request data from a client from the server

lib.callback.register(event, cb)

lib.objects.register

Create a new object

lib.objects.register(name, new_data)

lib.objects.get

Get information regarding an object

local obj = lib.objects.get(name)

lib.objects.destroy

Completely remove an object

lib.object.destroy(id)

Data Structure

This is the data structure of an object and the valid options

{
    type = "ped",                 -- This can be: ped, vehicle or object
    model = `a_f_m_bevhills_01`,  -- Model to be spawned, must be the model hash
    pos = vector4(0, 0, 0, 0),    -- Position of the object
                                  -- This also can be a polyzone for a set render area
    renderDist = 50,              -- When to render the object
}

setCharacterState

This will set the character state to one of the ones you have defined within settings/extras/characterStates

lib.camera.focusEntity

Quickly focus a camera towards an entity

lib.camera.focusEntity(entity, data)

lib.camera.focusHead

Focus onto a ped's head with the camera, great for menus

lib.callback.focusHead(entity, data)

lib.camera.focusPoint

Focus onto a specific position with the camera

lib.callback.focusPoint(data)

lib.camera.exit

Leave active camera

lib.callback.exit()

Data Structure

This is the data structure of a camera and the valid options

TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC TBC

{
    -- Required
    "pos": vector2(150.0, 100.0),    -- Used as the location on the map
    "name": "Example Blip",          -- Label displayed on the map key
    "sprite": 1,                     -- Sprite to be displayed
    "display": 4,                    -- Display options
    "scale": 1.0,                    -- Size of the blip
    "color": 1,                      -- Color of the blip
    -- Not Required
    "shortRange": false,             -- Is the blip short range
    "category": 1,                   -- Category of the blip
    "alpha": 255,                    -- Alpha (opacity) of the blip
    "rotation": 0,                   -- Rotation
    "route": false,                  -- Should the blip be routed to
    "canSee": function()             -- Should the blip render
        return true
    end,                  
}

lib.table.deepClone

Used to quickly copy a table, useful for global state values

lib.table.findKeyInTable

Check through a table for a set key

lib.table.includes

Check if a value is present in a table

lib.table.convert

Convert data to different formats

lib.table.count

Count a table and sub tables

lib.request.model

Load a model with timeout checks

local success = lib.request.model(model, timeout)

lib.request.streamedTextureDict

Request texture dictionary

local success = lib.request.streamedTextureDict(txd, timeout)

logout [QBX|QBCore ONLY]

This will make the player sit down and wait for logout, this can be adjusted under settings.basic

lib.file.load

Load a file and it's content

lib.file.save

Save a file and it's contents

lib.print

Print some information to the console

lib.print(_type, ...)

-- Example
lib.print("debug", "Example print")

lib.addPrintType

Add a new of print to be used

lib.addPrintType(_type, prefix, condition)

Dependencies

• dirk_lib (REQUIRED)

Items

There is a folder within the script called 'install' within that is another folder called 'itemsToAdd' please choose the format you require for your framework/inventory

projectCar:deleteNearest

Will delete the nearest projectCar entirely from the database and the world.

projectCar:completeNearest

Will complete the nearest projectCar requiring the player to just get in and start it

projectCar:giveEngine

This will give you an engine with the correct metadata dependant on the class you supply.

projectCar:allItems

Will give you all the items you need to complete a car.

lib.interact.register

Create a new player interaction

lib.interact.get

Get information regarding an interaction

lib.interact.destroy

Completely remove an interaction

Data Structure

This is the data structure of an interaction and the valid options

There are multiple different interactions seen below:

Circle

Poly

Box

Marker

Text

lib.blip.register

Register a new blip to be shown on the map

lib.blip.get

Get a blip's data via it's id

lib.blip.delete

Remove a blip from the map and cache

Data Structure

This is the data structure of a blip and the valid options

Useful Links

FiveM Blip Sprites Reference:

FiveM Native SetBlipDisplay Reference:

Fivem Blip Colour Reference:

FiveM Native SetBlipCategory Reference:

Item Name

type: string

label:

type: string

weight:

type: integer

description:

type: string

chanceOfBreak?:

type: integer

holdRotation?:

type: vector3

holdOffset?:

type: vector3

model?:

Model of object to hold type: string

useable?:

type: function

strength?:

type: integer Used to limit the maximum weight of a vehicle that can be supported by the item.

Usage

The cache is simple to access, once you've followed the steps, you will be able to access the following values:

Cache Types

Accessing

You can simple called cache.x with whichever type you wish anywhere in your code, so long as dirk_lib is imported.

lib.onCache

All of the above cache types can be used with lib.onCache, this is essentially a listener that will trigger upon change of the value and at initial set.

Server Vars

These are some settings you can use to tailor the lib to your needs you can also make a new file within the same directory as your server.cfg and call it dirk_lib.cfgand then you can simply put exec dirk_lib.cfg in your server.cfg somewhere before dirk_lib is ensured

Convars

If you are setting framework/inventory/target etc please make sure you use the exact resource name so the bridging will work correctly. You can easily reference all the bridge resources by checking the bridge folder, you can also easily add your own bridging here for resources that are not yet supported

# The theme below will apply to all UI created by DirkScripts utilising the lib themes. 
# Theme starts at 0 and goes to 9 
# 0 is the lightest color and 9 is the darkest
# You can set the primary color to custom and set the customTheme to your own colors
# Use this generator in order to make your own custom color palettes https://mantine.dev/colors-generator/?color=7b36b5 
# Default mantine colors can be found here https://mantine.dev/theming/colors/#default-colors
setr dirk_lib:primaryColor dirk # Set to custom to use customTheme
setr dirk_lib:primaryShade 9 # 0-9
setr dirk_lib:customTheme [
  "#e5f8ff",
  "#d0ecff",
  "#a0d7fc",
  "#6dc1fa",
  "#47aef9",
  "#32a2f9",
  "#259cfa",
  "#1888df",
  "#0179c8",
  "#0068b1"
]

setr dirk_lib:language en
setr dirk_lib:debug true
setr dirk_lib:currency $
setr dirk_lib:serverName DirkRP
setr dirk_lib:logo https://via.placeholder.com/150

# Configure the resources you want to use will autodetect otherwise [OPTIONAL]
setr dirk_lib:framework qbx_core
setr dirk_lib:inventory dirk_inventory
setr dirk_lib:itemImgPath nui://dirk_inventory/web/images/
setr dirk_lib:primaryIdentifier license
setr dirk_lib:target ox_target
setr dirk_lib:interact sleepless_interact
setr dirk_lib:time dirk_weather
setr dirk_lib:phone lb-phone

setr dirk_lib:keys dirk_keys
setr dirk_lib:garage dirk_vehicles
setr dirk_lib:fuel dirk_fuel


setr dirk_lib:ambulance dirk_ambulance
setr dirk_lib:prison dirk_prison
setr dirk_lib:dispatch dirk_dispatch


# NOTIFICATIONS
setr dirk_lib:notify dirk_lib
setr dirk_lib:notifyPosition top-right
setr dirk_lib:notifyAudio true

# Context Menu 
setr dirk_lib:contextMenu dirk_lib
setr dirk_lib:contextClickSounds true
setr dirk_lib:contextHoverSounds true

# Dialog
setr dirk_lib:dialog dirk_lib
setr dirk_lib:dialogClickSounds true
setr dirk_lib:dialogHoverSounds true

# showTextUI 
setr dirk_lib:showTextUI dirk_lib
setr dirk_lib:showTextPosition bottom-center

# progressBar 
setr dirk_lib:progress dirk_lib
setr dirk_lib:progBarPosition bottom-center

# Groups 
setr dirk_groups:maxMembers 5
setr dirk_groups:maxDistanceInvite 5
setr dirk_groups:inviteValidTime 5
setr dirk_groups:maxLogOffTime 5

To get started with lib, include the shared script within your resource's fxmanifest.lua

shared_scripts {
  '@dirk_lib/init.lua'
}

You are able to select modules to be loaded, however they will also dynamically import. This can be done via the dirk_libsmanifest option

dirk_libs {
  'math',
  'objects'
}

Bridging

This is a list of all the resources that this lib will bridge for, add your own by making a PR or contacting me on discord.

SUPPORTED RESOURCES

lib.target.box

Create a simple box zone

lib.target.box(id, data)

lib.target.polyzone

Create a polrzone

lib.target.polyzone(id, data)

lib.target.removeZone

Remove a created zone

lib.target.removeZone(id)

lib.target.entity

Create an entity and allow targeting

lib.target.entity(entity, data)

lib.target.removeEntity

Remove an entity zone

lib.target.removeEntity(entity, net)

You can allow players to purchase labs via tebex instead of in-game for some labs should you wish players can join the server after purchase and use the Config.RedeemCommand (/ClaimLab) in order to claim their new lab this will give them keys into their inventory and ownership.

First you will need to ensure you have linked your tebex to your FiveM server there are many guides for this on Google. You will then need to make a new package with the deliverable product being a Game Server command setup like so: The name of this package you create must be the name of the index of the lab in the config. So in the example below it would have to be "Downtown Cocaine Lab"

Converting Data from Older Version

Please grab your old projectCars.json and place it in the root directory of clean_projectCars. The script will auto-detect it on startup and convert any old vehicles to the new SQL table.

Inventory Instructions

OX_INVENTORY/CLEAN_INVENTORY

In order for this to work you will need to add all the data in INSTALLATION/itemsToAdd/ox_items.lua to ox_inventory/data/items.lua

['windscreen'] = {
  ['weight'] = 1000,
  ['label'] = 'Windscreen',
},

QB-INVENTORY

For all QB based inventory systems you can find the items in the following folder

INSTALLATION/itemsToAdd/qb_items.lua should you wish to manually add them

['windscreen'] = {
  ['description'] = 'Vehicle Part',
  ['useable'] = true,
  ['weight'] = 1000,
  ['shouldClose'] = false,
  ['type'] = 'item',
  ['label'] = 'Windscreen',
  ['unique'] = false,
  ['name'] = 'windscreen',

},

lib.player.get

Get the player's information

lib.player.identifier

Returns the identifier (CitizenID) of the player

lib.player.name

Returns the name of the character

lib.player.phone_number

Return the phone number of the character

lib.player.gender

Return the gender of the character

lib.player.checkOnline

Check if a player is online by their CitizenID

lib.player.jail

Send a player to jail

lib.player.addMoney

Add money to a player

lib.player.removeMoney

Remove money to a player

lib.player.addItem

Add item to a player

lib.player.removeItem

Remove an item for a player

lib.player.editItem

Edit the metadata of an item

lib.player.getInventory

Returns the inventory of the player

Example Return:

label:

type: string

searchChance:

type: number

• Think of names in a hat, how many times is this name in the hat?

weight:

type: number

• The weight of the item in the inventory

tools?:

type: table (object)

• Tools required to fit this part ex: {funnel = 1}

  • item?: number Quantity required

consumables?:

type: table (object)

• Consumables required to fit this part, these will be removed.

  • item?: number Quantity required

anim?:

type: table (object)

• dict?: string

  • Must specify either scenario or dict

• clip: string

• flag?: number

• time?: number time required to fit the part

reqParts?:

type: table (array)

• other part names required before fitting this part

model?:

type: string (prop name)

• the model name of part that is carried in hand/placed on floor whilst installing

applyRange?:

type: number

• the maximum range from vehicle this part can be installed

applyAtBone?:

type: string

• the bone where this part needs to be applied at (ex: "engine" for coolant)

canStart?:

function triggered when trying to start project vehicle

type: function(itemExists, _type)

Parameters

Return

removePart?:

function triggered to remove parts from base vehicle

type: function(self, entity, _type)

addPart?:

function triggered when part is added

type: function(self, entity, _type)

lib.zones.register

Create a new zone

Zone Examples

lib.zones.get

Get zone information

lib.zones.delete

Remove a created zone

lib.zones.isInsideZone

Check whether a position lies inside a zone(s)

Data Structure

This is the data structure of a blip and the valid options

Some zones have different requirements, see below: