uw-unity-feature-scaffold

Unity Feature Scaffold

Generate a feature module with folders, assembly definitions, and a starter class based on docs/ProjectConfig.yaml.

Before You Start

1. Read docs/ProjectConfig.yaml for:
   • project_name — derive root namespace by converting to PascalCase (e.g., "my cool game" → MyCoolGame)
   • folder_strategy — "feature-based" or "type-based"
   • architecture_pattern — "so-first" or "di-first" (informs post-scaffold next steps)
   • mcp.unity_mcp — if true, call refresh_unity after creating files
2. Ask the user for the feature name (PascalCase, e.g., Combat, PlayerMovement, Inventory).
3. Derive the namespace: {RootNamespace}.{FeatureName} (e.g., MyCoolGame.Combat).
4. Confirm the namespace with the user before generating files.

Folder Structures

Feature-based (folder_strategy: "feature-based"):

Assets/_Project/Features/{FeatureName}/
├── Scripts/
│   ├── {RootNamespace}.{FeatureName}.asmdef
│   └── {FeatureName}Manager.cs
├── Data/
└── Tests/
    └── {RootNamespace}.{FeatureName}.Tests.asmdef

Type-based (folder_strategy: "type-based"):

Assets/_Project/Scripts/{FeatureName}/
├── {RootNamespace}.{FeatureName}.asmdef
└── {FeatureName}Manager.cs
Assets/_Project/Tests/{FeatureName}/
└── {RootNamespace}.{FeatureName}.Tests.asmdef

Assembly Definition Templates

Feature asmdef

File: {RootNamespace}.{FeatureName}.asmdef

{
    "name": "{RootNamespace}.{FeatureName}",
    "rootNamespace": "{RootNamespace}.{FeatureName}",
    "references": [
        "GUID:{CoreAsmdefGUID}"
    ],
    "includePlatforms": [],
    "excludePlatforms": [],
    "allowUnsafeCode": false,
    "overrideReferences": false,
    "precompiledReferences": [],
    "autoReferenced": true,
    "defineConstraints": [],
    "versionDefines": [],
    "noEngineReferences": false
}

Test asmdef

File: {RootNamespace}.{FeatureName}.Tests.asmdef

{
    "name": "{RootNamespace}.{FeatureName}.Tests",
    "rootNamespace": "{RootNamespace}.{FeatureName}.Tests",
    "references": [
        "GUID:{FeatureAsmdefGUID}",
        "UnityEngine.TestRunner",
        "UnityEditor.TestRunner"
    ],
    "includePlatforms": [
        "Editor"
    ],
    "excludePlatforms": [],
    "allowUnsafeCode": false,
    "overrideReferences": true,
    "precompiledReferences": [
        "nunit.framework.dll"
    ],
    "autoReferenced": false,
    "defineConstraints": [
        "UNITY_INCLUDE_TESTS"
    ],
    "versionDefines": [],
    "noEngineReferences": false
}