KoleVault-Core

KoleVault-Core

简单易用的玩家和开发者插件基础版本。处理自定义货币和资源的插件。

生活质量

KoleVault

专为 Hytale 服务器打造的轻量级、开发者友好的经济插件。KoleVault 旨在简化资源管理，处理数据库、资源和交易，让您可以专注于打造出色的游戏体验。

✨ 功能特性

  • 资源管理：通过灵活的 YAML 配置，存储和管理任意虚拟资源（金币、钻石、经验等）。
  • 完整交易系统：支持支付、请求命令，并提供完整的审计历史记录。
  • 事件驱动 API：可扩展架构，允许其他插件监听经济事件（转账、余额变化）。
  • 数据库就绪：内置支持 HyDB（SQLite），自动管理数据表。
  • 简洁命令：直观的命令，支持 Tab 补全和有用的反馈信息。

🚀 快速开始

安装（服务器管理员）

  1. 安装依赖：将以下 .jar 文件放入服务器的 mods/ 文件夹，然后重启服务器：
    • HyDB（用于数据库管理）
    • TinyMessage（用于格式化聊天消息）
  2. 安装 KoleVault：将 KoleVault-Core.jar 放入 mods/ 文件夹。
  3. 配置：首次运行后，编辑生成的配置文件 plugins/KoleVault/resources.yml。
  4. 重启：重启服务器以使更改生效。

📖 命令与用法

玩家命令

查看余额

  • /balance
  • 别名：/bal，/money
  • 描述：查看自己或另一名玩家的资源余额。
  • 选项：
    • -p=<玩家> - 指定玩家。
  • 示例：
    • /balance - 显示自己的余额。
    • /balance -p=Alex - 显示玩家“Alex”的余额。

向其他玩家付款

  • /pay <玩家> <数量>
  • 别名：/payPlayer
  • 描述：将资源转给其他玩家。默认使用主货币。
  • 选项：
    • -r=<资源ID> - 指定其他资源（例如：-r=diamonds）。
    • -c="文本" - 为交易添加备注。
  • 示例：
    • /pay Alex 100 - 向 Alex 发送 100 主货币。
    • /pay Alex 50 -r=experience -comment="感谢帮忙做任务" - 发送 50 经验值。

请求资源

  • /req <玩家> <数量>
  • 别名：/request，/requestResource
  • 描述：向其他玩家发送资源请求。
  • 选项：与 /pay 相同（-r，-comment）。
  • 示例：/req Alex 200 -r=gold -comment="借点钱买新工具"

管理自己的请求

  • /reqCan <玩家>
  • 别名：/reqDecline，/requestDecline
  • 描述：取消已发送的资源请求。
  • 示例：/reqCan Alex -r=gold -c="算了，我更需要它。"

拒绝收到的请求

  • /reqDec <玩家>
  • 别名：/reqDecline，/requestDecline
  • 描述：拒绝收到的待处理资源请求。
  • 示例：/reqDec Alex -r=diamonds -c="抱歉，我钻石也不多。"

接受收到的请求

  • 接受：/reqAcc [请求ID]（别名：reqAccept，requestAccept）
  • 拒绝：/reqDec [请求ID]（别名：reqDecline，requestDecline）
  • 描述：接受或拒绝收到的待处理资源请求。
  • 示例：/reqAcc Alex -r=gold

（完整列表请查看 GitHub 页面）

命令选项

大多数命令支持可选标记：

  • -r=<资源ID>：指定使用哪种资源（默认为配置文件中的 main_currency）。
    /pay Alex 100 -r=diamonds
/req Alex 50 -r=experience
  • -comment="文本"：为交易添加备注。
    /pay Alex 100 -comment="为了传说之剑！"

⚙️ 配置

在 plugins/KoleVault/resources.yml 中定义资源：

main_currency: "gold"

resources:
  gold:
    display_name: "&lt;c:gold&gt;金币&lt;/c&gt;"
    # "short_sign" 用于字符串格式化
    # 示例：
    # - "你的余额：5$"
    # - "你有1🗝️。需要2🗝️才能打开锁。"
    # - "你需要更多的🌟经验才能使用此物品。再获得50🌟。"
    
    # 可惜 Hytale 不支持表情符号
    short_sign: "$"
    default_amount: 100.0
    transferable: true  # 可以转给其他玩家

  # 其他资源
  diamonds:
    display_name: "&lt;c:aqua&gt;钻石&lt;/c&gt;"
    short_sign: "D"
    description: "你好，这是一个可选的描述！" # 可选！
    default_amount: 0.0
    max_amount: 1000.0 # 可选！删除此行可禁用最大值
    min_amount: 0.0 # 可选！删除此行可禁用最小值
    transferable: true

  keys:
    display_name: "&lt;c:yellow&gt;钥匙&lt;/c&gt;"
    short_sign: "K"
    default_amount: 0.0
    max_amount: 100.0
    min_amount: 0.0
    transferable: false

🛠️ 开发者 API

KoleVault 提供基于事件的 API，便于集成。您可以在项目的 GitHub 页面上找到示例。

🚧 当前状态

正在积极开发中 - 核心功能稳定，但将持续改进和添加新内容。

🤝 贡献与反馈

发现了 Bug？有功能建议？请：

在 GitHub 仓库中提交 issue 目前还没有可访问的仓库，将在未来几天内开放。

欢迎在评论区留下您的建议。

分享您使用该插件的方式！

本插件旨在简化经济交互——让您专注于打造精彩体验，而非重复的样板代码。