mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-06 16:16:44 +08:00

History

GeWuYou 16686a0d97 docs(config): 添加游戏内容配置系统文档和验证工具

- 新增游戏内容配置系统完整文档，涵盖 YAML 配置、JSON Schema 结构、目录组织等
- 添加 Schema 示例和 YAML 示例，说明怪物、物品等静态数据配置方式
- 提供推荐接入模板，包括目录结构、csproj 配置和启动代码模板
- 实现官方启动帮助器 GameConfigBootstrap 与 GameConfigModule 集成
- 添加运行时读取模板，提供强类型配置访问入口
- 实现生成查询辅助功能，支持 FindBy* 和 TryFindFirstBy* 查询接口
- 提供 Architecture 推荐接入模板，支持模块化配置管理
- 添加热重载模板，支持开发期配置文件自动刷新
- 实现运行时接入方案，提供只读表形式的配置访问
- 添加运行时校验行为说明，支持跨表引用和数据完整性检查
- 实现开发期热重载功能，支持配置变更自动重载
- 添加生成器接入约定，自动生成配置类型和表包装代码
- 提供 VS Code 工具支持，包括配置浏览、表单编辑和批量更新功能
- 实现配置验证工具，支持 JSON Schema 子集解析和 YAML 校验功能

2026-04-09 19:23:06 +08:00

src

docs(config): 添加游戏内容配置系统文档和验证工具

2026-04-09 19:23:06 +08:00

test

docs(config): 添加游戏内容配置系统文档和验证工具

2026-04-09 19:23:06 +08:00

.gitignore

feat(config-tool): 添加配置验证工具和相关功能

2026-04-01 23:06:44 +08:00

.vscodeignore

feat(config-tool): 添加配置验证工具和相关功能

2026-04-01 23:06:44 +08:00

bun.lock

feat(config-tool): 添加配置验证工具和相关功能

2026-04-01 23:06:44 +08:00

LICENSE

feat(config-tool): 添加配置验证工具和相关功能

2026-04-01 23:06:44 +08:00

package.json

feat(config): 添加游戏内容配置系统和VS Code工具

2026-04-02 21:29:07 +08:00

package.nls.json

feat(config-tool): 添加 VS Code 扩展实现配置文件管理功能

2026-04-02 20:45:02 +08:00

package.nls.zh-cn.json

feat(config-tool): 添加 VS Code 扩展实现配置文件管理功能

2026-04-02 20:45:02 +08:00

README.md

feat(config): 添加游戏内容配置系统和VS Code工具

2026-04-02 21:29:07 +08:00

README.md

GFramework Config Tool

VS Code extension for the GFramework AI-First config workflow.

Current MVP

Browse config files from the workspace config/ directory
Open raw YAML files
Open matching schema files from schemas/
Localize extension UI text in English and Simplified Chinese, including the form preview, prompts, and notifications
Run lightweight schema validation for nested required fields, unknown nested fields, scalar types, scalar arrays, and arrays of objects
Open a lightweight form preview for nested object fields, object arrays, top-level scalar fields, and scalar arrays
Render existing YAML comments in the form preview and edit per-field YAML comments directly from the form
Jump from reference fields to the referenced schema, config domain, or direct config file when a reference value is present
Initialize empty config files from schema-derived example YAML
Batch edit one config domain across multiple files for top-level scalar and scalar-array fields
Surface schema metadata such as title, description, default, enum, and x-gframework-ref-table in the lightweight editors

Validation Coverage

The extension currently validates the repository's minimal config-schema subset:

required properties in nested objects
unknown properties in nested objects
scalar compatibility for integer, number, boolean, and string
scalar arrays with scalar item type checks
arrays of objects whose items use the same supported subset recursively
scalar enum constraints and scalar-array item enum constraints

Local Testing

cd tools/gframework-config-tool
bun install
bun run test

Packaging And Publishing

cd tools/gframework-config-tool
bun install
bun run package:vsix
VSCE_PAT=your_marketplace_pat bun run publish:marketplace

Current Constraints

Multi-root workspaces use the first workspace folder
Validation only covers a minimal subset of JSON Schema
Form preview supports object-array editing, but nested object arrays inside array items still fall back to raw YAML
Batch editing remains limited to top-level scalar fields and top-level scalar arrays

Workspace Settings

gframeworkConfig.configPath
gframeworkConfig.schemasPath