Navigate to:
📂 resources/0bug_Battlepass/Customize.lua
Modify the settings as needed:
Customize = { Lang ="en", -- Set language ItemImagePath ="nui://qb-inventory/html/images/", -- Path for inventory images Tebex_Credit_Readme_Code_Command ="purchase_credit", -- Command for purchasing credits Tebex_Premium_Readme_Code_Command ="purchase_premium" -- Command for purchasing premium pass}
📌 Tip: Set ItemImagePath to match your inventory system (qb-inventory, ox_inventory, etc.).
2️⃣ UI & XP Settings
Configure UI and XP settings inside Customize.lua:
UI_Settings = { Open_Buy_More_Credits_Web_Site ="https://0bugscripts.tebex.io/", -- Tebex store link Buy_Level_Price =5, -- Price per level Buy_Level_Price_Type ="credit", -- Options: "credit", "cash", "bank" Total_XP =500, -- XP required to complete the BattlePass Daily_Quiz_Award ="1000", -- XP reward for correct quiz answers Daily_Get_Spin_Credit =1-- Credits needed for extra spins}
3️⃣ BattlePass Commands
Here are the available commands you can modify:
Command = {
Open_Menu = "openMenu", -- Opens the BattlePass UI
Add_Level = "addLevel", -- Add levels to a player
Remove_Level = "removeLevel", -- Remove levels
Add_XP = "addXP", -- Grant XP manually
Set_Premium = "setPremium", -- Activate Premium for a player
Clear_Player_Data = "refreshPlayerData", -- Reset a single player’s data
Clear_Players_Data = "allRefreshPlayersData", -- Reset all players’ data
Clear_Script_Data = "refreshScriptData" -- Reset entire BattlePass script data
}
4️⃣ Season & Daily Spin Settings
Manage BattlePass duration, daily resets, and spins in Customize.lua:
Data_Settings = {
endingTime = 30, -- BattlePass season duration (days)
dailySpin = true, -- Enable or disable daily spin
restartDailyDataHours = "00:00", -- Time to reset daily missions
restartWeeklyDays = 7 -- Weekly mission reset interval (days)
}
5️⃣ BattlePass Server Exports
💡 Getting Player Identifier
Before using these exports, you need to get the player's identifier.
Example:
local playerId = source -- Gets the player's server ID
local identifier = GetPlayerIdentifier(playerId, 0) -- Retrieves the player's unique identifier
🎮 Player Data Functions
🔹 addLevel(identifier, amount)
Increases a player's level by a given amount.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:addLevel(identifier, 1)
🔹 removeLevel(identifier, amount)
Decreases a player's level by a given amount.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:removeLevel(identifier, 1)
🔹 addXP(identifier, amount)
Adds XP to a player. If XP exceeds the max, it levels up the player.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:addXP(identifier, 500)
🔹 setPremium(identifier, value)
Sets a player's premium status (true or false).
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:setPremium(identifier, true)
💰 Credit Functions
🔹 addCredit(identifier, amount)
Adds credits to a player.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:addCredit(identifier, 100)
🔹 removeCredit(identifier, amount)
Removes credits from a player.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:removeCredit(identifier, 50)
🔹 getCredit(identifier)
Returns the player's current credit balance.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
local credit = exports['0bug_Battlepass']:getCredit(identifier)
print("Player Credit:", credit)
🔄 Data Management Functions
🔹 clearPlayerData(identifier)
Clears all stored data for a specific player.
Usage:
local identifier = GetPlayerIdentifier(PlayerPedId(), 0):gsub('license:', '')
exports['0bug_Battlepass']:clearPlayerData(identifier)
🔹 clearPlayersData()
Clears all players' data.
Usage:
exports['0bug_Battlepass']:clearPlayersData()
🔹 clearScriptData()
Resets script-related data (e.g., daily missions, spins, weekly missions).
Usage:
exports['0bug_Battlepass']:clearScriptData()
📌 Notes
Use GetPlayerIdentifier(source, 0) to get the player's unique identifier.
Make sure0bug_Battlepass is started before using these exports.
🎯 Configuring Missions, Quiz, & Rewards
✅ Editing Missions & Rewards
Navigate to:
📂 resources/0bug_Battlepass/config/
This folder contains JSON files for:
dailyMissionsList.json (Daily missions)
weeklyMissions.json (Weekly missions)
dailyQuizList.json (Daily quiz)
dailySpinList.json (Spin rewards)
freeProducts.json (Free rewards)
premiumProducts.json (Premium rewards)
📝 Adding a Daily or Weekly Mission
{
"title": "Buy Something from the Store",
"description": "Visit a store and purchase any item.",
"value": 1,
"totalValue": 3,
"trigger": "0bug-Battlepass:BuyFromStore",
"triggerAddXP": 50
}
🔹 How it works:
title: Name of the mission.
description: What players need to do.
totalValue: How many times they must complete it.
trigger: The event that grants XP when triggered.
triggerAddXP: How much XP players earn for completing it.
How to implement the Mission in Other Scripts!
When adding support for daily and weekly missions, we need to ensure that both the client-side and server-side events are properly triggered.
🔄 Server-Side Integration
To make the mission work, add the event you did set in the config inside another script (e.g., when a player eats 🍔) :
RegisterNetEvent('consumables:server:addHunger', function(amount)
local Player = QBCore.Functions.GetPlayer(source)
if not Player then return end
Player.Functions.SetMetaData('hunger', amount)
TriggerClientEvent('hud:client:UpdateNeeds', source, amount, Player.PlayerData.metadata.thirst)
TriggerClientEvent('0bug-Battlepass:EatFood', source) -- 🔹 This triggers XP for the BattlePass
end)
📌 Client-Side Integration
📂 Modify your client-side script (e.g., consumables.lua) to add XP when a player drinks 💧
