Table of Contents

Tools Overview

All tools live under the Pixel Engine / menu in Unity.


Menu Path What It Does Files Affected
Pixel Engine / Setup All Runs both setup steps below in sequence Folders + templates
Pixel Engine / Setup Project Structure Creates standard project folders Assets/Scripts/, Assets/Prefabs/, etc.
Pixel Engine / Install Script Templates Writes Module + Component .cs.txt templates Assets/ScriptTemplates/
Pixel Engine / Generate Module Generates a plain C# module from name User-selected folder
Pixel Engine / Generate Module Component Generates a MonoBehaviour module from name User-selected folder

Architecture interfaces (IConfiguration, IReference, IState, IComponents, IView, IFrame) ship with the package -- no generation menu needed. See Architecture Interfaces.


Setup All -- Quick Start

Run Pixel Engine / Setup All once on a fresh project. It:

  1. Creates folder structure
  2. Installs script templates (restart Unity to see them in Create menu)

Folder Structure Created

Assets/
  Scripts/
    Runtime/
    Editor/
  ScriptTemplates/
  Prefabs/
  ScriptableObjects/
  Art/
  Audio/
  Scenes/

Script Templates Installed

File Menu Generates
81a-C# Module-NewModule.cs.txt Create > C# Module Plain C# module with Module Pattern
81b-C# Module Component-NewModuleComponent.cs.txt Create > C# Module Component MonoBehaviour module with Module Pattern

See Script Templates for template details.


Module Generator

The generator creates modules from a dialog prompt instead of the Create menu. Useful for batch generation or custom editor tooling.

  • Pixel Engine / Generate Module -- plain C# module
  • Pixel Engine / Generate Module Component -- MonoBehaviour module

Both generate the Module Pattern. See Module Generator for programmatic usage.


Source Files

File Location
ProjectSetupTool.cs Editor/ProjectSetupTool.cs
ModuleGenerator.cs Editor/ModuleGenerator.cs

Both are in the PixelEngine.Editor namespace, editor-only assembly.