# Axmol
## 一个适用于桌面、XBOX (UWP)、WebAssembly 和移动游戏的多平台引擎。
[Axmol](https://axmol.dev) 是一款开源的 C++ 多平台引擎,专为移动设备、桌面和 Xbox 设计,非常适合 2D 游戏开发。它于 2019 年 11 月推出,是 Cocos2d-x v4.0 的分支。
请 [访问我们的 Wiki](https://github.com/axmolengine/axmol/wiki) 了解更多关于 Axmol 的信息。
***
***
## 分支
> **重要通知**
> - **`dev` 分支**：作为 **v3** 开发分支，正在积极开发中，可能包含不稳定或实验性的功能。对于新功能、增强或错误修复（除非对 v2 LTS 至关重要），应将 PR 提交到此分支 **作为主要目标**。
> - **`release/2.x` 分支**：已进入 **稳定维护阶段**（2.11.x 将是最终的 v2 LTS 版本）。此分支仅用于修复关键错误和安全补丁，以确保生产稳定性。
> 如果您希望为 v3 开发做出贡献，测试新功能或提交非关键的错误修复，请使用 `dev` 分支。对于生产部署，请继续使用 `release/2.x` 分支，以保持稳定性和兼容性。
> ⚠️ **请勿将适用于全文 `clang-format` 或大规模重新格式化更改的 PR 提交到 `release/2.x` 分支。**
> 此类更改会显著增加合并冲突，使代码审查变得不必要地困难，从而耗费额外时间。此外，针对 `release/2.x` 的非关键功能/增强 PR 将不会被接受，因为其处于 LTS 维护状态。
> 违反这些规则的任何 PR **都不会被接受**。
***
## ⚡️建筑
如果您有 Cocos2d-x 项目,迁移到 Axmol 非常容易。我们已经准备了 [迁移指南](https://github.com/axmolengine/axmol/wiki/Cocos2d%E2%80%90x-migration-guide)。
## 学习和文档
* [文档](https://axmol.dev/manual/latest/)
* [Axmol Wiki](https://github.com/axmolengine/axmol/wiki)
* [教程页面](https://github.com/axmolengine)
[Chinese ver. / 简体中文](README_CN.md)
[Setup & Building Guide](docs/DevSetup.md)