2020-08-04 14:53:59 +08:00
# EGNX
2020-02-23 22:31:31 +08:00
[](https://travis-ci.com/c4games/engine-x)
[](https://ci.appveyor.com/project/halx99/engine-x)
2019-11-25 17:06:24 +08:00
2020-08-20 09:11:08 +08:00
**This is another more radical fork of ```cocos2d-x v4```, use OpneAL for all platforms, single texture multi GPU texture handler, C++14/17 etc.**
2019-11-25 10:23:47 +08:00
2020-08-04 11:23:36 +08:00
**[简体中文](README_CN.md)**
2020-08-03 19:17:26 +08:00
2020-08-04 16:48:47 +08:00
### Purpose Summary:
* C++14/17
2020-08-20 09:11:08 +08:00
* Focus on native game dev only
* Bugfixes ASAP
* Review/Merge PR ASAP
* Excellent PRs from YOU are welcome, we will review & merge ASAP
2020-08-04 16:48:47 +08:00
### Highlight Features:
2020-08-15 18:17:03 +08:00
* Refactor AudioEngine, OpenAL for all platforms
2020-08-17 21:15:15 +08:00
* [openal-soft ](https://github.com/kcat/openal-soft ), pass -DBUILD_EXT_ALSOFT=ON to cmake to force enable it
2020-08-20 09:11:08 +08:00
* [OpenAL.framework ](https://opensource.apple.com/tarballs/OpenAL ), if no ```BUILD_EXT_ALSOFT``` option specified, cmake script will choose it on osx/ios, even through it was mark as deprecated, but still available.
2020-08-04 16:48:47 +08:00
* Refactor UserDefault with [mio ](https://github.com/mandreyel/mio ), very fast
* Modularize all optional extension, all move from engine core to folder extensions
* Implement all .wav formats supported by ```openal-soft```, such as MS-ADPCM, ADPCM...
* Use modern gl loader ```glad``` to instead glew
* Add google angle renderer backend support
* Set default C++ standard to 14
* Set min deploy target ios sdk to 9.0
* Remove tinyxml2, use more fast pugixml instead
2020-08-20 09:11:08 +08:00
* Use curl for HttpClient downloader on all platforms
2020-08-04 16:48:47 +08:00
* Use SAX parser for all plist file, remove apple platform spec for getValueMapFromFile stubs
2020-08-05 18:45:21 +08:00
* Spine-3.8 support
* Add engine extension ```FairyGUI``` support
2019-11-25 10:22:58 +08:00
2020-08-04 11:23:36 +08:00
### [Roadmap](https://github.com/c4games/engine-x/issues/1)
2020-08-03 20:31:47 +08:00
2020-08-04 11:23:36 +08:00
### Quick Start
2020-08-05 18:31:24 +08:00
#### Common Requirement [python](https://www.python.org/downloads/)
* python-2.7.17+, python-3.7+ also works
2020-08-04 11:23:36 +08:00
#### Windows
1. Install [CMake ](https://cmake.org/ ) 3.6+
2020-08-20 09:11:08 +08:00
2. Install Visual Studio 2019 build(we strong recommend you install this version)
2020-08-04 11:23:36 +08:00
3. Execute follow command at command line(Console, Window Terminal or Powershell)
```bat
cd engine-x\
cmake -S . -B build -G "Visual Studio 16 2019" -A Win32
```
2019-11-25 10:22:58 +08:00
2020-02-07 17:17:50 +08:00
2020-08-04 11:23:36 +08:00
#### Android
2020-08-17 19:09:54 +08:00
1. Install Android Studio 4.0+
2020-08-06 15:45:59 +08:00
2. When first start Android Studio, It will guide you to install sdk and other tools, just install them
3. Start Android and choose [Open an existing Android Studio Project] to open ```engine-x\tests\cpp-tests\proj.android```
4. Start Android Studio and Open [Tools][SDKManager], then switch to ```SDK Tools```, check the ```Show Package Details```, choose follow tools and click the button ```Apply``` to install them:
2020-08-10 15:04:12 +08:00
* Android SDK Platform 28 r3
2020-08-17 19:09:54 +08:00
* Android SDK Build-Tools 29.0.2
2020-08-09 22:41:06 +08:00
* NDK r16b+
2020-08-10 15:04:12 +08:00
* CMake 3.6
2020-08-06 15:45:59 +08:00
5. Waiting for ```Gradle sync``` finish.
2020-05-06 15:43:55 +08:00
2020-08-20 09:11:08 +08:00
6. Remark: If you use non-sdk provided CMake edition, you need download ```ninja``` from https://github.com/ninja-build/ninja/releases, and copy ```ninja.exe``` to cmake's bin directory
2020-02-07 17:17:50 +08:00
2020-08-04 11:23:36 +08:00
#### iOS
1. Ensure xcode11+ installed
2. Install brew: ```/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"```
when finish, install follow tools:
2020-02-12 16:58:47 +08:00
```sh
2020-08-04 11:23:36 +08:00
brew update
brew install git
brew install cmake
brew install autoconf
brew install automake
brew install libtool
2020-02-12 16:58:47 +08:00
```
2020-08-04 11:23:36 +08:00
3. Execute follow command
2020-02-12 16:58:47 +08:00
```sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer```
2020-08-04 11:23:36 +08:00
4. Generate xcode project
2020-02-12 16:58:47 +08:00
```sh
2020-08-04 11:23:36 +08:00
mkdir engine-x/build
cd engine-x/build
2020-02-12 16:58:47 +08:00
cmake .. -GXcode -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator
2020-07-21 23:06:01 +08:00
# for simulator64
2020-08-18 13:06:30 +08:00
# cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../cmake/ios.toolchain.cmake -DPLATFORM=SIMULATOR64 -DENABLE_ARC=0
2020-07-21 23:06:01 +08:00
# for (armv7, armv7s, arm64)
2020-08-18 13:06:30 +08:00
# cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../cmake/ios.toolchain.cmake -DPLATFORM=OS -DENABLE_ARC=0
2020-07-21 23:06:01 +08:00
# for device 64
2020-08-18 13:06:30 +08:00
# cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../cmake/ios.toolchain.cmake -DPLATFORM=OS64 -DENABLE_ARC=0
2020-02-12 16:58:47 +08:00
```
2020-08-04 11:23:36 +08:00
5. After cmake generate finish, you can open xcode project at ```build``` folder and run cpp-tests or other test targets.
2020-06-19 18:26:24 +08:00
2020-08-04 11:23:36 +08:00
### Pitfalls
* ThreadLocalStorage(TLS)
- ios x86 simulator ios>=10
- ios x64 or devices(armv7,arm64) ios sdk>=9.0
- the openal-soft maintained by kcat use TLS
2020-07-21 23:06:01 +08:00
2020-08-04 11:23:36 +08:00
### Reference links
* engine-x-3rd: https://github.com/c4games/engine-x-3rd
* official v4: https://github.com/cocos2d/cocos2d-x
