axmol/README_CN.md

115 lines
5.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# adxe
[![dev](https://img.shields.io/badge/v1.0.0-beta1-yellow.svg)](https://github.com/adxeproject/adxe/releases)
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/adxeproject/adxe/blob/master/LICENSE)
[![Android Build Status](https://github.com/adxeproject/adxe/workflows/android/badge.svg)](https://github.com/adxeproject/adxe/actions?query=workflow%3Aandroid)
[![iOS Build Status](https://github.com/adxeproject/adxe/workflows/ios/badge.svg)](https://github.com/adxeproject/adxe/actions?query=workflow%3Aios)
[![Windows Build Status](https://github.com/adxeproject/adxe/workflows/win32/badge.svg)](https://github.com/adxeproject/adxe/actions?query=workflow%3Awin32)
[![Linux Build Status](https://github.com/adxeproject/adxe/workflows/linux/badge.svg)](https://github.com/adxeproject/adxe/actions?query=workflow%3Alinux)
[![macOS Build Status](https://github.com/adxeproject/adxe/workflows/osx/badge.svg)](https://github.com/adxeproject/adxe/actions?query=workflow%3Aosx)
**这是另外一个基于 *Cocos2d-x-4.0* 持续维护的分支, 全平台基于OpenAL, c++14/17...**
**[English](README.md)**
### 宗旨:
* C++14/17
* Focus on native game dev only
* Fix bugs ASAP
* Review PR ASAP
* Excellent PRs from any guys are welcome, we will review & merge ASAP
### 主要特性:
* 基于yasio重构HttpClient以支持并发Http请求不再需要sendImmidate接口
* 重构AudioEngine, 全平台OpenAL
* [openal-soft](https://github.com/kcat/openal-soft), pass -DBUILD_DEP_ALSOFT=ON to cmake to force enable it
* [OpenAL.framework](https://opensource.apple.com/tarballs/OpenAL), if no and ```BUILD_DEP_ALSOFT``` option specified, cmake script will choose it on osx/ios, even through it was mark as deprecated, but still avaiable.
* 重构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平台的实现
* Spine 3.8支持
* 新增FairyGUI支持
* 新增硬件压缩纹理格式ASTC 4x4/6x6/8x8支持支持软解
* 新增硬件压缩纹理格式ETC2 RGB/RGBA支持支持软解
* **ImGui集成非常方便写游戏内嵌小工具用法详见[ImGuiEXT](extensions/ImGuiEXT/README.md)**
### [Roadmap](https://github.com/adxeproject/adxe/issues/1)
### 快速开始
#### 必要工具 [python](https://www.python.org/downloads/)
* python-2.7.17+, python-3.7+都可以
#### 准备步骤
1. 进入引擎```adxe```根目录
3. 执行```python setup.py```后重启控制台
#### Windows
1. 安装CMake要求3.14以上
2. 确保 Visual Studio 2019 已正确安装
3. 执行下面的命令
```bat
cd adxe
cmake -S . -B build -G "Visual Studio 16 2019" -A Win32
```
4. 之后就可以用vs打开```adxe/build/adxe.sln```启动cpp-tests等测试工程了
#### Android
1. 安装 Android Studio 4.2或更高版本
2. 第一次启动Android Studio, 会引导安装一些工具,默认安装即可,如果不需要模拟器可以把```Virutal Device```勾选去掉
2. 启动 Android Studio并打开adxe\tests\cpp-tests\proj.android
3. 通过 [Tools][SdkManagers] 打开sdk管理工具选择如下SDK Platforms和SDK Tools后 点击按钮 ```Apply``` 一路跟着引导安装即可:
* Android SDK Platform 29 r5 (在SDK Platforms页签)
* Android SDK Build-Tools 29.0.2
* NDK r19c+
* CMake 3.10+
5. 等待Gradle sync完成后Build APKs安装运行
6. 如果使用非sdk自动安装的CMake版本, 需要下载[ninja](https://github.com/ninja-build/ninja/releases) 并且拷贝```ninja.exe```到CMake的bin目录
#### iOS
1. 确保已安装xcode11+和[cmake3.14+](https://github.com/Kitware/CMake/releases), 安装CMake命令行支持: ```sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install```
2. 执行如下命令确保cmake能成功生成xcode工程:
```sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer```
3. 生成xcode工程, 进入adxe根目录执行如下命令之一:
- 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 armv7,arm64 combined:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake "-DCMAKE_OSX_ARCHITECTURES=armv7;arm64"```
- for simulator x86_64:
```cmake -S . -B build -GXcode -DCMAKE_TOOLCHAIN_FILE=cmake/ios.mini.cmake -DCMAKE_OSX_ARCHITECTURES=x86_64```
4. 之后就可以用xcode打开, 选择cpp-tests编译运行
### 注意
* ThreadLocalStorage线程本地存储
- ios x86 simulator ios>=10 and adxe no longer provide x86 libraries
- ios x64 or devices(armv7,arm64) ios sdk>=9.0
- the openal-soft maintained by kcat use TLS
### QQ交流群
点击链接加入群聊【Adxe 交流群】https://jq.qq.com/?_wv=1027&k=nvNmzOIY
### 参考链接
* official v4: https://gitee.com/mirrors/cocos2d-x
* Git快速手册: https://github.com/adxeproject/adxe/wiki/Git-Guides
### adxe项目的活跃贡献者
- @halx99
- @rh101
- @aismann
- @weiwest