- Java 21
- Paper 1.21+
- 源码当前使用的 Paper API 为 1.21.4-R0.1-SNAPSHOT
Wiki · Install
安装部署从源码构建到服务端落地
这一页面向第一次把插件跑起来的人。流程尽量按最短路径写，不绕。
1. 环境要求
2. 构建插件
在项目根目录执行以下命令：
./gradlew.bat compileJava
./gradlew.bat clean shadowJar
- 最终产物路径：build/libs/Yuanshen-1.0.jar
- ShadowJar 会生成不带 classifier 的最终 JAR。
3. 安装到服务端
- 停止 Paper 服务端。
- 把 build/libs/Yuanshen-1.0.jar 放到服务端的 plugins/ 目录。
- 启动服务端，等待插件首次生成数据目录。
4. 首次启动后会生成什么
服务端启动后，插件会在 plugins/Yuanshen/ 下生成和同步资源配置。
config.yml
attributes.yml
sidebar.yml
character-gui.yml
starter-characters.yml
mod-keybind.yml
playerdata.yml
juese/*.yml
weapons/*.yml
mobs/*.yml
5. 可选依赖
- PlaceholderAPI：启用 `%yuanshen_*%` 占位符和外部面板联动。
- MythicMobs：按 Mythic 怪物 ID 应用怪物抗性。
- ProtocolLib：当前在软依赖声明中存在，但当前源码桥接重点不是它。