由于一些开发者不知道如何去使用和编译Github上的源码示例,本篇将引导开发者去使用Github上的DEMO。这对于引擎初学者,快速了解引擎API与引擎示例效果会有着帮助。
一、克隆 LayaAir源码项目到本地
先安装好Git环境,不会的可以自行百度搜索一下,这里就不展开了。然后clone(克隆)LayaAir源码仓库到本地。
git clone https://github.com/layabox/LayaAir.git
二、通过npm安装LayaAiri源码环境依赖包
因为我们需要用到npm安装一些LayaAir引擎源码开发编译的依赖环境。
基础的Node环境npm,需要提前安装好。没安装好的,要看一下官网文档,进行安装:
https://ldc2.layabox.com/doc/?nav=zh-ts-1-0-0
当我们进入clone后的LayaAi源码本地根目录后,需要通过命令行环境来安装依赖包,操作如下图所示:
然后在命令行下,执行npm install
命令,如下图所示:
由于引擎根目录中有package.json文件,所以npm install
会自动执行安装package.json中指定的依赖包。
如上图所示,在安装的过程会有一个警告,那是安装依赖包所使用的第三方依赖,可以不用管。不影响使用。
三、引擎使用示例目录说明
引擎的源码目录可以用VSCode打开,示例目录位于 源码根目录/src/samples/
目录下,如下图所示。
在上图中,index.ts
是示例的入口文件,2d
与3d
目录分别对应着引擎的2D与3D示例。
由于引擎源码是TS语言的,所以示例也是基于TS源码的示例。如果想看AS3与JS示例,可以前往官网的开发者中心,查看线上示例。
示例的资源文件位于源码根目录/bin/res/
,如下图所示:
四、如何运行查看LayaAir引擎示例
为了验证我们的编译与项目环境没有问题,我们先把默认的示例给编译运行起来看一看。
由于引擎源码目录中,已经配置好gulp任务,可以直接在VSCode中通过 Ctrl + Shift + B
运行gulp任务(gulp:LayaAirBuild
),启动编译。如下图所示:
当然,我们也可以在VSCode中通过F5
或者Ctrl + F5
,自动启动gulp任务,进行代码的编译。
效果如下图所示: