# Installation

### Dependencies

<details>

<summary>oxmysql</summary>

#### Installation

* Download the [latest build](https://github.com/overextended/oxmysql/releases/latest) of oxmysql (not the source code).
* Extract the contents of the archive to your resources folder.
* Start the resource near the top of your resources in your server.cfg.

#### Required version

Your oxmysql version must be <mark style="color:yellow;">2.0.0 or above</mark> in order to work with our system.

#### Use the built version

Make sure you have downloaded the <mark style="color:yellow;">built version</mark> of oxmysql! If you download the source code, then the resource won't start and queries are unable to execute.&#x20;

The built version can be downloaded from the [releases page](https://github.com/overextended/oxmysql/releases/latest) (oxmysql.zip).

</details>

<details>

<summary>ox_lib</summary>

#### Installation

* Download the [latest build](https://github.com/overextended/ox_lib/releases/latest) of ox\_lib (not the source code).
* Extract the contents of the archive to your resources folder.
* Start the resource near the top of your resources in your server.cfg.

#### Use the built version

Make sure you have downloaded the <mark style="color:yellow;">built version</mark> of ox\_lib! If you download the source code, then it won't function correctly and the application will have problems.&#x20;

The built version can be downloaded from the [releases page](https://github.com/overextended/ox_lib/releases/latest) (ox\_lib.zip).

</details>

<details>

<summary>xsound</summary>

#### Installation

* Download the latest [xsound](https://github.com/Xogy/xsound).
* Extract the contents of the acrhive to your resources folder.
* Start the resource in your server.cfg.

</details>

### Installing the resource&#x20;

1. Make sure you have the [dependencies](#dependencies) listed above installed.
2. Extract the contents of the archive to your resources folder.
3. Run the SQL queries provided in <mark style="color:blue;">rahe-boombox/db.sql</mark>.
4. Choose your framework tab from the section below & follow the instructions.

{% tabs %}
{% tab title="QB" %}
Open <mark style="color:blue;">rahe-boombox/config/shared.lua</mark> and set line 4 to <mark style="color:blue;">framework = 'QB'</mark>
{% endtab %}

{% tab title="ESX" %}
Open <mark style="color:blue;">rahe-boombox/config/shared.lua</mark> and set line 4 to <mark style="color:blue;">framework = 'ESX'</mark>
{% endtab %}

{% tab title="Custom" %}
Open <mark style="color:blue;">rahe-boombox/config/shared.lua</mark> and set line 4 to <mark style="color:blue;">framework = 'CUSTOM'</mark>
{% endtab %}
{% endtabs %}

{% hint style="info" %}
Recommended, but not neccessary:

* Get your own API key using our tutorial in <mark style="color:blue;">config/server.lua</mark>.
* Insert your Youtube API key in <mark style="color:blue;">config/server.lua</mark> (`youtubeApiKey` variable)
  {% endhint %}

### Using the resource

Use the command <mark style="color:blue;">/music</mark> in-game to open the boombox menu.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rahe.dev/our-scripts/boombox/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.