> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectx.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> The Project X Bridge is a **shared resource** that acts as the compatibility layer between your server's resources (framework, inventory, dispatch, etc.) and Project X scripts. Instead of configuring each script individually, you configure the bridge once and every script that uses it inherits those settings automatically.

<CardGroup cols={2}>
  <Card title="Configure Once" icon="gear">
    Set your framework, inventory, dispatch, and more in a single config file. All bridge-dependent scripts pick it up automatically.
  </Card>

  <Card title="Auto Detection" icon="wand-magic-sparkles">
    Most settings support `'auto'` mode. The bridge scans your started resources and picks the correct system without manual setup.
  </Card>

  <Card title="Global Cooldowns" icon="clock">
    A built-in cross-script cooldown system. Completing one robbery can lock others for a configurable duration, preventing farming.
  </Card>

  <Card title="Open Source Layer" icon="code">
    Every integration function is open source. If your system isn't supported by default, you can add it yourself without touching escrow.
  </Card>
</CardGroup>

## What It Handles

The bridge manages the following systems across all dependent scripts:

| System              | What it does                                                       |
| ------------------- | ------------------------------------------------------------------ |
| **Framework**       | Player data, money, permissions (QBCore, Qbox, ESX)                |
| **Inventory**       | Item checks, adding and removing items                             |
| **Dispatch**        | Sending police alerts to 30+ dispatch systems                      |
| **Interaction**     | Door/zone interactions (ox\_target, qb-target, interact, drawtext) |
| **Notification**    | Player notifications                                               |
| **Progressbar**     | Progress circles and bars                                          |
| **XP System**       | Experience and level integration                                   |
| **Evidence**        | Fingerprint drops at crime scenes                                  |
| **Logs**            | Discord, Fivemerr, and Fivemanage activity logging                 |
| **Global Cooldown** | Cross-script robbery cooldown system                               |

## Supported Scripts

The bridge is required by the following documented scripts. Configure compatibility once in the bridge — each script below inherits those settings automatically.

<Tabs>
  <Tab title="Sandy Bank">
    * [`projectx-sandybankrobbery-prompt`](/resources/sandy-bank-robbery/installation)
  </Tab>

  <Tab title="Store Robbery">
    * [`projectx-storerobbery-fmv2`](/resources/store-robbery-fmv2/installation) (FM V2)
    * [`projectx-storerobbery-fm`](/resources/store-robbery-fm/installation) (FM)
    * [`projectx-storerobbery-gabz`](/resources/store-robbery-gabz/installation) (Gabz)
    * [`projectx-storerobbery-default`](/resources/store-robbery-default/installation) (Default)
  </Tab>

  <Tab title="Ammunation">
    * [`projectx-ammunationrobbery-fm`](/resources/ammunation-robbery-fm/installation) (FM)
    * [`projectx-ammunationrobbery-tstudio`](/resources/ammunation-robbery-tstudio/installation) (TStudio)
    * [`projectx-ammunationrobbery-prompt`](/resources/ammunation-robbery-prompt/installation) (Prompt)
    * [`projectx-ammunationrobbery-gabz`](/resources/ammunation-robbery-gabz/installation) (Gabz)
    * [`projectx-ammunationrobbery-default`](/resources/ammunation-robbery-default/installation) (Default)
  </Tab>

  <Tab title="Bobcat Heist">
    * [`projectx-bobcatheist-k4mb1`](/resources/bobcat-heist-k4mb1/installation) (K4MB1)
    * [`projectx-bobcatheist-gabz`](/resources/bobcat-heist-gabz/installation) (Gabz)
    * [`projectx-bobcatheist-default`](/resources/bobcat-heist-default/installation) (Default)
  </Tab>

  <Tab title="Cash Exchange">
    * [`projectx-cashexchangerobbery-k4mb1`](/resources/cash-exchange-robbery-k4mb1/installation) (Cash Exchange 1)
    * [`projectx-cashexchange2robbery-k4mb1`](/resources/cash-exchange-robbery-2-k4mb1/installation) (Cash Exchange 2)
  </Tab>

  <Tab title="Laundromat">
    * [`projectx-laundromatrobbery-k4mb1`](/resources/laundromat-robbery-k4mb1/installation) (K4MB1)
  </Tab>
</Tabs>

<Info>
  Other documented scripts — House Robbery V2, Tasks, and Burner Phone — do **not** use the bridge and configure framework, inventory, and dispatch in their own config files.
</Info>

See [Supported integrations](/faqs) for the full list of compatible inventories, dispatch systems, evidence systems, and XP systems.

Future Project X releases will also use the bridge as the standard integration layer.

<Info>
  When purchasing any script that requires the bridge, the `projectx-bridge` asset will automatically be delivered to your [CFX portal](https://portal.cfx.re/assets/granted-assets?page=1\&sort=asset.updated_at\&direction=asc\&search=projectx-bridge). You do not need to purchase it separately.
</Info>

## Getting Started

<Card title="Installation & Configuration" icon="download" href="/resources/bridge/installation">
  Download the bridge from your CFX portal and follow the step by step setup guide.
</Card>