2022-10-01 16:24:52 +08:00
# Axmol Game Engine
2021-12-28 21:50:41 +08:00
2022-10-01 16:24:52 +08:00
[](https://github.com/axmolengine/axmol/releases)
[](https://github.com/axmolengine/axmol/blob/master/LICENSE)
[](https://www.codacy.com/gh/axmolengine/axmol/dashboard?utm_source=github.com& utm_medium=referral& utm_content=axmolengine/axmol& utm_campaign=Badge_Grade)
[](https://github.com/axmolengine/axmol/pulls)
2020-11-15 17:56:03 +08:00
2022-10-01 16:24:52 +08:00
2022-03-24 22:17:41 +08:00
2022-10-01 16:24:52 +08:00
[](https://github.com/axmolengine/axmol/actions/workflows/windows-ci.yml)
[](https://github.com/axmolengine/axmol/actions?query=workflow%3Aandroid)
[](https://github.com/axmolengine/axmol/actions?query=workflow%3Aios)
[](https://github.com/axmolengine/axmol/actions?query=workflow%3Atvos)
[](https://github.com/axmolengine/axmol/actions?query=workflow%3Alinux)
[](https://github.com/axmolengine/axmol/actions?query=workflow%3Aosx)
2020-10-24 18:41:20 +08:00
2022-10-04 10:40:31 +08:00
**This is another more radical fork of *Cocos2d-x-4.0* , it has Full Support OpenAL for all platforms, single texture multi GPU texture handler, C++ 17/20 and more! (see 'Highlighted Features' for more info).**
2021-06-08 22:52:31 +08:00
2021-11-09 16:34:32 +08:00
### View code with vscode online:
2022-10-01 16:24:52 +08:00
- [](https://github1s.com/axmolengine/axmol)
- [](https://vscode.dev/github/axmolengine/axmol)
2021-11-09 16:34:32 +08:00
2019-11-25 10:23:47 +08:00
2020-08-03 19:17:26 +08:00
**[简体中文](README_CN.md)**
2020-11-19 13:48:12 +08:00
### Purpose Summary
2022-10-05 14:32:06 +08:00
* C++ 17/20
2022-02-10 03:17:40 +08:00
* Focuses on native game dev (easy to use, fast deployment, intuitive)
2020-08-18 17:30:56 +08:00
* Bugfixes ASAP
2022-08-14 11:19:56 +08:00
### Thirdparty
2022-10-01 16:24:52 +08:00
* All thirdparty prebuilt libs are built from https://github.com/axmolengine/buildware via github actions automatically.
2020-08-04 16:48:47 +08:00
2022-02-10 14:22:41 +08:00
### Highlighted Features
2022-08-14 11:19:56 +08:00
* Add apple M1, android x64 support, contributed by @pietpukkel
2022-10-01 16:24:52 +08:00
* Improve windows workflow, support linking with engine prebuilt libs, read [windows workflow guide ](https://github.com/axmolengine/axmol/issues/564 )
2022-02-24 20:34:24 +08:00
* Windows video player support (based on microsoft media foundation)
2021-08-27 12:27:45 +08:00
* Windows x64 build support
2022-02-10 03:15:53 +08:00
* Reimplement HttpClient based on yasio for concorrent http requests processing.
2022-10-27 16:09:15 +08:00
* ['Upstream-Version-License' ](thirdparty/README.md ) Third-party
2022-10-01 16:24:52 +08:00
* 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.
2022-10-27 16:09:15 +08:00
* ['Upstream-Version-License' ](extensions/README.md ) Extensions
* Extensions license overview for easier publishing of your commercial apps based on axmol framework.
* Spine-3.8 support
* ```FairyGUI``` support
* DragonBones support
* Live2D support
* **ImGui integrated, easy to write game embedded tools, very easy to use, read [ImGui ](extensions/ImGui/README.md ) for more info**
2020-08-15 18:17:03 +08:00
* Refactor AudioEngine, OpenAL for all platforms
2022-02-17 17:11:17 +08:00
* [OpenAL Soft ](https://github.com/kcat/openal-soft ), pass -DAX_USE_ALSOFT=ON to cmake to force enabling it
2022-09-05 14:13:52 +08:00
* [OpenAL.framework ](https://opensource.apple.com/tarballs/OpenAL ), if no ```AX_USE_ALSOFT``` option specified, cmake script will choose it on osx/ios/tvos, even though it was marked as deprecated, but still available.
2020-08-31 18:44:52 +08:00
* Refactor UserDefault with [mio ](https://github.com/mandreyel/mio )
2022-02-10 03:15:53 +08:00
* Modularize all optional extensions, move from engine core folder to an extensions folder
2020-11-26 14:27:47 +08:00
* Implement all .wav formats supported by ```OpenAL Soft```, such as MS-ADPCM, ADPCM, ...
2022-02-10 03:15:53 +08:00
* Use a modern GL loader ```Glad```
2020-11-19 13:48:12 +08:00
* Google [angle ](https://github.com/google/angle ) renderer backend support
2022-10-03 22:57:36 +08:00
* C++ 17/20
2022-09-05 14:13:52 +08:00
* IOS/TVOS SDK 9.0 as minimal deployment
2020-09-22 18:14:39 +08:00
* Use fast pugixml
2020-11-19 13:48:12 +08:00
* Use [curl ](https://github.com/curl/curl ) for transferring data with URL syntax
2022-02-10 03:15:53 +08:00
* Use SAX parser for all plist files
2022-02-10 13:55:35 +08:00
* 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)
2022-02-24 22:36:08 +08:00
* Supported 2D physics engines (see also [APPENDIX.md ](APPENDIX.md )):
2021-08-12 13:03:14 +08:00
* Box2D
2021-08-13 14:13:25 +08:00
* Box2D-optimized
2021-08-12 13:03:14 +08:00
* Chipmunk2D
2021-08-13 14:13:25 +08:00
* Supported 3D physics engines:
2021-08-12 17:24:22 +08:00
* Bullet Physics SDK
2019-11-25 10:22:58 +08:00
2022-02-24 17:57:08 +08:00
[Read Full changes since cocos2d-x-4.0 ](CHANGELOG )
2022-10-01 16:24:52 +08:00
Open [APPENDIX.md ](APPENDIX.md ) for additional information and see [Milestones ](https://github.com/axmolengine/axmol/milestones ) for planed features too.
2020-10-22 16:53:28 +08:00
2020-08-03 19:12:07 +08:00
### Quick Start
2020-11-19 13:48:12 +08:00
#### Common Requirement [Python](https://www.python.org/downloads/)
* Python-2.7.17+, Python-3.7+
2020-08-05 18:31:24 +08:00
2020-10-22 16:58:56 +08:00
#### Prerequisites
2022-10-01 16:24:52 +08:00
1. Enter ```axmol``` root directory
2022-02-10 03:19:59 +08:00
2. Run ```python setup.py```, restart the console after it has finished for environment variables to take effect
2020-10-22 16:58:56 +08:00
2021-11-23 20:16:36 +08:00
#### Windows (64/32 bit Visual Studio 2019/2022)
2022-10-11 10:40:39 +08:00
1. Install [CMake ](https://cmake.org/ ) 3.22.1+
2022-02-10 03:15:53 +08:00
2. Install Visual Studio 2019/2022 (it's recommended that you only use these versions)
3. Execute the following commands in a command line (Console, Window Terminal or Powershell)
2021-11-23 20:16:36 +08:00
2022-10-05 14:32:06 +08:00
```cd axmol ```
2022-10-06 03:16:33 +08:00
a) C++ 20:
2021-11-23 20:16:36 +08:00
- for 32 bit Visual Studio 2019:
```cmake -S . -B build -G "Visual Studio 16 2019" -A Win32```
- for 64 bit Visual Studio 2019:
```cmake -S . -B build -G "Visual Studio 16 2019" -A x64```
- for 32 bit Visual Studio 2022:
```cmake -S . -B build -G "Visual Studio 17 2022" -A Win32```
- for 64 bit Visual Studio 2022:
```cmake -S . -B build -G "Visual Studio 17 2022" -A x64```
2022-10-05 14:32:06 +08:00
2022-10-06 03:16:33 +08:00
b) C++17
- add ```-DCXX_STD=17``` for C++17 on your command line like:
cmake -S . -B build ```-DCXX_STD=17``` -G "Visual Studio 17 2022" -A x64
2021-11-23 20:16:36 +08:00
2022-10-05 16:24:16 +08:00
4. Build excecutable in a command line (e.g. cpp-tests):
2022-10-01 16:24:52 +08:00
```msbuild .\build\axmol.sln -target:cpp_tests -maxCpuCount```
2022-07-06 22:52:23 +08:00
2022-07-06 23:08:38 +08:00
#### Improve 'Visual Studio' workflow, support linking with engine prebuilt libs
2022-10-01 16:24:52 +08:00
See [windows workflow guide ](https://github.com/axmolengine/axmol/issues/564 )
2021-09-17 16:02:36 +08:00
2020-08-03 19:12:07 +08:00
#### Android
2022-08-06 19:29:04 +08:00
##### With Android Studio
2022-01-28 12:47:05 +08:00
1. Install Android Studio 2021.1.1+
2022-02-10 03:15:53 +08:00
2. When starting Android Studio for the first time, It will guide you to install the SDK and other tools, just install them
2022-10-01 16:24:52 +08:00
3. Start Android and choose [Open an existing Android Studio Project] and select ```axmol\tests\cpp-tests\proj.android```
2022-02-10 03:15:53 +08:00
4. Start Android Studio and Open [Tools][SDKManager], then switch to ```SDK Tools```, check the ```Show Package Details```, choose the following tools and click the button ```Apply``` to install them:
2022-08-06 19:47:45 +08:00
* Android SDK Platform 33
2022-08-06 20:05:12 +08:00
* Android Gradle Plugin (AGP) 7.2.2
2022-10-27 13:00:59 +08:00
* Android SDK Build-Tools 30.0.3 match with AGP, refer to: https://developer.android.com/studio/releases/gradle-plugin
2022-08-06 20:05:12 +08:00
* Gradle 7.4.2
2022-06-11 16:16:47 +08:00
* NDK r23c+
2022-08-06 19:47:45 +08:00
* CMake 3.22.1+
2022-02-10 03:15:53 +08:00
5. Wait for ```Gradle sync``` finish.
6. Note: If you use non-sdk provided CMake edition, you will need to download ```ninja``` from https://github.com/ninja-build/ninja/releases, and copy ```ninja.exe``` to cmake's bin directory
2022-08-06 19:29:04 +08:00
##### Without Android Studio
1. Download command-tools from https://developer.android.com/studio#command-tools
2. Install Android devtools (for example in windows)
```bat
# unzip command-tools at D:\dev\adt\
# Install android devtools
cd D:\dev\adt\
mkdir sdk
.\cmdline-tools\bin\sdkmanager.bat --verbose --sdk_root=D:\dev\adt\sdk "platform-tools" "cmdline-tools;latest" "platforms;android-33" "build-tools;30.0.3" "cmake;3.22.1" "ndk;23.2.8568313"
set ANDROID_HOME=D:\dev\adt\sdk
# Goto xxx\proj.android
.\gradlew.bat assembleRelease -PPROP_BUILD_TYPE=cmake -PPROP_APP_ABI=arm64-v8a --parallel --info
```
2020-02-04 21:42:43 +08:00
2022-09-05 14:13:52 +08:00
#### iOS, tvOS and macOS
2022-06-13 20:12:14 +08:00
1. Ensure xcode12+ & [cmake3.21+ ](https://github.com/Kitware/CMake/releases ) are installed, install cmake command line support: ```sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install```
2022-02-10 03:15:53 +08:00
2. Execute the following command
2020-02-08 21:55:36 +08:00
```sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer```
2020-12-03 12:45:06 +08:00
3. Generate xcode project
2022-08-18 09:13:09 +08:00
- for ios arm64:
2022-09-05 14:13:52 +08:00
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=$AX_ROOT/cmake/ios.toolchain.cmake -DPLATFORM=OS64```
- for ios armv7,arm64 combined:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=$AX_ROOT/cmake/ios.toolchain.cmake -DPLATFORM=OS```
2022-08-18 09:13:09 +08:00
- for ios simulator x86_64:
2022-09-05 14:13:52 +08:00
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=$AX_ROOT/cmake/ios.toolchain.cmake -DPLATFORM=SIMULATOR64```
- for tvos arm64:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=$AX_ROOT/cmake/ios.toolchain.cmake -DPLATFORM=TVOS```
- for tvos simulator x86_64:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=$AX_ROOT/cmake/ios.toolchain.cmake -DPLATFORM=SIMULATOR_TVOS```
2022-08-18 09:13:09 +08:00
- for macos x86_64(Intel)
2022-09-05 14:13:52 +08:00
```cmake -S . -B build -GXcode -DCMAKE_OSX_ARCHITECTURES=x86_64```
2022-08-18 09:13:09 +08:00
- for macos arm64(M1)
2022-09-05 14:13:52 +08:00
```cmake -S . -B build -GXcode -DCMAKE_OSX_ARCHITECTURES=arm64```
2020-08-24 16:26:12 +08:00
2022-02-10 03:15:53 +08:00
4. After cmake finishes generating, you can open the xcode project at ```build``` folder and run cpp-tests or other test targets.
2020-08-27 12:51:35 +08:00
5. Notes
2022-09-05 14:13:52 +08:00
- **The code signing is required to run the ios/tvos app on your device, just change the bundle identifier until the auto manage signing is solved**
2022-10-01 16:24:52 +08:00
- **axmol only provides armv7, arm64, x86_64 prebuilt libraries for ios/tvos**
2020-06-19 18:26:24 +08:00
2021-10-09 11:29:09 +08:00
### New Project
2022-10-01 16:24:52 +08:00
- Cpp: `axmol new -p org.axmol.hellocpp -d D:\dev\projects\ -l cpp --portrait HelloCpp`
- Lua: `axmol new -p org.axmol.hellolua -d D:\dev\projects\ -l lua --portrait HelloLua`
2021-10-09 11:29:09 +08:00
2022-10-01 16:24:52 +08:00
### Some interesting related projects based on axmol
2022-10-01 16:57:17 +08:00
https://github.com/axmolengine/axmol/discussions/694
2022-08-02 17:54:18 +08:00
2020-11-16 13:46:24 +08:00
### Notes
2020-11-19 13:48:12 +08:00
* ThreadLocalStorage (TLS)
2022-10-01 16:24:52 +08:00
- ios x86 simulator ios>=10 and axmol no longer provide x86 libraries
2020-11-19 13:48:12 +08:00
- ios x64 or devices (armv7, arm64) ios sdk>=9.0
2022-02-10 03:15:53 +08:00
- the 'OpenAL Soft' maintained by kcat uses TLS
2020-07-21 20:13:44 +08:00
2020-08-03 19:12:07 +08:00
### Reference links
2022-02-10 03:15:53 +08:00
* Official Cocos2d-x Repo: https://github.com/cocos2d/cocos2d-x
2021-05-26 14:46:15 +08:00
2021-08-27 15:47:40 +08:00
### Contributing guide
2022-10-01 16:24:52 +08:00
https://github.com/axmolengine/axmol/discussions/411
2021-08-27 15:47:40 +08:00
2022-10-01 16:24:52 +08:00
### The axmol Active Stats
2021-12-17 11:55:57 +08:00
2022-11-08 23:28:15 +08:00
