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

# 📦 Installation

🔧 Installation Guide

Follow these steps carefully to install **BrosDev Waypoint System** on your FiveM server.

***

#### 📦 1. Download Resource

Download the latest version from your **Cfx**.

Make sure you extract the folder properly after downloading.

***

#### 📁 2. Add to Resources Folder

Place the resource inside your server’s `resources` directory:

```
resources/[standalone]/brosdev_waypoint
```

> You can also place it in any folder, but keep the name unchanged for consistency.

***

#### 🔧 3. Add to server.cfg

Open your `server.cfg` and add:

```cfg
ensure brosdev_waypoint
```

> Make sure this is placed **after core dependencies** (like ESX/QBCore/ox\_lib if used in your server).

***

#### ⚙️ 4. Configure the Script

Open:

```
config.lua
```

Here you can customize:

* HUD settings
* Marker style, size, and height
* Colors & themes
* Arrival distance
* Vehicle sync behavior
* Sound settings
* Player toggle options

> No database setup is required — everything is saved per player using KVP.

***

#### 🎮 5. Restart Server / Resource

After installation, restart either your server or just the resource:

```bash
restart brosdev_waypoint
```

***

#### 🚗 6. Optional Dependencies (Recommended)

This script works **fully standalone**, but for best experience:

* OneSync Enabled (recommended for vehicle sync)
* Latest FiveM build (cerulean+)
* Any framework (ESX / QBCore / QBX optional)

***

#### 🔊 7. Verify Installation

Once in-game:

* Set a waypoint on map
* HUD + marker should appear automatically
* Use `/wpsettings` to open configuration menu
* Use `/wptoggle` to enable/disable system

***

#### ⚠️ Troubleshooting Tip

If nothing appears:

* Check `ensure brosdev_waypoint`
* Make sure resource name matches folder name
* Verify client F8 console for errors

***