Split game module documentation
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
# Debug Tools
|
||||
|
||||
## 职责
|
||||
|
||||
调试模块负责白盒/灰盒阶段的可视化和开发开关。
|
||||
|
||||
主要源码:
|
||||
|
||||
- `game/src/debug/debug_overlay.*`
|
||||
- `game/src/core/debug_flags.h`
|
||||
- `game/docs/controls.md`
|
||||
|
||||
## 当前显示项
|
||||
|
||||
- 场景碰撞。
|
||||
- 场景网格。
|
||||
- 玩家包围盒。
|
||||
- battle zone 触发框。
|
||||
- battle zone camera bounds。
|
||||
- enemy spawn point。
|
||||
|
||||
## 快捷键
|
||||
|
||||
快捷键统一维护在 `../controls.md`。
|
||||
|
||||
当前 debug 开关会通过 `GameSave` 保存,下次启动后恢复。
|
||||
|
||||
## 约束
|
||||
|
||||
- 调试绘制继续使用引擎 `Renderer::drawQuad`。
|
||||
- 不单独实现 debug render backend。
|
||||
- 正式版本需要能关闭或剥离开发快捷键。
|
||||
|
||||
## 下一步
|
||||
|
||||
- 增加输入状态显示。
|
||||
- 增加 hitbox/hurtbox 显示。
|
||||
- 增加地图加载错误和资源缺失提示面板。
|
||||
Reference in New Issue
Block a user