跳到主要内容

安装与授权

运行环境​

项目要求
服务端Minecraft 1.21.10 / 1.21.11 / 26.1 / 26.2 / 26.3,同一个 jar。1.21.10 / 1.21.11 用 Paper / Purpur;26.x 用 Paper。其他版本(包括 1.21.4 – 1.21.9)会在控制台提示不支持并停用
Java1.21.10 / 1.21.11 用 Java 21 或更新;26.x 需要 Java 25
前置插件无
客户端原版客户端即可,需要载入资源包;画面依赖资源包里的核心着色器
实测1.21.10 / 1.21.11 / 26.1 / 26.2 / 26.3 五个版本都在装满本系列插件的实验服实测:画面一致,后台零红字、零黄字
可选:PlaceholderAPI画面文字与动作里的 %变量%
可选:CraftEngine资源包自动合并进 CraftEngine 一起发送;ce: 物品
可选:Vault + 经济插件按钮的金钱花费 cost.money
可选:PlayerPoints按钮的点券花费 cost.points
可选:ItemsAdderia: 物品
光影包

光影包(Iris、OptiFine 光影)会取代原版的核心着色器:实测 Iris + Complementary 开着光影时,云界面选单会整个看不到,服务器也侦测不到。所以装了模组的客户端第一次打开选单时,会用原版对话框(光影盖不掉)问一次有没有开光影,选「有」就改用箱子选单(menu.ask-modded)。玩家随时可以输入 /cui classic 切换,见 箱子备援。

安装步骤​

  1. 放入插件把 CloudUI-<版本>-簡體授權版.jar 放进 plugins/,启动服务器一次,产生 plugins/CloudUI/。
  2. 填授权码打开 会员中心「我的授权」,复制 CloudUI 的授权码(以 UI 开头),填进 plugins/CloudUI/token.yml,重启服务器。第一次启动时自动绑定这台服务器。
  3. 确认资源包默认 pack.mode: auto:有 CraftEngine 就交给 CraftEngine 合并发送,没有就由 CloudUI 自己发送。自己发送时,把 pack.url 改成玩家连得到的公网 IP 或网域,见 资源包。
  4. 打开选单进入游戏,站在地上输入 /cui,打开默认的主选单画面 main。
授权
  • 产品代码 cloudui,授权码前缀 UI。
  • 没有授权时,玩家打开选单会看到「選單暫時無法使用,請通知伺服器管理員」;管理员会看到要把授权码填进 token.yml 的提示,控制台有详细原因。
  • 换服务器时,到会员中心「我的授权」解绑,新服务器启动时自动绑定。

插件文件夹​

位置内容
config.yml主设定:资源包、字体、网页编辑器、游标、选单、音效,见 配置文件
lang.yml指令与提示文字(MiniMessage 格式)
token.yml授权码
screens/画面文件,一个 .yml 一个画面,文件名就是画面 ID(可以放在子文件夹)。默认有 main.yml、teleport.yml
images/画面用的 PNG 图片,画面里写相对路径,例如 image: main/backdrop.png
fonts/自己的 .ttf 字体(在 config.yml 的 fonts.*.file 填相对路径)
sounds/换掉内置音效:ui_click.ogg(点击)、ui_open.ogg(打开 / 关闭),Ogg Vorbis 格式
CloudUI-pack.zip、resource_pack/产生的资源包(压缩档与解压后的文件夹)
installed.yml本系列插件自动安装的画面记录(见下方)
本系列插件自动安装画面

云公会、星月邮箱等本系列插件会把自己的画面与图片自动放进 screens/、images/。插件更新时,你没改过的文件会自动更新,改过的保留不动(控制台列出一次)。较早安装、还没有安装记录的旧文件会直接更新,旧文件另存成同名的 .old。见 本系列整合。

资源包​

CloudUI 每次启动或 /cui reload 都会依画面文件重新产生资源包(图片、字体、着色器、音效)。由谁发送给玩家由 config.yml 的 pack.mode 决定:

pack.mode说明
auto(默认,建议)装了 CraftEngine 就交给 CraftEngine,没有就自己发送
selfCloudUI 自己开一个 HTTP 服务发送资源包(pack.url / pack.bind / pack.port)
craftengine一定交给 CraftEngine
external由其他插件(ItemsAdder 等)合并后发送:自行把 CloudUI-pack.zip 或 resource_pack/ 文件夹加进去

自己发送(self)​

pack:
mode: auto
url: 'http://你的公网IP或网域:8164/' # 结尾要有 /
bind: '0.0.0.0'
port: 8164 # 防火墙要开放这个端口
send-on-join: true
required: false
prompt: '此伺服器的選單介面需要資源包'

玩家没收到或想重新下载时输入 /cui pack。

搭配 CraftEngine​

pack.mode: auto 且装了 CraftEngine 时:

  • pack.craftengine.auto-register: true:自动把 CloudUI/resource_pack 加进 CraftEngine 的 resource-pack.merge-external-folders(先备份成 config.yml.cloudui-backup)。
  • pack.craftengine.auto-reload: true:资源包有变动时自动执行 pack.craftengine.reload-command(默认 ce reload all),让 CraftEngine 重新打包并发送。

资源包大小​

  • pack.reduce-colours: true:把画面图片减成每块最多 256 色,资源包约小一半;只有和原图几乎一样的图块才会替换,pack.colour-error(建议 4–8)是允许的最大色差。
  • 画面里大张、柔和的背景图设 resolution: 0.25,以四分之一尺寸储存、放大绘制,见 画面元素 · image。
  • fonts.text.common: false 可省约 0.5~0.9 MB,但插件执行时才给的文字(信件标题、公会名称…)可能缺字,见 配置文件 · 字体。

重新载入​

修改画面或设定后执行 /cui reload:关闭所有打开中的选单、重新读取设定与画面、重建资源包。资源包有变动时,玩家需要重新载入资源包(CraftEngine 模式会自动重新发送)。