GeWuYou 7531762d3e docs(documentation): 收口栏目入口页导航
- 更新 Core、Game 与 Source Generators 栏目 landing page,使其对齐当前模块定位、包关系与最小接入路径
- 修复 VitePress 对 docs 目录外 README 相对链接的 dead-link 校验问题,改为纯文本入口提示
- 补充 documentation-governance-and-refresh 主题的恢复点、验证结果与下一步专题页修订计划
2026-04-21 07:45:39 +08:00

3.5 KiB
Raw Blame History

Game

Game 栏目对应 GFramework.GameGFramework.Game.Abstractions 这层游戏运行时能力。

它建立在 Core 之上,负责把“能运行的基础架构”继续扩展成“可落地的游戏项目基础设施”,重点覆盖静态内容配置、数据与存档、设置、场景与 UI 路由、序列化和文件存储。

先理解包关系

  • GeWuYou.GFramework.Game
    • 游戏层默认运行时实现。
  • GeWuYou.GFramework.Game.Abstractions
    • 对应的契约层。
  • GeWuYou.GFramework.Game.SourceGenerators
    • 面向 schemas/**/*.schema.json 的配置类型与表包装生成器。
  • GeWuYou.GFramework.Core
    • 本层直接依赖的底座,提供架构、生命周期、事件、日志等通用能力。

如果你的项目只想依赖契约,不想带入默认实现,请选择 Game.Abstractions。如果你需要可运行的默认基类与实现,请使用 Game

这个栏目应该回答什么

Game 栏目聚焦“游戏项目该怎么接这些运行时能力”,不再保留与当前实现脱节的泛化模块示例。

当前栏目主要入口:

最小接入路径

接入 Game 层前,先确保你已经完成 Core 的基础架构初始化。

最常见的四种接入目标如下:

1. 只想先拿到文件存储

using GFramework.Core.Abstractions.Storage;
using GFramework.Game.Serializer;
using GFramework.Game.Storage;

var serializer = new JsonSerializer();
IStorage storage = new FileStorage("GameData", serializer);

2. 接入设置与存档

典型顺序是:

  1. 注册 JsonSerializer
  2. 注册 IStorage
  3. 注册 ISettingsDataRepository
  4. 注册 SettingsModel<TRepository>
  5. 注册 SettingsSystem
  6. 注册 ISaveRepository<TSaveData>

具体组合方式见:

3. 接入静态 YAML 配置

当你要维护怪物、物品、技能、任务等只读内容数据时,优先使用:

  • GFramework.Game 运行时
  • GFramework.Game.SourceGenerators
  • schemas/**/*.schema.json + config/**/*.yaml

完整约定见:

4. 接入 Scene / UI 路由

SceneRouterBaseUiRouterBase 提供的是可复用基类不直接绑定具体引擎。工厂、root、注册表通常由引擎适配层或项目自身提供。

入口见:

推荐阅读顺序

  1. Core 入口
  2. config-system
  3. data
  4. setting
  5. sceneui

与真实接法的关系

这个栏目以源码、*.csproj、模块 README.mdCoreGrid 中已验证的接法为准。

例如当前仓库与 CoreGrid 的共同事实包括:

  • 配置系统采用 YAML + JSON Schema + Source Generator
  • 设置持久化通常通过 UnifiedSettingsDataRepository
  • 场景与 UI 路由依赖项目自己的 factory / root而不是框架替你绑定引擎对象

如果某个旧页面与这些事实冲突,应以源码和模块 README 为准,并在同一轮里修正文档。

对应模块入口

  • GFramework.Game/README.md
  • GFramework.Game.Abstractions/README.md
  • 仓库根 README.md