chore: checkpoint current workspace changes
This commit is contained in:
251
README.md
251
README.md
@@ -1,6 +1,6 @@
|
||||
# XCEngine
|
||||
|
||||
`XCEngine` 是一个基于 `C++20` 的游戏引擎。当前代码中已经包含 `RHI`、`Rendering`、`Scene`、`Resources`、`Editor`、`Mono C# Scripting` 和 `XCUI` 相关模块;本 README 只描述当前已经实现或已经接入的能力。
|
||||
`XCEngine` 是一个 Windows-first、editor-first 的 `C++20` 游戏引擎工作区。当前代码中已经形成 `RHI`、`Rendering`、`Scene`、`Resources`、`Editor`、`Mono C# Scripting` 和 `XCUI` 相关主线;本 README 只描述当前已经实现、已经接入或已经成为正式工作流一部分的能力。
|
||||
|
||||
## 核心特性
|
||||
|
||||
@@ -91,7 +91,8 @@
|
||||
- `UIScreenDocumentHost`
|
||||
- `UIScreenPlayer`
|
||||
- `UISystem`
|
||||
- 新编辑器路线基于 `XCUIEditorLib` 推进,当前已经包含树视图、列表视图、菜单、标签条、属性网格、字段控件、workspace / dock / viewport shell 等基础组件
|
||||
- `tests/UI/` 是当前 XCUI `Core / Editor / Runtime` 三层的正式基础层验证入口
|
||||
- `new_editor/` 是未来正式编辑器主线,不再只是临时沙盒;当前已经包含树视图、列表视图、菜单、标签条、属性网格、字段控件、workspace / dock / viewport shell 等基础组件
|
||||
|
||||
### 音频
|
||||
|
||||
@@ -122,7 +123,7 @@
|
||||
- 当前 `RHI` 后端为 `D3D12`、`OpenGL`、`Vulkan`
|
||||
- 当前项目资产工作流已经接入 `AssetDatabase + Artifact + Library`
|
||||
- 当前 `Mono C#` 脚本程序集与运行时链路已经接入
|
||||
- 当前 `XCUI` 新编辑器路线仍在继续实现中
|
||||
- 当前 `XCUI` 新编辑器路线以 `new_editor/` 为正式主线继续推进
|
||||
|
||||
## 快速开始
|
||||
|
||||
@@ -170,6 +171,12 @@ cmake --build build --config Debug --target xcengine_project_managed_assemblies
|
||||
cmake --build build --config Debug --target XCUIEditorApp
|
||||
```
|
||||
|
||||
运行 XCUI 新编辑器宿主:
|
||||
|
||||
```powershell
|
||||
.\new_editor\bin\Debug\XCUIEditor.exe
|
||||
```
|
||||
|
||||
## 测试入口
|
||||
|
||||
```powershell
|
||||
@@ -189,10 +196,248 @@ cmake --build build --config Debug --target editor_ui_all_tests
|
||||
cmake --build build --config Debug --target runtime_ui_all_tests
|
||||
```
|
||||
|
||||
## 完整目录结构
|
||||
|
||||
以下目录树按当前工作树整理,保留了真实使用的生成目录与关键子树;省略了 `.git/`、`build/_deps/`、部分重复资源文件,以及 `docs/used/` 中大量历史归档的长尾条目。
|
||||
|
||||
```text
|
||||
XCEngine/
|
||||
|- .gitattributes
|
||||
|- .gitignore
|
||||
|- AGENT.md
|
||||
|- CMakeLists.txt
|
||||
|- README.md
|
||||
|- build/ # 本地 CMake 构建输出
|
||||
|- docs/
|
||||
| |- api/
|
||||
| | |- XCEngine/
|
||||
| | |- _guides/
|
||||
| | |- _meta/
|
||||
| | |- _tools/
|
||||
| | `- main.md
|
||||
| |- issues/
|
||||
| | `- Editor模块_Console面板错误绑定fallback sink导致运行时日志不显示4.3.md
|
||||
| |- plan/
|
||||
| | |- end/
|
||||
| | | |- RHI模块设计与实现/
|
||||
| | | | |- RHIFence.md
|
||||
| | | | `- RHI模块总览.md
|
||||
| | | `- 编辑器与运行时分层架构设计.md
|
||||
| | |- 开题报告和任务书/
|
||||
| | |- 旧版题目/
|
||||
| | |- 3DGS专用PLY导入器与GaussianSplat资源缓存正式化计划_2026-04-10.md
|
||||
| | |- API文档目录结构第二轮并行任务板_2026-04-09.md
|
||||
| | |- API文档目录结构第二轮重构计划_2026-04-09.md
|
||||
| | |- API文档目录结构重大重构并行任务板_2026-04-09.md
|
||||
| | |- API文档目录结构重构并行任务板_2026-04-09_第二轮.md
|
||||
| | |- API文档目录重构计划_2026-04-09.md
|
||||
| | |- C#脚本模块下一阶段计划.md
|
||||
| | |- Editor架构说明.md
|
||||
| | |- Library启动预热与运行时异步加载混合重构计划_2026-04-04.md
|
||||
| | |- Library启动预热与运行时异步加载混合重构计划_进度更新_2026-04-04.md
|
||||
| | |- NanoVDB体积云加载阻塞与Runtime上传修复计划_2026-04-10.md
|
||||
| | |- Unity SRP API参考文档.md
|
||||
| | |- Unity绝区零开发文档还原版.md
|
||||
| | |- Unity风格模型导入与Model资产架构重构计划_2026-04-10.md
|
||||
| | |- XCUI_NewEditor主线重建计划_2026-04-07.md
|
||||
| | `- XCUI完整架构设计与执行计划.md
|
||||
| |- used/ # 历史材料、阶段归档和旧计划背景
|
||||
| | |- API文档实时同步任务池_2026-04-03.md
|
||||
| | |- Library资产导入与缓存系统收口计划_完成归档_2026-04-03.md
|
||||
| | |- NanoVDB稀疏体积渲染后续正式化计划_阶段归档_2026-04-10.md
|
||||
| | |- NanoVDB稀疏体积渲染正式集成计划_第一阶段完成归档_2026-04-09.md
|
||||
| | |- Renderer当前阶段正式收口计划_阶段归档_2026-04-10.md
|
||||
| | |- Renderer剩余收口与体积渲染多后端正式化计划_完成归档_2026-04-10.md
|
||||
| | |- Renderer下一阶段_Unity风格Shader体系正式化计划_完成归档_2026-04-07.md
|
||||
| | |- SceneViewport_Overlay_Gizmo_Rework_Plan_完成归档_2026-04-04.md
|
||||
| | |- Unity式SceneView_Gizmo系统完整审查与正式化重构方案_完成归档_2026-04-06.md
|
||||
| | `- XCUI_Phase_Status_2026-04-05.md
|
||||
| |- api-skill.md
|
||||
| |- blueprint-skill.md
|
||||
| `- blueprint.md
|
||||
|- editor/
|
||||
| |- CMakeLists.txt
|
||||
| |- README.md
|
||||
| |- bin/
|
||||
| |- resources/
|
||||
| | `- Icons/
|
||||
| `- src/
|
||||
| |- Actions/
|
||||
| |- Commands/
|
||||
| |- ComponentEditors/
|
||||
| |- Core/
|
||||
| |- Layers/
|
||||
| |- Layout/
|
||||
| |- Managers/
|
||||
| |- panels/
|
||||
| |- Platform/
|
||||
| |- Scripting/
|
||||
| |- UI/
|
||||
| |- Utils/
|
||||
| |- Viewport/
|
||||
| | |- Passes/
|
||||
| | |- SceneViewportChrome.*
|
||||
| | |- SceneViewportInteractionFrame.h
|
||||
| | |- SceneViewportNavigation.h
|
||||
| | |- SceneViewportOverlayBuilder.*
|
||||
| | |- SceneViewportOverlayFrameCache.*
|
||||
| | |- SceneViewportOverlaySpriteResources.*
|
||||
| | |- SceneViewportPassSpecs.h
|
||||
| | |- SceneViewportPicker.*
|
||||
| | |- SceneViewportResourcePaths.h
|
||||
| | |- SceneViewportTransformGizmoCoordinator.*
|
||||
| | `- ViewportHostService.h
|
||||
| |- Application.cpp
|
||||
| |- Application.h
|
||||
| |- Theme.cpp
|
||||
| `- main.cpp
|
||||
|- engine/
|
||||
| |- CMakeLists.txt
|
||||
| |- include/
|
||||
| | `- XCEngine/
|
||||
| | |- Audio/
|
||||
| | |- Components/
|
||||
| | |- Core/
|
||||
| | |- Debug/
|
||||
| | |- Input/
|
||||
| | |- Memory/
|
||||
| | |- Platform/
|
||||
| | |- Rendering/
|
||||
| | | |- Caches/
|
||||
| | | |- Execution/
|
||||
| | | |- Extraction/
|
||||
| | | |- FrameData/
|
||||
| | | |- Materials/
|
||||
| | | |- Passes/
|
||||
| | | |- Picking/
|
||||
| | | |- Pipelines/
|
||||
| | | `- Planning/
|
||||
| | |- Resources/
|
||||
| | | |- AudioClip/
|
||||
| | | |- Material/
|
||||
| | | |- Mesh/
|
||||
| | | |- Shader/
|
||||
| | | |- Texture/
|
||||
| | | `- Volume/
|
||||
| | |- RHI/
|
||||
| | | |- D3D12/
|
||||
| | | |- OpenGL/
|
||||
| | | `- Vulkan/
|
||||
| | |- Scene/
|
||||
| | |- Scripting/
|
||||
| | |- Threading/
|
||||
| | `- UI/
|
||||
| |- src/
|
||||
| |- third_party/
|
||||
| `- tools/
|
||||
|- managed/
|
||||
| |- CMakeLists.txt
|
||||
| |- GameScripts/
|
||||
| `- XCEngine.ScriptCore/
|
||||
|- mvs/
|
||||
| |- 3DGS-Unity/
|
||||
| |- D3D12/
|
||||
| |- OpenGL/
|
||||
| |- RenderDoc/
|
||||
| |- ui/
|
||||
| `- VolumeRenderer/
|
||||
|- new_editor/
|
||||
| |- app/
|
||||
| | |- Host/
|
||||
| | |- Application.cpp
|
||||
| | |- Application.h
|
||||
| | `- main.cpp
|
||||
| |- bin/
|
||||
| |- include/
|
||||
| | `- XCEditor/
|
||||
| | |- Collections/
|
||||
| | |- Fields/
|
||||
| | |- Foundation/
|
||||
| | |- Shell/
|
||||
| | `- Widgets/
|
||||
| |- src/
|
||||
| | |- Collections/
|
||||
| | |- Fields/
|
||||
| | |- Foundation/
|
||||
| | |- Shell/
|
||||
| | `- Widgets/
|
||||
| |- ui/
|
||||
| | |- themes/
|
||||
| | `- views/
|
||||
| `- CMakeLists.txt
|
||||
|- project/
|
||||
| |- .xceditor/
|
||||
| | |- imgui_layout.ini
|
||||
| | `- thumbs/
|
||||
| |- Assets/
|
||||
| | |- Materials/
|
||||
| | |- Models/
|
||||
| | |- Scenes/
|
||||
| | `- Scripts/
|
||||
| |- Library/
|
||||
| | |- ArtifactDB/
|
||||
| | |- Artifacts/
|
||||
| | |- ScriptAssemblies/
|
||||
| | `- SourceAssetDB/
|
||||
| |- Assets.meta
|
||||
| `- Project.xcproject
|
||||
|- scripts/
|
||||
| `- Run-RendererPhaseRegression.ps1
|
||||
|- tests/
|
||||
| |- CMakeLists.txt
|
||||
| |- TEST_SPEC.md
|
||||
| |- Components/
|
||||
| |- Core/
|
||||
| |- Debug/
|
||||
| |- Editor/
|
||||
| |- Fixtures/
|
||||
| |- Input/
|
||||
| |- Memory/
|
||||
| |- NewEditor/ # 当前为空的预留测试根目录
|
||||
| |- Rendering/
|
||||
| | |- integration/
|
||||
| | | |- alpha_cutout_scene/
|
||||
| | | |- camera_post_process_scene/
|
||||
| | | |- directional_shadow_scene/
|
||||
| | | |- final_color_scene/
|
||||
| | | |- multi_light_scene/
|
||||
| | | |- skybox_scene/
|
||||
| | | |- volume_occlusion_scene/
|
||||
| | | |- volume_scene/
|
||||
| | | `- volume_transform_scene/
|
||||
| | `- unit/
|
||||
| |- Resources/
|
||||
| |- RHI/
|
||||
| |- Scene/
|
||||
| |- Scripting/
|
||||
| |- Threading/
|
||||
| `- UI/
|
||||
| |- Core/
|
||||
| |- Editor/
|
||||
| |- Runtime/
|
||||
| `- TEST_SPEC.md
|
||||
|- 参考/
|
||||
| |- Fermion/
|
||||
| |- TransformGizmo/
|
||||
| |- unity editor/
|
||||
| |- unity-editor-icons/
|
||||
| |- unity-icons/
|
||||
| `- UnityRuntimeSceneGizmo-master/
|
||||
`- .vscode/
|
||||
```
|
||||
|
||||
## 文档入口
|
||||
|
||||
- `docs/api/main.md`
|
||||
- `editor/README.md`
|
||||
- `AGENT.md`
|
||||
- `docs/blueprint.md`
|
||||
- `tests/TEST_SPEC.md`
|
||||
- `tests/UI/TEST_SPEC.md`
|
||||
- `docs/plan/Editor架构说明.md`
|
||||
- `docs/plan/Library启动预热与运行时异步加载混合重构计划_2026-04-04.md`
|
||||
- `docs/plan/XCUI_NewEditor主线重建计划_2026-04-07.md`
|
||||
- `docs/plan/XCUI完整架构设计与执行计划.md`
|
||||
- `docs/plan/NanoVDB体积云加载阻塞与Runtime上传修复计划_2026-04-10.md`
|
||||
- `docs/plan/Unity风格模型导入与Model资产架构重构计划_2026-04-10.md`
|
||||
- `docs/plan/3DGS专用PLY导入器与GaussianSplat资源缓存正式化计划_2026-04-10.md`
|
||||
|
||||
Reference in New Issue
Block a user