Skip to content

Spec-driven development (SDD) for AI game design assistants.

License

Notifications You must be signed in to change notification settings

zhing2006/OpenGameDesign

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

492 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OGD

游戏设计规范驱动开发工具

License: MIT

OpenGameDesign (OGD)

OGD 是一个面向游戏策划的规范驱动设计工具,从 OpenSpec 分叉而来。它帮助人类和 AI 助手在编写设计文档之前就设计规范达成一致。

为什么使用 OGD?

AI 助手功能强大,但当设计需求只存在于聊天历史中时,结果往往不可预测。OGD 添加了一个轻量级的规范工作流,在输出设计文档之前锁定设计意图,为你提供确定性的、可审查的设计产物。

核心价值:

  • 人类和 AI 在工作开始前就规范达成一致
  • 结构化的变更文件夹(提案、任务和规范更新)使范围明确且可审计
  • 共享可见性:可以查看哪些内容被提议、正在进行或已归档
  • 与你已使用的 AI 工具兼容:支持自定义斜杠命令的工具可使用原生命令,其他工具使用上下文规则

游戏设计专属功能

  • 设计支柱系统 - 定义核心设计原则,所有功能规范必须与之对齐
  • 双类型规范 - 全局规范 (game-vision) + 功能规范 (feature specs)
  • 中文模板 - 所有模板均为中文,适合中文游戏设计团队
  • 设计产物类型 - 支持 gameplay-design.md, numerical-framework.md 等设计产物

工作流程

┌────────────────────┐
│ 起草变更提案        │
│                    │
└────────┬───────────┘
         │ 与 AI 分享意图
         ▼
┌────────────────────┐
│ 审查与对齐          │◀──── 反馈循环 ──────┐
│ (编辑规范/任务)     │                     │
└────────┬───────────┘                     │
         │ 批准的方案                       │
         ▼                                 │
┌────────────────────┐                     │
│ 执行设计任务        │─────────────────────┘
│ (AI 生成设计文档)   │
└────────┬───────────┘
         │ 交付设计产物
         ▼
┌────────────────────┐
│ 归档并更新规范      │
│ (设计文档)          │
└────────────────────┘

1. 起草一个捕获你想要的设计规范更新的变更提案
2. 与 AI 助手一起审查提案,直到达成一致
3. 执行任务,生成设计文档(玩法设计、数值框架等)
4. 归档变更,将批准的更新合并回源规范

快速开始

安装

npm install -g @zhing2006/ogd@latest
#
pnpm add -g @zhing2006/ogd@latest

初始化项目

cd your-game-project
ogd init

这将创建 ogd/ 目录结构:

ogd/
├── AGENTS.md           # AI 助手指南
├── pillars.md          # 设计支柱(核心设计原则)
├── specs/              # 已定稿的设计规范
│   ├── game-vision/    # 全局规范(游戏愿景、世界观)
│   │   └── spec.md
│   └── [feature]/      # 功能规范(战斗系统、装备系统等)
│       └── spec.md
└── changes/            # 变更提案(计划中的设计变更)
    ├── [change-name]/
    │   ├── proposal.md
    │   ├── tasks.md
    │   └── specs/
    └── archive/

核心命令

# 查看活跃变更
ogd list

# 查看规范列表
ogd list --specs

# 显示变更或规范详情
ogd show <item>

# 验证变更或规范
ogd validate <item> --strict

# 归档已完成的变更
ogd archive <change-id>

支持的 AI 工具

工具 支持方式
Amazon Q Developer 自定义提示
Claude Code Agent Skills
Cursor 规则文件
GitHub Copilot 自定义指令
Windsurf 规则文件
更多... 参见 ogd init

目录结构

ogd/
├── pillars.md            # 设计支柱(核心设计原则)
├── AGENTS.md             # AI 助手指南
├── specs/                # 已定稿的设计规范
│   ├── game-vision/      # 全局规范(游戏愿景、世界观)
│   │   └── spec.md
│   └── combat-system/    # 功能规范示例
│       └── spec.md
└── changes/              # 设计变更提案
    ├── add-equipment-system/
    │   ├── proposal.md   # 为什么需要这个变更
    │   ├── design.md     # 设计决策(数值框架等)
    │   ├── tasks.md      # 设计任务清单
    │   └── specs/
    │       └── equipment-system/
    │           └── spec.md
    └── archive/          # 已归档的变更

docs/                     # 设计产物输出目录
├── combat-system/
│   ├── gameplay-design.md      # 玩法设计
│   ├── numerical-framework.md  # 数值框架
│   └── balance-analysis.md     # 平衡分析
└── equipment-system/
    └── ...

Schema 系统

OGD 使用 Schema 定义工作流程。默认使用 spec-driven Schema。

查看可用 Schema:

ogd schemas

使用自定义 Schema 创建变更:

ogd new change my-feature --schema custom

贡献

欢迎提交 Issue 和 Pull Request!

许可证

MIT License - 参见 LICENSE 文件。

致谢

本项目基于 OpenSpec 开发,感谢 Fission AI 团队的出色工作。

About

Spec-driven development (SDD) for AI game design assistants.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.8%
  • Other 1.2%