接入文档 · Getting Started

五分钟把助梦行
接进你的服务器

不需要写代码、不需要数据库。按下面 5 步走一遍:下载插件 → 丢进 plugins/ → 改 3 行配置 → 注册拿密钥 → 重启测试,玩家就能扫码赞助了。

环境要求:Spigot / Paper 1.21.4(或更高),Java 17+。下载到的 jar 是完整包,直接放进插件目录即可,无需再加装任何依赖。

接入步骤

按顺序做完这 5 步,你的服务器就接好了。

1

下载插件

点下面的按钮下载 SponsorPlugin-1.0.0.jar(约 1 MB),保存到电脑上。

当前地址:https://mc.cyeidc.cn/SponsorPlugin-1.0.0.jar
2

注册账号 · 创建服务器 · 拿密钥

先去网站端注册一个服主账号,登录后进入后台,在「服务器」页点创建并生成密钥。创建完表格里会出现这台服务器的 server_id 和 secret,先把它们记下来——下一步写配置要用。

名称server_idsecret(填入插件)
我的生存服Sccf8ae39690a1b2c3…(48位)
密钥只会生成一次,请立刻复制保存好。忘记或怀疑泄露,随时在后台「服务器」页重新生成。
3

放进服务器 · 写好 config.yml

把下载好的 jar 上传到你服务器的 plugins/ 文件夹里。然后打开 plugins/SponsorPlugin/config.yml——第一次就配好,免得还要重启两次。只需改 3 处,其余保持默认即可。

你的服务器/
└─ plugins/
   └─ SponsorPlugin-1.0.0.jar   ← 上传到这里
配置项改成什么
website.base_url固定填 https://mc.cyeidc.cn(本站地址,不要带末尾斜杠)
website.server_id把你在步骤 2 拿到的 server_id 原样贴进去
website.secret把步骤 2 拿到的 48 位 secret 原样贴进去

改完后应该长这样(只有高亮行是你要动的):

website:
  base_url: "https://mc.cyeidc.cn"          # 固定本站地址,不用改
  server_id: "Sccf8ae39690"          # ← 贴你步骤 2 拿到的值
  secret: "你的48位十六进制密钥"      # ← 贴你步骤 2 拿到的值
  verify_ssl: true
  timeout_ms: 8000
  retry_max: 5

command:
  name: "zz"                        # 玩家输入 /zz 打开赞助
  aliases: ["赞助", "dz", "sp"]
注意:secret 是插件与网站通信的钥匙,只填在你自己的服务器上,不要发到群里或截图外传。泄露后请到后台「服务器」页重新生成,再同步回 config.yml。
保存文件即可。先别急着重启——如果你已经配好了,下一步直接重启一次就够。万一忘记填,服务器启动后也会生成默认 config.yml,改完再重启一次就行。
4

(可选)配赞助档位与支付

插件能正常连上网站后,还需要在后台给服务器加上「赞助档位」(如 6 元送烟花 / 30 元送称号 / 98 元给飞行),玩家才能在游戏里选择。档位里的游戏内动作可以自由组合。

没有配档位时,/zz 会提示「暂无档位」——正常的,配好就有了。支付接口没填也能测试插件联通,只是扫码支付不会到账。
5

重启服务器,游戏内测试

保存好 config.yml 后,重启服务器(或输入 /reload confirm)。进游戏后输入:

/zz        # 打开助梦行菜单,列出可选档位
/赞助      # 同上(别名)

选择档位后会得到一张二维码地图,扫码支付。付款成功后,你在档位里配置的游戏内动作(烟花、公告、称号、飞行、礼包…)会自动执行。

如果提示 order_failed 或连不上:对照下方的「常见问题」逐条排查。

常见问题

接入过程中最容易卡住的几个点。

游戏里输入 /zz 没反应,或提示没有权限?

先确认玩家拥有权限 sponsor.use。如果用的是 LuckPerms,执行 /lp group default permission set sponsor.use true。

OP 默认拥有全部权限,可以直接测试。插件是否加载成功,看服务器启动日志里有没有 SponsorPlugin 的启用信息。

提示认证失败 / secret 无效?

server_id 与 secret 必须和后台「服务器」页显示的完全一致,注意别多复制了空格或换行。

如果怀疑密钥泄露,可在后台重新生成 secret,并把新值同步回 config.yml 后重启。

连不上网站 / 请求超时?

确认 base_url 填的是 https://mc.cyeidc.cn(不要带 /mc 之类的子路径,也不要带末尾斜杠)。

服务器需能访问公网。若你的机器时间不准,会导致签名校验失败,请开启 NTP 校时。

二维码地图扫不出来?

把 qr.error_correction 调为 Q 或 H 可提升识别率;确认下载的是完整包(约 1 MB),而不是 original-* 瘦包。

付款成功了但游戏内没收到?

插件按订单轮询网站,付款后通常几秒内生效。请确认后台「支付设置」里已填好你自己的易支付 PID / AppKey。

没有支付接口的,先看 支付接入说明 →

都改好了?那就开服吧 🌸

注册账号、创建服务器、拿密钥,然后回游戏里打一句 /zz。