Enari Engine 开源项目启动与配置教程

Enari Engine 开源项目启动与配置教程

enari-engine three.js FPS playground 项目地址: https://gitcode.com/gh_mirrors/en/enari-engine

1. 项目目录结构及介绍

Enari Engine 的项目目录结构如下所示：

enari-engine/
├── assets/                # 存放项目资源文件，如图片、音频、模型等
├── build/                 # 构建目录，用于存放编译后的文件
├── config/                # 配置文件目录
│   └── config.json        # 项目配置文件
├── docs/                  # 文档目录
├── include/               # 包含目录，存放头文件和库文件
│   └── ...
├── lib/                   # 存放项目依赖的第三方库
├── scripts/               # 脚本目录，包含构建、打包等脚本
├── src/                   # 源代码目录
│   ├── main.cpp           # 主函数文件
│   ├── ...
│   └── ...
└── tests/                 # 测试代码目录

• assets/: 存放所有的项目资源文件，如纹理、模型、音效等。
• build/: 构建目录，所有的编译输出文件都会放在这里。
• config/: 配置文件目录，包含项目所需的配置文件。
• docs/: 文档目录，存放项目相关的文档。
• include/: 包含目录，主要用于存放项目的头文件。
• lib/: 存放项目依赖的第三方库。
• scripts/: 脚本目录，包含构建、打包等自动化脚本。
• src/: 源代码目录，包含项目的所有源代码。
• tests/: 测试代码目录，用于存放单元测试和集成测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.cpp。这是程序的主入口点，它负责初始化引擎、加载资源、设置游戏循环以及处理用户输入等。

#include <enari_engine.h>

int main(int argc, char* argv[]) {
    // 初始化引擎
    EnariEngine engine;
    if (!engine.init()) {
        return -1;
    }

    // 加载资源
    if (!engine.loadResources()) {
        return -1;
    }

    // 主循环
    while (engine.run()) {
        // 更新游戏逻辑
    }

    // 关闭引擎
    engine.shutdown();
    return 0;
}

3. 项目的配置文件介绍

项目的配置文件位于 config/config.json，它是一个 JSON 格式的文件，包含了项目的各种设置，如窗口大小、渲染参数、资源路径等。

{
    "window": {
        "title": "Enari Engine",
        "width": 800,
        "height": 600
    },
    "render": {
        "clear_color": [0.2, 0.3, 0.4, 1.0]
    },
    "resources": {
        "path": "assets/"
    }
}

这个配置文件可以通过 config/ 目录下的 config.json 文件进行修改，以适应不同的项目需求。在程序启动时，引擎会读取这个配置文件并应用这些设置。

enari-engine three.js FPS playground 项目地址: https://gitcode.com/gh_mirrors/en/enari-engine