# Getting set up

<details>

<summary>Step 1: Server Artifacts</summary>

It is important to update your server artifacts at least once a **month**. \
\
You can download the latest artifacts for [Windows](https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/) or[ Linux](https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/)

</details>

<details>

<summary>Step 2: Enforcing Gamebuilds</summary>

For all GTA 5 props and animations to work with RPEmotes, it is recommended that you use the latest supported gamebuild. For an in depth guide, please read through our [Enforcing Gamebuilds tutorial](https://rpemotes-reborn.gitbook.io/rpemotes-reborn/fundamentals/getting-set-up/enforcing-gamebuilds).

</details>

<details>

<summary>Onesync Infinity</summary>

For rpemotes-reborn and particle effects to sync across clients as intended, Onesync Infinity is a requirement. Please check [this guide](https://rpemotes-reborn.gitbook.io/rpemotes-reborn/fundamentals/getting-set-up/enforcing-gamebuilds/onesync-infinity) to set it up.

</details>

<details>

<summary>Step 3: Downloading</summary>

Click [here](https://github.com/alberttheprince/rpemotes-reborn/releases) to download rpemotes-reborn

Extract the file inside of the zip to a new folder and rename it to `rpemotes-reborn`

</details>

<details>

<summary>Step 4: Installing</summary>

Once rpemotes-reborn is successfully downloaded and extracted into a folder renamed `rpemotes-reborn`  copy it  to the `/resources` folder in your fiveM server.

Add`ensure rpemotes-reborn` to your `server.cfg`

*If the folder is already ensured e.g. `ensure [example folder],` this step can be skipped.*

</details>

<details>

<summary>Step 5: Configuring</summary>

Open the `rpemotes-reborn` resource and edit the `config.lua` to enable or disable certain features. To edit the `config.lua` use a text editor e.g. Visual Studio Code or Notepad++.

</details>

<details>

<summary>(Optional): SQL Setup</summary>

To use the SQL features, install the latest version of the [oxmysql](https://github.com/overextended/oxmysql) resource and enable the setting in `config.lua`

{% code title="config.lua" %}

```
SqlKeybinding = true,
```

{% endcode %}

In order for rpemotes-reborn to work with SQL you will need to open `fxmanifest.lua` and uncomment the following lines

<pre data-title="fxmanifest.lua"><code><strong>-- dependency 'oxmysql' 
</strong><strong>-- server_script '@oxmysql/lib/MySQL.lua'
</strong></code></pre>

***

Alternatively, you can use the keybind command that comes with FiveM without having to use SQL, by entering the following into F8:

`bind keyboard "Yourbutton" "e youremote"`. To remove the key bind, type `"unbind keyboard "Yourbutton"`.

</details>

<details>

<summary>(Optional): QB-Core Integration</summary>

If you’re using qb-core, you can now set

{% code title="config.lua" %}

```
Framework = "qb-core",
```

{% endcode %}

in the config file, otherwise leave it as

{% code title="config.lua" %}

```
Framework = false,
```

{% endcode %}

*You may need to alter some code within qb-core to work with rpemotes-reborn .*

</details>

<details>

<summary>Adding Custom Content</summary>

Adding custom content to rpemotes-reborn doesn't need to be complicated. The rpemotes-reborn team suggests using the appropiately named `AnimationListCustom.lua` file to add your own animations into our menu and simply adding your props and animations files in the `stream` folder. Here you can find folders named `[Custom Emotes]` and `[Props]`.\
\
We'll go into more detail about adding your content over on our [Custom Emotes & Props ](https://rpemotes-reborn.gitbook.io/rpemotes-reborn/for-developers/important-note/custom-emotes-and-props)page.

</details>
