mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
- 更新 AGENTS、Game README 与游戏栏目入口中的参考表述,统一改为 ai-libs 下的只读参考实现 - 移除活跃文档入口中的旧外部项目命名,避免继续暴露特定参考仓库线索 - 补充 documentation-governance-and-refresh 主题的 tracking 与 trace,记录本轮引用迁移和后续约束
3.5 KiB
3.5 KiB
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 栏目聚焦“游戏项目该怎么接这些运行时能力”,不再保留与当前实现脱节的泛化模块示例。
当前栏目主要入口:
- 配置与内容系统
- 数据、设置、序列化与存储
- 导航与界面
最小接入路径
接入 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. 接入设置与存档
典型顺序是:
- 注册
JsonSerializer - 注册
IStorage - 注册
ISettingsDataRepository - 注册
SettingsModel<TRepository> - 注册
SettingsSystem - 注册
ISaveRepository<TSaveData>
具体组合方式见:
3. 接入静态 YAML 配置
当你要维护怪物、物品、技能、任务等只读内容数据时,优先使用:
GFramework.Game运行时GFramework.Game.SourceGeneratorsschemas/**/*.schema.json+config/**/*.yaml
完整约定见:
4. 接入 Scene / UI 路由
SceneRouterBase 与 UiRouterBase 提供的是可复用基类,不直接绑定具体引擎。工厂、root、注册表通常由引擎适配层或项目自身提供。
入口见:
推荐阅读顺序
与真实接法的关系
这个栏目以源码、*.csproj、模块 README.md 与 ai-libs/ 下已验证的参考接法为准。
例如当前文档应优先和以下已验证事实保持一致:
- 配置系统采用
YAML + JSON Schema + Source Generator - 设置持久化通常通过
UnifiedSettingsDataRepository - 场景与 UI 路由依赖项目自己的 factory / root,而不是框架替你绑定引擎对象
如果某个旧页面与这些事实冲突,应以源码和模块 README 为准,并在同一轮里修正文档。
对应模块入口
GFramework.Game/README.mdGFramework.Game.Abstractions/README.md- 仓库根
README.md