# 🛠️ Installation – Advance Blip Creator

**Welcome to the official documentation for Advance Blip Creator by Syntax Store. This guide will help you install, configure, and use the script properly on your FiveM server.**

### 📦 Step 1: Installation

1. Download the script from your [KeyMaster account](https://keymaster.fivem.net/).
2. Extract the `.zip` file.
3. Move the folder `syntax-blipcreator` to your server's resources directory:

   ```
   ../[resources]/syntax-blipcreator
   ```
4. Add this line to your `server.cfg`:

   ```cfg
   ensure syntax-blipcreator
   ```

***

### ⚙️ Step 2: Basic Configuration

Open `shared/config.lua` and adjust the settings to your needs.

#### Framework

Choose your framework:

```lua
luaCopiarEditarConfig.Framework = 'esx' -- or 'qbcore'
```

#### Language

Set the UI and notification language:

```lua
luaCopiarEditarConfig.Language = "en"
```

Available languages:\
`en`, `es`, `it`, `fr`, `de`, `pt`, `nl`, `pl`, `ru`, `ar`, `zh`, `ja`, `ko`, `tr`

***

### 🔧 Command & Keybind Settings

#### Command

```lua
luaCopiarEditarConfig.Command.enable = true
Config.Command.commandName = 'blipcreator'
```

> Use `/blipcreator` in-game to open the menu.

#### Keybind

```lua
luaCopiarEditarConfig.KeyBind.enable = true
Config.KeyBind.key = 'H'
```

> Press `H` (or your custom key) to open the blip creator.

***

### 🔐 Admin Access Control

Define which admin groups have access to the menu:

```lua
luaCopiarEditarConfig.AdminGroup = {
    'admin',
    'superadmin',
    'mod',
}
```

* **ESX:** Uses `getGroup()`.
* **QBCore:** Uses `HasPermission()`.

***

### 📡 Discord Webhook Logging (Optional)

Enable logging of create/edit/delete actions to a Discord channel:

```lua
luaCopiarEditarConfig.Webhook.url = "https://discord.com/api/webhooks/..."
Config.Webhook.username = "Blip Logs"
Config.Webhook.avatar = "https://i.imgur.com/xxxxx.png"
```

Color codes for Discord embeds:

```lua
luaCopiarEditarcolor_create = 65280    -- Green
color_delete = 16711680 -- Red
color_edit = 16776960   -- Yellow
```

***

### ✅ Final Checklist

1. Restart the resource or your entire server:

   ```
   /restart syntax-blipcreator
   ```
2. Join the server and test using `/blipcreator` or the assigned key.
3. Create, manage, and remove blips easily through the user-friendly interface.
