2021-05-19 08:15:21 +08:00
# adxe
2021-12-28 21:50:41 +08:00
2021-12-28 21:28:04 +08:00
[](https://github.com/adxeproject/adxe/releases)
2021-05-18 16:51:46 +08:00
[](https://github.com/adxeproject/adxe/blob/master/LICENSE)
2021-12-28 21:50:41 +08:00
[](https://app.codacy.com/gh/adxeproject/adxe?utm_source=github.com& utm_medium=referral& utm_content=adxeproject/adxe& utm_campaign=Badge_Grade_Settings)
2021-12-28 21:32:25 +08:00
[](https://github.com/adxeproject/adxe/pulls)
2020-11-15 17:56:03 +08:00
2021-08-27 13:27:04 +08:00
[](https://github.com/adxeproject/adxe/actions/workflows/windows-ci.yml)
2021-05-18 16:51:46 +08:00
[](https://github.com/adxeproject/adxe/actions?query=workflow%3Aandroid)
[](https://github.com/adxeproject/adxe/actions?query=workflow%3Aios)
[](https://github.com/adxeproject/adxe/actions?query=workflow%3Alinux)
[](https://github.com/adxeproject/adxe/actions?query=workflow%3Aosx)
2020-10-24 18:41:20 +08:00
2022-02-10 03:17:40 +08:00
**This is another more radical fork of *Cocos2d-x-4.0* , it uses OpenAL for all platforms, single texture multi GPU texture handler, C++ 17 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:
- [](https://github1s.com/adxeproject/adxe)
2022-01-27 18:23:44 +08:00
- [](https://vscode.dev/github/adxeproject/adxe)
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
2021-12-28 21:32:25 +08:00
* C++ 17
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
2020-08-04 16:48:47 +08:00
2020-11-19 13:48:12 +08:00
### Highlight Features
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.
* **More clearer third-party libs ['Upstream-Version-License' ](thirdparty/README.md ) for easier publishing of your commercial apps based on adxe. Also some links to third party libs which support adxe too.**
2020-08-15 18:17:03 +08:00
* Refactor AudioEngine, OpenAL for all platforms
2022-02-10 03:15:53 +08:00
* [OpenAL Soft ](https://github.com/kcat/openal-soft ), pass -DBUILD_DEP_ALSOFT=ON to cmake to force enabling it
* [OpenAL.framework ](https://opensource.apple.com/tarballs/OpenAL ), if no ```BUILD_DEP_ALSOFT``` option specified, cmake script will choose it on osx/ios, 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
2021-12-28 21:28:04 +08:00
* C++ 17 standard
2020-08-24 15:09:02 +08:00
* IOS 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
2020-08-05 18:45:21 +08:00
* Spine-3.8 support
2020-11-19 13:48:12 +08:00
* Extension ```FairyGUI``` support
2022-02-10 03:15:53 +08:00
* ASTC 4x4/6x6/8x8 support (if hardware decoding is not present, software decoding will be used instead)
* ETC2 RGB/RGBA support (if hardware decoding is not present, software decoding will be used instead)
2021-11-23 20:16:36 +08:00
* Supported 2D physics engines (see also [Wiki ](https://github.com/adxeproject/adxe-wiki )):
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
2022-02-10 03:15:53 +08:00
* **ImGui 1.87 integrated, easy to write game embedded tools, very easy to use, read [ImGuiEXT ](extensions/ImGuiEXT/README.md ) for more info**
2019-11-25 10:22:58 +08:00
2022-02-10 03:15:53 +08:00
Open [Wiki ](https://github.com/adxeproject/adxe-wiki ) for additional information and see [Milestones ](https://github.com/adxeproject/adxe/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
2021-05-18 16:51:46 +08:00
1. Enter ```adxe``` 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)
2020-10-22 11:35:52 +08:00
1. Install [CMake ](https://cmake.org/ ) 3.14+
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
```cd adxe ```
- 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-02-10 03:15:53 +08:00
Build excecutable in a command line (e.g. cpp-tests):
2021-11-23 20:16:36 +08:00
```msbuild .\build\adxe.sln -target:cpp-tests -maxCpuCount```
2021-09-17 16:02:36 +08:00
2020-08-03 19:12:07 +08:00
#### Android
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
3. Start Android and choose [Open an existing Android Studio Project] and select ```adxe\tests\cpp-tests\proj.android```
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:
2020-10-25 19:12:13 +08:00
* Android SDK Platform 29 r5
2020-08-17 19:09:54 +08:00
* Android SDK Build-Tools 29.0.2
2021-04-28 17:59:39 +08:00
* NDK r19c+
2020-10-25 19:12:13 +08:00
* CMake 3.10+
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
2020-02-04 21:42:43 +08:00
2020-08-03 19:12:07 +08:00
#### iOS
2022-02-10 03:15:53 +08:00
1. Ensure xcode11+ & [cmake3.21+ ](https://github.com/Kitware/CMake/releases ) are installed, install cmake command line support: ```sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install```
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
- for any device
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake```
- for arm64:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake -DCMAKE_OSX_ARCHITECTURES=arm64```
2021-06-08 21:53:18 +08:00
- for armv7,arm64 combined:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake "-DCMAKE_OSX_ARCHITECTURES=armv7;arm64"```
2020-12-03 12:45:06 +08:00
- for simulator x86_64:
2021-06-08 21:53:18 +08:00
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake -DCMAKE_OSX_ARCHITECTURES=x86_64```
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-02-10 03:15:53 +08:00
- **The code signing is required to run the ios app on your device, just change the bundle identifier until the auto manage signing is solved**
- **adxe only provides armv7, arm64, x86_64 prebuilt libraries for ios**
2020-06-19 18:26:24 +08:00
2021-10-09 11:29:09 +08:00
### New Project
2021-11-29 22:04:31 +08:00
- Cpp: `adxe new -p org.adxe.hellocpp -d D:\dev\projects\ -l cpp --portrait HelloCpp`
- Lua: `adxe new -p org.adxe.hellolua -d D:\dev\projects\ -l lua --portrait HelloLua`
2021-10-09 11:29:09 +08:00
2020-11-16 13:46:24 +08:00
### Notes
2020-11-19 13:48:12 +08:00
* ThreadLocalStorage (TLS)
2021-05-18 16:51:46 +08:00
- ios x86 simulator ios>=10 and adxe 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
https://github.com/adxeproject/adxe/discussions/411
2021-05-26 14:46:15 +08:00
### The adxe Active Contributors
- @halx99
- @rh101
- @aismann
- @weiwest
2021-12-17 11:55:57 +08:00
2022-01-27 18:23:44 +08:00
2022-02-10 03:15:53 +08:00
### Full changes since cocos2d-x-4.0
2021-12-17 11:55:57 +08:00
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] Improve spine RTTI compare performance when compiler string pooling is enabled
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] Implement Windows WebView using WebView2 Edge Chromium, thanks to @rh101
- [HIGHLIGHT] Windows x64 build support
- [HIGHLIGHT] Support custom texture atlas formats, thanks to @rh101
- [HIGHLIGHT] Downloader realtime md5 checksum calculation support
- [HIGHLIGHT] Decompress astc parallel support
- [HIGHLIGHT] Reimplement HttpClient based on yasio for concurrent http request support
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] Improve Lua RTTI performance and increase memory efficiency
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] Virtual File System support, thanks to @rh101
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] Refactor lua loader, gain 30%+ speed
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] Update plainlua version to 5.4.3
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] Use Openal-Soft for all platforms
- [HIGHLIGHT] Refactor UserDefault with mio, gain 100x+ speed
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] Implement all .wav formats supported by Openal-Soft, such as MS-ADPCM, ADPCM
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] Use a modern GL loader Glad
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] Google angle renderer backend support
- [HIGHLIGHT] Update codebase to C++ 17 standard
- [HIGHLIGHT] Remove tinyxml2
- [HIGHLIGHT] Use fast pugixml
- [HIGHLIGHT] Spine-3.6~4.0 support
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] ASTC 4x4/6x6/8x8 support (if hardware decoding is not present, software decoding will be used instead)
- [HIGHLIGHT] ETC2 RGB/RGBA support (if hardware decoding is not present, software decoding will be used instead)
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] ImGui integrated for PC platforms
- [HIGHLIGHT] Extension FairyGUI support
- [HIGHLIGHT] Use curl for transferring data with URL syntax
2022-02-10 03:15:53 +08:00
- [HIGHLIGHT] Modularize all optional extension, move from engine core folder to an extensions folder
- [HIGHLIGHT] Improve thirdparty library building, 99% of builds are from sources or github actions with latest toolchain, see also: `adxeproject/buildware`
- [HIGHLIGHT] Added a new API `Director::setChildrenIndexerEnabled` for speeding up getChildByTag & getChildByName support
- [HIGHLIGHT] Added a new API `FontFreeType::setStreamParsingEnabled` for stream parsing support, it's very useful for reducing memory cost when loading a large .ttf font file
2021-12-17 11:55:57 +08:00
- [HIGHLIGHT] Remove all unnecessary `std::nothrow` stubs
2022-01-05 14:50:39 +08:00
- [HIGHLIGHT] Use c++17 string_view instead `const std::string&`
2022-02-10 03:15:53 +08:00
- [NEW] Added int64_t/uint64_t support for `cocos2d::Value`
- [Fix] Fixed Label overflow shrink bug
- [FIX] Fixed uniform location mismatch when having more than 1 spine with different shaders
- [FIX] Fixed imgui draw frame cause afterimage when game scene nothing to draw
- [FIX] Set global Z value of label debug layer to be the same as the parent label to fix display issues
- [FIX] Using TTF scaled metrics to calculate line height, thanks to @rh101
- [FIX] Fixed Memory leak in ShaderModuleGL::getErrorLog(), thanks to @Xrysnow
- [FIX] Fixed console output text encoding for win32
- [FIX] Fixed charset processing for fontName on win32
- [FIX] Fixed A crash on ParticleBatchNode::updateProgramStateTexture()
- [FIX] Fixed A crash on SpriteBatchNode::appendChild when CC_SPRITE_DEBUG_DRAW==1
- [FIX] Fixed A bug where Lua can't get `unsigned char` or `unsigned int` values of a `ValueMap`
- [FIX] Fixed A crash on AudioEngine::end after the `Director` has been destroyed
- [FIX] Fixed font atlas memory leaking when it doesn't exist in the atlas cache, thanks to @rh101
- [FIX] Fixed A bug where ScrollView randomly shows in an incorrect position vertically, thanks to @wzhengsen
- [FIX] Fixed Spine ClippingAttachment not working
2021-12-17 11:55:57 +08:00
- [REFINE] CCValue move construct and assign with std::string support
2022-02-10 03:15:53 +08:00
- [REFINE] Improve windows dev workflow, use working directory instead of copying resources to build binary directory manually
2021-12-17 11:55:57 +08:00
- [REFINE] Add lua debug project file to lua project template
- [REFINE] Remove lua 64bit spec search path, since we can compile compatible bytecode for both plainlua and luajit
2022-02-10 03:15:53 +08:00
- [REFINE] Put stats labels to a safe origin to make sure we can see it integral at some mobile device
2021-12-17 11:55:57 +08:00
- [REFINE] Improve cmake scripts
- [REFINE] Replace deprecated repo `jcenter` with `mavenCentral`
- [REFINE] Lua-5.4 compatible
- [REFINE] Improve cmdline-tools
2022-02-10 03:15:53 +08:00
- [REFINE] Ensure label underline node has the same global Z value as the label node to fix visibility issues when global Z value is not 0
2021-12-17 11:55:57 +08:00
- [REFINE] Improve android astc support check
- [REFINE] Improve the "Physics part" (#379), thanks to @aismann
2022-02-10 03:15:53 +08:00
- [REFINE] Rename command line to `adxe`
2021-12-17 11:55:57 +08:00
- [REFINE] Update imgui to 1.84 WIP
- [REFINE] Rename thirdparty folder `external` to `thirdparty`
2022-02-10 03:15:53 +08:00
- [REFINE] Force building plainlua as dll on windows for the debugger, better for debuging apps quickly
- [REFINE] Fix some audio test cases where sound can't be heard
2021-12-17 11:55:57 +08:00
- [REFINE] Avoid OS_WINDOWS conflict with system macro
- [REFINE] Update OpenSSL to v3.0.1
- [REFINE] Update FreeType to latest
2022-02-10 03:15:53 +08:00
- [REFINE] Use Freetype SDF rendering when label distance field is enabled
- [REFINE] Force enable string pooling for msvc on cmake
2021-12-17 11:55:57 +08:00
- [REFINE] Change DrawNode api color parameters from `Color4F` to low `Color4B`
2022-02-10 03:15:53 +08:00
- [REFINE] Improve DrawNode GC allocations
- [REFINE] Use `jni.hpp` to improve jni calls without method signature GC allocations
