> 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

Step by step documentation how to properly install script.

## Database

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

## 🛠️ Installation Steps

{% stepper %}
{% step %}

### Download the Script

Download `rcore_banners` from [CFX Portal](https://portal.cfx.re/assets/granted-assets?page=1\&sort=asset.updated_at\&direction=asc\&search=rcore_banners).
{% endstep %}

{% step %}

### Place the Files

Open the downloaded `.zip`, copy the `[banners]` folder, and put it in your resources folder.
{% endstep %}

{% step %}

### Edit server.cfg

Go to your `server.cfg` and add `ensure [banners]`.
{% endstep %}

{% step %}

### Define Items

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 items](/paid-resources/rcore_banners/integrations/inventory-items.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
   ```

{% hint style="info" %}
`inventory_name` should correspond to the name of your inventory system. Ensure it matches your configuration to avoid errors.

The deployer supports: **mf-inventory** and **es\_extended**. For other inventories, please follow the manual setup guide.
{% endhint %}

</details>

<details>

<summary>Manually Adding Items</summary>

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

</details>
{% endstep %}

{% step %}

### Define ACE Permissions

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
```

{% endstep %}

{% step %}

### Define Business/Job

Job setup is required to control which groups can access billboards - see [Business](/paid-resources/rcore_banners/configs/business.md) for defining your own business.
{% endstep %}
{% endstepper %}