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

# Installation

Install Hoverboard and spawn your first board.

{% stepper %}
{% step %}

### Add the resource

Put the `hoverboard` folder into your `resources` folder. See [Installation basics](/organized-chaos-docs/installation-basics.md) for the download and the licence key.
{% endstep %}

{% step %}

### Start it

Add it to your `server.cfg`:

```cfg
ensure hoverboard
```

{% endstep %}

{% step %}

### Add the items (optional)

For the boards as inventory items, run `install/esx_items.sql` (ESX) or add the lines for QBCore or ox\_inventory to your item list. See [Items](/organized-chaos-docs/hoverboards/items.md).
{% endstep %}

{% step %}

### Restart the server

Restart the whole server once after adding the resource.
{% endstep %}

{% step %}

### Spawn a board

As an admin, put a board in front of you with `/hoverboard`, or a particular one with `/hoverboard manta`. The command is for admins by default:

```cfg
add_ace group.admin command.hoverboard allow
```

The boards are ordinary vehicles, so any vehicle spawner works too, for example the `/car` command of your framework: `/car hoverboard_rocket`.
{% endstep %}
{% endstepper %}

## Spawn names

| Spawn name           | Name in game       |
| -------------------- | ------------------ |
| `hoverboard`         | Hoverboard         |
| `hoverboard_manta`   | Hoverboard Manta   |
| `hoverboard_stealth` | Hoverboard Stealth |
| `hoverboard_halo`    | Hoverboard Halo    |
| `hoverboard_turbine` | Hoverboard Turbine |
| `hoverboard_street`  | Hoverboard Street  |
| `hoverboard_rocket`  | Hoverboard Rocket  |
| `hoverboard_exo`     | Hoverboard Exo     |
| `hoverboard_shard`   | Hoverboard Shard   |
| `hoverboard_retro`   | Hoverboard Retro   |

Use the same names for an entry in your vehicle shop or garage script. The items have the same names too.

## Requirements

{% hint style="warning" %}
OneSync has to be enabled on the server. Without it, other players do not see the rider's poses, the ribbons of light or the boosts.
{% endhint %}

No framework is needed. ESX, QBCore, Qbox or ox\_inventory make the boards inventory items, ox\_target picks them up again, and ESX, QBCore or ox\_lib can show the resource's few messages, see `Config.Notify` on the [Configuration](/organized-chaos-docs/hoverboards/configuration.md) page.

## What you can edit

The code ships encrypted. These files are left open:

| File                      | What it is for                                                                                                                        |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `config.lua`              | Every setting and every text. See [Configuration](/organized-chaos-docs/hoverboards/configuration.md)                                 |
| `client_exports.lua`      | The client exports. Add exports of your own here. See [Exports](/organized-chaos-docs/hoverboards/exports.md)                         |
| `server_exports.lua`      | The server exports                                                                                                                    |
| `install/esx_items.sql`   | The item rows for ESX. See [Items](/organized-chaos-docs/hoverboards/items.md)                                                        |
| `data/carvariations.meta` | The colour sets a freshly spawned board picks from. See [Boards and colours](/organized-chaos-docs/hoverboards/boards-and-colours.md) |
| `data/handling.meta`      | The handling, and the values native flight goes by                                                                                    |
| `data/vehicles.meta`      | Camera, detail distances and the boost sound                                                                                          |

Restart the resource after changing `config.lua`. After changing a file in `data/`, restart the server and have players reconnect.