Skip to content

Configuration

Quests is configured in config.json in its data folder (mods/kyuubisoft_questbook/). Every option on this page can also be changed in the Settings tabs of the admin window, which shows below each value what it does in the game and applies changes at once.

After editing config.json by hand, run /ksquestadmin reload. Reset time, reset day and time zone changes then apply without a restart.

New installs get a production config.json (English, 300-second save interval). If the admin window or a save finds config.json unreadable, it stops and names the file instead of replacing it.


{
"useCustomContent": true,
"loadDefaultQuests": true,
"loadDefaultStoryQuests": true,
"loadDefaultChapters": true,
"loadDefaultDailyPool": true,
"loadDefaultWeeklyPool": true,
"language": "en-US",
"timezone": "Europe/Berlin",
"dailyResetTime": "04:00",
"weeklyResetDay": "MONDAY",
"dailyQuestCount": 3,
"weeklyQuestCount": 5,
"streak": { ... },
"questItem": { ... },
"economy": { ... },
"tierSystem": { ... },
"reroll": { ... },
"questTracker": { ... },
"placedBlockTracker": { ... },
"proximityToast": { ... },
"notifications": { ... },
"saveIntervalSeconds": 300,
"debug": false
}

FieldDefaultDescription
language"en-US"Server language of Quests (console, chat lines without a player language, fallback). Players choose their own language with /kslang or in /kssettings, which applies to all KS mods
timezone"Europe/Berlin"Time zone for the resets (Java zone ID)
dailyResetTime"04:00"Time of the daily reset (24 h)
weeklyResetDay"MONDAY"Day of the weekly reset (at dailyResetTime)
dailyQuestCount3Daily quests per player
weeklyQuestCount5Weekly quests per player
saveIntervalSeconds300Autosave interval for player data
useCustomContenttrueLoad your content from custom/
loadDefaultQueststrueLoad the shipped quests.json (daily, weekly, side)
loadDefaultStoryQueststrueLoad the shipped story_quests.json
loadDefaultChapterstrueLoad the shipped chapters.json
loadDefaultDailyPooltrueLoad the shipped daily_pool.json
loadDefaultWeeklyPooltrueLoad the shipped weekly_pool.json

Resets run at the configured time in the configured time zone. Daylight saving time does not move them, and a login before the reset time no longer causes a second reset that morning.


"streak": {
"enabled": true,
"cumulative": true,
"gracePeriodDays": 7,
"gracePeriodWindow": 14,
"questStreak": false,
"rewardsEnabled": false,
"milestones": [
{ "days": 7, "lootbagId": "streak_reward_7", "tier": "bronze" },
{ "days": 14, "lootbagId": "streak_reward_14", "tier": "silver" },
{ "days": 21, "lootbagId": "streak_reward_21", "tier": "gold" },
{ "days": 28, "lootbagId": "streak_reward_28", "tier": "platinum" }
]
}
FieldDefaultDescription
enabledtrueCount the quest streak
cumulativetrueLenient counting: up to gracePeriodDays missed days in a row do not break the streak
gracePeriodDays7Missed days in a row that are forgiven when cumulative is on
questStreakfalseShow the quest streak in the Questbook
rewardsEnabledfalsePay the milestones (needs questStreak)
milestones4 milestonesDays, lootbag and tier (bronze, silver, gold, platinum) of each milestone

See Streak System.


"questItem": {
"enabled": true,
"itemId": "QuestBook",
"hotbarSlot": 8,
"giveOnJoin": false,
"giveDelay": 500
}
FieldDefaultDescription
enabledtrueUse the Quest Book item
itemId"QuestBook"Item ID
hotbarSlot8Hotbar slot (0-8)
giveOnJoinfalseHand the item out on join
giveDelay500Delay in ms after joining

"economy": {
"rewardCurrency": "quest_tokens",
"tokenExchangeRate": 100.0,
"tokenShopUsesEconomy": false,
"tokenEarnings": {
"dailyQuestComplete": 1,
"allDailiesBonus": 2,
"allDailiesBonusEnabled": false,
"weeklyQuestComplete": 5,
"streakBronze": 5,
"streakSilver": 10,
"streakGold": 15,
"streakPlatinum": 20
}
}
FieldDefaultDescription
rewardCurrency"quest_tokens"quest_tokens, or economy to pay every token reward as coins of an economy plugin (for example Ecotale). Existing token balances stay
tokenExchangeRate100.0Coins per token in economy mode. Also converts the reroll price
tokenShopUsesEconomyfalseIn economy mode, the token shop charges coins (price × rate) instead of tokens
tokenEarnings.dailyQuestComplete1Bonus tokens per completed daily quest
tokenEarnings.weeklyQuestComplete5Bonus tokens per completed weekly quest
tokenEarnings.allDailiesBonusEnabledfalsePay allDailiesBonus once per day when every current daily is done
tokenEarnings.allDailiesBonus2Tokens for the all-dailies bonus
tokenEarnings.streakBronze … streakPlatinum5 / 10 / 15 / 20Tokens per streak milestone level

"tierSystem": {
"enabled": true,
"tiers": [
{ "id": "common", "difficulty": "easy", "color": "#A0A0A0", "multiplier": 1.0, "weight": 50, "name": { "en": "Common", "de": "Gewöhnlich" } },
{ "id": "rare", "difficulty": "medium", "color": "#4169E1", "multiplier": 2.0, "weight": 30, "name": { "en": "Rare", "de": "Selten" } },
{ "id": "epic", "difficulty": "hard", "color": "#9932CC", "multiplier": 3.0, "weight": 15, "name": { "en": "Epic", "de": "Episch" } },
{ "id": "legendary", "difficulty": "legendary", "color": "#FFD700", "multiplier": 5.0, "weight": 5, "name": { "en": "Legendary", "de": "Legendär" } }
]
}
FieldDescription
enabledApply the tier factor to rewards
idTier ID
difficultyThe quest difficulty this tier stands for
colorColour in the UI
multiplierReward factor
nameDisplay name per language

The tier weight is not used; how often a quest is drawn comes from its pool weight. See Tier System.


"reroll": {
"enabled": true,
"freeRerollsPerDay": 1,
"freeRerollsPerWeek": 1,
"paidRerollCost": 10,
"maxPaidRerollsPerDay": 5,
"maxPaidRerollsPerWeek": -1,
"allowRerollStarted": false
}
FieldDefaultDescription
enabledtrueAllow rerolls
freeRerollsPerDay1Free daily rerolls per day
freeRerollsPerWeek1Free weekly rerolls per week
paidRerollCost10Price of the first paid reroll in tokens. It doubles with each paid reroll
maxPaidRerollsPerDay5Paid daily rerolls per day
maxPaidRerollsPerWeek-1Paid weekly rerolls per week. -1 = same as maxPaidRerollsPerDay (the behaviour before 2.0)
allowRerollStartedfalseAllow rerolling quests that already have progress

A single quest can switch rerolling off with options.rerollable: false.


"questTracker": {
"enabled": true,
"showOnJoin": true,
"maxTrackedQuests": 5,
"autoUntrackCompleted": true,
"defaultShowEmptyState": true
}
FieldDefaultDescription
enabledtrueTracker HUD available
showOnJointrueShow the tracker right after joining
maxTrackedQuests5Quests a player can track at once
autoUntrackCompletedtrueAllow removing finished quests from the tracker (players can still switch it off for themselves)
defaultShowEmptyStatetrueShow an empty tracker card for new players

The tracker has a fixed place on the screen. See HUD Tracker.


"proximityToast": {
"enabled": true,
"toastRange": 20.0
}
FieldDefaultDescription
enabledtrueShow the NPC’s picture when a player comes near a quest NPC
toastRange20.0Range in blocks

"notifications": {
"enabled": true,
"showProgress": true,
"progressThreshold": 25,
"broadcastCompletion": false,
"announceResets": false
}
FieldDefaultDescription
enabledtrueQuest notifications
showProgresstrueReport progress
progressThreshold25Notify every n percent (1-100)
broadcastCompletionfalseAnnounce quest completions to everyone
announceResetsfalseTell online players in chat when the daily or weekly quests were reset

These values stay in config.json and are not changed, but Quests 2.1 does not use them. The admin window lists them under “No longer in the window”.

FieldWhy
economy.provider, economy.primaryCurrency, economy.alternativeCurrencyNever read. Economy mode uses Core’s economy bridge
economy.rerollCostTokensDuplicate; reroll.paidRerollCost counts
economy.rerollCostGoldNot used by the Questbook. In economy mode the token price × rate applies
questTracker.maxDisplayedQuests, questTracker.maxDisplayedObjectivesPlayers set these themselves
questTracker.position, questTracker.defaultPositionPresetIgnored. The tracker has a fixed place on the screen
placedBlockTracker.*KyuubiSoft Core handles self-placed blocks with a fixed 30 minutes
proximityToast.durationMsNo effect
streak.gracePeriodWindowOnly used by the old login counter
tierSystem.tiers[].weightNot used
debugNo effect. Extra log output follows Core’s logLevel (all = debug)

FileContents
configs/quests.json, configs/story_quests.json, configs/chapters.json, configs/daily_pool.json, configs/weekly_pool.jsonShipped content (replaced by newer shipped versions, with a backup)
configs/quest_token_shop.jsonThe Quest Token Shop (a Core shop). A newer shipped version replaces it and keeps the old one as quest_token_shop.json.backup-v<N>; while the shipped file carries no version, your edits are never touched
custom/Your own content. See Custom Content
quest_npc_profiles/NPC quest profiles. See NPC Quest Profiles
localization/Language files. See Localization
backups/Backup sets of the admin window (last 20)
exports/Exports and import files
players/Player data (when Core uses file storage)
server_stats.jsonServer statistics (written on autosave)