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

History

GeWuYou 6d5d9e2240 docs(config): 添加游戏内容配置系统完整文档

- 新增游戏内容配置系统详细介绍文档
- 包含 YAML 配置源文件支持说明
- 提供 JSON Schema 结构描述功能说明
- 说明一对象一文件的目录组织方式
- 介绍运行时只读查询功能特性
- 详细说明 Runtime / Generator / Tooling 共享支持的约束类型
- 提供 Source Generator 生成配置类型的完整说明
- 包含 VS Code 插件功能详细介绍
- 提供推荐目录结构和 Schema 示例
- 说明 YAML 示例格式和接入模板
- 详细说明 Godot 文本配置桥接功能
- 提供运行时读取模板和生成查询辅助说明
- 包含 Architecture 接入模板和热重载配置说明
- 详细说明运行时校验行为和跨表引用机制
- 提供开发期热重载功能完整配置指南
- 说明生成器接入约定和 VS Code 工具功能
- 包含当前限制和独立 Config Studio 评估说明
- 新增配置验证 JavaScript 工具实现

2026-04-16 09:16:50 +08:00

src

docs(config): 添加游戏内容配置系统完整文档

2026-04-16 09:16:50 +08:00

test

docs(config): 添加游戏内容配置系统完整文档

2026-04-16 09:16:50 +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