Kivo Battlepass
Kivo Battlepass adds a seasonal battle pass to your server. Players complete daily and weekly missions to earn XP, climb tiers and claim rewards from a free track and a premium track. Players unlock the premium track by redeeming a Tebex or Stripe payment id, or you can grant it yourself.
Players open the Battle Pass with the /battlepass command or the F7 key. Both can be changed in the config.
Features
Section titled “Features”- Seasons. Each season has its own dates, number of tiers and XP per tier. Progress, claims and mission progress are stored per season.
- Two reward tracks. The free track and the premium track each hold one reward per tier. The shipped config defines 50 tiers.
- Many reward types. Cash or bank money, items, items with metadata, weapons, vehicles, bonus XP, premium itself, or your own custom reward code.
- Daily and weekly missions. Eleven mission types: Play Time, Way Point, Object Hunt, Social Gathering, Emote Spot, Drunk Activities, Yoga, Damage Contract, Time Race, Elimination Zone and Peyote Time. Missions are plain Lua tables in
config/quests.lua. - In-game quest creator. Admins can add new missions from an ox_lib menu without editing files.
- Premium purchases. A Buy now button opens your store page. Players paste their transaction id into the upgrade window and the server confirms the payment with Tebex or Stripe.
- Carryover. Rewards that a player reached but did not claim can be saved when a season ends and claimed later.
- Admin tools. A menu and chat commands for giving XP, setting tiers, granting or revoking premium, resetting daily missions and testing missions.
- Multi-framework. QBox, QBCore and ESX are detected automatically.
- Multi-inventory. ox_inventory, qb-inventory, ps-inventory, qs-inventory and the ESX built-in inventory are supported.
- Vehicle rewards. Vehicles are saved to the player’s garage through
qbx_vehicles, the QBplayer_vehiclestable or the ESXowned_vehiclestable. - Notifications. Mission messages use a built-in toast or ox_lib notifications.
- Languages. English and German are included. You can add more.
- Discord webhooks. Optional log messages for code redemptions, claims and admin actions.
- Exports and open files. Other scripts can add XP and mission progress. The
bridge/andopen/files are yours to edit.
Requirements
Section titled “Requirements”| Item | Details |
|---|---|
| Game build | GTA V (game 'gta5'), fx_version 'cerulean', Lua 5.4 |
ox_lib |
Required. Listed as a dependency in fxmanifest.lua. |
oxmysql |
Required. Listed as a dependency in fxmanifest.lua. |
| Framework | One of qbx_core, qb-core or es_extended. Any other framework needs the bridge files adapted (see Exports and bridge files). |
| Inventory | One of ox_inventory, qb-inventory, ps-inventory, qs-inventory, or the ESX built-in inventory. Other inventories need bridge/inventory.lua adapted. |
| Database | MySQL or MariaDB through oxmysql. |
| Store | Optional. A Tebex or Stripe account if you sell the premium track. |
| Discord bot | Optional. Used for Discord profile pictures in the Battle Pass window. |
Start order
Section titled “Start order”Start the Battle Pass after ox_lib, oxmysql, your framework and your inventory.
ensure ox_libensure oxmysqlensure qbx_core # or qb-core / es_extendedensure ox_inventory # or your inventoryensure kivo-battlepassDocumentation
Section titled “Documentation”- Installation: copy the resource, set up the database,
server.cfglines, permissions and purchase settings. - Configuration: every option in
config/config.lua, purchase window, convars, webhooks and locales. - Seasons and rewards: season dates, tiers, reward types, carryover and season rollover.
- Missions: the mission table, parameters for each mission type and the in-game quest creator.
- Admin tools: permissions, chat commands and the admin menu.
- Exports and bridge files: exports for other scripts, and how to adapt the bridge and open files to other frameworks, inventories, garages, notifications and payment providers.
- Examples and troubleshooting: ready-made config examples, edge cases and fixes for common problems.
Back to the scripts index.
