kubejs-utils/README_zh.md

KubeJS Utils

English | 简体中文

这是一个用于 Minecraft KubeJS 的实用脚本集合，旨在为服务器管理员和整合包作者提供强大而高效的工具。

脚本说明

areacontrol.js

一个强大的区域管理脚本，允许管理员定义一个特殊区域并对进入该区域的玩家施加规则。

• 主要功能:
  • 玩家进入/离开指定区域时，自动切换游戏模式（如冒险/旁观模式与生存模式的切换）。
  • 可配置的白名单，允许特定玩家（如OP）不受影响。
  • 为区域内玩家设置统一的物品使用冷却。
  • 提供丰富的游戏内命令，用于实时配置区域中心、半径、目标模式等。
• 设计理念:
  • 高性能: 采用事件驱动和降频检查机制，最大限度地减少对服务器性能的影响。
  • 持久化: 所有配置都会自动保存，服务器重启后不会丢失。

详细用法请参考 areacontrol.js 文档。

event_register.js

一个为 KubeJS 设计的轻量级自定义事件总线系统。它创建了一个全局的 eventBus 对象，允许在不同的脚本文件之间解耦事件的监听和触发。

• 主要功能:
  • 代码解耦: 允许一个脚本触发事件，而其他脚本可以监听并响应，降低脚本间的直接依赖。
  • 简化事件处理: 将复杂的原生 Forge 事件转换为易于管理的自定义事件。
  • 全局可用: 在任何服务器、客户端或启动脚本中都可以访问 eventBus。

areacontrol.js 的物品冷却功能依赖此脚本。详细用法请参考 event_register.js 文档。

许可证

本项目采用 MIT 许可证。