project-adopt

Generates project documentation by scanning existing Unity codebase structure and configs.

Updated Apr 27, 2024
One-click install
npx skills add https://github.com/IgorGribowsky/rts-sandbox --skill project-adopt-igorgribowsky
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-adopt
Source: https://github.com/IgorGribowsky/rts-sandbox/tree/main/rts-sandbox-src/.claude/skills/project-adopt
Command: npx skills add https://github.com/IgorGribowsky/rts-sandbox --skill project-adopt-igorgribowsky

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When adopting a documentation pipeline on a project that was already built without one, there is no source of truth except the code itself. This Skill reverse-engineers documentation from an existing Unity project without modifying anything, so the pipeline starts from facts rather than guesses. ## Core Features & Use Cases - Code-to-docs scanning: Reads ProjectSettings, manifest.json, the Assets/ tree, script filenames, and ScriptableObject configs in a cheap-to-expensive order to map systems without burning context. - Mechanics documentation: Creates one doc per discovered system in docs/mechanics/ with status implemented and actual numbers read from configs, describing how things work now rather than how they should. - Backlog generation: Converts found TODOs, unfinished systems, and placeholders into backlog tasks, marking AI-discovered items with origin: ai and design-blocking ones with needs-design. - Use Case: You have a half-finished Unity RTS with no docs. Run /adopt once to get a project map, per-system mechanics docs with real balance numbers, a backlog of unfinished work, and a batched list of questions about vision and scope that code cannot answer. ## Quick Start Run the /adopt command to scan this existing Unity project and generate its documentation and backlog from the code.

Frequently Asked Questions about project-adopt

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document an existing Unity project that has no docs?

Scan from cheap to expensive sources: ProjectSettings and manifest.json for the stack, the Assets folder tree for structure, script filenames for system candidates, then targeted reading of key files and ScriptableObject configs. Write one doc per discovered system describing how it actually works.

What is the correct order to scan a Unity codebase for documentation?

Start with ProjectSettings and Packages/manifest.json, then the Assets directory tree and scene list, then script filenames to draft a system list, then targeted reads of key files, and finally ScriptableObject configs which hold the real balance numbers.

Can the adopt process fix issues it finds in the code?

No. The adopt mode is strictly read-only: it never fixes, refactors, renames, or changes settings. Everything worth fixing becomes a backlog task instead, so the first pipeline experience is not the AI rewriting the project.

Should I enable Force Text serialization in Unity Project Settings?

Force Text makes diffs reviewable and rollbacks meaningful, but switching it on a live project rewrites all scenes and prefabs in one huge commit. The skill only reports the setting and its consequences; the decision and timing stay with the user.

What questions should be asked when adopting a project pipeline?

Ask only what code cannot reveal: the intended feel and reference game, the nearest milestone, which found systems are unfinished versus deliberately dropped, which placeholders are temporary, and target platforms. Ask in one batch after reading the code, not before.