diff --git a/README.md b/README.md index fc75c907b5..5524256f57 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Axmol Engine -## A Multi-platform Engine for Desktop, XBOX (UWP) and Mobile games. (A radical fork of Cocos2d-x-4.0) +## A Multi-platform Engine for Desktop, XBOX (UWP) and Mobile games. (A fork of Cocos2d-x-4.0) [![dev](https://img.shields.io/github/v/release/axmolengine/axmol?include_prereleases&label=release)](https://github.com/axmolengine/axmol/releases) [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/axmolengine/axmol/blob/master/LICENSE) @@ -107,10 +107,12 @@ Open [APPENDIX.md](APPENDIX.md) for additional information and see [Milestones]( ## Reference links -- [buildware](https://github.com/axmolengine/buildware), the axmol prebuilt build-bot +- [build1k](https://github.com/axmolengine/build1k), the axmol prebuilt build-bot +- [axmolengine/glslcc](https://github.com/axmolengine/glslcc), a fork of glslcc for axmol new shader workflow tool - [Some interesting related projects based on axmol](https://github.com/axmolengine/axmol/discussions/694) - [Axmols contributing guide](https://github.com/axmolengine/axmol/discussions/411) - [Official Cocos2d-x](https://github.com/cocos2d/cocos2d-x) ## The axmol Active Stats + ![Alt](https://repobeats.axiom.co/api/embed/6fcb8168a3af91ba9e797a1f14a3c2edc42ac56a.svg "Repobeats analytics image") diff --git a/README_CN.md b/README_CN.md index a518c472b3..c06abe302a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,14 +2,30 @@ # Axmol引擎 -## A Multi-platform Engine for Desktop, XBOX (UWP) and Mobile games. (A radical fork of Cocos2d-x-4.0) +## A Multi-platform Engine for Desktop, XBOX (UWP) and Mobile games. (A fork of Cocos2d-x-4.0) [![dev](https://img.shields.io/github/v/release/axmolengine/axmol?include_prereleases&label=release)](https://github.com/axmolengine/axmol/releases) [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/axmolengine/axmol/blob/master/LICENSE) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/81fa1aba09ab41a98b949064b928d06e)](https://www.codacy.com/gh/axmolengine/axmol/dashboard?utm_source=github.com&utm_medium=referral&utm_content=axmolengine/axmol&utm_campaign=Badge_Grade) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/axmolengine/axmol/pulls) +[![QQ Group](https://img.shields.io/badge/QQGroup-join-green.svg)](https://jq.qq.com/?_wv=1027&k=nvNmzOIY) + + +> ⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️ +> +> 本分支处于早期开阶段, 主要目标是: + +> - OpenGL3/GLESv3支持 +> - 废弃GLES2设备支持 +> - Mesh实例化渲染支持 +> - 使用`glslcc`作为新的引擎着色器工作流,开发者使用ESSL310或GLSL450语法编写shader, 引擎自动使用`glslcc`编译为目标支持平台语法: +> - Desktop GL: GLSL330 +> - GLESv3: ESSL300 +> - Metal: MSL +> - 增强shader缓存管理和加载机制,加载API更加易用 +> - 其他更多优化,请查看: #1279 + - **[English](README.md)** ## 支持平台列表 @@ -36,22 +52,10 @@ | Android | H264, HEVC | NV12 | .mp4,.mkv,.webm | ExoPlayer2 | | Linux | H264, HEVC | NV12 | .mp4,.mkv,.webm | libVLC | -### 关于预编译库 -- 所有预编译库均通过[buildware](https://github.com/axmolengine/buildware)使用GitHub Actions自动构建 -- 预编译库支持架构 - - windows: x86,x64 - - linux: x64 - - macos: x64, arm64(M1芯片) - - android: armv7, arm64, x86, x64 - - ios: arm64, x64 - - tvos: arm64, x64 +## 构建 -### 宗旨: -* C++17/20 -* 专注C++ -* Fix bugs ASAP -* Review PR ASAP +请查看: [Dev setup instructions](docs/DevSetup.md). ### 主要特性: @@ -80,82 +84,15 @@ * 新增硬件压缩纹理格式ETC2 RGB/RGBA支持,支持软解 * **ImGui集成,非常方便写游戏内嵌小工具,用法详见[ImGui](extensions/ImGui/README.md)** * 完整改动列表,请查看[CHANGELOG](CHANGELOG) - -### 快速开始 -#### 必要工具 [python](https://www.python.org/downloads/) - * python-3.7+ -#### 准备步骤 - 1. 进入引擎```axmol```根目录 - 3. 执行```python setup.py```后重启控制台 - -#### Windows - 1. 安装CMake,要求3.22以上 - 2. 确保 Visual Studio 2019/2022 已正确安装 - 3. 执行下面的命令 - - PC: ```cmake -S . -B build -G "Visual Studio 16 2019"``` - - - UWP: ```cmake -S . -B build -G "Visual Studio 17 2022" -A x64 -DCMAKE_SYSTEM_NAME=WindowsStore "-DCMAKE_SYSTEM_VERSION=10.0" "-DAX_VS_DEPLOYMENT_TARGET=10.0.17763.0"``` - 4. 之后就可以用vs打开```axmol/build/axmol.sln```启动cpp-tests等测试工程了 - -#### Android - 1. 安装 Android Studio 2021.1.1+ - 2. 第一次启动Android Studio, 会引导安装一些工具,默认安装即可,如果不需要模拟器可以把```Virutal Device```勾选去掉 - 2. 启动 Android Studio并打开axmol\tests\cpp-tests\proj.android - 3. 通过 [Tools][SdkManagers] 打开sdk管理工具,选择如下SDK Platforms和SDK Tools后, 点击按钮 ```Apply``` 一路跟着引导安装即可: - * Android SDK Platform 33 (在SDK Platforms页签) - * Android Gradle Plugin (AGP) 7.2.2 - * Android SDK Build-Tools 30.0.3 和 AGP 版本对应 - * Gradle 7.4.2 - * NDK r23c+ - * CMake 3.22.1+ - - 5. 等待Gradle sync完成后,Build APKs,安装运行 - 6. 如果使用非sdk自动安装的CMake版本, 需要下载[ninja](https://github.com/ninja-build/ninja/releases), 并且拷贝```ninja.exe```到CMake的bin目录 - -#### iOS - 1. 确保已安装xcode12+和[cmake3.21+](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工程, 进入axmol根目录执行如下命令之一: - - for ios arm64: - ```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``` - - for ios simulator x86_64: - ```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``` - - for macos x86_64(Intel) - ```cmake -S . -B build -GXcode -DCMAKE_OSX_ARCHITECTURES=x86_64``` - - for macos arm64(M1) - ```cmake -S . -B build -GXcode -DCMAKE_OSX_ARCHITECTURES=arm64``` - - 4. 之后就可以用xcode打开, 选择cpp-tests编译运行 - -### 一些基于axmol有趣的项目 - -- https://github.com/solan-solan/HeightMap/tree/smooth_lod_passing -- https://github.com/wzhengsen/StarryX -- https://github.com/aismann/SimpleSnake -- https://github.com/EugenyN/TanksKombat - -### 注意 - * ThreadLocalStorage线程本地存储 - - ios x86 simulator ios>=10 and axmol no longer provide x86 libraries - - ios x64 or devices arm64 ios sdk>=9.0 - - the openal-soft maintained by kcat use TLS - -### QQ交流群 - - 点击链接加入群聊【axmol 交流群】:https://jq.qq.com/?_wv=1027&k=nvNmzOIY - ### 参考链接 - * official v4: https://gitee.com/mirrors/cocos2d-x - * Git快速手册: https://github.com/axmolengine/axmol/discussions/411 + +- axmol引擎预编译库生成工具: [build1k](https://github.com/axmolengine/build1k), +- axmol专用shader编译工具: [axmolengine/glslcc](https://github.com/axmolengine/glslcc), +- 一些基于axmol引擎的开源项目: https://github.com/axmolengine/axmol/discussions/694 +- official v4: https://gitee.com/mirrors/cocos2d-x +- Git快速手册: https://github.com/axmolengine/axmol/discussions/411 ### axmol项目活跃状态