Egret Engine 开源项目教程

1. 项目的目录结构及介绍

Egret Engine 项目的目录结构如下：

egret-core/
├── build/
├── docs/
├── src/
├── tools/
├── .gitignore
├── LICENSE.md
├── README.md
├── README_CN.md
├── package.json
├── package_en.json

目录结构介绍

• build/: 存放项目的构建文件和编译输出。
• docs/: 存放项目的文档文件，包括用户手册、API文档等。
• src/: 存放项目的源代码文件，包括核心引擎代码和示例代码。
• tools/: 存放项目相关的工具和脚本文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的英文介绍文件。
• README_CN.md: 项目的中文介绍文件。
• package.json: 项目的包管理文件，包含项目的依赖和脚本命令。
• package_en.json: 项目的英文包管理文件。

2. 项目的启动文件介绍

Egret Engine 项目的启动文件通常位于 src/ 目录下。默认情况下，项目的入口文件是 src/Main.ts。

启动文件介绍

• src/Main.ts: 这是 Egret Engine 项目的默认入口文件。在这个文件中，你可以定义游戏的初始场景、资源加载、事件处理等。

// src/Main.ts
class Main extends egret.DisplayObjectContainer {
    public constructor() {
        super();
        this.addEventListener(egret.Event.ADDED_TO_STAGE, this.onAddToStage, this);
    }

    private onAddToStage(event: egret.Event) {
        // 初始化游戏场景
        this.createGameScene();
    }

    private createGameScene(): void {
        // 创建游戏场景
        console.log("Hello World");
        var sky: egret.Bitmap = this.createBitmapByName("bgImage");
        this.addChild(sky);
        var stageW: number = this.stage.stageWidth;
        var stageH: number = this.stage.stageHeight;
        sky.width = stageW;
        sky.height = stageH;
    }

    private createBitmapByName(name: string): egret.Bitmap {
        var result = new egret.Bitmap();
        var texture: egret.Texture = RES.getRes(name);
        result.texture = texture;
        return result;
    }
}

window["Main"] = Main;
egret.runEgret();

3. 项目的配置文件介绍

Egret Engine 项目的配置文件主要包括 package.json 和 egretProperties.json。

配置文件介绍

• package.json: 这是 Node.js 项目的标准配置文件，包含了项目的元数据、依赖项和脚本命令。

{
  "name": "egret-core",
  "version": "1.0.0",
  "description": "Egret Engine Core",
  "main": "src/Main.ts",
  "scripts": {
    "build": "egret build",
    "start": "egret startserver"
  },
  "dependencies": {
    "egret": "^5.3.11"
  }
}

• egretProperties.json: 这是 Egret Engine 特有的配置文件，用于配置项目的路径、模块和其他属性。

{
  "engineVersion": "5.3.11",
  "compilerVersion": "5.3.11",
  "template": {},
  "target": {
    "current": "web"
  },
  "modules": [
    {
      "name": "egret"
    },
    {
      "name": "game"
    }
  ]
}

通过这些配置文件，你可以自定义项目的构建、运行和依赖管理。