Skip to content

Commit 89c3fe3

Browse files
AllRoundJonUAllRoundJonU
committed
Add before-you-start category
1 parent 543ff11 commit 89c3fe3

File tree

5 files changed

+208
-0
lines changed

5 files changed

+208
-0
lines changed

‎pages/before-you-start/_category_.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
collapsible: true
2+
collapsed: true
3+
link:
4+
type: generated-index
5+
description: "Important guids on how to get started with setting up your IT scripts"

‎pages/before-you-start/_meta.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"how-to-install-heidisql": {
3+
"title": "How to install HeidiSQL",
4+
"theme": {
5+
"footer": false
6+
}
7+
},
8+
"how-to-update-my-server": {
9+
"title": "How to update my server",
10+
"theme": {
11+
"footer": false
12+
}
13+
},
14+
"how-to-enable-onesync": {
15+
"title": "How to enable OneSync",
16+
"theme": {
17+
"footer": false
18+
}
19+
}
20+
}
21+

‎pages/before-you-start/how-to-enable-onesync.mdx‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: it-scripts - How to enable OneSync
3+
description: Here’s a step-by-step guide to enable OneSync.
4+
---
5+
6+
import { Steps } from 'nextra/components'
7+
8+
# How to enable OneSync
9+
OneSync is a feature in FiveM that allows for larger server capacities and improved synchronization of entities and players.
10+
Enabling OneSync is a straightforward process that requires a simple edit to your server.cfg file.
11+
12+
### Steps to Enable OneSync
13+
<Steps>
14+
### Open Your Server.cfg File
15+
- Navigate to your server directory and locate the `server.cfg` file.
16+
- Open the `server.cfg` file using a text editor (e.g., Notepad, Visual Studio Code).
17+
18+
### Add the OneSync Command
19+
Add the following line to your `server.cfg` file to enable OneSync:
20+
```plaintext
21+
onesync on
22+
```
23+
24+
### Optional: Enable OneSync Infinity
25+
If your server needs support for more than 64 players (up to 1024), enable OneSync Infinity by adding this line:
26+
```plaintext
27+
onesync_enableInfinity 1
28+
```
29+
Infinity mode is designed for large-scale servers and requires proper resource optimization.
30+
31+
## Save and Restart
32+
- Save the changes to your `server.cfg` file.
33+
- Restart your server for the changes to take effect.
34+
35+
</Steps>

‎pages/before-you-start/how-to-install-heidisql.mdx‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: it-scripts - How to install HeidiSQL
3+
description: Here’s a step-by-step guide to downloading and installing MariaDB and HeidiSQL.
4+
---
5+
6+
import { Steps } from 'nextra/components'
7+
import YouTube from '@components/YouTube'
8+
9+
# How to install HeidiSQL
10+
HeidiSQL is a powerful and user-friendly tool for managing databases.
11+
It’s particularly useful for working with MariaDB, which is the database system used by many of our assets.
12+
Here’s a step-by-step guide to downloading and installing MariaDB and HeidiSQL.
13+
14+
## Download and Install MariaDB
15+
<Steps>
16+
### Donwload MariaDB
17+
- Visit the official [MariaDB website](https://mariadb.org/download/).
18+
- Select your operating system (Windows, macOS, Linux)
19+
- Download the latest stable version of MariaDB.
20+
21+
### Run the Installer
22+
- Open the downloaded installer file and start the installation process.
23+
- Follow the on-screen instructions to complete the installation.
24+
25+
### Configuration During Installation
26+
- **Select Components**: Ensure "MariaDB Server" and "Command Line Tools" are selected for installation.
27+
- **User Setup**: Set a password for the `root` user (administrator). Save this password securely.
28+
- **Connection Port**: The default port for MariaDB is `3306`. Keep this default unless another service is using the same port.
29+
30+
### Complete the Installation
31+
- Follow the remaining prompts to finish the installation.
32+
- MariaDB will be installed as a service, which means it will run in the background automatically.
33+
34+
</Steps>
35+
36+
## Download and Install HeidiSQL
37+
<Steps>
38+
### Download HeidiSQL
39+
- Visit the official [HeidiSQL website](https://www.heidisql.com/download.php).
40+
- Click on the "Download" button to get the latest version of HeidiSQL.
41+
42+
### Run the Installer
43+
- Open the downloaded installer file and start the installation process.
44+
- Follow the on-screen instructions to complete the installation.
45+
46+
### Set Up a Connection in HeidiSQL
47+
- Open HeidiSQL after installation.
48+
- Click **"New"** to create a new connection.
49+
- Fill in the fields as follows:
50+
- **Network Type**: MySQL (TCP/IP).
51+
- **Hostname/IP**: `localhost` (or your server's IP).
52+
- **User**: `root`.
53+
- **Password**: Use the password you set during the MariaDB installation.
54+
- **Port**: `3306` (or the port you configured for MariaDB).
55+
- Click **"Save"** and then **"Open"** to connect.
56+
57+
</Steps>
58+
59+
## Visual Guide With Video
60+
If you haven't done it yet, here is a short installation guide for MariaDB and HeidiSQL.
61+
62+
<YouTube
63+
id="6QCx0ayBLUQ"
64+
/>

‎pages/before-you-start/how-to-update-my-server.mdx‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: it-scripts - How to update my server
3+
description: Here’s a step-by-step guide to updating your server.
4+
---
5+
6+
import { Steps } from 'nextra/components'
7+
8+
# How to update my server
9+
To ensure your FiveM server runs smoothly and avoids critical issues, it’s essential to keep your framework, artifacts, and gamebuild up to date. Here's a detailed guide:
10+
11+
<Steps>
12+
### Framework
13+
Your server framework is the most important thing, we will always recommend the great ESX, but here is a small guide on how to update it correctly.
14+
15+
### Artifacts
16+
Artifacts are everything on our server, they are the brain of it.
17+
18+
### Gamebuild
19+
The gamebuild is the version of the game or DLC that we will run, we always recommend the latest version.
20+
21+
</Steps>
22+
23+
## Framework Update
24+
Updating your framework is a crucial step before proceeding with artifacts and gamebuild updates. Follow these steps carefully:
25+
26+
<Steps>
27+
### Download the Official Framework
28+
- For **es_extebded (ESX)**, visit the official [**ESX GitHub repository**]()
29+
- For **QBCore**, visit the official [**QBCore GitHub repository**]()
30+
- For **Obox Framework**, visit the official [**Obox GitHub repository**]()
31+
- For **ND_Core**, visit the official [**ND_Core GitHub repository**]()
32+
33+
### Replace Your Current Framework Folder
34+
Completely remove your existing framework folder and replace it with the latest version from GitHub. Avoid merging files as this may cause unexpected issues.
35+
36+
### Do Not Rename the Framework Folder
37+
Keep the folder name exactly as provided by the official repository (e.g., qb-core or es_extended).
38+
Renaming it can lead to severe compatibility problems with scripts, as they rely on specific folder names for proper integration.
39+
Renaming your framework does not make it "custom"—it makes it dysfunctional.
40+
41+
</Steps>
42+
43+
### Update Artifacts
44+
Artifacts are the core files needed to run your server. Keeping them updated is essential for compatibility with the latest FiveM features.
45+
46+
<Steps>
47+
48+
### Remove Old Artifacts
49+
Delete the current `artifacts` folder from your server directory. This ensures that no outdated files remain that could cause conflicts.
50+
51+
### Download Latest Artifacts
52+
Get the latest version of artifacts for your operating system from the official FiveM links:
53+
- [Windows Artifacts](https://runtime.fivem.net/artifacts/fivem/build_proot_win64/master/)
54+
- [Linux Artifacts](https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/)
55+
56+
### Extract and Replace
57+
Extract the downloaded artifacts and replace your old artifacts folder completely.
58+
59+
</Steps>
60+
61+
## Update Gamebuild
62+
Updating the gamebuild is the final step in ensuring your server is running the latest version of FiveM. Follow these steps:
63+
64+
<Steps>
65+
### Open Your server.cfg File
66+
Find the `server.cfg` file in your server directory. This file contains all the configuration settings for your server.
67+
68+
### Edit Your Server Configuration
69+
Open the `server.cfg` file in a text editor and locate the line that specifies the gamebuild. It should look something like this:
70+
```plaintext
71+
set sv_enforceGameBuild "3258"
72+
```
73+
74+
Replace the number with the latest gamebuild version. You can find the latest gamebuild version on the official [FiveM website](https://runtime.fivem.net/artifacts/fivem/build_proot_win64/master/).
75+
76+
</Steps>
77+
78+
## Why Is This Important?
79+
- Keeping your framework, artifacts, and gamebuild updated ensures your server is compatible with the latest scripts and features.
80+
- Not updating can lead to crashes, bugs, or incomplete functionality.
81+
- Avoid renaming folders or using unofficial versions of frameworks, as this often causes critical errors.
82+
83+
By following these steps, you ensure a stable, well-functioning server that minimizes common issues.

0 commit comments

Comments
 (0)