Egret02-项目配置介绍

最新推荐文章于 2024-10-25 14:42:45 发布

芒种的农民

最新推荐文章于 2024-10-25 14:42:45 发布

阅读量1.2k

点赞数

CC 4.0 BY-SA版权

分类专栏： Egret开发教程文章标签： Egret egretProperties tsconfig 微信小游戏 TypeSctipt

本文链接：https://blog.youkuaiyun.com/weixin_44588191/article/details/102893788

Egret开发教程专栏收录该内容

7 篇文章

订阅专栏

本文深入解析Egret引擎的项目配置，包括index文件、template模板、egretProperties项目文件及tsconfig配置文件的关键参数，助你掌握Egret项目定制与优化。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

上一篇文章，我们简单介绍了Egret的项目目录结构，这篇文章详细讲解常用配置文件的参数作用。

一、index文件配置

index.html文件是项目的入口，div内是项目的默认配置，我们可以根据需要做修改。

  <div style="margin: auto;width: 100%;height: 100%;" class="egret-player"
         data-entry-class="Main"
         data-orientation="auto"
         data-scale-mode="showAll"
         data-frame-rate="30"
         data-content-width="640"
         data-content-height="1136"
         data-multi-fingered="2"
         data-show-fps="false" data-show-log="false"
         data-show-fps-style="x:0,y:0,size:12,textColor:0xffffff,bgAlpha:0.9">
    </div>

每个配置参数的作用如下：

data-entry-class=”Main”：文件类名称，表示项目的入口类，默认为Main,如果需要自定义的话需要在项目中先创建类，然后在这里配置类的名字。Main和index不一样，前者是游戏正常开始的入口函数，后者是项目初始化配置的入口文件。
data-orientation=”auto” ：旋转模式，可以理解是横竖屏自动适配。
data-scale-mode=“showAll”：缩放模式。
data-frame-rate=“30”：运行的帧率。
data-content-width=“640”：游戏场景的宽度。
data-content-height=“1136”：游戏场景的宽度。
data-multi-fingered=“2”：多指最大数量，也就是最多能接收多少个手指的触摸信号。
data-show-fps=“false”：是否显示 fps 帧频信息，仅调试时设置true，发布一律设置为false.
data-show-log=“false”：是否显示日志，发布时设置为false.
data-show-fps-style：fps面板的样式。支持5种属性，也就是面板的位置（x，y）、大小（size）、文字颜色（textColor）、背景面板的透明度（bgAlpha）。

二、template模板配置

1、runtime

runtime目录下的配置文件用于发布原生项目时使用，可参考官方文档“如何发布原生项目”：
http://developer.egret.com/cn/github/egret-docs/Native/native/projectsetting/index.html

2、web

发布HTML5项目时，如果配置了egretProperties.json文件的template属性，就会使用 template/web/index.html 来作为入口文件。
在这里插入图片描述

三、egretProperties项目文件配置

项目根目录下的egretProperties.json是引擎的核心配置文件，主要涉及以下5个参数：

1、engineVersion

定义当前项目的游戏版本号。

2、compilerVersion

项目使用的编译命令（build、publish等）版本号。

3、template

可以留空，如果填写该字段，则发布H5项目时，就会使用template/web/index.html 来作为项目的入口文件。

4、target

指定build编译、publish发布时指定的项目类型，支持以下5种：

web： Html5 项目
wxgame：微信小游戏项目
bricks：QQ 玩一玩项目
android：安卓项目
iOS：iOS 项目

5、modules

可以添加项目中需要引用的库文件，name是库名称，path是库文件路径，如果路径为空，则默认使用${EGRET_DEFAULT}值，比如下图的5个内置类库（egret、eui、assetsmanager、tween、promise）默认路径就是libs/modules下，Egret现有的内置类库如下：

egret：引擎核心库
egret3d： 引擎 3D 库
assetsmanager ：资源管理模块
dragonBones ：龙骨
eui UI： 组件库
game ：游戏库
media ：多媒体库
socket websocket： 网络通讯库
tween ：缓动动画库

在这里插入图片描述

四、tsconfig 配置文件

tsconfig是Egret是项目默认创建的关于Typescript语言项目配置文件，编译器在编译代码之前，先读取这个配置的属性来设置编译参数。
1、首先，compilerOptions 字段涉及以下四个参数：

target:编译之后生成的JavaScript文件需要遵循的标准，默认为 es5，兼容性比较好，不建议修改
outDir:编译出来的js文件，放到哪个目录下，默认编译到 bin-debug 里，目前暂不支持修改
experimentalDecorators:启用实验性质的语法装饰器，引擎里的部分库使用了最新的语法，需要开启这个配置
lib: 编译需要的库文件，默认有3个，你可以根据需求自行添加

2、include 表示哪些文件会参与编译（4.x 之前的版本里，使用的是 exclude 排除方式）