Skip to content

蛋仔开发助手

蛋仔开发助手是一个专注于蛋仔自定义脚本编辑的高效插件,提供实时文件同步功能、控制台调试,游戏对象快速查看, 数据导出,编辑器功能快捷入口等。

插件分为两部分:

  • PC编辑器端的 插件-》蛋仔开发助手
  • VSCode端的插件 蛋仔开发助手

一、PC编辑器端的插件:

1. 连接状态

  • 未连接: 表示当前未与VSCode插件端连接成功
  • 已连接:表示当前已与VSCode插件端连接成功
  • 正在连接:当前PC编辑器正在尝试与VSCode端插件进行连接
  • 连接错误: 与VSCode端插件连接失败, 可能原因,VSCode未打开Lua工程/端口已被占用,VSCode插件服务没有正常启动

2. 日志区域

  • 展示连接状态、文件修改同步日志

3. 生成工程

  • 生成地图初始的Lua工程文件
  • 自动检测用户本地是否有安装VSCode
  • 自动检测安装VSCode端蛋仔开发助手插件

4. 连接与断开

  • 支持自定义指定端口号(当默认端口已被占用且手动在VSCode插件设置里修改了服务端口号)

二、VSCode端的插件

vscode最低版本要求: 1.80.0

1. 游戏数据区

  • 展示PC编辑端的场景对象、UI对象、预设、存档、成就、属性、Lua给PC编辑端蛋码接口
  • 鼠标悬停数据项, 支持显示对象的ID、名称、类型、描述等信息
  • 支持鼠标右键复制ID、复制名称
  • 支持鼠标单击,快速定位(Focus)PC编辑端的场景对象和预设

2. 功能面板区

  • 支持调用PC编辑端的部分功能, 目前包括 运行游戏、停止游戏
  • 支持导出API, 以及地图相关数据,包括: UI节点,成就, 存档,预设编号,技能预设

3. 蛋仔控制台

  • 展示插件的连接状态、文件的修改同步记录, PC编辑器的部分关键事件信息, 包括, 地图保存,地图加载, 地图切换,地图运行,地图关闭等
  • 展示Lua脚本的输出日志
  • 支持Lua脚本编译错误展示
  • 支持Lua脚本的运行Trace展示, 支持文件单击跳转定位功能
  • 支持命令行执行Lua脚本的功能, 支持历史记录
  • 支持右键菜单, 包含 清楚控制台, 复制,粘贴等操作

4. 状态栏图标

  • 已断开(: 未与PC端插件连接成功
  • 已连接(: 与PC端插件成功连接
  • 服务启动失败(: 插件服务启动失败,一般是因为默认端口已被占用, 可以在工作区的插件设置里修改服务端端口号

5. 插件设置

如何插件服务启动失败,提示端口被占用,在插件设置里改成不冲突的端口号

三、使用指引

1. 启动蛋仔PC编辑器, 并新建空白工程

2. 使用蛋仔开发助手插件,生成VSCode Lua工程

2.1 生成成功,且插件已正常安装的情况

2.2 没有安装VSCode情况

需要玩家本地先安装好VSCode

2.3 自动安装VSCode端插件失败的情况

需要玩家手动安装安装下插件

2.4 本地已经有工程文件的情况

3. 连接VSCode插件

4. 修改文件,实时同步测试

Lua类型文件的修改,会实时同步到PC编辑器端

四. 手动在vscode中安装蛋仔开发助手插件

插件位于 Eggitor安装目录/Documents/res/luac/eggitor.vsix, 如果文件不存在,请先生成工程