项目配置文件

时间：2021-09-29 20:02:55

整体结构

项目配置文件

字段描述

egret_version 字段

项目当前的使用的 egret 命令行的版本。

在白鹭引擎 4.1 版之前，egret 命令行版本与 egret 的内置类库版本是统一的，从 4.1 版本开始，这两者的概念进行了分离，这意味着开发者可以使用 4.1 版的命令行，但是继续使用老版本的内置类库。

白鹭引擎的设计目标是，所有的开发者均使用命令行的最新版本，而内置类库则使用开发者认为最稳定的版本。更多详情，请参加下一小节 modules
字段

modules 字段

定义项目中引用的所有库文件。每一个库都是形如 {
"name":"moduleName" , "path":"modulePath"} 这样的配置信息。

在白鹭引擎4.1版本之前，白鹭引擎内置库不包含 path 字段，从白鹭引擎4.1版本开始，包括引擎内置库在内的所有库均包含path字段，如果没有此字段，编译器内部会为其添加一个名为${EGRET_DEFAULT}的默认值。

4.1 版本的白鹭引擎引入了模块化更新机制，这使得开发者可以更*的升级引擎的特定模块，而非每次升级就会更新项目中的全部引擎内置库。如下所示：

 

    

  1. {
    2.  
 
  2.  "egret_version":"4.1.0",
    3.  
 
  3.  "modules":[
    4.  
 
  4.  {
    5.  
 
  5.  "name":"egret",
    6.  
 
  6.  "path":"${EGRET_DEFAULT}"
    7.  
 
  7.  },
    8.  
 
  8.  {
    9.  
 
  9.  "name":"tween",
    10.  
 
  10.  "path":"${EGRET_APP_DATA}/4.0.3"
    11.  
 
  11.  }
    12.  
 
  12.  ]
    13.  
 
  13. }
    14.  



白鹭引擎4.1版本引入了两个环境变量
 

    

  • 
EGRET_DEFAULT，表示当前引擎的路径，即执行 egret info命令后输出的路径。
    •  
 
  • 
EGRET_APP_DATA，表示引擎启动器中的缓存文件夹中的路径，引擎的历史版本会储存在此处。
    •  



在上述配置文件中，引擎的 egret模块会使用 egret_version中配置的版本所对应的路径，tween模块会使用引擎启动器中下载的 4.0.3 版本所对应的路径。通过这种方式，开发者可以选择性的升级引擎的特定模块，而非一次性全部升级，从而降低因为版本升级带来的稳定性隐患。
 

每个模块的 path 字段所对应的路径可能在项目中，也可能在项目外。



    

  • 如果在项目中，项目运行就会直接加载此路径所对应的库。
    •  
 
  • 如果在项目外，引擎编译时会首先将此路径所对应的库拷贝至项目中的 libs/modules 文件夹中，然后加载该文件夹中的库。
    •  



修改该配置中的内容后，需要执行 egret
 clean 命令进行一次重新构建以保证改动生效
 


publish 字段
 

发布项目所需要的一些配置文件。
 

    

  • path。发布文件所在的目录，默认创建的为 “bin-release”。 通过 egret
     publish [projectName] [--runtime native] [--version yourVersion]     发布后的文件所在的目录。其中，不加 --runtime native 即发布 web 项目，文件会被发布在 path/web/版本号下，不加 --version yourVersion，即会生成一个当前时间点的文件夹，分别为 年后2位+月2位+日2位+时2位+分2位+秒2位。 Native 发布和 Web 类似。
    •  



    

  • web。发布 Web 项目资源文件发布的方式。0，按照原素材路径名称发布；1，会将资源发布成以 crc32 命名方式重新命名。默认为 0。
    •  




项目配置文件
 

    

  • native。发布 Native 项目资源文件发布的方式。0，按照原素材路径名称发布；1，会将资源发布成以 crc32 命名方式重新命名。默认为 1。
    •  



项目配置文件
 

目前 Egret 提供的 RES 模块中，支持发布方式为 web = 0、native= 1，如果大家需要自定义版本控制，请修改对应的发布方式。
 


native 字段
 

native 相关配置，只对 native 项目有用，在发布 Web 项目时，不会使用此字段相关参数。
 

    

  • path_ignore。拷贝项目素材到发布目录时所需要忽略的列表，这个里面的字符串会当做一个正则表达式，如果 “anim.*ons”。
    •  



项目配置文件
项目配置文件
 

 

    

  1.  每个字符串都是一个正则表达式，并非简单的一个文件（夹）名。这样大家可以根据自己的需求，去写对应的正则表达式。
    2.  



    

  • android_path（可省字段）。创建的android工程的目录，这个是在创建android项目时自动创建的。
    •  
 
  • ios_path（可省字段）。创建的ios工程的目录，这个是在创建ios项目时自动创建的。
    •  





web 字段
 

web 相关配置，只对 web 项目有用，在发布 Native 项目时，不会使用此字段相关参数。
 

    

  • path_ignore。(4.0.0 以上支持)拷贝项目素材到发布目录时所需要忽略的列表
    •  




urlParams 字段 (3.1.6 以上支持)
 

    

  • 

    针对egret
     run    命令添加URL参数，比如执行egret run后打开的地址：
    

    http://10.0.4.63:3001/index.html?okok=12&id=455464564
    

    •  

标签：
相关文章