Axmol Engine – A Multi-platform Engine for Desktop, XBOX (UWP) and Mobile games. (A radical fork of Cocos2d-x-4.0)
Go to file
halx99 01d223a5c9 Update ChangeLog 2024-07-13 01:51:41 +08:00
.github Update llvm setup 2024-06-10 00:42:21 +08:00
1k 1k: parse generater from cmake options 2024-06-14 09:00:20 +08:00
3rdparty Update plainlua to 5.4.7 2024-07-12 23:58:07 +08:00
cmake Fix #1943, Make extension luabinding can be controlled by AX_EXT_HINT 2024-07-08 23:17:25 +08:00
core Remove redundant log message 2024-07-12 23:57:14 +08:00
docs Update DevSetup.md (#1965) 2024-06-05 20:25:34 +08:00
extensions Committing luabindings for commit fe0adcb (#2026) 2024-07-12 00:24:04 +08:00
templates Update TLD to axmol.dev in sources (#1977) 2024-06-10 02:25:43 +08:00
tests (Spelling) rename getSubtitleLable(), add setSubtitleLabel() (#2025) 2024-07-11 23:29:08 +08:00
tools Rename all AXLOG/printf to AXLOGD (without .\core, .\3rdparty) (#2020) 2024-07-11 23:28:31 +08:00
.clang-format Tidy platform macros/consts value 2023-09-11 19:37:49 +08:00
.editorconfig Add apple tvos support (#846) 2022-09-05 14:13:52 +08:00
.gitattributes Improve make-pkg.ps1 2023-12-27 23:29:38 +08:00
.gitignore Add unit tests (#1862) 2024-04-30 20:52:28 +08:00
AUTHORS.md Prepare release 2.1.3 2024-03-26 00:08:53 +08:00
CHANGELOG.md Update ChangeLog 2024-07-13 01:51:41 +08:00
CMakeLists.txt Update TLD to axmol.dev in sources (#1977) 2024-06-10 02:25:43 +08:00
CMakeOptions.md Update emsdk to 3.1.61 and add cmake option AX_WASM_INITIAL_MEMORY 2024-06-12 23:13:49 +08:00
CONTRIBUTING.md Some additions and corrections for readme files. (#1682) 2024-02-14 15:39:24 +08:00
LICENSE Prepare 2.1.0 release 2023-12-08 01:04:43 +08:00
README.md Update readme badges 2024-05-24 01:38:28 +08:00
README_CN.md Fix emsdk 3.1.60 compile errors 2024-05-24 04:17:04 +08:00
manifest.json Update oboe to 1.9.0 2024-07-03 00:07:42 +08:00
setup.ps1 Linux WebView implementation (#1985) 2024-06-13 22:49:59 +08:00

README.md

axmol logo

Axmol Engine

A Multi-platform Engine for Mobile, Desktop and Xbox.

Axmol Engine is an open-source, C++ multi-platform engine designed for mobile devices, desktop, and Xbox, well-suited for 2D game development. It was launched in November 2019 as a fork of Cocos2d-x v4.0.

Please visit our Wiki to know more about Axmol.


Build Status

Latest Release LICENSE Codacy Badge cxxstd

issues forks stars GitHub code size in bytes

PRs Welcome Discord awesome-cpp ossinsight

Chinese ver. / 简体中文


Building

If you have a Cocos2d-x project, migrating to Axmol Engine is easy. We have prepared a Migration Guide.

Learning and docs

General information

Axmol Engine has iterated and improved over the Cocos2d-x v4.0 base. Now is faster and more capable, while staying lightweight. Check a comparative here.

Supported platforms:

  • Mobile: iOS, Android
  • Desktop: Windows, Linux, macOS, tvOS
  • Console: Xbox (Universal Windows Platform)
  • Web: WebAssembly (Preview: Axmol tests / FairyGUI tests)

Languages:

  • C++
  • Lua

Renderer backends:

  • Metal for macOS, iOS and tvOS
  • OpenGL 3.3+ for Linux, macOS and Win32
  • OpenGL ES 2.0+ for Android
  • OpenGL ES 3.0+ for iOS and tvOS
  • ANGLE GLES 3.0+ for Win32 and UWP
  • WebGL 2.0 (OpenGL ES 3.0): WASM

Architectures:

  • iOS/tvOS (x64, arm64)
  • Android (x86, x64, armv7, arm64)
  • Windows (x86, x64)
  • Linux (x64)
  • OSX (x64, arm64)
  • UWP (x64, arm64)
  • Wasm32

Supported 2D physics engines (more info here):

  • Box2D
  • Chipmunk2D

Supported 3D physics engines:

  • Bullet Physics SDK

Included extensions:

More extensions created by our community

Features

Some highlights:

  • New MediaPlayer: render video as texture2D using MediaEngine. More info in our Wiki.
  • Windows video player support (based on Microsoft Media Foundation)
  • WebAssembly support (by @nowasm) - Preview: Axmol tests
  • Universal Windows Platform (UWP) support for Xbox consoles
  • Apple M1 and Android x64 support (by @pietpukkel)
  • Windows x64 build support
  • Improved Windows workflow, supporting linking with engine prebuilt libs. Please read the Windows workflow guide.
  • Refactored AudioEngine, OpenAL for all platforms:
    • OpenAL Soft (pass -DAX_USE_ALSOFT=ON to CMake to force enabling it)
    • OpenAL.framework (if no AX_USE_ALSOFT option specified, cmake script will choose it on OSX/iOS/tvOS, even though it was marked as deprecated is still available)
  • Implemented all .wav formats supported by OpenAL Soft (MS-ADPCM, ADPCM, etc.)
  • Refactored UserDefault with mio
  • Upstream Version License - Third-party:
    • Third-party license overview, for easier publishing of your commercial apps based on Axmol framework.
    • Some links to third party libs which support axmol too.
  • Upstream Version License - Extensions:
    • Extensions license overview, for easier publishing of your commercial apps based on Axmol framework.
  • Reimplemented HttpClient based on yasio for concurrent http requests processing.
  • Modularized all optional extensions, move from engine core folder to an extensions folder.
  • Use Google Angle as default renderer backend on Windows.
  • Using GL loader Glad.
  • Using pugixml
  • Using curl for transferring data with URL syntax
  • Using SAX parser for .plist files
  • ASTC 4x4 / 6x6 / 8x8 support (if hardware decoding is not supported, then software decoding is used)
  • ETC2 RGB / RGBA support (if hardware decoding is not supported, then software decoding is used)

Please read the full list of changes since Cocos2d-x v4.0.

See the Milestones for planned features.

Contributions

How to contribute:

  • Suggestions, bug fixes, and improvements are highly appreciated!
  • Please do not forget to add the topic axmol and axmolengine to any related repository you create!
  • Adding a star on GitHub will help Axmol grow as well. Thank you!

If you find Axmol Engine helpful, please consider donating in Open Collective or in GitHub Sponsors. Thank you very much!

Community

Our community is growing! Please join us at:

In order to see some of our community works, please check our Axmol Showcase: Made in Axmol

Axmol Stats

Alt