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

# Welcome

## Welcome to PyroByte Docs

Welcome to the official documentation for **PyroByte Scripts** — your go-to resource for getting started, configuring, and troubleshooting your purchases from our [Tebex store](https://pyrobyte.tebex.io/).

Whether you’re a first-time buyer or a returning customer, these docs are here to help you get up and running quickly and smoothly.

***

### 📦 What’s Included

Most of the scripts packages contain:

* A `README.md` or `INSTALL.md` file with setup instructions
* A `config.lua` file for easy customization
* Dependencies list and framework compatibility info (ESX / QBCore)
* Optional translation/localization files

***

### 🚀 Getting Started

#### 1. Downloading Your Scripts

After purchase, scripts can be downloaded via:

* The **email** sent after purchase
* Your **Tebex account**
* [Keymaster](https://keymaster.fivem.net/) (for linked scripts)

#### 2. Installation

* Follow the included`README.md` guide in each script folder.
* Place the script in your `resources` directory.
* Ensure all required dependencies are installed.
* Add the script to your `server.cfg` or `resources.cfg`.

#### 3. Framework Compatibility

Our scripts support:

* ✅ ESX Legacy
* ✅ QBCore
* ✅ Standalone (any Framework)
* ❌ vRP (unless otherwise specified)

Refer to individual script pages for specific framework notes.

***

### ⚙️ Configuration

Each script is built to be fully configurable:

#### `config.lua`

Adjust settings such as:

* Permissions
* Cooldowns
* Item names
* Events
* Blip markers and zones

#### Localization

Most scripts include `locales` or language config files. Translate in-game messages for your community easily.

***

### 🛠 Troubleshooting

Having issues? Here’s how to fix the most common problems:

#### Script not working?

* Check `F8` or server console for errors.
* Ensure all dependencies are installed.
* Check for framework mismatches.

#### Config errors?

* Look for typos or syntax errors in `config.lua`.
* Refer to the example config in the script docs.

***

### 🙋 Need Help?

We're here for you.

* Join our [**Discord Server**](htttps://discord.gg/fwghTtFyYb) for fast support

***

#### 📌 Stay Updated

We’re constantly updating and improving our scripts. Check back regularly or follow announcements in our Discord to stay in the loop.