CompendiumZZ

What CompendiumZZ Does

• Indexes items and recipes directly from native Hytale assets instead of external catalogs.
• Provides a browser with text search, category filters, namespace filters, and a detail side panel.
• Shows both craft recipes and "used in" recipes for each item.
• Stores player favorites, recent history, and view preferences.
• Includes an admin panel for manual reindexing and catalog diagnostics.

Commands And Workflow

• /compendium opens the main browser.
• /compendium admin opens the admin panel for authorized users.
• /compendium reload reloads config and messages.
• /compendium reindex forces a manual catalog reindex.
• The normal player flow is UI-first from /zz and the compendium hub entry.

Runtime Files And Data

• config.json stores hub entry, commands, grid density, history, favorites, and reindex settings.
• messages.json stores the editable operational message catalog.
• The module stores its runtime data under ZonaZeroMc/ZZCompendium.
• players/ stores favorites, recent items, and view preferences by UUID.
• cache/index-state.json stores the latest indexing state and recent indexing errors.
• The live index is rebuilt from Hytale item and crafting assets.

Visible Config Example

This is the kind of config.json file you will see when the module generates its settings:

{
  "enableHubEntry": true,
  "enableCommands": true,
  "defaultGridColumns": 5,
  "defaultGridRows": 6,
  "maxRecentHistory": 16,
  "allowFavorites": true,
  "showNamespaceFilter": true,
  "showCraftableFilter": true,
  "enableInspectOverlay": true,
  "adminReindexCooldownSeconds": 20,
  "debugLogging": false
}

The section below explains what each line changes in normal language.

Configuration Reference

Main Settings In config.json

• enableHubEntry (true/false): shows or hides the compendium entry in the ecosystem hub.
• enableCommands (true/false): enables or disables the /compendium command surface.
• defaultGridColumns (number): default number of grid columns in the browser.
• defaultGridRows (number): default number of grid rows in the browser.
• maxRecentHistory (number): max number of recent items kept per player.
• allowFavorites (true/false): enables or disables favorites.
• showNamespaceFilter (true/false): enables the namespace filter in the UI.
• showCraftableFilter (true/false): enables the craftable-only filter in the UI.
• enableInspectOverlay (true/false): enables the item inspect overlay.
• adminReindexCooldownSeconds (number): cooldown before another manual reindex can be triggered.
• debugLogging (true/false): enables extra debug logging.

Permissions

• compendium.use
• compendium.admin
• compendium.reindex

Installation

1. Copy ZZCore.jar into the server mods folder first.
2. Copy ZZCompendium.jar into the same server mods folder after that.
3. Start Hytale.
4. Let the module index assets and then configure player/admin permissions as needed.

License

All Rights Reserved.

Redistribution, reposting, resale edits, or reuploading forks is not allowed without written permission from the author.