Egret 学习之简介，环境搭建及命令行语法

Posted 2020-08-23 RitaLee

1，简介

1）egret是一个开源免费的游戏框架，它使用TypeScript脚本语言进行开发；当游戏完成最终的打包后，可以将程序转换为h5游戏，实现跨平台性；它基于BSD（Berkly Software Distribution 伯克利软件发行）协议；

2）它不仅是基于h5的游戏引擎，还提供了很多辅助游戏开发的工具。准确的来说egret是一套游戏开发的 解决方案。既可以使用该引擎开发h5游戏，并运行到手机和PC端的浏览器中，同时也可以使用egret来搭建游戏开发工作流；

2，安装过程：

到官网下载即可，有稳定版和开发版之分，下载最新的安装包即可；

3，安装之后可到命令行输入：egret info 查询安装的egret的版本信息；

4，相关的命令行：

egret command [-v];

1）create   创建新项目;  egret create project_name [--type empty|game|gui|eui]

关键字解析：

project_name :项目名称；

[--type empty|game|gui|eui]  :  项目类型，empty是空类型，可省略；game是游戏类型，默认就是game；

例：创建一个名字为HelloWorld的eui项目：

egret create HelloWorld --type eui   

创建名字为HelloWorld的空项目：

egret create HelloWorld  //此处省略空类型

2）create_lib  创建第三方库项目：

egret create_lib lib_name  

关键字：lib_name:第三方库名称，按操作系统的规范命名；

3）create_app  从h5游戏生成app

egret  create_app app_name -f h5_game_path -t template_path 

描述：构建指定项目，如果是在项目文件夹下编译，就不要加项目名称；

app_name ：移动应用项目的名称，命名按照操作系统的规范来写；

-f : app项目对应h5项目的路径；

-t ： 对应Native Support 路径；  //native support  指原生支持；

4）build  构建指定项目

描述：构建指定项目，如果是在项目文件夹下编译，就不加项目名称；

egret  build [project_name] [-e]  [--runtime native]

project_name :项目名称

-e：在编译指定项目的同时编译引擎；

--runtime ：如果有native工程，则会将文件拷贝到工程里（编译项目的同时编译native工程）

例：编译HelloWorld的同时编译引擎：

egret build HelloWorld -e

编译HelloWorld的同时编译native项目：

egret build HelloWorld --runtime native 

5）publish 发布项目：

描述：发布项目，如果是在项目文件夹下编译，就不要加项目名称；

egret publish  [project_name] [--version [vesion]] [--runtime html5|native] [--password]

关键字：

project_name :项目名称；

--version :设置发布后的版本豪，可以不设置；

--runtime：设置发布方式为html5或native （原生）  默认是html5；

--password：设置发布的zip文件的解压密码；

6）startserver  :启动HttpServer，并打开项目；

egret startserver [project_name] [--port 3000] [-ip] [-serveronly]

关键字：

project_name :项目名称；

--port ：指定端口号；

-ip：是否使用本机ip；

-serveronly：是否只运行服务器；

例：运行HelloWorld项目；

egret startserver HelloWorld --port 3000

7）clean 重置项目中的引擎代码；

egret clean [project_name]

描述：重置项目文件中的代码，如果是在项目文件夹下，就不加项目名称 ；

8）upgrade 升级项目代码 

egret upgrade [project_name]

描述：跟随egret引擎的升级，对项目进行升级，如果是在项目文件夹下，就不加项目名称；

9）make  编译引擎源码：

egret  make  

描述 ：修改引擎源码后，编译源码；

10）apitest : 版本升级后检测api是否替换完成；限于2.4之前版本升到2.5（及以上），需要在2.5（及以上）的版本中输入；

egret apitest [project_name]

描述：检测项目中api是否冲突；

例：检测HelloWorld项目中的api是否冲突；

egret apitest HelloWorld

11) info 获得egret信息（包括当前版本及安装路径）

egret info 

12）egret help ”command“ 了解各个command的细节；

例： egret help create   得到如下：