Files
UnityAI/rules/00-项目概览.md

2.4 KiB
Raw Blame History

项目概览

定位

UnityAI 是 StrayFog 框架的通用知识库和工作流标准,服务 AI 工具、业务开发人员与框架维护人员。本仓库不保存完整游戏业务代码,具体结论必须结合接入的 Unity 项目验证。

  • 通用标准仓库:UnityAI
  • 当前已验证接入项目:FFCard_WeChat
  • 文档语言:中文
  • 适用范围:使用 StrayFog 框架的 Unity 项目

接入项目用于验证目录、接口、生成流程和平台行为,但项目专有实现不应被写成所有项目都必须遵守的框架规则。新增项目时应先读取其真实目录、Unity 版本与 Git 状态,不沿用其他项目的路径假设。

目录

目录 用途
ai/ AI 工具统一接入入口
rules/ 架构、开发、工作流、文档同步和扫描规则
modules/frameworks/ StrayFog 模块架构与使用文档
business-reference/ 外部项目业务案例,只作参考
hooks/ 只读工作流检查和提交检查
Tools/ MCP Server 等可执行工具

本仓库不建立独立的需求方案、阶段进度或任务清单目录。重大变更在对话中确认,稳定结论直接进入模块文档。

使用方式

AI 工具

  1. 读取 AI 接入入口。
  2. 读取 项目规则入口 和 工作流清单。
  3. 从 模块索引 读取任务相关模块。
  4. 读取目标 Unity 项目的真实代码、Prefab、配置和日志后再得出结论。

人工开发者

  1. 从 架构说明 了解源码和生成代码边界。
  2. 从 开发规则 了解编码、资源和生成约束。
  3. 从具体模块 README 和使用指南查找接口与数据流。

文档原则

  • rules/ 保存跨模块标准。
  • modules/ 保存模块长期知识。
  • 一个事实只在一处完整定义,其他文档通过链接引用。
  • business-reference/ 不能反向定义框架规范。
  • 当前工程的临时排错过程不进入长期文档。

文档关联

文档 关联原因
项目规则入口 项目规则总入口
架构说明 代码分层和项目边界
模块索引 框架知识总入口
AI 工具扫描范围 扫描范围和忽略目录