Skip to content

configuration

约 1124 字大约 4 分钟

2026-05-23

WorldMagic 通过服务器工作目录下的 application.properties 文件进行配置。

配置文件位置

your-minecraft-server/   ← 服务器根目录(执行 java -jar 的目录)
├── application.properties   ← 配置文件在此
├── plugins/
│   └── world-magic.jar
└── paper.jar

注意路径

配置文件位于服务器根目录,不是 plugins/ 子目录,也不是 plugins/WorldMagic/ 目录。

完整配置项

# ===========================
# WorldMagic 配置文件
# ===========================

# 服务器域名或公网 IP
# 用于 TLS SNI 和生成订阅链接
domain=your-server.example.com

# Tuic Server 监听端口(UDP)
# 需要在防火墙中开放此端口的 UDP 流量
port=25565

# 认证 UUID
# 格式:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
# 留空则插件首次启动时自动生成随机 UUID
uuid=

# 认证密码
# 留空则插件首次启动时自动生成 8 位随机密码
password=

# Tuic Server 版本号
# 参考:https://github.com/Itsusinn/tuic/releases
tuic-version=1.6.5

# 订阅节点名称前缀
# 最终节点名格式为 <remarks-prefix>-tuic
remarks-prefix=my-server

# 下载源
# foreign:直连 GitHub Releases(境外服务器推荐)
# china:通过 gh-proxy.com 镜像(国内服务器推荐)
download-source=foreign

配置项详解

domain

  • 类型:字符串
  • 默认值vevc.github.com
  • 说明:服务器的域名或公网 IP 地址。

此值用于:

  1. 生成 tuic-config.json 中的 TLS hostname 字段
  2. 生成订阅链接中的服务器地址和 SNI

使用 IP 还是域名?

  • 使用域名:客户端 SNI 为域名,更接近正常 HTTPS 流量,抗干扰能力更强
  • 使用 IP:更简单,但 TLS 握手中 SNI 为 IP,可能被某些防火墙识别

如果你的服务器有域名,推荐使用域名。


port

  • 类型:整数字符串
  • 默认值25565
  • 说明:Tuic Server 的监听端口(UDP)。

端口选择建议

  • 使用与 Minecraft 相同的端口(25565):减少开放端口数量,但 Minecraft TCP 和 Tuic UDP 不冲突,可共用端口
  • 使用 443:伪装成 HTTPS 流量,穿透性更强(需要超级用户权限或端口转发)

uuid

  • 类型:UUID 格式字符串(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  • 默认值:自动随机生成
  • 说明:Tuic 协议的用户认证 UUID。

留空时,插件首次启动会自动生成一个随机 UUID 并存储。你可以通过 /wm status 查看实际使用的值。


password

  • 类型:字符串
  • 默认值:自动随机生成(8 位)
  • 说明:Tuic 协议的用户认证密码。

留空时,插件首次启动会自动生成一个 8 位随机密码并存储。


tuic-version

  • 类型:版本号字符串
  • 默认值1.6.5
  • 说明:要下载和使用的 tuic-server 版本号。

版本号格式必须与 GitHub Releases 中的 tag 对应(不含 v 前缀)。

# 正确
tuic-version=1.6.5

# 错误(不要加 v)
tuic-version=v1.6.5

remarks-prefix

  • 类型:字符串
  • 默认值vevc
  • 说明:生成订阅节点时使用的名称前缀。

最终节点名格式为 <remarks-prefix>-tuic。例如:

remarks-prefix=Tokyo01
# → 节点名称:Tokyo01-tuic

download-source

  • 类型:枚举(foreign | china
  • 默认值foreign
  • 说明:tuic-server 二进制文件的下载源。
实际下载地址
foreignhttps://github.com/Itsusinn/tuic/releases/download/v{version}/tuic-server-{arch}-linux-musl
chinahttps://gh-proxy.com/https://github.com/Itsusinn/tuic/releases/download/v{version}/tuic-server-{arch}-linux-musl

也可通过 /wm source 命令在运行时修改此值。

配置加密机制

配置文件安全机制

WorldMagic 采用特殊的配置加密流程,确保敏感信息(UUID、密码)不以明文形式长期存在于磁盘:

  1. 首次读取:插件读取明文 application.properties
  2. 自动加密:使用 RSA 公钥加密整个配置内容
  3. 加密存储:将密文以 MD5 值命名,保存到 config/ 目录
  4. 删除明文:原始 application.properties 被删除
  5. 后续启动:插件从 config/ 读取加密文件,用 RSA 私钥解密后使用
  6. 完整性校验:通过校验文件名(MD5)与文件内容的 MD5 是否一致,防止文件被篡改

加密后的配置目录结构:

your-minecraft-server/
└── config/
    └── a3f8c2d1e4b7...   ← 加密配置文件(文件名为内容的 MD5)

修改配置

如需修改已加密的配置:

  1. 重新在服务器根目录创建 application.properties,写入完整的新配置
  2. 删除 config/ 目录下的旧加密文件(或删除整个 config/ 目录)
  3. 重启 Minecraft 服务器,插件会读取新的明文配置并重新加密

注意

不要试图直接编辑 config/ 目录下的加密文件——文件名是其内容的 MD5,修改内容后文件名不匹配,插件会拒绝加载并报错。

Forked from vevc/world-magic | MIT License