CoreZZ

CoreZZ

CoreZZ它启动了其他ZZ模块所消费的公共服务:配置、文本、权限、审计、存储、UI、注册表、经济、组织、前缀、冷却、安全和领地API。

实用

CoreZZ 的功能

  • 启动生态系统其他部分所使用的共享服务。
  • 提供通用的 /zz 中心以及管理用的 /zzcore 命令界面。
  • 注册权限命名空间、节点、共享消息目录以及外部中心条目。
  • 为经济、组织、前缀、领地、审计、消息、UI 和玩家偏好设置提供公共 API。
  • 定义生态模块使用的共享目录约定 ZonaZeroMc/<Module>

命令与权限

  • /zz 在中心命令启用时打开生态系统中心。
  • /zzcore 涵盖核心的管理、重载和状态流程。
  • 主要记录的权限:
  • zzcore.menu
  • zzcore.admin
  • zzcore.reload
  • zzcore.status
  • zz.admin 是全局生态系统的覆盖权限。

运行时文件

  • config.json 存储中心、存储、UI、注册表和共享服务设置。
  • messages.json 存储共享的生态系统文本目录。
  • 大多数业务数据存放在消费模块中;CoreZZ 专注于共享服务和约定。

可见配置示例

{
  "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": []
  }
}

此示例展示了该模块当前使用的默认配置结构。

配置参考

config.json 中的主要设置

  • version(数字):内部配置模式版本。
  • debug(布尔值):启用或禁用额外的调试行为。
  • logLevel(文本):基础日志级别,例如 INFO
  • prefix(文本):核心使用的聊天和文本前缀。

审计设置

  • audit.enabled(布尔值):开启或关闭核心审计收集。
  • audit.minLevel(文本):要保留的最低审计级别,例如 INFO
  • audit.persistToFile(布尔值):启用时将审计数据写入文件。
  • audit.directory(文本):相对审计文件夹名称。
  • audit.maxRecentEntries(数字):在内存中保留的最近审计条目数量。

存储设置

  • storage.defaultProvider(文本):存储后端名称,当前标准化为 json 之类的值。
  • storage.prettyPrint(布尔值):启用时写入格式化的 JSON。
  • storage.backupOnWrite(布尔值):启用时在保存时写入备份副本。

安全设置

  • security.trimInput(布尔值):在处理前裁剪玩家和 UI 的输入。
  • security.stripColorsFromInput(布尔值):启用时从输入中移除颜色格式。
  • security.maxInputLength(数字):最大可接受输入长度。
  • security.defaultRateLimitWindowSeconds(数字):默认速率限制窗口大小。
  • security.defaultRateLimitMaxActions(数字):该窗口内允许的最大操作数。

服务设置

  • services.allowHotReload(布尔值):启用时允许热重载流程。
  • services.colorizeMessages(布尔值):启用时对共享消息应用颜色解析。
  • services.missingMessageFormat(文本):消息键缺失时显示的备用文本。

UI 设置

  • ui.enableHubCommand(布尔值):启用 /zz
  • ui.enableHubHotkey(布尔值):启用打开中心的快捷键或触发器。
  • ui.showHubKeyHint(布尔值):启用时显示打开中心提示。
  • ui.preferredHubKey(文本):可选的偏好按键绑定提示。
  • ui.hubOpenTrigger(文本):打开触发器模式,由核心进行标准化。

覆盖 HUD 设置

  • ui.overlayHud.enableStatusOverlay(布尔值):启用状态覆盖层。
  • ui.overlayHud.enableInspectOverlay(布尔值):启用检查覆盖层。
  • ui.overlayHud.updateIntervalTicks(数字):状态覆盖层刷新间隔。
  • ui.overlayHud.inspectUpdateIntervalTicks(数字):检查覆盖层刷新间隔。
  • ui.overlayHud.inspectRange(数字):检查扫描范围。

外部中心条目

  • ui.externalEntries[](条目列表):在 /zz 中心暴露的额外菜单条目。
  • enabled(布尔值):启用或禁用该条目。
  • id(文本):稳定的内部条目 ID。
  • order(数字):在中心中的显示顺序。
  • pluginId(文本):所属插件标识。
  • command(文本):该中心条目打开的命令。
  • permission(文本):该条目所需的权限。
  • title(文本):默认标题。
  • subtitle(文本):默认副标题。
  • description(文本):默认描述。
  • titleLocalizedsubtitleLocalizeddescriptionLocalized(按语言的文本):特定语言文本覆盖。

安装

  1. ZZCore.jar 复制到服务器的 mods 文件夹中。
  2. 启动 Hytale 一次。
  3. 确认 /zz/zzcore 能正确加载。
  4. 之后,添加你想要的依赖模块。

在仓库中检测到的可用生态模块:

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

许可证

保留所有权利。

未经作者书面许可,不允许再分发、转载、转售编辑或重新上传分支版本。