Axmol

Axmol is an MIT-licensed, cross-platform game engine for 2D and 3D games. Build with C++ or Lua for mobile, desktop, WebAssembly, and Xbox via UWP.

Try it online · Get started · Games made with Axmol · 简体中文

Try it online

Run the Axmol WebAssembly tests or the FairyGUI demo in your browser. Explore games and other projects made with Axmol.

Toward v3 beta1

Major feature development for v3 beta1 is largely complete on dev. Current work focuses on final cleanup and release preparation.

• Integrated: C++23, Box2D v3 and Jolt physics, Vulkan/D3D11/D3D12 rendering backends alongside Metal and GL, and high-DPI improvements for Windows, Linux, and WebAssembly.
• Experimental: optional VR/OpenXR support.

The following rendering backends are enabled by default on dev. A build can include multiple backends.

GL refers to OpenGL or OpenGL ES depending on the platform. WebAssembly uses WebGL. See rendering build options for configuration and the v3 roadmap for progress. These v3 capabilities do not describe the stable v2 release.

Choose a version

v3 beta1 is in preparation, and dev remains the v3 pre-release branch. The latest stable release is from v2 LTS. Contribution and branch rules are in CONTRIBUTING.md.

Get started

Install a C++23 compiler and PowerShell 7, then follow the setup and building guide for platform-specific prerequisites. To try v3 from the default dev branch:

git clone https://github.com/axmolengine/axmol.git
cd axmol
./setup.ps1

Restart your terminal after setup, return to the cloned Axmol directory, then create and build a C++ project:

axmol new -p dev.axmol.hellocpp -d ./projects -l cpp HelloCpp
cd ./projects/HelloCpp
axmol

Use -l lua to create a Lua project. For a production project on stable v2 LTS, clone release/2.x instead; it requires C++20. See the full guide for Windows setup, other targets, and troubleshooting.

What you can build

• Across platforms: iOS, Android, Windows, Linux, macOS, tvOS, WebAssembly, and Xbox through UWP.
• 2D and 3D: graphics and scene APIs, with Box2D v3 for 2D physics and Jolt for 3D physics on v3 dev.
• Extensions: FairyGUI, ImGui, Spine, Live2D, and Effekseer. See the extensions guide.

See the documentation, tutorials, and FAQ for details.

Background and migration

Axmol began in November 2019 as a fork of Cocos2d-x v4.0 and has continued to evolve with its contributors. If you have an existing Cocos2d-x project, see the migration guide and major changes from Cocos2d-x v4.0 to Axmol v3.

Community and support

Ask questions in GitHub Discussions, join Discord, or read the contribution guide and contributors list. If Axmol is useful to you, a GitHub star helps others discover it. You can also support development.

Corporate Diamond sponsor

Project activity

Explore awesome-cpp.