mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-07 00:39:00 +08:00

gewuyou 8209d7a29f docs(documentation): 收口公开文档口吻约束

- 修复公开 README 与 docs 页面中的反问式标题、维护者口吻和裸文件名链接标签
- 补充 AGENTS.md 与 gframework-doc-refresh 的 reader-facing 文档输出约束
- 更新 documentation-full-coverage-governance 的恢复点与验证记录

2026-04-25 09:27:06 +08:00

4.6 KiB

Raw Blame History

title, description

title	description
Game 模块	GFramework.Game family 的运行时入口、采用顺序与源码阅读导航。

Game 模块

Game 栏目对应 GFramework.Game 与 GFramework.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 栏目聚焦“游戏项目该怎么接这些运行时能力”，不再保留与当前实现脱节的泛化模块示例。

当前栏目主要入口：

配置与内容系统
- 配置系统
数据、设置、序列化与存储
导航与界面
- 场景系统
- UI 系统

最小接入路径

接入 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. 接入设置与存档

典型顺序是：

具体组合方式见：

3. 接入静态 YAML 配置

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

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

完整约定见：

配置系统

4. 接入 Scene / UI 路由

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

入口见：

阅读顺序

源码与 API 阅读入口

如果你已经完成栏目入口页阅读，下一步通常不是看统计表，而是按模块角色回到源码和 XML 文档：

模块	代表类型	建议先确认什么
`GFramework.Game`	`YamlConfigLoader`、`SettingsModel<TRepository>`、`SceneRouterBase`、`UiRouterBase`	默认运行时实现、配置加载、设置编排和路由基类
`GFramework.Game.Abstractions`	`IConfigRegistry`、`ISaveRepository<TSaveData>`、`ISettingsSystem`、`ISceneRouter`、`IUiRouter`	契约层边界，以及项目中哪些程序集只应依赖接口
`GFramework.Game.SourceGenerators`	`SchemaConfigGenerator`、`ConfigSchemaDiagnostics`	schema 生成入口与诊断模型，确认配置系统的编译期链路

与真实接法的关系

本栏目内容以源码、*.csproj、模块说明页与 ai-libs/ 下已验证的参考接法为准。

例如当前文档应优先和以下已验证事实保持一致：

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

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

4.6 KiB Raw Blame History Unescape Escape