> For the complete documentation index, see [llms.txt](https://bl4ck.gitbook.io/_bl4ck-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bl4ck.gitbook.io/_bl4ck-docs/scripts/lb_vips/configuration.md).

# Configuration

## **ATTENTION FOR ESX USERS**

If you're using ESX, you must uncomment `'@es_extended/imports.lua'` from `fxmanifest.lua`.

### Instructions:

* Locate the following section: 

```lua
shared_scripts {
    -- '@es_extended/imports.lua',
    '@ox_lib/init.lua',
    'shared/framework.lua',
    'shared/locale.lua'
}
```

* Modify it to:

```lua
shared_scripts {
    '@es_extended/imports.lua',
    '@ox_lib/init.lua',
    'shared/framework.lua',
    'shared/locale.lua'
}
```

## **CONFIGURATION OPTIONS**

```lua
--[[------------------------
    CONFIG FILE EXAMPLE:
------------------------]]--

Config = {}
Config.Locale               = GetConvar('lb:locale', 'es')
Config.vipCheck             = 'vip'
Config.givevip              = 'givevip'
Config.removevip            = 'removevip'
Config.giftCard             = 'vipgiftcard'
Config.vipCode              = 'vipcode'
Config.Identifier           = 'license'
Config.discordWebhook       = 'https://discord.com/api/webhooks/...'
Config.embedThumbnail       = 'https://i.imgur.com/image.png'
Config.embedImage           = 'https://i.imgur.com/image.png'
Config.embedFooterIcon      = 'https://i.imgur.com/image.png'
Config.allowedGroups        = {
    'owner',
    'dg'
}
Config.vipLevels            = {
    {label = 'VIP Gold', money = 25000000},
    {label = 'VIP Platinum', priority = 400},
    {label = 'VIP Diamond', priority = 500, money = 100000000}
}
```

### **Config.vipCheck**

This command allows players to verify their VIP status.\
If they have VIP, it will also display their VIP level and the expiration date.

Usage:

```lua
/vip
[command]
```

### **Config.givevip**

This command is used to grant VIP status to players.

Usage:

```lua
/givevip
[command]
```

### **Config.removevip**

This command is used to revoke a player's VIP status.

Usage:

```lua
/removevip
[command]
```

### **Config.giftCard**

This command is used to create a VIP gift card.\
Once created, a unique code associated with the gift card is sent to a specified Discord channel via the 'Config.discordWebhook'.

Usage:

```lua
/giftcard    3        1
[command] [level] [duration]
```

### **Config.vipCode**

This refers to the command players use in-game to redeem the unique code that was created and sent to the Discord channel.\
By redeeming this code, players can obtain or renew their VIP status.

Usage:

```lua
/vipcode 4xIljRDQnZH0gIb
[command] [code_string]
```

### **Config.Identifier**

This is the user identifier you wish to use. It can be set to 'license' or 'steam'.<br>

### **Config.discordWebhook**

This is the webhook link to a specific Discord channel.\
When the 'Config.giftCard' command is used, an embed message containing the unique VIP code is generated and then sent to this Discord channel via this webhook.

The Gift Card will be like this:

![](/files/FmpCDTdEq1gdChqu1qBS)<br>

### **Config.embedThumbnail**

This is the URL for the thumbnail image that will appear in the Discord embed notification.<br>

### **Config.embedImage**

This is the URL for the main image that will appear in the Discord embed notification.<br>

### **Config.embedFooterIcon**

This is the URL for the footer icon that will appear at the bottom of the Discord embed notification.<br>

### **Config.allowedGroups**

Groups that are permitted to use the command."<br>

### **Config.vipLevels**

Here, you can define the desired VIP levels." "For each entry in the table, the level increases by 1.\
If 'money' is assigned, the player will automatically receive the specified amount of money.\
If 'priority' is assigned, the player will be granted the specified amount of priority when joining the queue.

Usage and example:

{% code overflow="wrap" %}

```lua
Config.vipLevels = {
    {label = 'VIP Gold', money = 25000000},
--[ THIS WILL BE LEVEL 1 AND WHEN THE PLAYER RECIVES THE VIP HE WILL RECIVE THE SPECIFIED AMMOUNT OF MONEY ]--

    {label = 'VIP Platinum', priority = 400},
--[ THIS WILL BE LEVEL 2 AND WHEN THE PLAYER RECIVES THE VIP HE WILL REVICE A PRIORITY LIST OF 400 POINTS ]--

    {label = 'VIP Diamond', priority = 500, money = 100000000}
--[ THIS WILL BE LEVEL 3 AND WHEN THE PLAYER RECIVES THE VIP HE WILL RECIVE THE SPECIFIED AMMOUNT OF MONEY AND A PRIORITY IN QUEUE OF 500 POINTS ]--
}
```

{% endcode %}