Skip to main content

Admin Panel

The Quest Admin Panel is a full in-game graphical interface for managing all aspects of the quest system. Open it with:

/ksquestadmin panel

Permission required: questbook.admin

The panel uses a working copy pattern: all changes are made to a copy of the configuration. You must explicitly Save to apply changes or Cancel to discard them. This prevents accidental modifications.

Panel Layout

The admin panel has three areas:

  • Tab bar (top) -- 7 tabs for different configuration areas
  • Content area (center) -- tab-specific controls, lists, and editors
  • Footer (bottom) -- Save, Cancel, Reload, and Close buttons
ButtonDescription
SaveWrites all changes to config.json and reloads the configuration
CancelDiscards all unsaved changes and reverts to the last saved state
ReloadReloads configuration from disk (equivalent to /ksquestadmin reload)
CloseCloses the admin panel
BackReturns to the previous view (e.g., from an editor overlay back to the list)

Tab 1: General

Manages core plugin settings that affect the overall quest system behavior.

Settings

SettingControlDescription
LanguageDropdownUI language (en-US, de-DE, and any custom languages)
TimezoneDropdownTimezone for reset calculations (Europe/Berlin, UTC, etc.)
Daily Reset TimeDropdownWhen daily quests rotate (24h format, e.g., 04:00)
Weekly Reset DayDropdownDay of the week when weekly quests rotate
Save IntervalSliderAuto-save interval for player data (in seconds)
Daily Quest CountSliderNumber of daily quests assigned to each player
Weekly Quest CountSliderNumber of weekly quests assigned to each player
DebugCheckboxEnable verbose debug logging to server console
Use Custom ContentCheckboxLoad content from the custom/ folder

Add Language

Click the Add Language button to register a new language code. The code must follow the xx-XX format (e.g., fr-FR, pt-BR). After adding, the language appears in the Language dropdown and localization files can be created for it.

warning

Disabling Use Custom Content creates an automatic backup of your custom files before saving. This prevents data loss if you re-enable the option later.


Tab 2: Systems

Manages the tier system, reroll system, and streak system.

Tier System

Control the rarity tier system for daily and weekly quests.

SettingControlDescription
EnabledCheckboxEnable/disable the tier system globally
Tier ListSelectable listAll configured tiers (up to 10)
Add/Edit/DeleteButtonsCRUD operations for tiers

Tier Editor Overlay

When editing or creating a tier, an overlay opens with:

FieldDescription
Tier IDUnique identifier (e.g., common, rare, epic)
Localized NameDisplay name per language (via localization editor)
WeightSlider -- selection weight (higher = more frequent)
MultiplierSlider -- reward multiplier for this tier
ColorHex color for UI display
DifficultyAssociated difficulty label

Reroll System

SettingControlDescription
EnabledCheckboxEnable/disable quest rerolling
Free Rerolls/DaySliderNumber of free rerolls per day
Reroll CostSliderToken cost for paid rerolls
Max Paid Rerolls/DaySliderMaximum paid rerolls per day
Allow Reroll StartedCheckboxAllow rerolling quests that have progress

Streak System

SettingControlDescription
EnabledCheckboxEnable/disable the streak system
CumulativeCheckboxAnti-FOMO mode (days don't need to be consecutive)
Grace Period DaysSliderRequired active days within the window
Grace Period WindowSliderRolling window in days

Milestone Management

Milestones are streak rewards granted at specific day counts. The panel supports up to 10 milestones with Add/Edit/Delete buttons.

Each milestone has:

FieldDescription
DaysDay count to reach this milestone
Lootbag IDLoot bag reward to grant
TierMilestone tier label (bronze, silver, gold, platinum)

Tab 3: Player

Manages player-facing features: the quest item, HUD tracker, notifications, and anti-exploit settings.

Quest Item

SettingControlDescription
EnabledCheckboxGive players a Quest Book item
Item IDText fieldThe item ID to use (default: QuestBook)
Hotbar SlotSliderHotbar slot to place the item (0-8)
Give on JoinCheckboxAutomatically give item when player joins
Give DelaySliderDelay in milliseconds before giving the item

HUD Tracker

SettingControlDescription
EnabledCheckboxEnable the on-screen quest tracker
Show on JoinCheckboxShow tracker automatically when player joins
PositionDropdownHUD side (left or right)
Max Tracked QuestsSliderMaximum quests a player can track
Max Displayed QuestsSliderMaximum quests shown on the HUD at once
Max Displayed ObjectivesSliderMaximum objectives shown per quest
Auto-Untrack CompletedCheckboxAuto-remove completed quests from tracker
Default Show Empty StateCheckboxShow HUD even when no quests are tracked
Position PresetDropdownDefault position for new players (top_right, bottom_left, etc.)

Notifications

SettingControlDescription
EnabledCheckboxEnable quest notifications
Show ProgressCheckboxShow progress milestones (25%, 50%, 75%)
Progress ThresholdSliderPercentage interval for progress notifications
Broadcast CompletionCheckboxBroadcast quest completions to all players

Placed Block Tracker (Anti-Exploit)

SettingControlDescription
EnabledCheckboxEnable the placed-block anti-exploit tracker
Expiry MinutesSliderTime before placed blocks count as natural

Tab 4: Economy

Manages quest economy settings: currency providers, reroll costs, and token earnings.

Currency Settings

SettingControlDescription
Economy ProviderText fieldProvider name (auto, vaultunlocked, eliteessentials, internal, command)
Primary CurrencyText fieldPrimary currency identifier (e.g., quest_tokens)
Alternative CurrencyText fieldAlternative currency for gold rerolls (e.g., gold)

Reroll Costs

SettingControlDescription
Reroll Cost (Tokens)SliderToken cost per quest reroll
Reroll Cost (Gold)SliderGold cost per quest reroll

Token Earnings

Configure how many tokens players earn from various activities:

SettingControlDescription
Daily Quest CompleteSliderTokens per daily quest completed
All Dailies BonusSliderBonus tokens for completing all daily quests
Weekly Quest CompleteSliderTokens per weekly quest completed

Streak Token Earnings

SettingControlDescription
Bronze StreakSliderToken bonus for bronze milestone
Silver StreakSliderToken bonus for silver milestone
Gold StreakSliderToken bonus for gold milestone
Platinum StreakSliderToken bonus for platinum milestone

Tab 5: Content

The largest tab -- provides a full quest editor with search, filter, CRUD operations, and sub-editors for objectives and rewards.

Quest List

The quest list shows all loaded quests with pagination (navigated via Prev/Next buttons). Each entry displays:

  • Quest ID
  • Quest type badge (daily, weekly, story, side, hub)
  • Source badge (base or custom)

Quest CRUD

ButtonDescription
New QuestOpens the quest editor with a blank template
Edit QuestOpens the editor for the selected quest
Clone QuestDuplicates the selected quest with a new ID
Delete QuestOpens a confirmation dialog, then removes the quest

Quest Editor Overlay

When creating or editing a quest, a full-screen editor overlay opens with:

FieldDescription
Quest IDUnique identifier (editable only for new quests)
TypeQuest type dropdown: daily, weekly, story, side, hub
CategoryCategory string (e.g., mining, combat, crafting)
DifficultyDifficulty dropdown: easy, medium, hard, legendary
TierTier dropdown (from configured tiers)
ChapterChapter dropdown (for story quests)
Icon ItemItem ID for the quest icon (with browse panel)
Localized NamePer-language name (via localization editor)
Localized DescriptionPer-language description (via localization editor)
SequentialCheckbox for sequential objective mode
Next QuestQuest ID to auto-offer after completion
Sets FactFact key set on completion
Sets Fact ValueValue to assign to the fact

Prerequisites Editor

Configure requirements that must be met before the quest becomes available:

  • Required Quests -- list of quest IDs that must be completed first
  • Required Facts -- fact conditions that must be true

Objectives Editor

Add up to 10 objectives per quest. Each objective has:

FieldDescription
Objective IDUnique ID within the quest (e.g., obj_1)
TypeObjective type dropdown (all tracked types)
ModeTarget mode: any, block, group, item, npc, zone, interaction
TargetTarget value (with browse panel for blocks/items)
CountRequired count
Localized DescriptionPer-language description text
Consume ItemsCheckbox (for items_collected type)
HiddenCheckbox for hidden objectives

Rewards Editor

Add up to 10 rewards per quest. Supported reward types in the editor:

quest_tokens, item, mmo_xp, rpg_xp, endless_xp, leveling_xp, currency, title, achievement, lootbag, command

Each reward type shows relevant fields (amount, item ID, skill name, etc.).

Browse Panel

A permanent right-side panel that lets you browse game items and blocks. Click an entry to insert its ID into the active field. Useful for setting icon items and objective targets.

Pool Management

From the Content tab you can manage daily and weekly quest pools. Add or remove quests from pools and adjust their selection weights.

NPC Dialogs

Click the Open NPC Dialogs button to navigate to the NPC dialog editor (opens the core mod's NPC dialog system).


Tab 6: Chapters

Manages story chapters with full CRUD support and quest ordering within chapters.

Chapter List

Displays all chapters with pagination (up to 10 per page). Each entry shows:

  • Chapter ID
  • Localized chapter name
  • Number of quests
  • Category badge

Chapter CRUD

ButtonDescription
New ChapterOpens the chapter editor with a blank template
Edit ChapterOpens the editor for the selected chapter
Delete ChapterOpens a confirmation dialog, then removes the chapter

Chapter Editor Overlay

FieldDescription
Chapter IDUnique identifier (editable only for new chapters)
Localized NamePer-language chapter name (via localization editor)
Localized DescriptionPer-language description
CategoryCategory dropdown: main, side, event
OrderSort order number
HiddenCheckbox -- hide chapter until unlocked
Unlock ConditionFact condition for visibility
Required ChaptersComma-separated chapter IDs that must be completed first
Sets FactFact key set on chapter completion

Quest Order

Within the chapter editor, you can reorder the quests assigned to a chapter. The quest list shows up to 15 entries and supports drag-style reordering.


Tab 7: Stats

Displays server-wide quest statistics for monitoring player engagement and quest balance.

Overview Section

MetricDescription
Total StartedTotal number of quests started across all players
Total CompletedTotal number of quests completed
Total AbandonedTotal number of quests abandoned
Completion RateOverall completion percentage

Insights

InsightDescription
Most PopularQuest with the most starts
Least PopularQuest with the fewest starts
Most AbandonedQuest with the most abandons

Per-Quest Table

A paginated table (10 entries per page) showing per-quest statistics:

ColumnDescription
Quest IDShortened quest identifier
StartedNumber of times started
CompletedNumber of times completed
AbandonedNumber of times abandoned
RateCompletion rate (color-coded: green >= 75%, yellow >= 50%, red < 50%)

Controls

ControlDescription
FilterDropdown to filter by quest type: all, daily, weekly, story
SortDropdown to sort by: started, completed, rate, abandoned
Prev/NextPagination buttons
RefreshReload statistics from the server
ExportExport statistics as a JSON file

Localization Editor

The admin panel includes a shared Localization Editor overlay used across multiple tabs (Content, Chapters, Systems). When editing localized text (quest names, descriptions, tier names, chapter names), the overlay shows text fields for all configured languages (up to 9 slots).

Changes in the localization editor are captured in real-time and saved when you click Done.


Workflow

A typical admin workflow in the panel:

  1. Open the panel with /ksquestadmin panel
  2. Navigate to the desired tab
  3. Make changes (edit settings, create/modify quests, adjust economy)
  4. Click Save to apply all changes
  5. Changes are written to config.json and the configuration is reloaded
tip

If you make a mistake, click Cancel before saving to discard all changes and revert to the last saved state.

info

The admin panel modifies the same config.json and custom content files that can be edited manually. Changes made in the panel are immediately reflected in the JSON files after saving.