> For the complete documentation index, see [llms.txt](https://docs.cdev.shop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cdev.shop/fivem/cdev-chess/integrations.md).

# Integrations

CDEV Chess is built with a flexible bridge system that supports multiple frameworks, inventories, and interaction resources.\
Auto-detection is enabled by default for seamless setup.

***

### 🌐 Supported Integrations

> ⚠️ If a resource is not listed below, it is not officially supported.\
> Custom integrations can be implemented through the bridge system.

***

## 🧩 Frameworks

| Framework                     | Status             | Notes                                            |
| ----------------------------- | ------------------ | ------------------------------------------------ |
| **QBox (qbx\_core)**          | ✅ Fully Supported  | Uses qb-core compatibility layer.                |
| **QBCore**                    | ✅ Fully Supported  | Native integration.                              |
| **ESX Legacy (es\_extended)** | ✅ Fully Supported  | Uses `identifier` for persistent player linking. |
| **Custom Framework**          | ⚠️ Bridge Required | Manual implementation via bridge system.         |

***

## 🎒 Inventories

| Inventory            | Status             | Notes                                                                |
| -------------------- | ------------------ | -------------------------------------------------------------------- |
| **ox\_inventory**    | ✅ Fully Supported  | Use `server.export = 'cdev_chess.useChessBoard'` for the board item. |
| **qb-inventory**     | ✅ Fully Supported  | Useable item registered automatically.                               |
| **qs-inventory**     | ✅ Fully Supported  | Useable item registered automatically.                               |
| **Custom Inventory** | ⚠️ Bridge Required | Implement via `public/bridge/inventory/`.                            |

***

## 🎯 Interaction Systems

| System            | Status             | Notes                                                    |
| ----------------- | ------------------ | -------------------------------------------------------- |
| **ox\_target**    | ✅ Fully Supported  | Supports Font Awesome icons (e.g. `fas fa-chess-board`). |
| **qb-target**     | ✅ Fully Supported  | Native target integration.                               |
| **DrawText**      | ✅ Built-in         | No external resource required.                           |
| **Custom Target** | ⚠️ Bridge Required | Implement via `public/bridge/target/`.                   |

***

## 🔔 Notifications

| System      | Status      | Notes                                          |
| ----------- | ----------- | ---------------------------------------------- |
| **ox\_lib** | ✅ Preferred | Used automatically when available (e.g. QBox). |
| **QBCore**  | ✅ Supported | Uses `QBCore:Notify`.                          |
| **ESX**     | ✅ Supported | Uses `xPlayer.showNotification`.               |
| **Native**  | ✅ Fallback  | Used if no supported system is detected.       |

***

## ⚙️ Bridge Configuration

You can override auto-detection in `config.lua`:

```lua
Bridge = {
    Framework = "auto",      -- "qb-core" | "qbx_core" | "es_extended"
    Inventory = "auto",      -- "ox_inventory" | "qb-inventory" | "qs-inventory"
    Interaction = "target",  -- "drawtext" | "target"
    Target = "auto",         -- "ox_target" | "qb-target"
    Notify = "auto",         -- "ox_lib" | "qbcore" | "esx" | "native"
},
```
