VoidkitVoidkit
指南
模块
反作弊
审计
管理平台
开发
GitHub
指南
模块
反作弊
审计
管理平台
开发
GitHub
  • 指南

    • 快速开始
    • 安装与部署
    • 配置文件
    • 命令速查
    • 权限节点参考
    • 版本与加载器
    • 文本语法
    • 架构
    • 常见问题

配置文件

首次启动后,voidkit/ 会出现在服务端根目录下:

voidkit/
├── core/
│   ├── config.json          内核:语言 / 模块开关 / 世界名 / 追踪 / 落盘间隔
│   └── data/                玩家档案、上下线日志
├── display/
│   ├── motd.json            MOTD(可配多套轮换)
│   ├── tab.json             TAB 顶栏 / 底栏
│   ├── scoreboard.json      记分牌(可按权限切换多套)
│   ├── chat.json            聊天栏格式、悬停浮层、点击动作
│   ├── announce.json        公告框线 / 通道 / 轮播
│   └── menu.json            菜单与物品绑定
├── perm/
│   ├── groups.json          权限组树
│   ├── users.json           玩家级覆盖
│   └── settings.json        全局设置
├── title/
│   └── titles.json          称号定义
├── essentials/
│   ├── config.json          家上限 / TPA / back / 传送冷却
│   └── commands.json        要停用的命令简写
├── economy/
│   ├── config.json          货币名 / 初始余额 / 转账手续费
│   ├── values.json          物品估值表(/sell、/worth)
│   └── accounts.json        账户余额
├── utility/
│   ├── clearlag.json        清扫间隔 / 通道 / 垃圾桶规则
│   └── perf.json            TPS·MSPT 阈值 / 区块热点 / 干预开关
└── web/
    └── config.json          管理 API 监听地址与令牌

所有文件都带中文注释,打开即可改。配置文件按插件分家 —— 一份插件的配置可以整体备份、整体交接。

📌 目录里的 perm/ title/ economy/ 虽然已不再是独立 jar(源码并入 voidkit_essentials / voidkit_display),但它们的配置与数据目录刻意保持不变 —— 升级到合并版后这些文件原地不动, 不需要搬迁。

改完配置执行 /vk reload 生效。

reload 会重新读盘的范围:内核配置、显示层(MOTD / TAB / 记分牌 / 聊天)、公告、菜单、 称号、传送与家、清扫与性能、经济(开关与价格表)、权限数据(组 / 用户 / 设置)、管理接口。 命令回执里也会列出这份清单。

以下不随 reload 变更,属有意为之:

  1. 玩家余额(economy/accounts.json)—— 运行数据,用游戏内 /eco 或网页面板改。
  2. 管理接口的 bind / port —— 监听套接字已经绑好,改这两项要重启服务端 (token 与限流是每请求实时读的,reload 后立即生效)。
  3. 其它注释里明确写「仅启动期读取」的项。

core/config.json

字段说明
language界面语言 zh_cn(默认)/ en_us,词表在 voidkit/lang/
features模块开关。键是模块 id,值 false 表示停用
worldNames维度显示名(%world% 变量用),支持 & 颜色码 —— 见下
recordIps是否记录玩家 IP 历史
maxJoinLogEntries上下线日志最多保留多少条
autoSaveSeconds玩家档案自动落盘的兜底间隔(秒)

worldNames:给世界起中文名

"worldNames": {
  // 完整维度 ID 或只写路径都可以;值支持 & 颜色码
  "minecraft:overworld": "&a主世界",
  "minecraft:the_nether": "&c下界",
  "minecraft:the_end": "&5末地",
  // 模组维度照写自己的 ID
  "twilightforest:twilight_forest": "&d暮色森林"
}
  • 匹配顺序:完整 ID → 路径简写(overworld)→ 维度路径原文。
  • 没配到的维度回退显示路径原文,不会留空或显示 %world%。
  • 空 {} 合法,表示全部按路径原文显示。

essentials/config.json

字段默认说明
defaultHomeLimit3默认家的数量上限
maxHomes32权限能给到的最高上限
tpaEnabledtrue是否允许玩家互传
tpaTimeoutSeconds60TPA 请求超时
backEnabledtrue/back 是否可用
teleportCooldownSeconds0传送冷却(秒)

家上限的分级:用权限节点 voidkit.homes.limit.<N>(例如 voidkit.homes.limit.10) 给不同组不同上限。

commands.json 用来停用某个命令简写(整合包里被别的 mod 抢了名字时):

{ "disabled": ["day", "sun"] }

可用名字:day night noon midnight dawn dusk freeze unfreeze sun rain thunder gr diff gm。


display/chat.json

聊天栏的核心是 format 一行:

"format": "&8[&6%group%&8]&7[&aLv%level%&7] %title%&b{name} &8» &f{message}"
字段说明
format整条消息的模板,见 文本语法
colorEnabled / colorPermission谁能在自己的发言里打 & 颜色码
placeholderPermission允许在聊天里用 %变量% 的权限节点
blockMuted被禁言玩家发言是否直接拦下
nameHover鼠标悬停玩家名时的浮层(每项一行)
nameClick点击玩家名做什么,如 run:/tpa {name}

常用占位符:{name} {message} {world} %group% %prefix% %title%%level% %playtime% %ping% %health% %x% %y% %z% %online% %tps%。


perm/settings.json

字段说明
defaultGroup没有显式分组的玩家归到哪个组
opBypass原版 OP 是否直接放行所有权限检查
defaultValue谁都没命中时的默认结果(一般保持 false)
wildcardEnabled是否启用通配(* 与 voidkit.home.*)
prefixFromHighestWeight前缀取权重最高的组 / 始终取主组

组的字段:prefix suffix weight permissions parents。 详见 权限模块。


title/titles.json

"titles": {
  "vip": {
    "display": "&6[VIP]",
    "description": "VIP 专属称号",
    "permission": "voidkit.title.vip",   // 留空 = 人人可用
    "weight": 10,
    "icon": "minecraft:gold_ingot"
  }
}

「谁佩戴了哪个称号」不在这里 —— 那存在玩家档案里;「谁有资格用」直接复用权限系统。 让某玩家拿到称号:/perm user <玩家> add voidkit.title.vip。


economy/config.json

字段默认说明
currencyName金币货币名
format{amount} {currency}金额显示格式
startingBalance0.0新玩家初始余额
maxBalance1e9余额上限
payEnabledtrue是否允许转账
payMin0.01单次转账下限
payCooldownSeconds0转账冷却
taxPercent0.0转账手续费百分比

values.json 是物品估值表,供 /sell、/worth、/shop 使用。


utility/clearlag.json

字段默认说明
intervalSeconds300清扫间隔
warnSeconds30清扫前提前播报
announceChannelchat播报通道
removeItems / removeXpOrbs / removeArrowstrue各类实体的处理开关
maxTypes45垃圾桶最多保留多少种物品
junkKeepLimit512垃圾物品每类保留上限
protectedItems—永不动的贵重物白名单
trashItems—优先淘汰的垃圾物
maxPerSweep20000单轮处理实体数上限(防卡主线程)

垃圾桶的淘汰策略详见 清扫与性能。


web/config.json

字段默认说明
bind127.0.0.1监听地址(默认只本机,安全)
port8765监听端口
token自动生成访问令牌,用 /vk token 查看
rateLimitPerSecond30每秒请求上限

⚠️ 不要随便把 bind 改成 0.0.0.0 暴露到公网 —— 正确做法是让它只听 127.0.0.1, 由本机的 管理平台 去连它。

在 GitHub 上编辑此页
最后更新: 2026/10/14 08:58
Prev
安装与部署
Next
命令速查