Skip to content
| Marketplace
Sign in
Visual Studio Code>Debuggers>Egret HelperNew to Visual Studio Code? Get it now.
Egret Helper

Egret Helper

zt5

|
4,907 installs
| (1) | Free
egret工具 支持调试,编译,管理资源,发布,创建
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

egret 工具

建议和bug反馈

特性

  • 支持在编辑器中开启Egret服务器
  • 支持在编辑器中重新编译
  • 支持Egret调试(支持Egret自带编译和最新的Webpack编译)
  • 支持ts代码中的 非空字符.skinName 路径快速跳转和补全
  • 支持将 扩展设置 egret-helper.egretResourcePath 目录的资源文件同步到 egret-helper.egretResourceJsonPath json中
  • 如果安装了 Egret UI Editor 按下快捷键(默认 Alt+F1 )会自动打开当前ts绑定的exml(Mac平台需要手动安装shell命令,打开Egret UI Editor 菜单栏:文件->安装 shell 命令)
  • 支持在编辑器调用 Egret Launcher 的发布和创建页面

如何使用

  • 安装 Chrome 或 Microsoft Edge 浏览器
  • 更多功能 点击 vscode左下角的状态栏插件图标 ,选择对应操作即可即可

扩展设置

属性名 类型 枚举值 默认 说明
enable boolean true,false true 是否启用插件
devlog boolean true,false false 是否打印详细日志
egretResourceJsonPath string - resource/default.res.json Egret资源配置的路径(相对于项目根目录)
egretResourcePath string - resource Egret资源的路径(相对于项目根目录)
alertErrorWin boolean true,false false 是否在碰到错误时弹出错误提示框
openEgretServer enum auto,alert auto 打开项目时怎么开启Egret服务器 (注¹)
resMap object array - vscode设置中查看 同步Egret资源映射 (注²)
resMapIgnore string array - vscode设置中查看 同步Egret忽略资源 (注³)
hostType enum 127.0.0.1,ip 127.0.0.1 Egret服务器http地址的格式 (注⁴)
debugBrowser enum chrome,edge chrome 调试使用的浏览器
port number - 7000 Egret服务器首选端口 (注⁵)
egretCompileType enum auto auto,legacy,webpack Egret编译方式 (注⁶)

注释

注¹

auto:打开Egret项目时,自动开启Egret服务器
alert:打开Egret项目时,弹框询问是否开启Egret服务器


注²

例如{".png":{tail:"_png",type:"image"}}
.png:代表文件扩展名(必须小写)
_png:扩展名尾巴(Egret资源的名字xxx_xx_png)
image:default.res.json 中资源的type属性定义


注³

可以是文件名 xx.png(不区分大小写)
路径的末尾 tmp/xx.png(不区分大小写)
某一类文件 .png(不区分大小写)


注⁴

ip:Egret服务器使用 ip:端口号 例如(http://192.168.1.1:8000/index.html) 注意使用这种方式 .vscode/launch.json 里的ip容易频繁变动
127.0.0.1:强制Egret服务器使用 127.0.0.1:端口号 例如(http://127.0.0.1:8000/index.html)


注⁵

Egret服务器使用端口 如果被占用默认寻找可用端口


注⁶

auto自动判断Egret的编译方式,如果有问题 可以手动选择正确方式(legacy或webpack)
legacy传统的编译方式,适用版本在5.3.6以下(非绝对,要看项目脚本中是否使用了WebpackBundlePlugin)
webpack最新的编译方式,适用版本在5.3.6和5.3.6以上(非绝对,要看项目脚本中是否使用了WebpackBundlePlugin),自动修改scripts/config.ts中的build命令配置,默认调试资源输出目录bin-debug(目前没有什么好办法动态读取,因为白鹭在scripts/config.ts中以outputDir变量配置,太灵活)

扩展命令

  • egret-helper.goToExml: 使用Egret UI Editor打开 快捷键默认 Alt + F1
  • egret-helper.egretBuildAndDebug: 重新编译项目并调试 快捷键默认 Ctrl + F5
  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft