> For the complete documentation index, see [llms.txt](https://rickys-organization-6.gitbook.io/hwc-documentions/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rickys-organization-6.gitbook.io/hwc-documentions/hwc-blips-v2.md).

# HWC Blips V2

### 📥 Downloading Your Resource

After purchasing **HWC Blips V2**, you must download it via the **CFX Portal**:

1. Go to: <https://portal.cfx.re/>
2. Log in with the account used to purchase
3. Navigate to:

```
Granted Assets
```

4. Locate:

```
HWC Blips V2
```

5. Click **Download**

***

### 📂 Installing The Resource

#### 1️⃣ Extract The Download

* Extract the `.zip` file
* You will get a folder:

```
HWC_Blips_V2
```

***

#### 2️⃣ Add To Your Server

Place the folder inside your resources directory:

```
resources/[standalone]/HWC_Blips_V2
```

*(You can place it anywhere, folder name does not matter)*

***

#### 3️⃣ Add to server.cfg

```
ensure HWC_Blips_V2
```

***

#### 4️⃣ Framework Order (If Used)

If you are using a framework, ensure it starts **before** this resource:

```
ensure qb-core
ensure HWC_Blips_V2
```

***

#### 5️⃣ Restart Your Server

***

### ⚙️ Requirements

***

#### ✅ Required

* FiveM Server (latest recommended build)

***

#### 🔌 Optional (For Job / Gang Features)

* QBCore
* Qbox
* ESX Legacy

👉 If no framework is used:

* Resource still works fully
* Job / gang visibility will be disabled

***

### ⚙️ Configuration

All settings are located in:

```
config.lua
```

***

#### 🌍 Language

```
Config.Language = 'en'
```

Available:

* `en` (English)
* `es` (Spanish)
* `fr` (French)

***

#### 💬 Command

```
Config.Command = 'hwcblips'
```

👉 In-game usage:

```
/hwcblips
```

*(You can rename this to anything, e.g. `/blips`)*

***

#### 🔐 Permissions

```
Config.PermissionMode = 'both'
```

Options:

* `'ace'` → ACE permissions only
* `'individual'` → Identifier list only
* `'both'` → Either works

***

**🔑 ACE Setup**

Add to `server.cfg`:

```
add_ace group.admin command.hwcblips allow
```

***

**👤 Individual Admins**

```
Config.Admins = {
    'license:xxxxxxxxxxxxxxxx',
    'discord:xxxxxxxxxxxxxxxx'
}
```

***

#### 🧠 Framework Detection

```
Config.Framework = 'auto'
```

Options:

* `auto` (recommended)
* `qbcore`
* `qbox`
* `esx`
* `none`

***

#### 📂 Categories

```
Config.EnableCategories = true
```

* Organises blips into groups
* Can be edited in config or created in-game
* Saved automatically to `categories.json`

***

### 🎮 How To Use

***

#### 🖥️ Opening The Menu

Open chat and type:

```
/hwcblips
```

***

#### 📍 Creating a Blip

1. Open the admin panel
2. Fill in:
   * Name
   * Sprite
   * Colour
   * Size
   * Coordinates (use **Get Current**)
3. Choose:
   * Display type
   * Visibility (players / jobs / gangs)
   * Category
4. Click **Save**

👉 Blip appears instantly for all players

***

#### ✏️ Editing a Blip

1. Open panel
2. Select a blip
3. Click **Edit**
4. Update values
5. Click **Update**

***

#### 🗑️ Deleting a Blip

1. Open panel
2. Find blip
3. Click **Delete**

👉 Removed instantly

***

### ⚙️ Key Features (User Perspective)

* Create unlimited blips
* Real-time updates (no restart)
* Job / gang visibility
* Distance-based rendering
* Minimap / pause map control
* Custom categories
* Multi-language support

***

### 📁 Data Storage

Blips are saved in:

```
blips.json
```

Categories are saved in:

```
categories.json
```

👉 No database required

***

### ⚠️ Important Notes

* Resource is **standalone compatible**
* Framework only required for job/gang visibility
* Do NOT edit JSON files while server is running
* Ensure write permissions are enabled


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://rickys-organization-6.gitbook.io/hwc-documentions/hwc-blips-v2.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
