Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
axmol/README_CN.md

105 lines
5.3 KiB
Markdown
Raw Normal View History

Lock name
2020-10-24 21:57:36 +08:00
# Engine-x
Add license badge
2020-11-15 17:56:03 +08:00
[![dev](https://img.shields.io/badge/v1.0.0-alpha19-yellow.svg)](https://github.com/c4games/engine-x/releases)
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/c4games/engine-x/blob/master/LICENSE)
Lock name
2020-10-24 21:57:36 +08:00
[![Android Build Status](https://github.com/c4games/engine-x/workflows/android/badge.svg)](https://github.com/c4games/engine-x/actions?query=workflow%3Aandroid)
[![iOS Build Status](https://github.com/c4games/engine-x/workflows/ios/badge.svg)](https://github.com/c4games/engine-x/actions?query=workflow%3Aios)
[![Windows Build Status](https://github.com/c4games/engine-x/workflows/win32/badge.svg)](https://github.com/c4games/engine-x/actions?query=workflow%3Awin32)
[![Linux Build Status](https://github.com/c4games/engine-x/workflows/linux/badge.svg)](https://github.com/c4games/engine-x/actions?query=workflow%3Alinux)
[![macOS Build Status](https://github.com/c4games/engine-x/workflows/osx/badge.svg)](https://github.com/c4games/engine-x/actions?query=workflow%3Aosx)
Migrate to github ci (#247)
2020-10-24 18:41:20 +08:00
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
Sync rename engine
2020-10-22 10:23:41 +08:00
**这是另外一个基于 *Cocos2d-x-4.0* 持续维护的分支, 全平台基于OpenAL, c++14/17...**
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
**[English](README.md)**
Updat readme [skip travis][skip appveyor]
2020-08-04 16:48:47 +08:00
### 宗旨:
* C++14/17
fix typo [skip appveyor][skip travis]
2020-10-22 15:35:02 +08:00
* Focus on native game dev only
Updat readme [skip travis][skip appveyor]
2020-08-04 16:48:47 +08:00
* Fix bugs ASAP
* Review PR ASAP
Refine readme [skip travis][skip appveyor]
2020-08-04 17:31:54 +08:00
* Excellent PRs from any guys are welcome, we will review & merge ASAP
Updat readme [skip travis][skip appveyor]
2020-08-04 16:48:47 +08:00
### 主要特性:
Update README
2020-08-15 18:17:03 +08:00
* 重构AudioEngine, 全平台OpenAL
fix typo [skip appveyor] [skip travis]
2020-08-17 21:16:27 +08:00
* [openal-soft](https://github.com/kcat/openal-soft), pass -DBUILD_EXT_ALSOFT=ON to cmake to force enable it
* [OpenAL.framework](https://opensource.apple.com/tarballs/OpenAL), if no and ```BUILD_EXT_ALSOFT``` option specified, cmake script will choose it on osx/ios, even through it was mark as deprecated, but still avaiable.
Updat readme [skip travis][skip appveyor]
2020-08-04 16:48:47 +08:00
* 重构UserDefault, 全平台基于内存映射文件 [mio](https://github.com/mandreyel/mio), 性能提升百倍
* 模块化所有引擎扩展库, 所有扩展库放到extensions目录下，如cocostudio, spine
* AudioEngine实现wav所有 ```openal-soft``` 支持的封装格式, 例如MS-ADPCM, ADPCM等
* 使用现代化的GL加载器glad代替glew
* 增加google angle渲染后端支持
* 设置默认C++标准为C++14
* 设置ios下最低目标平台为ios9.0
* 使用更快的xml解析库pugixml代替tinyxml2
* HttpClient, Downloader全平台统一实现，均基于curl
* 全平台统一使用XML SAX解析plist文件, 移除Apple平台的实现
Update features [skip appveyor] [skip travis]
2020-08-05 18:11:52 +08:00
* Spine 3.8支持
Update readme [skip appveyor][skip travis]
2020-08-05 18:45:21 +08:00
* 新增FairyGUI支持
Update readme files [skip appveyor][skip travis]
2020-09-08 15:53:56 +08:00
* 新增硬件压缩纹理格式ASTC 4x4/6x6/8x8支持，支持软解
Improve images decoder
2020-08-31 21:04:47 +08:00
* 新增硬件压缩纹理格式ETC2 RGB/RGBA支持，支持软解
fix typo [skip appveyor][skip travis]
2020-09-08 15:55:16 +08:00
* **ImGui集成，非常方便写游戏内嵌小工具，用法详见[ImGuiEXT](extensions/ImGuiEXT/README.md)**
Updat readme [skip travis][skip appveyor]
2020-08-04 16:48:47 +08:00
Lock name
2020-10-24 21:57:36 +08:00
### [Roadmap](https://github.com/c4games/engine-x/issues/1)
Updat readme [skip travis][skip appveyor]
2020-08-04 16:48:47 +08:00
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
### 快速开始
python3 also works for CMake build system
2020-08-05 18:31:24 +08:00
#### 必要工具 [python](https://www.python.org/downloads/)
* python-2.7.17+, python-3.7+都可以
Update readme [skip appveyor][skip travis]
2020-10-22 16:58:56 +08:00
#### 准备步骤
Lock name
2020-10-24 21:57:36 +08:00
1. 进入引擎```engine-x```根目录
Make setup.py works with python3
2020-10-22 16:53:28 +08:00
3. 执行```python setup.py```后重启控制台
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
#### Windows
Update cmake require version to 3.14 for vs2019 [skip appveyor][skip travis]
2020-10-22 11:35:52 +08:00
1. 安装CMake，要求3.14以上
Merge: 2aa2d69151 b7506fed0c Merge branch 'vfs-support' of https://github.com/rh101/engine-x into vfs-support
2021-04-22 22:01:47 +08:00
2. 确保 Visual Studio 2019 已正确安装
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
3. 执行下面的命令
```bat
Lock name
2020-10-24 21:57:36 +08:00
cd engine-x
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
cmake -S . -B build -G "Visual Studio 16 2019" -A Win32
```
Lock name
2020-10-24 21:57:36 +08:00
4. 之后就可以用vs打开```engine-x/build/engine-x.sln```启动cpp-tests等测试工程了
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
#### Android
Update README files [skip appveyor] [skip travis]
2020-08-17 19:09:54 +08:00
1. 安装 Android Studio 4.0或更高版本
Refine Android build guide
2020-08-06 15:45:59 +08:00
2. 第一次启动Android Studio, 会引导安装一些工具，默认安装即可，如果不需要模拟器可以把```Virutal Device```勾选去掉
Lock name
2020-10-24 21:57:36 +08:00
2. 启动 Android Studio并打开engine-x\tests\cpp-tests\proj.android
Sets Gradle Plugin version to 3.4.0 to fix cmake can't recognize ninja
2020-08-10 15:04:12 +08:00
3. 通过 [Tools][SdkManagers] 打开sdk管理工具，选择如下SDK Platforms和SDK Tools后， 点击按钮 ```Apply``` 一路跟着引导安装即可:
Update cmake minimal requirement version [skip ci]
2020-10-25 19:12:13 +08:00
* Android SDK Platform 29 r5 (在SDK Platforms页签)
Update README files [skip appveyor] [skip travis]
2020-08-17 19:09:54 +08:00
* Android SDK Build-Tools 29.0.2
Disable double use in chipmunk_types.h instead CMakeLists.txt more stable for ENGX
2020-08-09 22:41:06 +08:00
* NDK r16b+
Update cmake minimal requirement version [skip ci]
2020-10-25 19:12:13 +08:00
* CMake 3.10+
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
Refine Android build guide
2020-08-06 15:45:59 +08:00
5. 等待Gradle sync完成后，Build APKs，安装运行
Fix README_CN.md markdown format [skip travis][skip appveyor]
2020-08-10 16:12:35 +08:00
6. 如果使用非sdk自动安装的CMake版本, 需要从https://github.com/ninja-build/ninja/releases下载 ```ninja```， 并且拷贝```ninja.exe```到CMake的bin目录
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
#### iOS
Update cmake minimal requirement version [skip ci]
2020-10-25 19:12:13 +08:00
1. 确保已安装xcode11+和[cmake3.14+](https://github.com/Kitware/CMake/releases), 安装CMake命令行支持: ```sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install```
Refine readme, remove unnecessary step for ios build guide
2020-08-27 12:51:35 +08:00
2. 执行如下命令确保cmake能成功生成xcode工程:
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
```sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer```
Merge: 2aa2d69151 b7506fed0c Merge branch 'vfs-support' of https://github.com/rh101/engine-x into vfs-support
2021-04-22 22:01:47 +08:00
3. 生成xcode工程, 进入engine-x根目录执行如下命令之一:
- 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```
- for simulator x86_64:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64```
Improve ios CMake scripts
2020-08-24 16:26:12 +08:00
Refine readme, remove unnecessary step for ios build guide
2020-08-27 12:51:35 +08:00
4. 之后就可以用xcode打开, 选择cpp-tests编译运行
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
### 注意
* ThreadLocalStorage线程本地存储
Since we don't support ios x86 simulator yet, set ios default min deployment target to 9.0 is ok
2020-11-16 13:46:24 +08:00
- ios x86 simulator ios>=10 and engine-x no longer provide x86 libraries
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
- ios x64 or devices(armv7,arm64) ios sdk>=9.0
- the openal-soft maintained by kcat use TLS
### QQ交流群
Lock name
2020-10-24 21:57:36 +08:00
点击链接加入群聊【engine-x交流群】：https://jq.qq.com/?_wv=1027&k=nvNmzOIY
Merge: 7b034c4d5f 88d6c48d98 Merge pull request #138 from halx99/moduls Modularize all optional extensions
2020-08-04 11:23:36 +08:00
### 参考链接
Update README_CN.md
2020-08-30 00:28:20 +08:00
* official v4: https://gitee.com/mirrors/cocos2d-x
Merge: 5da2894e1b f80a6ef25c Merge branch 'master' of https://github.com/c4games/engine-x into master
2020-11-08 13:12:06 +08:00
* Git快速手册: https://github.com/c4games/engine-x/wiki/Git-Guides