> For the complete documentation index, see [llms.txt](https://documentation.rcore.cz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.rcore.cz/paid-resources/rcore_banners/installation.md).

# Installation

## Database

The database will be imported automatically for you when you start the resource for the first time.

## Script

1. [Download the script from Keymaster](#script-download).
2. [Place the files in the resources folder](#place-files).
3. [Edit the server.cfg](#edit-server-cfg).
4. [Define items using Deployer or manually](#define-items).
5. [Define business job](#define-items).
6. [Start the server](#start-server).

***

### Step 1: Download the Script <a href="#script-download" id="script-download"></a>

* Download the script from [keymaster](https://keymaster.fivem.net).

***

### Step 2: Place the Files <a href="#place-files" id="place-files"></a>

* Open the downloaded `.zip`, copy the `[banners]` folder, and put it in your resources folder.

<details>

<summary>Resource folder image</summary>

<figure><img src="/files/deDG1ZXOvXUotsfPrxkQ" alt="Resource Folder"><figcaption><p>Resources folder</p></figcaption></figure>

</details>

***

### Step 3: Edit server.cfg <a href="#edit-server-cfg" id="edit-server-cfg"></a>

Go to your `server.cfg` and add `ensure [banners]`.

***

### Step 4: Define Items <a href="#define-items" id="define-items"></a>

* To define items in the RCore Banners script, you can either use the Deployer command or edit the configuration manually.
* Item definitions can be found at `rcore_banners/inventory_items.lua`
* Item images are located in `rcore_banners/assets/inventory_images/`

<details>

<summary>Using the Deployer command</summary>

* Full guide at this page [Inventory](/paid-resources/rcore_banners/inventory.md)

1. Start the server.
2. Open the server console (`txAdmin - Live console`)
3. Type the following command to automatically define items:

   ```bash
   bannersetup mf-inventory
   bannersetup es_extended
   ```

> **Note:** `inventory_name` should correspond to the name of your inventory system. Ensure it matches your configuration to avoid errors.

> **Note:** The deployer supports: **mf-inventory** and **es\_extended**. For other inventories, please follow the manual setup guide.

</details>

<details>

<summary>Manually Adding Items</summary>

* Follow this guide at this page [Inventory](/paid-resources/rcore_banners/inventory.md)

</details>

***

### Step 4.5: Define ace permissions <a href="#define-aces" id="define-aces"></a>

* Add to bottom of server.cfg permission part (script need this permission to use properly ACE permission)

```lua
add_ace resource.rcore_banners command.add_ace allow
add_ace resource.rcore_banners command.remove_ace allow
add_ace resource.rcore_banners command.add_principal allow
add_ace resource.rcore_banners command.remove_principal allow
```

### Step 5: Define jobs for business/billboards <a href="#define-jobs" id="define-jobs"></a>

✍️ Define Jobs

* Job setup is required to control which groups can access billboards

<details>

<summary>How to define business?</summary>

* Follow this guide at this page [Guide](/paid-resources/rcore_banners/how_to_begin.md)

</details>

***

### Step 6: Enjoy <a href="#start-server" id="start-server"></a>

* Start your server and enjoy RCore Banners.

## Commands

| Command        | Description                                                                                                    |
| -------------- | -------------------------------------------------------------------------------------------------------------- |
| /banners       | This is used for opening banner menu with all server banners                                                   |
| /rbanner       | This is used for removing nearby poster at player position.                                                    |
| /billboardHide | This is used for hiding billboards - it will enable tool, which allows to select billboards to hide on server. |