Table of Contents

Project Setup

The package ships with editor tools that scaffold your host project. Architecture interfaces ship with the package -- your code references them directly via using PixelEngine.Architecture;.


Menu: Pixel Engine / Setup All

Run this once after importing the package. It creates folders and script templates in your project's Assets/:

Step What It Creates Where
1. Project Structure Standard folders Assets/Scripts/, Assets/Prefabs/, etc.
2. Script Templates Module + Component templates Assets/ScriptTemplates/

Restart Unity after running for script templates to appear in the Create menu.

After running:

YourProject/
  Assets/
    Scripts/
      Runtime/
      Editor/
    ScriptTemplates/
      81a-C# Module-NewModule.cs.txt
      81b-C# Module Component-NewModuleComponent.cs.txt
    Prefabs/
    ScriptableObjects/
    Art/
    Audio/
    Scenes/
  Packages/
    manifest.json

What Lives Where

Location Contains
Package (Packages/com.pixelengine/) Architecture interfaces, editor tools, docs
Your project (Assets/) Script templates, folders, your game code

The interfaces (IConfiguration, IState, IReference, IComponents, IView, IFrame) live in the package under Runtime/Architecture/. Your code references them via using PixelEngine.Architecture; -- no generation needed. See Architecture Interfaces.


Next Steps