Axmol Engine 项目教程

Axmol Engine 项目教程

axmol 项目地址: https://gitcode.com/gh_mirrors/en/engine-x

1. 项目目录结构及介绍

Axmol Engine 是一个多平台游戏引擎，基于 Cocos2d-x v4.0 开发。以下是项目的主要目录结构及其介绍：

axmol/
├── 3rdparty/          # 第三方库
├── cmake/             # CMake 配置文件
├── core/              # 引擎核心代码
├── docs/              # 文档
├── extensions/        # 扩展功能
├── templates/         # 项目模板
├── tests/             # 测试代码
├── tools/             # 工具
├── clang-format       # 代码格式化配置
├── editorconfig       # 编辑器配置
├── gitattributes      # Git 属性配置
├── gitignore          # Git 忽略文件配置
├── AUTHORS.md         # 作者信息
├── CHANGELOG.md       # 更新日志
├── CMakeLists.txt     # CMake 主配置文件
├── CMakeOptions.md    # CMake 选项说明
├── CONTRIBUTING.md    # 贡献指南
├── LICENSE            # 许可证
├── README.md          # 项目介绍
├── README_CN.md       # 中文项目介绍
├── manifest.json      # 项目清单
└── setup.ps1          # 安装脚本

主要目录介绍

• 3rdparty/: 包含项目依赖的第三方库。
• cmake/: 包含 CMake 构建系统的配置文件。
• core/: 引擎的核心代码，包括渲染、输入、音频等模块。
• docs/: 项目文档，包括用户指南、API 文档等。
• extensions/: 扩展功能，如 FairyGUI、Spine 等。
• templates/: 项目模板，用于快速创建新项目。
• tests/: 测试代码，用于验证引擎功能的正确性。
• tools/: 开发工具，如代码格式化工具、构建工具等。

2. 项目启动文件介绍

Axmol Engine 的启动文件通常是 main.cpp，位于项目模板中的 src/ 目录下。以下是一个典型的启动文件示例：

#include "axmol.h"

int main(int argc, char** argv)
{
    ax::Director::getInstance()->init();
    auto scene = ax::Scene::create();
    ax::Director::getInstance()->runWithScene(scene);
    return ax::Application::getInstance()->run();
}

启动文件功能

• 初始化引擎: 通过 ax::Director::getInstance()->init() 初始化引擎。
• 创建场景: 使用 ax::Scene::create() 创建一个场景。
• 运行场景: 通过 ax::Director::getInstance()->runWithScene(scene) 运行场景。
• 运行应用: 最后调用 ax::Application::getInstance()->run() 启动应用。

3. 项目配置文件介绍

Axmol Engine 的配置文件主要包括 CMakeLists.txt 和 CMakeOptions.md。以下是这些文件的介绍：

CMakeLists.txt

CMakeLists.txt 是 CMake 构建系统的主配置文件，定义了项目的构建规则和依赖关系。以下是部分内容示例：

cmake_minimum_required(VERSION 3.14)
project(AxmolEngine)

set(CMAKE_CXX_STANDARD 17)

add_subdirectory(core)
add_subdirectory(extensions)
add_subdirectory(tests)

# 添加可执行文件
add_executable(MyGame src/main.cpp)
target_link_libraries(MyGame axmol)

CMakeOptions.md

CMakeOptions.md 文件详细介绍了 CMake 构建系统中可用的选项及其作用。以下是部分内容示例：

# CMake 选项

## AX_USE_ALSOFT
启用 OpenAL Soft 作为音频后端。

## AX_USE_METAL
启用 Metal 渲染后端。

## AX_USE_ANGLE
启用 Google ANGLE 作为 OpenGL 后端。

配置文件功能

• 定义构建规则: CMakeLists.txt 定义了项目的构建规则，包括源文件、依赖库等。
• 配置构建选项: CMakeOptions.md 提供了详细的构建选项说明，帮助开发者根据需求配置项目。

通过以上介绍，您可以更好地理解和使用 Axmol Engine 项目。

axmol 项目地址: https://gitcode.com/gh_mirrors/en/engine-x