English Version click here or drag page down
代码生成工具，风格仿UE（不依赖于C++的特性的meta注解）
使用CppAst.NET（基于clang）分析代码，调用scriban脚本生成代码
具体用途如下图：
开发框架的核心库，主要负责：
- 只在这个模块注入Hook
- 分发调用Hook事件
- 管理其他扩展DLL
除了其基本职能外，还提供了一些方便的工具：
- 适配于游戏的entt反射和ecs系统
- 适配于游戏的文件系统
- 提供一定的崩溃恢复机制，打印异常时的栈输出
- 利用meta注解自动生成附加到游戏对象上的组件实例化代码，INI配置读取代码
- 集成spdlog日志
基本UI框架，集成了方便调试开发的ImGui
功能模块，可细分为：
- 脚本模块：
- 读取，执行，热重载JavaScript
- 自动生成游戏对象的js wrap代码
- 音频模块：接入Wwise
- 交互性bgm
- 音频播放：子弹爆炸，受击，创建销毁
- 物理模块：接入JoltPhysics
- 正在探索用途
js代码热重载：
编辑器模块
- JavaScript终端
- Inspector
- xmake — 构建系统
- dotnet 8 — 用于构建代码生成工具
- VS2022 — 提供基本sdk
- YRpp（根据此项目进行了定制修改）— 提供游戏的基本接口声明
- CppAst.Net （根据此项目进行了定制修改）— C++ AST分析工具
- scriban — 文本渲染引擎和脚本语言
- entt — 提供ecs，反射框架
- puerts — 游戏Typescript编程解决方案
- imgui — 立即UI框架
- imgui-node-editor — 可视化节点编辑器UI
- v8 — javascript引擎
- nlohmann json — json库
- stb — 图像读取库
- spdlog — 日志库
- Wwise — 音频引擎
- JoltPhysics — 物理引擎
- 准备构建环境
在编译前，你需要安装xmake, dotnet, VS2022
- 准备第三方库
- v8-backend: 下载好之后，设置环境变量V8_PATH路径为v8 backend的路径
- 配置
命令行输入
xmake f -a x86 -m debug --skip_codegen=n --make_artifacts=y第一次运行时可能会出现第三方库的安装请求, 输入y安装即可
- 编译
命令行输入
xmake build -v- 复制成品
前往build\artifacts\debug 复制成品到游戏目录
- UI框架（如cegui）
- C#支持，考虑兼容dp，并且提供更高性能的语言交互（类似mono embed）
- 扩展模块管理工具
- Profiler工具
- MOD开发者便捷调试工具（如查看当前单位状态）
本项目与Electronic Arts Inc没有直接关系。Command & Conquer, Command & Conquer Red Alert 2, Command & Conquer Yuri's Revenge是Electronic Arts Inc的注册商标。保留所有权利。
Code generating tool has similar style with UE’s UnrealHeaderTool(independent on c++ attribute)
Use CppAst.Net(base on clang) to analyze code and generate code from scriban template
for example：
The core library of develop framework, mainly do:
- Inject hooks in this module only
- Dispatch hook events
- Manage extension dlls
Also some convenient tools are provided:
- Entt Reflection and ECS system ready for YR
- Filesystem ready for YR
- Exception recovery mechanic and exception stack printing
- Auto generating component instantiation code base on meta notation; such as ini reading, component instantiate on TechnoClass
- Spdlog logger integrated
Basic UI framework, integrating Imgui that convenient for debug developing
Feature module, can be divided in：
- Script module：
- load, execute, hot reload the JavaScript code
- Auto generating Js wrap code for game classes
- Audio module: Wwise integration
- interactive bgm
- audio play: bullet detonate, receive damage, create and destroy
- Physics module: JoltPhysics integration
- exploring usage
js code hot reload：
Editor module
- JavaScript Terminal
- Inspector
- xmake — build system
- dotnet 8 — use to build the code generating tool
- VS2022 — provide basic SDKs
- YRpp（Modified by this project）— Provide game basic interface declaration
- CppAst.Net （Modified by this project）— C++ AST analyze tool
- scriban — Text rendering engine and script language
- entt — ECS, Reflection framework
- puerts — Game Typescript programming resolution
- imgui — Immediate UI framework
- imgui-node-editor — Visual node editor UI
- v8 — javascript engine
- nlohmann json — json library
- stb — image library
- spdlog — logger library
- Wwise — Audio engine
- JoltPhysics — Physics engine
- Preparing build environment
Before compiling, you must install xmake, dotnet, VS2022
- Preparing third party
- v8-backend: After download, set the environment variable
V8_PATHto v8 backend path
- Configure
xmake f -a x86 -m debug --skip_codegen=n --make_artifacts=yThere may be some third party installation requests during the first configure. Please enter y to accept.
- Compile
xmake build -v- Copy artifacts
Gotobuild\artifacts\debug and copy files to game directory
- UI framework(cegui)
- C# support, dp compatible, providing faster performance (like mono embed)
- Extension module manager tool
- Profiler tool
- Modder debugging dev tool (such as inspect select object)
This project has no direct affiliation with Electronic Arts Inc. Command & Conquer, Command & Conquer Red Alert 2, Command & Conquer Yuri's Revenge are registered trademarks of Electronic Arts Inc. All Rights Reserved.