# BB Pursuit Mode

## Police Pursuit Mode Documentation

***

### Introduction

Welcome to the official documentation for the **BBStore** **Police Pursuit Mode** script for FiveM!\
This guide will help you install, configure, and get the most out of your pursuit mode experience.

***

### What is Police Pursuit Mode?

Police Pursuit Mode is a modern, fully responsive, and highly customizable pursuit system for FiveM servers.It allows police officers to switch between different pursuit modes (Normal, Traffic, Pursuit, Maximum Pursuit) with unique vehicle performance, visual effects, and user interface.The script is designed to enhance police roleplay, add tactical depth to chases, and provide a professional, immersive experience for both players and server owners.

* Key Features:
* Modern UI
* Real-time vehicle stats and effects
* Rank and department-based access control
* Customizable keybinds and localization
* Accessibility and performance focused

***

### Supported Frameworks

Police Pursuit Mode is compatible with all major FiveM frameworks:

* QBCore
* ESX
* QBOX

The script can auto-detect your framework or you can set it manually in config.lua for maximum compatibility.

***

### Installation

1. **Download & Extract**
   * Place the resource folder (e.g. `bb_pursuitmode`) in your server's `resources` directory.
2. **Add to server.cfg**

   ```
   ensure bb_pursuitmode
   ```
3. **Configure**
   * Open `config.lua` and adjust:
     * Framework (`auto`, `qbcore`, `esx`, `qbox`)
     * Departments, ranks, vehicles, pursuit levels
     * Keybinds (default: LSHIFT+UP/DOWN for mode, F5 for UI)
     * Localization (add more languages if needed)
4. **Keybinds**
   * Players can change keybinds in ESC > Settings > Key Bindings > FiveM.

***

### Configuration

#### Framework Setup

* Supported: QBCore, ESX, QBox, auto-detect.
* Set your framework in `config.lua`:

  ```lua
  Config.Framework = "auto" -- or "qbcore", "esx", "qbox"
  ```

#### Departments & Ranks

* Define police departments, ranks, and max pursuit levels in `Config.Departments`.
* Example:

  ```lua
  Config.Departments = {
    ["police"] = {
      label = "Police Department",
      ranks = {
        [0] = { name = "Trainee", maxPursuitLevel = 0 },
        [1] = { name = "Officer", maxPursuitLevel = 1 },
        ...
      },
      vehicles = { ... }
    }
  }
  ```

#### Vehicles & Pursuit Levels

* Set up which vehicles are eligible and their performance per pursuit level.

#### Keybinds

* All keybinds are set in `Config.Keybinds`:

  ```lua
  Config.Keybinds = {
    Shift = "LSHIFT",
    Up = "UP",
    Down = "DOWN",
    OpenUI = "F5"
  }
  ```
* Players can change keybinds in-game via ESC > Settings > Key Bindings > FiveM.

#### Localization (Languages)

* English and Turkish included by default.
* Add more languages in `Config.Locales`.

#### UI Customization

* Change colors, stats, and effects in `Config.UI`.
* Fully responsive and mobile-friendly.

***

### Usage Guide

#### Opening the UI

* Default: Press `F5` (configurable).

#### Changing Pursuit Modes

* Hold `LSHIFT` and press `UP` or `DOWN` to change modes.
* Modes: Normal, Traffic, Pursuit, Maximum Pursuit.

#### Tail Light & Engine Sound

* Special effects are only available at the maximum pursuit level.

#### Tooltips & Accessibility

* Disabled buttons show tooltips explaining why they are unavailable.
* Fully keyboard accessible, high-contrast

***

### FAQ & Troubleshooting

#### FAQ

* **Q:** How do I add a new vehicle?\
  **A:** Edit `Config.Departments` and add your vehicle under the correct department.
* **Q:** How do I add a new language?\
  **A:** Add a new entry to `Config.Locales`.

#### Troubleshooting

* UI not opening? Check keybinds and framework config.
* Errors in F8? Ensure all dependencies are started and config is correct.

***

### Support & Contact

* For support, join our [Discord](https://discord.gg/bbfivem).
* For bug reports, open an issue or contact us via Discord.

***

**Thank you for choosing BB Store!**


---

# Agent Instructions: 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:

```
GET https://bbstore.gitbook.io/docs/bb-pursuit-mode.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.