egret-resource-manager/README.md

# Egret 资源管理框架


## 核心功能

#### 友好的资源加载 API

* 遵循 ES6 Promise 标准的异步语法
``` javascript
RES.loadConfig().then(()=>{
    RES.getResAsync("assets/bg.jpg");
}).then(()=>{
    RES.getResAsync("assets/icon.jpg");
});
```
* 即将支持 ES2015 async / await 异步语法
``` javascript
await RES.loadConfig()
await RES.getResAsync("assets/bg.jpg");
await RES.getResAsync("assets/icon.jpg");
```

#### 版本控制支持

集成版本控制功能，无需额外配置即可支持素材热更新。可以帮助您的游戏或应用显著降低运维成本及用户的流量消耗。

#### 针对不同平台发布不同的资源



#### 更容易开发者进行扩展的结构
#### 80% 兼容旧版 API 
除了 ```RES.Analyzer```相关 API 之外其他所有API均可向下兼容，并提供升级脚本帮助您将现有项目升级至新版本资源管理器
## 当前状态 - Release Candidate

资源管理模块目前作为白鹭引擎的全新特性，本次开放发布希望获得开发者的广泛反馈意见，目前暂时不建议开发者用于正式项目中。具体时间表如下：

* 10月17日 Public Beta 1 ，第一次公开发布，收集开发者反馈
* 10月24日 Public Beta 2 ，完善功能，修复开发者反馈的 BUG，开发者可以将此版本用于两个月内会发布的商业项目中
* 10月31日 Public Beta 3 ，完善功能，与白鹭引擎的工具链完成集成
* 11月14日 Release Candidate , 候选发布版，这个版本全部功能已稳定，开发者可以将此版本用于一个月内会发布的商业项目中
* 11月下旬 Final ，正式版本，开发者可以将其使用于新产品或者线上已有产品（大型重度产品有可能需要白鹭引擎团队的配合技术支持）


## 运行测试项目

执行 ```egret run test/es6-api``` 或者 ``` egret run test/classic-api ``` 

## 如何调试

* 安装 Egret Wing 或者 VSCode ，打开项目根目录
* 在项目根目录下执行 npm install
* 调试项目（F5)，或执行 ``` npm run debug ```

## 如何使用

* 在命令行中执行 ``` npm install egret-resource-manager -g ``` 安装命令行工具

* 执行 egret upgrade { your-project } 将旧版 res 模块升级为新版本，升级过程会完成下述操作
    
    * 将 ```egret-resource-manager``` 中包含的新版本资源管理系统的源代码复制到项目文件夹的 bin 目录下
    
    * 将 ```egretProperties.json``` 中的 ```res``` 字段修改为 ```resourcemanager```

* 当游戏资源发生变化后，执行```res build { your_project }```，更新资源配置