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

# Summary

> A 0-100 tier seasonal battle pass for FiveM servers running QBX or QB-Core. Players earn XP by completing quests, advance through tiers, and claim rewards from

## Citizen's Journey

<iframe src="https://www.youtube.com/embed/21vKs-N_C7o" width="100%" height="400" frameborder="0" allowfullscreen />

A 0-100 tier seasonal battle pass for FiveM servers running QBX or QB-Core. Players earn XP by completing quests, advance through tiers, and claim rewards from a Free or Premium track - all through a live, real-time UI.

### Features

* **100-tier season pass** with Free and Premium reward tracks
* **Three quest categories** - Daily, Weekly, and Seasonal, each supporting optional job restrictions
* **Job-restricted quests** - attach a `job` field to any quest; the server validates the player's current job from qbx\_core / qb-core before crediting progress
* **Live UI** - XP bar, tier-up notifications, and quest progress update in real time
* **Login streak tracking** - consecutive daily logins rewarded (by quest, or add your own code)
* **Flexible premium purchase** - cash, item, or external web store
* **Full server-side export API** - integrate with any other resource
* **Configurable per season** - swap quests, tiers, and rewards in plain Lua config files

### Dependencies

| Resource                                                                      | Purpose                                     |
| ----------------------------------------------------------------------------- | ------------------------------------------- |
| [ox\_lib](https://github.com/overextended/ox_lib)                             | Callbacks, notifications                    |
| [oxmysql](https://github.com/overextended/oxmysql)                            | Database                                    |
| qbx\_core **or** qb-core                                                      | Player framework - auto-detected at runtime |
| [ox\_inventory](https://github.com/overextended/ox_inventory) or qb-inventory | Item rewards                                |

<Warning>
  Core scripts are protected via CFX native escrow. Config files are fully open and editable. Purchase grants a single-server licence. Redistribution and resale are prohibited.
</Warning>