adding-a-sim

What problem does it solve?

This tool automates scaffolding a new sim by generating the required folder structure, starter files, and metadata inside src/sims/ so teams can add a game quickly while keeping a consistent architecture.

Core Features & Use Cases

• Auto-creates a self-contained sim folder with standard layout (definition.ts, root Vue component, and per-sim subfolders like components, composables, modules, store, types, assets)
• Provides a ready-to-export definition.ts with id, title, description, icon, status, and dynamic import path
• Ensures auto-discovery via useSimRegistry.ts by scanning src/sims/*/definition.ts
• Guides starting points for sim root component and three recommended subfolders
• Validates naming conventions (lowercase kebab-case id) to ensure compatibility

Quick Start

Create a new folder under src/sims using a lowercase kebab-case id, add a definition.ts exporting the required fields, place the root Vue component, and follow the described folder structure to enable auto-discovery