经济核心

经济核心

玩家积分、物品交换和商店,配有店员NPC:为其他模组提供经济基础。

Economy Core

一个 NeoForge 1.21.1 模组,为服务器提供以 credits(信用点)为单位的经济系统,并提供一个可供其他模组构建的基础:赌场、拍卖行、集市。

Beta 版。 以下所有内容均可正常使用,并已在专用服务器上实际游玩,但在 1.0 之前仍可能发生变化。更新前请备份你的世界。


它添加了什么

  • 每个玩家的个人 credits 账户,随世界一同保存。每一笔变动都会写入日志,崩溃打断的操作会在服务器启动时恢复。
  • 交易所(The Exchange):将任意物品兑换为 credits,之后可再买回,价格由服务器在游戏内设置。任何模组的物品都可以作为货币,也可以是原版锭。可选的回购附加费可防止玩家将其用作免费仓库。
  • 商店(The Shop):以 credits 出售物品,包括附魔或重命名的物品,与上架时完全一致。它从不回购任何物品,因此是 credits 流出经济系统的地方。
  • 价格检查:在接受价格之前,会对照真实的合成配方进行检查。如果一组价格会让玩家通过合成来凭空产生 credits,则会被拒绝,并建议正确的数值。
  • 员工名单(staff list):无需管理员权限即可运行经济系统。版主可管理商店和交易所;管理员还可管理服务器银行和玩家余额。每位员工都有自己的员工密钥。

三种进入方式

无论玩家以何种方式进入交易所和商店,打开的都是同一个界面。每个服务器自行选择使用哪些方式。

  • 一个方块,可放置在柜台后面。
  • 一名职员(clerk):一个商店或交易所 NPC,像普通生物一样用其刷怪蛋或 /summon 放置。职员会停留在放置位置,朝向放置时的方向,不会受到伤害也不会消失,并会转头看向附近的玩家。每种职员各有三套服装。在创造模式下空手潜行并右键点击可更换其服装;在创造模式下攻击可将其移除。可用命名牌为其命名。
  • 一条命令:/exchange 和 /shop,可在任意位置使用。两者默认开启,可在服务器配置中关闭,以迫使玩家走到柜台前。

员工密钥可打开其中任一界面的设置:价格、商店上架商品、附加费。

命令

命令 使用者 作用
/exchange、/shop 所有人,除非已关闭 打开交易所或商店
/credits 所有人 你的余额
/credits pay <player> <amount> 所有人 向另一名玩家发送 credits
/credits balance <player> 员工管理员、管理员 任何人的余额,无论是否在线
/credits give / take / set 员工管理员、管理员 更改余额
/economycore help 所有人 你可以使用的所有命令,每条附一行说明

/economycore 还涵盖价格(values)、回购附加费(spread)、商店(shop)、服务器银行(bank)和员工名单(staff)。/economycore help 会为有权使用的人列出这些内容。

配置

config/economycore-server.toml。世界 serverconfig 文件夹中的副本会覆盖该世界的配置。

设置 默认值 作用
access.exchangeCommand true 允许玩家用 /exchange 打开交易所
access.shopCommand true 允许玩家用 /shop 打开商店
bank.alwaysOn false 即使没有模组请求,也保持服务器银行开启
bank.incomeToBank true 将服务器收取的收入存入银行,而非删除

服务器银行与服务器的收入

商店销售、交易所的回购附加费以及任何其他模组收取的费用,始终从玩家处扣除:这就是 credits 退出流通的方式。如果安装了从银行支付的模组(例如赌场),这些收入会进入服务器银行。否则,它会直接消失。


面向模组开发者

Economy Core 对其使用它的模组一无所知:是它们依赖于它,而绝非相反。模组所需的一切都在 com.github.arrivedbog593.economycore.api 包中,且只有该包在版本之间保持结构不变。

  • Credits:玩家的余额,以及其中他们仍可花费的部分。
  • PlayerCommitments(来自 Credits.commitments()):记录玩家已承诺但尚未支付的 credits,例如赌注或出价,这样商店和交易所就无法重复花费它们。
  • Settlement:在任意数量的账户之间同时转移 credits。会先检查每个账户,若有一个无法支付则不会发生任何变动,整个转移过程会被记录并在崩溃后恢复。
  • Bank:服务器自己的账户。从它支付的模组需在加载时用 Bank.enable(modId) 将其开启,并用 Bank.promise(...) 声明其欠款,这样员工取款时永远不会动用该项。
  • TransactionType:在你的模组构造函数中用 TransactionType.register(code, recoverable) 为日志注册你自己的变动类型。
  • Staff 和 StaffRank:玩家是否为员工,以及物品是否为员工密钥。
  • CreditFormat:按模组其余部分的方式书写 credits。

所有内容均仅限服务器线程。

依赖它

repositories {
    maven { url = "https://cursemaven.com" }
}

dependencies {
    implementation "curse.maven:economy-core-1775541:<fileId>"
}

将 <fileId> 替换为你想要版本的对应文件:它是该文件在 CurseForge 页面末尾的数字。

构建

./gradlew build
./gradlew publishToMavenLocal   # 供依赖它的模组在开发期间使用

许可证

MIT。