CoreZZ

What CoreZZ Does

• Starts the shared services used by the rest of the ecosystem.
• Provides the universal /zz hub and the administrative /zzcore command surface.
• Registers permission namespaces, nodes, shared message catalogs, and external hub entries.
• Exposes public APIs for economy, organizations, prefixes, territories, audit, messages, UI, and player preferences.
• Defines the shared directory convention ZonaZeroMc/<Module> used by ecosystem modules.

Commands And Access

• /zz opens the ecosystem hub when the hub command is enabled.
• /zzcore covers admin, reload, and status flows for the core.
• Main documented permissions:
• zzcore.menu
• zzcore.admin
• zzcore.reload
• zzcore.status
• zz.admin is the global ecosystem override.

Runtime Files

• config.json stores hub, storage, UI, registry, and shared-service settings.
• messages.json stores the shared ecosystem text catalog.
• Most business data lives in the consuming modules; CoreZZ focuses on shared services and contracts.

Visible Config Example

{
  "version": 1,
  "debug": false,
  "logLevel": "INFO",
  "prefix": "&6[ZZCore]&r ",
  "audit": {
    "enabled": true,
    "minLevel": "INFO",
    "persistToFile": true,
    "directory": "audit",
    "maxRecentEntries": 500
  },
  "storage": {
    "defaultProvider": "json",
    "prettyPrint": true,
    "backupOnWrite": false
  },
  "security": {
    "trimInput": true,
    "stripColorsFromInput": false,
    "maxInputLength": 128,
    "defaultRateLimitWindowSeconds": 10,
    "defaultRateLimitMaxActions": 5
  },
  "services": {
    "allowHotReload": true,
    "colorizeMessages": true,
    "missingMessageFormat": "&c<missing message: {key}>"
  },
  "ui": {
    "enableHubCommand": true,
    "enableHubHotkey": true,
    "showHubKeyHint": true,
    "preferredHubKey": "",
    "hubOpenTrigger": "ALT_WALK",
    "overlayHud": {
      "enableStatusOverlay": true,
      "enableInspectOverlay": true,
      "updateIntervalTicks": 10,
      "inspectUpdateIntervalTicks": 2,
      "inspectRange": 5
    },
    "externalEntries": []
  }
}

This shows the current default config structure used by the module.

Configuration Reference

Main Settings In config.json

• version (number): internal config schema version.
• debug (true/false): enables or disables extra debug behavior.
• logLevel (text): base log level such as INFO.
• prefix (text): chat and text prefix used by the core.

Audit Settings

• audit.enabled (true/false): turns core audit collection on or off.
• audit.minLevel (text): minimum audit level to keep, such as INFO.
• audit.persistToFile (true/false): writes audit data to file when enabled.
• audit.directory (text): relative audit folder name.
• audit.maxRecentEntries (number): number of recent audit entries kept in memory.

Storage Settings

• storage.defaultProvider (text): storage backend name, currently normalized to values like json.
• storage.prettyPrint (true/false): writes formatted JSON when enabled.
• storage.backupOnWrite (true/false): writes backup copies on save when enabled.

Security Settings

• security.trimInput (true/false): trims player and UI input before processing.
• security.stripColorsFromInput (true/false): removes color formatting from input when enabled.
• security.maxInputLength (number): max accepted input length.
• security.defaultRateLimitWindowSeconds (number): default rate-limit window size.
• security.defaultRateLimitMaxActions (number): max allowed actions inside that window.

Service Settings

• services.allowHotReload (true/false): allows hot reload flows when enabled.
• services.colorizeMessages (true/false): applies color parsing to shared messages when enabled.
• services.missingMessageFormat (text): fallback text shown for missing message keys.

UI Settings

• ui.enableHubCommand (true/false): enables /zz.
• ui.enableHubHotkey (true/false): enables the hotkey or trigger that opens the hub.
• ui.showHubKeyHint (true/false): shows the open-hub hint when enabled.
• ui.preferredHubKey (text): optional preferred key binding hint.
• ui.hubOpenTrigger (text): open trigger mode, normalized by the core.

Overlay HUD Settings

• ui.overlayHud.enableStatusOverlay (true/false): enables the status overlay.
• ui.overlayHud.enableInspectOverlay (true/false): enables the inspect overlay.
• ui.overlayHud.updateIntervalTicks (number): status overlay refresh interval.
• ui.overlayHud.inspectUpdateIntervalTicks (number): inspect overlay refresh interval.
• ui.overlayHud.inspectRange (number): inspect scan range.

External Hub Entries

• ui.externalEntries[] (list of entries): extra menu entries exposed in the /zz hub.
• enabled (true/false): enables or disables that entry.
• id (text): stable internal entry id.
• order (number): display order in the hub.
• pluginId (text): owning plugin identifier.
• command (text): command opened by that hub entry.
• permission (text): permission required for the entry.
• title (text): default title.
• subtitle (text): default subtitle.
• description (text): default description.
• titleLocalized, subtitleLocalized, descriptionLocalized (texts by language): language-specific text overrides.

Installation

1. Copy ZZCore.jar into the server mods folder.
2. Start Hytale once.
3. Confirm that /zz or /zzcore loads correctly.
4. After that, add the dependent modules you want.

Available ecosystem modules detected in the repository:

• BankZZ
• KitsZZ PvP/PvE
• CompendiumZZ
• EssentialsZZ
• EconomyZZ
• FrontierZZ
• ZZClan
• PermissionsZZ Bridge

License

All Rights Reserved.

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