Installation

This guide walks you through importing MCE into a Unity project and getting it running.

Prerequisites

• Unity 6 LTS (6000.3.8f1 or later) installed via Unity Hub.
• A new project created with the "Universal 2D" or "Universal 3D" template.

Important

Import MCE into a blank project only. Both URP templates include all required compile-time dependencies (URP, Input System, Cinemachine, TextMeshPro, Tilemaps).

Step 1: Import the .unitypackage

1. In Unity: Assets > Import Package > Custom Package.
2. Select the OpenMon_MCE_v1.0.0.unitypackage file.
3. Click Import — import ALL files.
4. Wait for Unity to compile scripts (~30-60 seconds).

Step 2: Automatic Setup (Two Dialogs)

After compilation, two dialogs appear automatically:

Dialog 1: "OpenMon — Install Dependencies"

The PackageDependencyInstaller detects missing UPM packages and offers to install them:

Package	Purpose
com.unity.cinemachine	Battle camera system
com.unity.2d.tilemap.extras	SiblingTile, RuleTile, autotiles
com.unity.2d.sprite	Sprite editor tools (Importer)
com.unity.render-pipelines.universal	URP (usually already present)
com.unity.inputsystem	Input handling (usually already present)

Click "Install All". Unity will install the packages and recompile.

After package installation, TMP Essential Resources (fonts, shaders, sprites) are auto-imported from com.unity.ugui.

How it works

The installer uses [InitializeOnLoad] in an isolated assembly (OpenMon.Setup) with zero external references. It tracks state via a file in Library/ (per-project, not global). If you skip the dialog, use MCE > Setup > Re-check Package Dependencies to retry.

Dialog 2: OpenMon Hub — Setup Status

Open the Hub via MCE > OpenMon Hub (or Ctrl+Shift+H). The Welcome tab shows a GREEN/RED setup status indicator.

If RED, click "Run Full Setup" which runs ProjectQuickSetup:

Configuration	What it does
Custom Layers	Creates BattleElement (6), Camera (7), EvolutionStage (8), MapScreen (9)
Render Pipeline	Sets MCERenderPipelineAsset (2D Renderer) for all quality levels
Build Settings	Adds 48 demo scenes with InitScene at index 0
Player Settings	Sets company name, product name, resolution
TMP Essentials	Imports TextMeshPro resources if not already present

When all checks pass, the indicator turns GREEN.

Manual re-run: MCE > Setup > Run Full Quick Setup

Step 3: Play

1. Open Assets/MCE_DemoGame/ExampleProject/Scenes/InitScene.
2. Press Play.
3. Choose your language, pick a starter monster, and explore!

Included Physical Plugins

MCE bundles two plugins physically in Assets/Plugins/ (not via UPM):

Plugin	Path	Why physical?
TriInspector	Assets/Plugins/TriInspector/	.unitypackage cannot include UPM packages. Without TriInspector, 100+ files fail to compile.
Zenject (Extenject)	Assets/Plugins/MCELibs/	DI framework used throughout the engine. Included as precompiled DLLs.

Do NOT install TriInspector via UPM

If you also install com.codewriter.triinspector from the Package Manager, you will get GUID conflicts (duplicate assembly names). The physical copy is the only supported method.

Project Structure

Assets/
  OpenMon/
    Core/
      Runtime/           # Core engine (battles, monsters, world, saves, UI)
      Editor/            # Editor tools, Hub, Command Palette, Map Editor
      Tests/             # NUnit test suites
      Art/               # Included art assets
      RPSettings/        # URP 2D Renderer configuration
    Foundation/          # Shared framework (DI, audio, localization, toolbar)
    Online/              # Nakama multiplayer layer (optional, requires MCE_ONLINE)
    Importer/            # RPG Maker Essentials import pipeline
    Setup/               # PackageDependencyInstaller + ProjectQuickSetup
  MCE_DemoGame/          # Complete demo project (scenes, regions, NPCs, data)
  Plugins/
    MCELibs/             # Zenject, ExtendedEditor
    TriInspector/        # Inspector attributes (physical, not UPM)
  Resources/             # Runtime-loaded assets (ProjectContext, singletons)

Verify Installation

1. Open the Hub: MCE > OpenMon Hub (Ctrl+Shift+H) — Welcome tab should be GREEN.
2. Open InitScene and press Play — the game should start.
3. Run tests: Window > General > Test Runner > EditMode > Run All — 2100+ tests should pass.
4. Run validator: MCE > DevTools > Validate Export Package — 0 errors, 0 warnings.

Troubleshooting

Issue	Solution
"Install Dependencies" dialog never appeared	MCE > Setup > Re-check Package Dependencies
Hub shows RED setup status	Click "Run Full Setup" button
TriInspector errors (GroupAttribute not found)	Do NOT install TriInspector via UPM — it's already physical in Assets/Plugins/TriInspector/
Battle sprites invisible	Ensure com.unity.2d.sprite is installed (the installer should handle this)
Missing tileset layer	Run MCE > Setup > Configure Layers
TMP text not rendering	Run MCE > Setup > Run Full Quick Setup to import TMP Essentials
Cinemachine errors	Run MCE > Setup > Re-check Package Dependencies

Keyboard Shortcuts

Action	Shortcut
OpenMon Hub	Ctrl+Shift+H
Command Palette	Ctrl+Shift+M
Map Editor: Pencil	B
Map Editor: Eraser	E