Skip to content

Commit c1ec450

Browse files
AllRoundJonUAllRoundJonU
committed
Update the it_bridge docs
1 parent cbb901f commit c1ec450

File tree

4 files changed

+270
-15
lines changed

4 files changed

+270
-15
lines changed

‎pages/it_bridge/_meta.json

+6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111
"footer": false
1212
}
1313
},
14+
"test": {
15+
"title": "❓・How to test?",
16+
"theme": {
17+
"footer": false
18+
}
19+
},
1420
"exports": "⚙️・Exports"
1521
}
1622

‎pages/it_bridge/config-preview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: it-crafting - Config Preview
2+
title: it_bridge - Config Preview
33
description: Full configuration preview of the it-crafting script
44
---
55

‎pages/it_bridge/installation.mdx

+31-14
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: it-crafting - Installation
2+
title: it_bridge - Installation
33
description: Welcome to the it-crafting installation guide, here you can learn how to completely install our asset, following each step we will achieve a clean and fluid installation where you will not find any problems, as long as the documentation has been completed in full.
44
---
55

66
import { Cards, Card, Tabs} from 'nextra/components'
77
import { Callout } from '@components/Callout'
88
import Accordion from '@components/Accordion'
99
import AccordionGroup from '@components/AccordionGroup'
10-
import { IconShoppingBag } from '@tabler/icons-react';
10+
import { IconShoppingBag, IconApps} from '@tabler/icons-react';
1111

1212
# Installation
1313
Welcome to the **it_bridge** installation guide, here you can learn how to completely install our asset,
@@ -24,36 +24,49 @@ as long as the documentation has been completed in full.
2424
you can obtain more information about common errors in the Common Problems section within this same documentation to seek help independently.
2525
</Callout>
2626

27-
<Callout type="warning">
28-
When installing the script make sure to **not** rename the script folder, this can cause errors in the script. The name of the script folder should always be **it-crafting**.
29-
</Callout>
30-
3127
## Asset download
32-
You can get the lates version of the it_bridge script fo free on our tebex store
28+
You can get the lates version of the it_bridge script fo free on our tebex store if you want to update the script you have to visit your keymaster.
3329
<Cards>
3430
<Card icon={<IconShoppingBag />} title="Tebex" href="https://it-scripts.tebex.io/package/6706602" />
31+
<Card icon={<IconApps />} title="Cfx.re Portal" href="https://portal.cfx.re/assets/granted-assets?page=1&sort=asset.updated_at&direction=asc&search=allroundjonu" />
3532
</Cards>
3633

3734
<Callout type="warning">
38-
If you have downloaded the script from another site, there is no guarantee that the script will actually work. Please download it again from the it-scripts tebex page.
39-
</Callout>
40-
41-
<Callout type="error">
42-
If you have paid money for this script, it is a **SCAM**. The **it_bridge** script is and will always remain free. Please report the page to us on the Discord server.
35+
If you have downloaded the script from another site, there is no guarantee that the script will actually work. Please download it again from the the Cfx.re Portal.
4336
</Callout>
4437

4538
## Asset dependencies
4639
| Dependencies | Links |
4740
| --- | --- |
4841
| ox_lib | https://github.com/overextended/ox_lib/releases |
4942

43+
<Callout type="info">
44+
If you have not installed the dependencies, you will not be able to use the asset correctly, please install them before continuing with the installation.
45+
</Callout>
46+
5047
## Asset positioning
5148
<Callout type="error">
5249
Correctly position the assets by following this step, if something goes wrong you will probably get errors about exports not found, do not skip this step.
5350
</Callout>
5451

55-
For the execution of this asset, we will respect the respective order mentioned below.
52+
When you have downloaded the asset, you will have a folder with the name of the asset, inside you will find to seperate folders, each folder is on asset.
53+
54+
We recommend to create a folder with the name `[it-scripts]` in your resources folder, and then move the asset folders inside the `[it-scripts]` folder.
55+
56+
After you added both assets you have to add the `it_bridge` resource to your `server.cfg` file.
57+
58+
<Callout type="warning">
59+
In your `server.cfg` file you have to add the `it_bridge` resource after any script the bridge needs to work for most servers that will be
60+
- Your Framework
61+
- Your Inventory Script
62+
- Your Notification Script *(If you have one on your server)*
63+
- Your TextUI Script *(If you have one on your server)*
64+
- Your Target Script *(If you have one on your server)*
65+
- Your Disptach Script *(If you have one on your server)*
66+
- ox_lib
67+
</Callout>
5668

69+
**Example:**
5770
```lua
5871
-- First we will start the Database
5972
ensure oxmysql
@@ -73,4 +86,8 @@ ensure ox_lib
7386
ensure it_bridge
7487

7588
-- After that you can start any other it script you want to use
76-
```
89+
```
90+
91+
<Callout type="error">
92+
Do not add the `bridge_tester` resource to your `server.cfg` file, this resource is only for testing purposes and should not be used on a live server.
93+
</Callout>

‎pages/it_bridge/test.mdx

+232
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,232 @@
1+
---
2+
title: it_bridge - How to test?
3+
description: Welcome to the it_bridge test guide, here you can learn how to completely test our asset, following each step we will achieve a clean and fluid test where you will not find any problems, as long as the documentation has been completed in full.
4+
---
5+
6+
import { Callout } from '@components/Callout'
7+
import { Steps } from 'nextra/components'
8+
9+
# How to test?
10+
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.
11+
12+
<Callout type="warning">
13+
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.
14+
</Callout>
15+
16+
<Steps>
17+
### Configuration of the script
18+
First you have to configure the **it_bridge** script, you can do this in the `config.lua` file.
19+
On most servers you can leave the default settings, but if you want to change something you can do this.
20+
21+
### Start the it_bridge script
22+
After you have configured the script, you can start the script on your server.
23+
If you followed the install guide correctly, the script should start aumaotically when you start your server.
24+
If the script does not start automatically, you can start it manually with the following command in your txAdmin Console:
25+
```lua
26+
start it_bridge
27+
```
28+
29+
After starting the script, you should see a message in your server console after a few seconds, that the script has started successfully.
30+
The script will also tell you which settings are currently active. Please make sure these settings are correct.
31+
32+
**Example Message:**
33+
[![Example Message](https://i.imgur.com/gyQOv2X.png)](https:/i.imgur.com/gyQOv2X.png "Open Image")
34+
35+
### Start the bridge_tester script
36+
After you started the **it_bridge** script, you can start the **bridge_tester** script.
37+
This script is used to test the **it_bridge** script and to make sure that everything is working correctly.
38+
You can start the **bridge_tester** script with the following command in your txAdmin console:
39+
```lua
40+
start bridge_tester
41+
```
42+
43+
### Test the script
44+
After you have started the **bridge_tester** script, you can test the **it_bridge** script.
45+
46+
<Steps>
47+
#### 1. Test your Framework
48+
To test if the it_brige script is working correctly, with your framework, you can use the following command in your txAdmin console:
49+
```lua
50+
bridgeTestFramework id money bank blackMoney
51+
```
52+
- **id**: The player ID you want to test the script with.
53+
- **money**: The amount of money (cash) the player currently has.
54+
- **bank**: The amount of money the player currently has in the bank.
55+
- **blackMoney**: The amount of black money the player currently has.
56+
57+
<Callout type="info">
58+
If you are using **qb-core**, **qBox** as your framework set the amount for **blackMoney** to the amount of crypto the player has.
59+
If you are using **ND_Core** set the amount for **blackMoney** to 0.
60+
</Callout>
61+
62+
After you issued the command, you should see some messages in your server console,
63+
the script will automatically test the **it_bridge** script with the given values.
64+
65+
The script will print the result of every test in the server console.
66+
If you encounter any errors, please report them in the [Discord](https://discord.it-scripts.com).
67+
68+
##### Example input
69+
```lua
70+
bridgeTestFramework 1 1000 500 0
71+
```
72+
73+
##### Example output
74+
[![Example Output](https://i.imgur.com/X4SPCCK.png)](https:/i.imgur.com/X4SPCCK.png "Open Image")
75+
76+
#### 2. Test your Inventory Script
77+
To test if the **it_bridge** script is working correctly with your inventory script, you can use the following command in your txAdmin console:
78+
```lua
79+
bridgeTestInventory id item
80+
```
81+
82+
- **id**: The player ID you want to test the script with.
83+
- **item**: The item you want to test the script with.
84+
85+
<Callout type="info">
86+
For the item parameter, you can use any item that is in your inventory **except** for the money items.
87+
</Callout>
88+
89+
After you issued the command, you should see some messages in your server console,
90+
the script will automatically test the **it_bridge** script with the given values.
91+
92+
The script will print the result of every test in the server console.
93+
If you encounter any errors, please report them in the [Discord](https://discord.it-scripts.com).
94+
95+
##### Example input
96+
```lua
97+
bridgeTestInventory 1 bread
98+
```
99+
100+
##### Example output
101+
[![Example Output](https://i.imgur.com/OIiB92j.png)](https:/i.imgur.com/OIiB92j.png "Open Image")
102+
#### 3. Test your Notification Script
103+
To test if the **it_bridge** script is working correctly with your notification script, you can use the following command in your txAdmin console:
104+
```lua
105+
bridgeTestNotify id
106+
```
107+
- **id**: The player ID you want to test the script with.
108+
109+
After you issued the command, the targeted player should receive 4 notifications (every notification type for 5 Seconds) on the screen.
110+
111+
If the player does not receive the notifications, please report this in the [Discord](https://discord.it-scripts.com).
112+
113+
##### Example input
114+
```lua
115+
bridgeTestNotify 1
116+
```
117+
118+
#### 4. Test your TextUI Script
119+
To test if the **it_bridge** script is working correctly with your TextUI script, you can use the following command in your txAdmin console:
120+
```lua
121+
bridgeTestTextUI id
122+
```
123+
- **id**: The player ID you want to test the script with.
124+
125+
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.
126+
This is normal and should not be a problem.
127+
128+
If the player does not receive the TextUI, please report this in the [Discord](https://discord.it-scripts.com).
129+
130+
##### Example input
131+
```lua
132+
bridgeTestTextUI 1
133+
```
134+
135+
#### 5. Test your Menu Script
136+
137+
<Callout type="warning">
138+
Before testing the Menu, please make sure you have tested the Notification script.
139+
</Callout>
140+
141+
To test if the **it_bridge** script is working correctly with your Menu script, you can use the following command in your txAdmin console:
142+
```lua
143+
bridgeTestMenu id
144+
```
145+
- **id**: The player ID you want to test the script with.
146+
147+
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.
148+
149+
If the player does not receive the Menu, please report this in the [Discord](https://discord.it-scripts.com).
150+
151+
152+
#### 6. Test your Target Script
153+
154+
<Callout type="info">
155+
To test your Target script, you need more than one command to test it, because you have to test every target type separately.
156+
</Callout>
157+
158+
To test if the **it_bridge** script is working correctly with your Target script, you can use the following commands in your txAdmin console:
159+
160+
```lua
161+
bridgeBoxZone id
162+
```
163+
- **id**: The player ID you want to test the script with.
164+
165+
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.
166+
The prop and the box zone should disappear after 15 seconds.
167+
168+
```lua
169+
bridgeTargetEntity id
170+
```
171+
- **id**: The player ID you want to test the script with.
172+
173+
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.
174+
The prop should disappear after 15 seconds.
175+
176+
```lua
177+
bridgeGlobalPedTest id
178+
```
179+
- **id**: The player ID you want to test the script with.
180+
181+
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!**
182+
After 15 seconds the target options should disappear.
183+
184+
```lua
185+
bridgeGlobalVehicle id
186+
```
187+
- **id**: The player ID you want to test the script with.
188+
189+
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!**
190+
After 15 seconds the target options should disappear.
191+
192+
```lua
193+
bridgeGlobalPlayer id
194+
```
195+
- **id**: The player ID you want to test the script with.
196+
197+
<Callout type="warning">
198+
To test the globalPlayer command there should be at least one other player in the server.
199+
</Callout>
200+
201+
After you issued the command, the targeted player should have two target options on every player in the server.
202+
After 15 seconds the target options should disappear.
203+
204+
```lua
205+
bridgeModel id
206+
```
207+
- **id**: The player ID you want to test the script with.
208+
209+
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.
210+
The prop should disappear after 15 seconds.
211+
212+
213+
If there any problems with the target script, please report this in the [Discord](https://discord.it-scripts.com).
214+
</Steps>
215+
216+
### Report your results
217+
After you have tested the **it_bridge** script, you should report your results in the [Discord](https://discord.it-scripts.com).
218+
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.
219+
220+
For reporting, please join the Discord and go to the `📑・tickets` channel and open a `Bridge Results` Ticket.
221+
In this ticket, please provide the following information:
222+
- Image of the startup message of the **it_bridge** script.
223+
- Results of the tests.
224+
- *If you do not have any errors you can just send a short message like `No errors found!`*
225+
- **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.**
226+
227+
### Stop the bridge_tester script
228+
After you have tested the **it_bridge** script, you can stop the **bridge_tester** script with the following command in your txAdmin console:
229+
```lua
230+
stop bridge_tester
231+
```
232+
</Steps>

0 commit comments

Comments
 (0)