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

# Overview

Official documentation for rayn\_boosting — a FiveM vehicle boosting (steal-to-order) script.

**Author:** rayn **Version:** 1.0.0 **Compatibility:** ESX • QBCore • QBox (ox\_core) • Standalone

{% hint style="info" %}
**A note on Escrow and file access**

This script is distributed with Tebex Escrow protection. Most of the logic is encrypted, but four files are intentionally left **unencrypted and fully editable**, because they are the files a server owner most often needs to touch:

| File                | Status   | Why it's open                                                                                                                                           |
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `config.lua`        | **Open** | All server settings — coordinates, prices, tiers, contract types, dispatch/GPS settings, and more.                                                      |
| `locales/*.lua`     | **Open** | All text strings for all 5 languages, plus the display text for everything configured in `config.lua` (tier names, contract labels, item labels, etc.). |
| `server/bridge.lua` | **Open** | Framework / inventory / dispatch / phone detection and integration logic.                                                                               |
| `client/bridge.lua` | **Open** | Framework / targeting system / notification logic.                                                                                                      |

Everything else (`server/main.lua`, `server/db.lua`, `server/shop.lua`, `client/main.lua`, `client/minigame.lua`, `client/guards.lua`, and the `html/` tablet UI) is encrypted and cannot be edited. This split is deliberate: it lets you fully configure the script, add your own item names, translate it, and even wire up frameworks/integrations that weren't built in — all without needing access to the protected gameplay logic. See [Customizing & Extending](/rayn-scripts-docs/customizing-and-extending.md) for exactly how to make use of this.
{% endhint %}

## What is rayn\_boosting?

**rayn\_boosting** is an original vehicle "boosting" (steal-to-order) script for FiveM. Players pick up contracts from a stranger NPC dealer through a tablet, steal the marked vehicle by hotwiring it through a minigame, and deliver it however the contract requires — to a drop-off point, straight to the crusher, repainted at a body shop, as a truck + trailer combo, stripped for specific ordered parts, or with its engine ripped out. Completed contracts pay out money and reputation, which unlocks harder, better-paying tiers with more NPC resistance and a higher chance of triggering a police response.

## Key Features

* Full multi-framework support with automatic detection: ESX, QBCore, QBox (ox\_core), and a Standalone mode (no framework at all).
* Automatic detection (with built-in fallbacks) for targeting (ox\_target → qb-target → drawtext), inventory (ox\_inventory → native framework system → standalone), phone (lb-phone → qs-smartphone → qb-phone), and dispatch (ps-dispatch → cd\_dispatch → aty\_dispatchv2 → p\_mdt → qb-policejob).
* 6 contract types: Quick Flip, To The Crusher, Repaint, Trailer Heist, Parts-to-Order Disassembly, and Engine Theft — see [Contract Types](/rayn-scripts-docs/contract-types.md).
* 4 reputation-gated tiers (Street / Suburbs / Downtown / VIP), each with its own payout multiplier, alert chance, and NPC guard count.
* Live, hackable vehicle GPS, with an optional 2-player co-op hack.
* Optional on-duty police/sheriff gate and a configurable cooldown between contracts.
* NUI-based hacking minigame (moving target / skill check) for both hotwiring and GPS hacking.
* Crusher materials economy and a tools shop, both built into the same tablet.
* Fully server-authoritative validation — reward, success, and reputation are never trusted from the client.
* Persistent reputation/stats via oxmysql, or in-memory storage for testing without a database.
* 5 languages built in: Polish, English, German, French, Russian.
* Admin commands for reputation management and clearing stuck contracts.

## Requirements

The script has no hard dependencies — it runs out of the box on plain FiveM. These are optional and auto-detected if installed:

* `oxmysql` — persistent reputation/stats (falls back to in-memory storage without it).
* `ox_lib` — nicer notifications/progress bars.
* `ox_target` or `qb-target` — targeting (falls back to a built-in E-key interaction).
* `ox_inventory` — auto-detected for materials, tools, and parts.
* Dispatch: `ps-dispatch`, `cd_dispatch`, `aty_dispatchv2`, `p_mdt`, or `qb-policejob`.
* Phone: `lb-phone`, `qs-smartphone`, or `qb-phone`.

## Where to go next

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-rocket" style="color:$primary;">:rocket:</i></h3></td><td><strong>Installation</strong></td><td>Get the resource running on your server in a few minutes.</td><td><a href="/rayn-scripts-docs/installation.md">Installation</a></td></tr><tr><td><h3><i class="fa-boxes-stacked" style="color:$primary;">:boxes-stacked:</i></h3></td><td><strong>Inventory Items</strong></td><td>The 11 items you need to add to your inventory system.</td><td><a href="/rayn-scripts-docs/inventory-items.md">Inventory Items</a></td></tr><tr><td><h3><i class="fa-sliders" style="color:$primary;">:sliders:</i></h3></td><td><strong>Configuration</strong></td><td>Full reference for every section of config.lua.</td><td><a href="/rayn-scripts-docs/configuration.md">Configuration</a></td></tr><tr><td><h3><i class="fa-route" style="color:$primary;">:route:</i></h3></td><td><strong>Contract Types</strong></td><td>All 6 contract types and how each one is delivered.</td><td><a href="/rayn-scripts-docs/contract-types.md">Contract Types</a></td></tr><tr><td><h3><i class="fa-puzzle-piece" style="color:$primary;">:puzzle-piece:</i></h3></td><td><strong>Customizing &#x26; Extending</strong></td><td>Add your own dispatch, framework, target or notification integration.</td><td><a href="/rayn-scripts-docs/customizing-and-extending.md">Customizing &amp; Extending</a></td></tr><tr><td><h3><i class="fa-terminal" style="color:$primary;">:terminal:</i></h3></td><td><strong>Admin Commands &#x26; Support</strong></td><td>Reputation/contract admin commands and how to get help.</td><td><a href="/rayn-scripts-docs/admin-commands-and-support.md">Admin Commands &amp; Support</a></td></tr></tbody></table>


---

# 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://rayn-scripts.gitbook.io/rayn-scripts-docs/overview.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.
