第一次运行egret项目
Egret Engine文档地址:https://docs.egret.com/engine/docs/installation/installation
1、引擎安装
-
windows系统下:下载地址 https://docs.egret.com/engine
-
通过 Launcher 安装引擎和工具
打开 EgretLauncher ,选择“引擎”,如下图。
选择“工具”,可下载和安装开发工具
-
- Egret Wing 代码和界面制作工具
- DragonBones 龙骨动画制作工具
- TextureMerger 图片资源合并工具
- Res Depot 资源管理工具
- Egret Feather 粒子制作工具
2、项目构建
1、安装编译器
- 安装 Egret Launcher 1.2.0 或更高版本
- 点击【工具】选项卡,下载【EgretCompiler】
- 确定
scripts/plugins/webpack-plugin.ts
中采用了快速安装
require('./npm').installFromLauncher(['@egret/egret-webpack-bundler']); // require('./npm').installDependencies(["@egret/egret-webpack-bundler"]);
- 执行 egret build 命令,构建脚本会自动在 scripts/plugins/node_modules 中创建相关软连接
3、命令行手册
-
create--创建新项目
用法:egret create project_name [--type core|eui]
参数说明:举例:
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名 --type
要创建的项目类型 core 或 eui,默认值为core 1、创建名为【HelloWorld】的一个空项目 egret create HelloWorld 2、创建名为【HelloWorld】的一个eui项目 egret create HelloWorld --type eui
-
create_lib--创建新第三方库项目
用法:egret create_lib lib_name
参数说明:
关键字 描述 lib_name
第三方库名称,按照操作系统的命名规范命名
-
build--构建指定项目
用法:egret build [project_name] [--target wxgame|bricks|ios|android]
参数说明:
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名 --target
编译的目标版本,可选参数有 wxgame
:微信小游戏;bricks
:玩一玩;android
:安卓项目;iOS
:iOS项目如果是在项目文件夹下执行命令,可以不加项目名称
举例:
1、编译【HelloWorld】 egret build HelloWorld 2、编译【HelloWorld】的同时编译引擎 egret build HelloWorld -e 3、编译【HelloWorld】的同时编译微信小游戏项目 egret build HelloWorld --target wxgame
-
publish--发布项目
用法:egret publish [project_name] [--version [version]] [--target wxgame|bricks|ios|android]
参数说明:
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名 --version
设置发布之后的版本号,可以不设置 --target
编译的目标版本,可选参数有 wxgame
:微信小游戏;bricks
:玩一玩;android
:安卓项目;iOS
:iOS项目如果是在项目文件夹下执行命令,可以不加项目名称
举例:
发布【HelloWorld】到微信小游戏 egret publish HelloWorld --version 0.03 --target wxgame
-
run--启动本地服务器,并在默认浏览器中运行指定项目
用法:egret run [project_name] [--port 3000]
参数说明:
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名 --port
指定端口号 如果是在项目文件夹下执行命令,可以不加项目名称
举例:
在指定端口下运行【HelloWorld】项目 egret startserver HelloWorld --port 3002
-
clean--重置项目中的引擎代码
用法:egret clean [project_name]
参数说明:如果是在项目文件夹下执行命令,可以不加项目名称
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名
-
upgrade--升级项目代码
Egret Launcher v1.0 之后的 upgrade
用法:egret upgrade [project_name] --egretversion [target version]
参数说明:
如果是在项目文件夹下执行命令,可以不加项目名称
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名 target version
要切换的目标版本号
举例:
升级当前目录下项目到 5.1.0 egret upgrade --egretversion 5.1.0
Egret Launcher v1.0之前的 upgrade
用法:egret upgrade [project_name]
参数说明:
关键字 描述 project_name
项目名称,按照操作系统的命名规范命名 如果是在项目文件夹下执行命令,可以不加项目名称
举例:
升级【HelloWorld】项目 egret upgrade HelloWorld
关于 Egret Launcher v1.0 中项目降版本的说明
1. 修改项目根目录下的配置文件 'egretProperties.json' 中的 'egret_version' 字段下的版本号 2. 执行 egret clean 后项目降到目标版本
-
make--修改引擎源码后,编译引擎源码。如果没有特殊需求,不建议普通用户使用
用法:egret make
-
info--获得Egret信息,如当前Egret版本,以及安装路径
用法:egret info
-
help--了解各个 command 的细节
用法:egret help [command]