Configurations
This documentation provides an overview of the Battle Pass system configuration file, detailing its settings and how they affect the system's behavior. The file is structured in JSON format, making it
General Information
The license-key field contains the system's license key, used for unique identification and authentication.
license-key
The license-key field contains the system's license key, used for unique identification and authentication.
KSE-f5933705-17fc-4b45-9c78-545d26d13361
Database Settings
The database-settings section defines the parameters for connecting to the database.
host
The address of the database server.
mysql.domain.com
username
The username used to access the database.
username
password
The password for the database.
password
database
The name of the database.
database
port
The port for database communication (default: 3306).
3306
sslmode
The type of encryption for the database connection. You can use values from: none, required, preferred, verifyfull, verifyca
preferred
table-purge-days
The number of days after which database entries are purged due to inactivity.
90
Round End Save
Automatically save results at the end of each round not just on disconnect.
true
Experience Settings
The experience-settings section defines the amount of experience points (XP) awarded for various in-game actions.
events-enabled
Whether XP events are active.
true
round-mvp
XP awarded to the most valuable player (MVP) of a round.
75
hostage-rescued
XP awarded for rescuing a hostage.
100
bomb-defused
XP awarded for defusing a bomb.
150
bomb-planted
XP awarded for planting a bomb.
75
player-kill
XP awarded for killing an opponent.
25
round-win
XP awarded for winning a round.
150
game-win
XP awarded for winning a game.
500
Level Settings
The level-settings section manages how players progress through levels in the system.
experience-per-level
Experience to achieve each level. Example: 1. level 1500, 3. 3000, etc
1500
level-cap
The maximum level a player can reach without a battle pass.
20
Mission Settings
The mission-settings section defines parameters for in-game missions.
missions-enabled
Whether missions are active.
true
daily-personal-mission-count
The number of personal daily missions available to players.
3
weekly-global-mission-count
The number of weekly missions available globally.
2
mission-daily-reroll-count
The number of times players can reroll their daily missions.
1
Mission Streak Settings
The mission-streak-settings section incentivizes mission completion streaks.
streaks-enabled
The number of daily missions required for a streak.
true
streak-required-daily-complete
The number of daily mission complete required for a streak.
3
streak-day-settings
Defines XP multipliers for streaks of specific lengths..
{ "3": 1.1, "5": 1.25, "7": 1.5 }
Weekly Bonus Settings
The weekly-bonus-settings section allows for additional bonuses on specific days.
sweekly-bonus-enabled
Whether weekly bonuses are active.
false
weekly-bonus-days
Multipliers for specific days of the week.
{ "Monday": 1f, "Tuesday": 1f, "Wednesday": 1f, "Thursday": 1f, "Friday": 1f, "Saturday": 1.2f, "Sunday": 1.2f }
Prime Time Settings
The prime-time-settings section defines bonus periods during specific times.
prime-time-enabled
Whether prime time bonuses are active.
false
prime-time-start
The start time for prime time.
"20:00:00"
prime-time-end
The end time for prime time.
"08:00:00"
prime-time-multiplier
The XP multiplier during prime time.
1.1f (10% increase)
Anti-Frustration Settings
The anti-frustration-settings section minimizes player frustration through periodic rewards. When they can't complete a mission within the interval, they are offered to abandon the mission and gain xp depending on ther current progress with the mission.
anti-frustration-enabled
Whether anti-frustration measures are active.
false
anti-frustration-interval
Time (in minutes) between before detecting a mission as abandonable.
60
anti-frustration-between-delay
Delay (in seconds) between notifying the user about the abandon option.
15
Toplist Settings
The toplist-settings section configures leaderboard bonuses.
toplist-enabled
Whether the leaderboard is active with their benefits.
true
toplist-bonus
XP multipliers for top-ranked players by their placement.
"toplist-bonus": { "1": 1.1f, "2": 1.09f, "3": 1.08f, ... }
Battle Pass Settings
The battle-pass-settings section manages premium content for players.
battle-pass-multiplier
Additional XP multiplier for Battle Pass users.
1.5f (50% increase)
battle-pass-daily-extra-mission
Extra daily missions for Battle Pass users.
2
battle-pass-mission-extra-reroll
Extra mission rerolls for Battle Pass users.
2
battle-pass-level-cap
Maximum level for the Battle Pass.
100
Menu Settings
The menu-settings section defines the behavior of the in-game menu.
menu-freeze
Whether the player is frozen while having a menu open.
false
menu-credits
Whether to display credits for KitsuneLab in the menu.
true
date-format
The format in which dates are displayed.
yyyy/MM/dd
Prestige Settings
The prestige-settings section manages the prestige system for advanced players. When they reach the maximum level, they can do a prestige reset, which sets their rank back to the start and allowing them to start the levelling again with a prestige level based XP multiplier.
prestige-enabled
Whether the prestige system is active.
false
prestige-level-cap
The maximum number of prestige levels.
5
prestige-multiplier-per-level
The XP multiplier for each prestige level.
1.2f (20% increase)
prestige-reminder-minute-interval
How often players are reminded of prestige status in minutes.
10
Catch-Up Settings
The catch-up-settings section helps players who are behind catch up with others. When someone purchase the battlepass later than the season started, they get a multiplier depending on how many week elapsed to gain XP faster than other, until they reach the avarage battle pass user's level - 10%. So people won't think about the purchase as they cant maximize their rewards from it.
catch-up-enabled
Whether the catch-up system is active.
false
catch-up-multiplier-per-week-of-season
XP multiplier for every week missed during the season with the purchase of the battle pass for the user.
1.2f (20% increase)
Last updated