AuroraUIEditor 使用 Wiki
AuroraUIEditor 是 AuroraUI 的管理端可视化编辑器(Fabric 客户端模组)。 你在游戏里用鼠标直接摆放、选中、拖动菜单元素,编辑结果由服务端权威保存回 YAML。
它是可选的管理工具:普通玩家不安装也能正常看到菜单;只有管理员在需要可视化编辑时才进入编辑器。 FabricMC 1.21.11仅客户端环境
下载与安装
AuroraUIEditor 是 Fabric 客户端模组,放进游戏实例的 mods/ 即可;它本身不含菜单逻辑,需要由服务端提供编辑通道。
| 渠道 | 链接 |
|---|---|
| MineBBS | AuroraUIEditor 资源页 → |
| Modrinth | modrinth.com/mod/auie → |
| 爱发电 | ifdian.net/a/aurorastudio →(支持 AuroraUI 项目) |
1. 它是什么
编辑器与浏览器「所见即所得」工具不同,它不修改客户端界面,也不跳过服务端:
服务端权威
模组只是一个「遥控器」。所有编辑操作都以二进制数据包发给服务端,由服务端改动菜单模型并写回磁盘 YAML。编辑会话
服务端执行/auroraui edit <菜单ID> 后为该玩家开启一个私有编辑会话,模组界面才可用。画布 = 真实菜单
中央视口渲染的就是运行中的菜单平面(16:9),你看到的即是玩家看到的。前端 / 后端
顶部可切换 前端(视觉节点)与 后端(屏幕对齐的点击命中区)两个标签页,分别编辑。2. 运行要求
| 项目 | 要求 |
|---|---|
| Minecraft | 1.21.11 |
| 模组加载器 | Fabric Loader ≥ 0.18.6 |
| 依赖模组 | Fabric API(必需) |
| Java | ≥ 21 |
| 运行环境 | client(仅客户端安装) |
| 服务端 / 环境 | 装有 AuroraUI 插件并开启编辑通道的 Paper 服务器;或安装了 AuroraUIEditor 的单人游戏 |
| 权限 | auroraui.admin(编辑器只在管理员会话下打开) |
0.1.0-M3.3。连接时会把客户端版本与协议版本发给服务端,版本不匹配时服务端会拒绝同步。3. 打开编辑器
编辑器只能由服务端推送打开,玩家无法自行打开(单人游戏中由本地集成服务器承担该角色):
# 在服务器控制台或游戏内以管理员身份执行
/auroraui edit <菜单ID>
# 例如
/auroraui edit example
mods/ 里装好 AuroraUIEditor 模组,进入存档后执行 /auroraui edit <菜单ID> 即可打开编辑器,无需额外配置。成功后会进入 AuroraUI 编辑器界面,顶部状态栏显示当前菜单与连接状态:
- 正在
/auroraui edit标题:显示菜单 ID 与「前端 / 后端」标签。 - 未连接编辑会话:说明服务端尚未打开会话,或已断开——确认命令执行成功且你有
auroraui.admin权限。 - 视口中央若提示「请在服务器执行
/auroraui edit <菜单ID>」,即表示当前没有活动会话。
4. 界面布局
选择
组
矩形
边框
线段
文本
图像
物品
方块
点击区域
(渲染真实菜单)
──
属性
(选中元素后
编辑 YAML 参数)
| 区域 | 作用 |
|---|---|
| 顶栏 | 前后端标签页切换、撤销/重做/保存/应用、打开设置(含选框校准与界面缩放) |
| 工具 | 选择工具,以及创建各类节点的「工具」,点击后在菜单里落点创建 |
| 视口 | 真实菜单的 16:9 画布;选择、拖动、缩放的直接操作区 |
| 元素管理器 | 当前标签页的节点/命中区层级树;支持折叠、展开、拖拽改变层级、右键菜单 |
| 属性 | 选中元素后编辑其 YAML 参数(数值可横拖调节) |
| 模板 | 把单个组保存为可复用模板,或把模板拖回管理器创建副本 |
底部状态栏会显示当前元素数量、草稿状态(已同步 / 有未保存修改)、坐标与操作提示。
5. 编辑流程
- 进入会话:管理员执行
/auroraui edit <菜单ID>。 - 选择工具:左侧点选「选择」用于选取/拖动;点选「组 / 矩形 / 边框 / 线段 / 文本 / 图像 / 物品 / 方块」后在视口落点创建。切到「后端」标签页时用「点击区域」创建命中区。
- 选中元素:可在视口直接点选,也可在「元素管理器」层级树中点选;按住可在视口拖动改变位置。
- 改属性:在「属性」面板编辑字段。数值字段可横向拖动调节,单击可键入精确值。
- 层级与组合:在管理器里拖拽调整父子关系;Ctrl+G 把多选编为一组。
- 复用到模板:把某个组拖到「模板」区保存;需要时从模板区拖回管理器生成副本。
- 保存 / 应用:Ctrl+S 保存回磁盘;「应用」让改动立即生效到运行中的菜单。
6. 快捷键
修饰键统一为 Ctrl(Mac 上为 Cmd)。
| 快捷键 | 作用 |
|---|---|
| Ctrl+Z | 撤销 |
| Ctrl+Shift+Z / Ctrl+Y | 重做 |
| Ctrl+S | 保存菜单到磁盘 |
| Ctrl+A | 全选当前标签页元素 |
| Ctrl+C | 复制选中元素 |
| Ctrl+V | 粘贴;若已选中一个组,则粘贴进该组内(Ctrl+Shift+V 为粘贴到该组) |
| Ctrl+D | 创建选中元素的副本 |
| Ctrl+G | 把多个选中元素编为一组(前端) |
| F2 | 单选时聚焦「键名」输入框,快速重命名 |
| Delete | 删除选中元素 |
| Esc | 关闭右键菜单 / 取消模板命名 / 取消属性输入 |
| Enter | 提交属性输入 / 确认模板命名 |
7. 选框校准(开发者)
在顶栏点「设置」可打开选框校准设置。它用于修正编辑器里「蓝色选框」与元素实际绘制范围之间的偏差,属于开发者级参数:
- 每种元素类型共享一套参数,且不会写入菜单 YAML——它只影响编辑器里的显示与交互。
- 可调字段:选框偏移比例 X/Y、选框缩放 X/Y;点「恢复本类默认」可重置当前类型。
- 所属参数同时用于绘制、命中、拖动与交互区域,确保选中框和可点击范围一致。
- 结果保存在客户端的
auroraui-editor-selection-calibration.properties。
1 为原尺寸,且必须大于 0。8. 界面缩放
校准设置里还有 界面缩放(默认 100%),用于整体放大/缩小编辑器面板,方便在小屏或大屏上作业:
- 用
-/+步进调节,每次 ±5%; - 单击数值可恢复 100%;
- 该值会持久化到客户端偏好文件
auroraui-editor.properties。
9. 通信与协议
编辑器与服务端通过一个自定义频道收发二进制帧,不依赖第三方网络库:
| 项 | 值 |
|---|---|
| 频道 | auroraui:editor |
| 协议版本 | 8(EditorProtocol.VERSION) |
| 帧魔数 | ARCF(数据帧) |
| 单包上限 | 1 MiB;单帧数据 28 000 字节分片 |
客户端连接时发送 Hello(带客户端版本),随后接收服务端的快照(Snapshot),并把编辑操作(移动、缩放、切换标签、撤销/重做、保存、应用、增删改、编组、重排、改属性、模板等)以命令包发回。服务端会回 Ack 或 Error;校验失败会以错误状态显示在界面里。
服务端 /aurora status 可查看当前协议版本。
10. 常见问题
图标显示成「一整张图标图集」而不是小图标
这是图标采样区域(UV)计算错误导致的:绘制图标时,横向/纵向的 UV 坐标被传错了位置,
于是渲染器从图集里取了一大块错误区域,看起来就像把小图标放大成了「整张图集的一角」。
修复方式是把 UV 参数按正确顺序(u0, u1, v0, v1)传入,或改用支持「区域绘制」的贴图接口,
只裁剪出每个图标 16×16 的那一块。
调「界面缩放」只缩小了一部分,不像浏览器的 Ctrl+/Ctrl-
浏览器缩放是给整页套一个统一的坐标变换;而当前实现里,「界面缩放」只按比例调整了几个 停靠面板的宽高(工具、元素管理器、模板),顶栏、视口、文字和图标并没有一起缩放, 所以看起来「只有一部分变小了」。
要做到浏览器那种整体缩放,需要在渲染编辑器整体时对整个图层栈套用一次统一缩放
(先 push 全局矩阵 → scale → 正常绘制 → pop),
这样鼠标坐标再按同一系数换算回逻辑坐标即可,所有面板、文字与图标都会一起缩放。
其他
- 改了没生效?确认已 Ctrl+S 保存,或点「应用」让运行中的菜单立即刷新。
- 粘贴没反应?剪贴板只在同一菜单、同一标签页内共享。
- 拖不进某个组?不能把组拖入自身或自己的后代。
- 模板保存失败?只有单个组可以保存为模板。