国库

国库

一个桥接层,用于提供经济与点数实现

经济

Treasury

一个面向 Minecraft 模组的简单经济与点数 API。
灵感来自 Bukkit 的 Vault 插件。
它不是一个经济实现。
与 Vault 类似,其他模组提供经济/点数实现,而 Treasury 作为桥接层。

我们需要一个好标志,哈哈,我的画技太烂了 —— 作者

它能做什么?

  • 维护服务器经济(支持多货币)
  • 访问点数 / 高级货币
  • 允许模组在不依赖具体实现的情况下与经济系统交互

工作原理

Treasury 定义两种主要的提供者类型:

  • EconomyProvider 用于普通货币
  • PointsProvider 用于点数(主要用于高级货币)

其他模组注册它们的实现,使用该 API 的其他开发者可以获取它们。 详见下文。

注册表

经济

  • 存储在 EconomyServiceRegistry 中
  • 支持多个提供者
  • 其中一个提供者被选为主提供者

选择规则:

  1. 如果配置中指定了 primaryEconomy,则使用它
  2. 否则,使用第一个注册的提供者

点数

  • 存储在 PointsServiceRegistry 中
  • 只允许一个提供者

注册另一个提供者将抛出异常。

注册提供者

经济

Treasury.economy().register(new ExampleEconomyProvider());

点数

Treasury.points().register(new ExamplePointsProvider());

注意:

  • 只允许一个点数提供者
  • 请在模组初始化期间注册

Fabric 入口点

Treasury 支持通过 Fabric 入口点注册提供者:

  • treasury-economy
  • treasury-points

示例:

{
  "entrypoints": {
    "treasury-economy": [
      "com.example.mod.ExampleEconomyProvider"
    ],
    "treasury-points": [
      "com.example.mod.ExamplePointsProvider"
    ]
  }
}

用法

经济

if (Treasury.economy().hasPrimary()) {
    EconomyProvider economy = Treasury.economy().getPrimary();
    double balance = economy.getBalance(playerUuid);
}

点数

if (Treasury.points().isRegistered()) {
    PointsProvider points = Treasury.points().get();
    int balance = points.getBalance(playerUuid);
}

命令

  • /treasury info
  • /treasury balance <player>

所需权限等级:2

要求

  • Fabric:Minecraft 1.20.1+,任意 Fabric 版本,不需要 Fabric API
  • NeoForge:Minecraft 1.20.4+,任意 NeoForge 版本
  • Java:17 或更高

不要问 Forge!

构建

./gradlew build

导入

dependencies {
    compileOnly("io.github.lijinhong11:treasury:VERSION")
}