Dependencies	Links
ox_lib	https://github.com/overextended/ox_lib/releases (opens in a new tab)
oxmysql	https://github.com/overextended/oxmysql (opens in a new tab)
Target System
ESX (ox_target)	https://github.com/overextended/ox_target (opens in a new tab)
QbCore (qb-target)	https://github.com/qbcore-framework/qb-target (opens in a new tab) (Currently not supported!)

Client

These exports can only be used on the client-side. Make sure to use them in your client-side script files.

Interactions Options

{
+  label = 'string', -- The label of the interaction.
+  name = 'string', -- The name of the interaction.
+  icon = 'string', -- The icon of the interaction.
+  item = {}, -- List of item you need to have to use the interaction.
+  groups = {}, -- List of groups you need to have to use the interaction.
+  canInteract = function(entity, distance), -- Function to check if the player can interact with the entity.
+  onSelect = function(entity), -- Function to execute when the player selects the interaction.
+  distance = number, -- The distance the player needs to be to interact with the entity.
+}

If you want your script to work with all Disptach systems that are integrated in it-brige please make sure that you enter all these data

CreateBoxZone

exports.it_bridge:CreateBoxZone(options, boxData)

options: table: The options of the box zone.
boxData: table: The data of the box zone.

Creates a box zone with the specified data.

BoxData

{
+  coords = vector3, -- The coordinates of the box zone.
+  size = vector3, -- The size of the box zone.
+  rotation = number, -- The rotation of the box zone.
+  debug = boolean, -- If the box zone should be debugged.
+  drawSprite = boolean, -- If the box zone should draw a sprite.
+  minZ = number, -- The minimum Z value of the box zone.
+  maxZ = number, -- The maximum Z value of the box zone.
+  interactDistance = number, -- The distance the player needs to be to interact with the box zone.
+}

Example

exports.it_bridge:CreateBoxZone({
+  label = 'Example Box Zone',
+  name = 'example_box_zone',
+  icon = 'fas fa-box',
+  canInteract = function(entity, distance)
+    return distance < 2.5
+  end,
+  onSelect = function(entity)
+    print('You have interacted with the box zone.')
+  end,
+  distance = 2.5,
+}, {
+  coords = vector3(0.0, 0.0, 0.0),
+  size = vector3(2.5, 2.5, 2.5),
+  rotation = 0.0,
+  debug = true,
+  drawSprite = true,
+  minZ = 0.0,
+  maxZ = 3.0,
+  interactDistance = 2.5,
+  })

AddTargetEntity

exports.it_bridge:AddTargetEntity(entities, options)

entities: table | number: The entities to add as target entities.
options: table: The options of the target entities.

Return all options that where added to the entities.

Adds the specified entities as target entities.

Example

local targetData = exports.it_bridge:AddTargetEntity(netId, {
+  label = 'Example Entity',
+  icon = 'fas fa-user',
+  canInteract = function(entity, distance)
+    return distance < 2.5
+  end,
+  onSelect = function(entity)
+    print('You have interacted with the entity.')
+  end,
+  distance = 2.5,
+})

RemoveTargetEntity

exports.it_bridge:RemoveTargetEntity(entities, options)

entities: table | number: The entities to remove as target entities.
options: table: The options of the target entities.

Return all options that where removed from the entities. +Removes the specified entities as target entities.

Example

local removed = exports.it_bridge:RemoveTargetEntity(netId, targetData)

AddGlobalPed

exports.it_bridge:AddGlobalPed(options)

options: table: The options of the global ped.

Return all options that where added to the peds. +Adds a interaction for all peds in the world.

Example

local pedData = exports.it_bridge:AddGlobalPed({
+  label = 'Example Ped',
+  icon = 'fas fa-user',
+  canInteract = function(entity, distance)
+    return distance < 2.5
+  end,
+  onSelect = function(entity)
+    print('You have interacted with the ped.')
+  end,
+  distance = 2.5,
+})

RemoveGlobalPed

exports.it_bridge:RemoveGlobalPed(options)

options: table: The options of the global ped.

Return true if the interactions was removed. +Removes the interaction for all peds in the world.

Example

local removed = exports.it_bridge:RemoveGlobalPed(pedData)

AddGlobalPlayer

exports.it_bridge:AddGlobalPlayer(options)

options: table: The options of the global player.

Return all options that where added to the players. +Adds a interaction for all players in the world.

Example

local playerData = exports.it_bridge:AddGlobalPlayer({
+  label = 'Example Player',
+  icon = 'fas fa-user',
+  canInteract = function(entity, distance)
+    return distance < 2.5
+  end,
+  onSelect = function(entity)
+    print('You have interacted with the player.')
+  end,
+  distance = 2.5,
+})

RemoveGlobalPlayer

exports.it_bridge:RemoveGlobalPlayer(options)

options: table: The options of the global player.

Return true if the interactions was removed. +Removes the interaction for all players in the world.

Example

local removed = exports.it_bridge:RemoveGlobalPlayer(playerData)

AddGlobalVehicle

exports.it_bridge:AddGlobalVehicle(options)

options: table: The options of the global vehicle.

Return all options that where added to the vehicles. +Adds a interaction for all vehicles in the world.

Example

local vehicleData = exports.it_bridge:AddGlobalVehicle({
+  label = 'Example Vehicle',
+  icon = 'fas fa-car',
+  canInteract = function(entity, distance)
+    return distance < 2.5
+  end,
+  onSelect = function(entity)
+    print('You have interacted with the vehicle.')
+  end,
+  distance = 2.5,
+})

RemoveGlobalVehicle

exports.it_bridge:RemoveGlobalVehicle(options)

options: table: The options of the global vehicle.

Return true if the interactions was removed. +Removes the interaction for all vehicles in the world.

Example

local removed = exports.it_bridge:RemoveGlobalVehicle(vehicleData)

AddTargetModel

exports.it_bridge:AddTargetModel(models, options)

models: table | string: The models to add as target models.
options: table: The options of the target models.

Return all options that where added to the models. +Adds the specified models as target models.

Example

local modelData = exports.it_bridge:AddTargetModel('a_m_m_skater_01', {
+  label = 'Example Model',
+  icon = 'fas fa-user',
+  canInteract = function(entity, distance)
+    return distance < 2.5
+  end,
+  onSelect = function(entity)
+    print('You have interacted with the model.')
+  end,
+  distance = 2.5,
+})

RemoveTargetModel

exports.it_bridge:RemoveTargetModel(models, options)

models: table | string: The models to remove as target models.
options: table: The options of the target models.

Return all options that where removed from the models. +Removes the specified models as target models.

Example

local removed = exports.it_bridge:RemoveTargetModel('a_m_m_skater_01', modelData)

Server Server

Dependencies	Links
ox_lib	https://github.com/overextended/ox_lib/releases (opens in a new tab)

How to test?

Welcome to the it_bridge test guide, where you can learn how to completely test the our asset on your server, following each step we will achieve a clean and fluid test where you will find any problems with the bridge on your server, as long as the documentation has been completed.

Before you start testing the script, make sure that you have followed the installation guide and that the script is correctly installed on your server.

Configuration of the script

First you have to configure the it_bridge script, you can do this in the config.lua file. +On most servers you can leave the default settings, but if you want to change something you can do this.

Start the it_bridge script

After you have configured the script, you can start the script on your server. +If you followed the install guide correctly, the script should start aumaotically when you start your server. +If the script does not start automatically, you can start it manually with the following command in your txAdmin Console:

start it_bridge

After starting the script, you should see a message in your server console after a few seconds, that the script has started successfully. +The script will also tell you which settings are currently active. Please make sure these settings are correct.

Example Message: +

Start the bridge_tester script

After you started the it_bridge script, you can start the bridge_tester script. +This script is used to test the it_bridge script and to make sure that everything is working correctly. +You can start the bridge_tester script with the following command in your txAdmin console:

start bridge_tester

Test the script

After you have started the bridge_tester script, you can test the it_bridge script.

1. Test your Framework

To test if the it_brige script is working correctly, with your framework, you can use the following command in your txAdmin console:

bridgeTestFramework id money bank blackMoney

id: The player ID you want to test the script with.
money: The amount of money (cash) the player currently has.
bank: The amount of money the player currently has in the bank.
blackMoney: The amount of black money the player currently has.

If you are using qb-core, qbx_core as your framework set the amount for blackMoney to the amount of crypto the player has. +If you are using ND_Core set the amount for blackMoney to 0.

After you issued the command, you should see some messages in your server console, +the script will automatically test the it_bridge script with the given values.

The script will print the result of every test in the server console. +If you encounter any errors, please report them in the Discord (opens in a new tab).

Example input

bridgeTestFramework 1 1000 500 0

Example output

2. Test your Inventory Script

To test if the it_bridge script is working correctly with your inventory script, you can use the following command in your txAdmin console:

bridgeTestInventory id item

id: The player ID you want to test the script with.
item: The item you want to test the script with.

For the item parameter, you can use any item that is in your inventory except for the money items.

After you issued the command, you should see some messages in your server console, +the script will automatically test the it_bridge script with the given values.

The script will print the result of every test in the server console. +If you encounter any errors, please report them in the Discord (opens in a new tab).

Example input

bridgeTestInventory 1 bread

Example output

3. Test your Notification Script

To test if the it_bridge script is working correctly with your notification script, you can use the following command in your txAdmin console:

bridgeTestNotify id

id: The player ID you want to test the script with.

After you issued the command, the targeted player should receive 4 notifications (every notification type for 5 Seconds) on the screen.

If the player does not receive the notifications, please report this in the Discord (opens in a new tab).

Example input

bridgeTestNotify 1

4. Test your TextUI Script

To test if the it_bridge script is working correctly with your TextUI script, you can use the following command in your txAdmin console:

bridgeTestTextUI id

id: The player ID you want to test the script with.

After you issued the command, the targeted player should receive a TextUI on the screen. On some TextUI scripts, you will recive TextUIs with a different design and on others you will recive a TextUI with the default design. +This is normal and should not be a problem.

If the player does not receive the TextUI, please report this in the Discord (opens in a new tab).

Example input

bridgeTestTextUI 1

5. Test your Menu Script

Before testing the Menu, please make sure you have tested the Notification script.

To test if the it_bridge script is working correctly with your Menu script, you can use the following command in your txAdmin console:

bridgeTestMenu id

id: The player ID you want to test the script with.

After you issued the command, the targeted player should receive a Menu on the screen. If you press any button on the menu, the script will show a notification.

If the player does not receive the Menu, please report this in the Discord (opens in a new tab).

6. Test your Target Script

To test your Target script, you need more than one command to test it, because you have to test every target type separately.

To test if the it_bridge script is working correctly with your Target script, you can use the following commands in your txAdmin console:

bridgeBoxZone id

id: The player ID you want to test the script with.

After you issued the command, in front of the targeted player should appear a prop with a box zone around. If the player tries to target the zone there should be two options. +The prop and the box zone should disappear after 15 seconds.

bridgeTargetEntity id

id: The player ID you want to test the script with.

After you issued the command, in front of the targeted player should appear a prop. If the player tries to target the entity there should be two options. +The prop should disappear after 15 seconds.

bridgeGlobalPedTest id

id: The player ID you want to test the script with.

After you issued the command, the targeted player should have two target options on every ped in the server. The script will not spawn a ped! +After 15 seconds the target options should disappear.

bridgeGlobalVehicle id

id: The player ID you want to test the script with.

After you issued the command, the targeted player should have two target options on every vehicle in the server. The script will not spawn a vehicle! +After 15 seconds the target options should disappear.

bridgeGlobalPlayer id

id: The player ID you want to test the script with.

To test the globalPlayer command there should be at least one other player in the server.

After you issued the command, the targeted player should have two target options on every player in the server. +After 15 seconds the target options should disappear.

bridgeModel id

id: The player ID you want to test the script with.

After you issued the command, in front of the targeted player should appear a prop. If the player tries to target the prop there should be two options. +The prop should disappear after 15 seconds.

If there any problems with the target script, please report this in the Discord (opens in a new tab).

Report your results

After you have tested the it_bridge script, you should report your results in the Discord (opens in a new tab). +Please report your results regardless of whether there were errors or not, this will help us to improve the script and to fix any errors that may occur.

For reporting, please join the Discord and go to the 📑・tickets channel and open a Bridge Results Ticket. +In this ticket, please provide the following information:

Image of the startup message of the it_bridge script.
Results of the tests. +
- If you do not have any errors you can just send a short message like No errors found!
- If you have any errors, please provide the error message and a description of what you did before the error occurred. And an image of you txAdmin and F8 Console.
+

Stop the bridge_tester script

After you have tested the it_bridge script, you can stop the bridge_tester script with the following command in your txAdmin console:

stop bridge_tester

📥・Installation 🔄・Shared

How to enable OneSync

Steps to Enable OneSync

Open Your Server.cfg File

Add the OneSync Command

Optional: Enable OneSync Infinity

Save and Restart

How to install HeidiSQL

Download and Install MariaDB

Donwload MariaDB

Run the Installer

Configuration During Installation

Complete the Installation

Download and Install HeidiSQL

Download HeidiSQL

Run the Installer

Set Up a Connection in HeidiSQL

Visual Guide With Video

How to update my server

Framework

Artifacts

Gamebuild

Framework Update

Download the Official Framework

Replace Your Current Framework Folder

Do Not Rename the Framework Folder

Update Artifacts

Remove Old Artifacts

Download Latest Artifacts

Extract and Replace

Update Gamebuild

Open Your server.cfg File

Edit Your Server Configuration

Why Is This Important?

How to anaging translations

Translation System

Where To Find Translations

Pre-Built Translations

Translate it yourself

Join our Discord community

How to change kay bindings

Register Key Mapping

Optimized performance

Client customization

How to Change Keys In-Game

Open the Settings Menu

Go to Key Bindings

Select FiveM Key Bindings

Adjust Key Bindings

How to Reset Keybinds

Using Console

Editing Configuration File

How to change notifications

Change Notifications

Delete notifications

Add your own notification logic

Always test with backups

Editing Notifications

How to enable target system

Target System

Supported Target Systems

ox_target

qb-target

How To Enable The Target System

Find the it_bridge asset

Locate the config.lua file

Enable the Target System

Restart the server

How to execute commands

How It Works

Run a Chat Command

Trigger a Custom Command

Create a Shortcut Command

How to set webhook system

Webhook System

Fivemanager Integration

Discord Webhooks

Player Logs

Custom Notifications

How to set up webhooks

Create a Discord Webhook

`📍` | Fixed Possitions

`🔨` | Crafting Tables

`📊` | Ingame Admin Menu

`🔧` | Fully Configurable

`🌱` | Planting

`🧪` | Processing Tables

`💰` | Selling Drugs to NPCs

`🚬` | Takeable Drugs

`📊` | Ingame Admin Menu

`🔧` | Fully Configurable