Client
安装插件
本文介绍如何将 FGateClient 插件安装到 Bukkit 系 Minecraft 服务器(支持 Spigot、Paper 及其衍生服务端),使其与 FGateNexus 建立连接。
后续还会制作 Forge / Fabric 等模组版的 FGateClient 插件,敬请期待!记得催更哦~
下载 FGateClient
前往 FGateClient Releases 根据你的服务端类型下载对应的插件 JAR 文件:
| 服务端类型 | 推荐版本 | 说明 |
|---|---|---|
| Paper、Purpur 等 Paper 衍生端 | FGateClient-paper-vx.x.x.jar | 支持 Paper API,功能更完整 |
| Spigot、CraftBukkit 等 Bukkit 系服务端 | FGateClient-bukkit-vx.x.x.jar | 兼容标准 Bukkit API |
如果你使用的是 Paper 或其衍生端(如 Purpur),建议优先下载 paper 版本以获得最佳兼容性。
Spigot 用户请下载 bukkit 版本。
放入 plugins 目录
将下载的 JAR 文件放入你的 Minecraft 服务器的 plugins/ 目录(只需放入其中一个,根据你的服务端类型选择):
FGateClient-xxx-x.x.x.jar
然后重启服务器,插件将自动加载并在 plugins/FGateClient/ 目录生成配置文件。
配置插件
编辑 plugins/FGateClient/config.yml,完整配置说明如下:
debug: true
websocket:
url: ws://127.0.0.1:3000/api
token: your_token_here
autoReconnect: true
reconnectInterval: 10
eventResolve:
join:
allowJoin: true
kickMessage: 服务器尚未准备好,请稍后再试
errorJoin: true
errorMessage: 服务器发生错误,请稍后再试| 配置项 | 说明 |
|---|---|
debug | 开启后输出详细日志,排查问题时建议启用 |
websocket.url | FGateNexus 的 WebSocket API 地址,一定要在 FGateNexus 的控制台 URL 后加上 /api |
websocket.token | 认证令牌,需与 FGateNexus 中配置的一致 |
websocket.autoReconnect | 断线后是否自动重连 |
websocket.reconnectInterval | 重连间隔,单位为秒 |
eventResolve.join.allowJoin | FGateNexus 未连接时是否允许玩家进入服务器 |
eventResolve.join.kickMessage | 拒绝进入时展示给玩家的提示信息 |
eventResolve.join.errorJoin | 处理登录事件时发生错误是否仍允许玩家进入 |
eventResolve.join.errorMessage | 错误发生时展示给玩家的提示信息 |
如果 FGateNexus 与 Minecraft 服务器运行在不同机器上,请将 websocket.url 中的 127.0.0.1 替换为 FGateNexus
所在机器的 IP 地址。
保存配置后,重载插件或重启服务器,插件即会自动连接 FGateNexus。
查看 FGateNexus 服务器管理页面,如果连接成功,你会在服务器列表中看到对应的实例状态为 在线。