Dashboard tour
The dashboard always works on one bot instance at a time. An instance is one complete bot: it has its own Discord token, collectibles, player data, modules, templates, messages, and settings. If you own or can access more than one instance, changing one does not change the others.
Start with the left sidebar
Section titled “Start with the left sidebar”The name and status under the Kompendium logo tell you which bot you are currently managing. The coloured status label is the runtime state of that bot. It may say that the bot is running, stopped, starting, or has not been linked yet.
Below it is the main navigation:
- Dashboard is the home screen. Use it to start, stop, deploy, update, and check the health of the selected bot.
- Logs & Activity shows events and useful recent activity when you need to see what the bot has been doing.
- Config holds the bot identity, Discord intents, collection wording, access rules, and reset controls.
- Modules is where you turn gameplay systems on or off and open the full settings page for an individual module.
- Spawn controls the timing, catch method, messages, variety, and limits for collectible spawns.
- Cards opens Card Studio, where card templates and fonts are managed.
- Packs appears when pack features are available. It is where you decide what a purchasable pack contains.
- Data is for backups, imports, exports, and migration jobs.
- Users appears for owners who can manage dashboard accounts. It lets you give trusted people their own dashboard login.
- Setup appears while an instance still needs its first bot token and basic details.
On a phone, the same sidebar is behind the menu button in the top bar. The Light and Dark buttons at the bottom only change the dashboard appearance in your browser; they do not change the bot or Discord.
Switching instances safely
Section titled “Switching instances safely”If you see Instance Switcher in the sidebar, choose an instance from View another instance, then press Switch. The entry includes the instance slug and its owner so that you can tell similarly named bots apart.
Before switching, look for the small bar at the bottom of the screen that says You have unsaved changes. It appears after you edit Config, Spawn, module settings, or a command response. Press Save Changes to keep the edit, or Discard to put the page back exactly as it was. The dashboard blocks page changes until you make that choice, so settings cannot be lost by accident.
Every screen described below belongs to the selected instance. This is especially important for imports, resets, bot tokens, and response templates.
The Dashboard page
Section titled “The Dashboard page”The top of the page shows the instance name, its current status, and today’s date. The status pill on the right is a quick check of whether the runtime is available. The buttons beside it perform real runtime actions:
- Start starts a stopped runtime. Use it after initial setup or after deliberately stopping the bot.
- Stop stops the runtime. Discord commands will not respond while it is stopped. Use it for maintenance or before a major change that you do not want live yet.
- Restart stops and starts the runtime again. This is the normal choice after replacing a Discord token or when the bot needs to reconnect to Discord.
- Provision / Deploy creates or refreshes the runtime deployment for this instance. Use it after setup or when a runtime has not been created correctly yet.
- Update to … only appears when a newer Kompendium runtime is available. It deploys that newer runtime version to this instance.
- Admin panel… is only visible to global administrators. It opens Django’s administrative tools for the global system or for a chosen instance. It is not needed for normal day-to-day bot management.
Wait for the status pill or the message below the buttons to confirm the action. Starting and deployment can take a little time. Repeatedly clicking the same action does not make the bot start faster.
Growth Graph and command sync
Section titled “Growth Graph and command sync”The lower half of Dashboard is a simple history of your bot. The metric buttons select what the graph shows, such as player, server, or collectible growth. The time-range buttons change how much history is drawn. They only change the graph view; they do not delete or alter any data.
Press Sync now to ask the dashboard to refresh the displayed measurements. The page shows when the data was last synced. A new instance can show an empty graph until it has enough activity.
The Command Sync area tells you whether the Discord application commands are in sync. Press Sync commands when slash commands have just been added, renamed, or are missing in Discord. The button restarts the runtime so it can register its commands again. Discord can take a short time to show command changes, especially outside a configured admin server.
The release line at the bottom names the installed runtime version and tells you if an update is available. It is information only; use the update button at the top if you decide to update.
The Admin panel
Section titled “The Admin panel”The Admin panel… menu is a separate, record-level management area for detailed work such as searching player inventories, auditing a trade, or editing a collectible record. It is different from Discord’s /admin commands. Instance owners see only their bot’s data; global administrators can choose an instance-filtered view or the global view. Read Admin panel overview before using it, especially before bulk edits or deletion.
First-time setup
Section titled “First-time setup”If an instance has not been completed, open Setup. Choose Start fresh when creating a new bot, or Migrate from Ballsdex when you already have a SQL dump and optional media.zip archive.
For a fresh bot, enter the Bot name and paste the Discord bot token, then choose Complete setup. The token is secret. Do not post it in Discord, screenshots, tickets, or documentation. The eye button only shows or hides the value while you are typing it.
For a migration, enter the name and token, choose the SQL dump and optional media archive, and leave Run import immediately after saving checked if you want the import to start as soon as setup completes. You can leave the files out and use the Data page later instead. The screen only asks for the essentials; collection labels and other settings can be changed afterward in Config.
After setup, return to Dashboard and use Provision / Deploy if the runtime has not started automatically. Then open Config, Modules, Spawn, and Cards in that order to finish shaping the bot.
A sensible order for a new bot
Section titled “A sensible order for a new bot”- Finish Setup and make sure Dashboard shows a running bot.
- In Config, set the collection wording, intents, and who may administer the bot.
- In Modules, enable only the systems you plan to use.
- In Spawn, choose the catch method and pace before inviting players.
- In Cards, create or select a card template.
- Add collectibles and test the bot in a private Discord server.
- Use Logs & Activity and Dashboard while testing so problems are easier to trace.
If a page says No bot linked, the dashboard account currently has no selected bot instance to manage. Return to the place where the instance was created or ask the instance owner to grant you access.