# Installation

## Requirements

Make sure you have the following installed:

* [ox\_lib](https://github.com/communityox/ox_lib)
* [oxmysql](https://github.com/communityox/oxmysql)

***

## Install Steps

{% stepper %}
{% step %}

### Download

Download the resource and extract it to your resources folder
{% endstep %}

{% step %}

### Database

Import the database tables: 

```
sql/collectables.sql
```

{% endstep %}

{% step %}

### Add

Add to your `server.cfg`:

```
start mad_collectables
```

{% endstep %}

{% step %}

### Configuration

Adjust settings in the [config](https://madcap.gitbook.io/docs/premium-resources/mad_collectables/configuration) files to your liking:

* `config/shared.lua` - Debug, Sounds, Animations
* `config/client.lua` - UI Settings, Keybinds
* `config/server.lua` - Collectable sets, Commands, Leaderboard, Rewards, Logging
  {% endstep %}

{% step %}

### *Optional*

Add the stickerbook item to your inventory
{% endstep %}
{% endstepper %}

***

## Inventory Item Setup

The stickerbook item lets players open the collectables UI from their inventory.

### ox\_inventory

Add to your items file:

```lua
["mad_collectables_stickerbook"] = {
    label = "Collectables Stickerbook",
    weight = 100,
    client = {
        export = "mad_collectables.openUI",
    },
},
```

### qb-inventory

Add to your shared items:

```lua
mad_collectables_stickerbook = {
    name = 'mad_collectables_stickerbook',
    label = 'Collectables Stickerbook',
    weight = 100,
    type = 'item',
    image = 'mad_collectables_stickerbook.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = 'Your personal sticker collection book'
},
```

### Item Image

An image for the inventory item is included in the `INSTALL/` folder:

```
INSTALL/mad_collectables_stickerbook.png
```

Copy this to your inventory's images folder.