> For the complete documentation index, see [llms.txt](https://vanishdev.gitbook.io/vanishdev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vanishdev.gitbook.io/vanishdev/gang-series/gangphone/installation.md).

# Installation

## Dependencies

* A supported framework: ESX, QB or QBOX
* A supported gang system: vanish\_gangs, qb-gangs or rcore\_gangs
* A supported inventory: ox\_inventory, qb-inventory or qs-inventory
* oxmysql
* ox\_lib <https://github.com/overextended/ox_lib>
* OneSync enabled, server artifact build 5848 or newer

{% hint style="info" %}
The phone reads who is in which gang from your gang system, so you need one of the supported ones running. Ambulance and crutch scripts are optional and only used to make kill detection more accurate.
{% endhint %}

## Steps

1. Download from keymaster and drag `vanish_gangphone` into your `resources` folder.
2. Import `sql/vanish_gangphone.sql` into your database. This creates the war, challenge, stats and leaderboard tables.
3. Add `ensure vanish_gangphone` to your `server.cfg`, after your framework, gang system, inventory and oxmysql.
4. Add the phone item to your inventory (see below).
5. Open `shared/config.lua` and set it up the way you want.
6. Start, or restart, the resource.

## Phone item

By default the phone needs an inventory item to open, set by `phone.itemName` in `shared/config.lua` (default `burnerphone`). Add that item to your inventory.

### ox\_inventory

Add the item to your `ox_inventory/data/items.lua`:

```lua
['burnerphone'] = {
    label = 'Burner Phone',
    weight = 200,
    stack = false,
    close = true,
    description = 'A throwaway phone for gang business.',
    client = {
        export = 'vanish_gangphone.OpenPhone'
    }
},
```

For qb-inventory and qs-inventory, add `burnerphone` to your shared items, then register it as a usable item that calls the `OpenPhone` export on the client. See the [Exports](/vanishdev/gang-series/gangphone/exports.md) page for the export.

{% hint style="info" %}
You do not have to use an item. Set `phone.enabled = false` to let players open the phone with the command or keybind alone, or set `phone.command` / `ui.openKey` to your liking.
{% endhint %}

{% hint style="warning" %}
If `phone.leaderOnly = true`, only gang leaders can open the phone at all. Leave it false to let any gang member open it, while still gating war actions behind the rank permissions.
{% endhint %}


---

# 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://vanishdev.gitbook.io/vanishdev/gang-series/gangphone/installation.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.