ZionGames Docs

Home / Zion Modules / Zion Console Menu

🎮 Zion Console Menu

A complete, controller-ready UI Toolkit menu foundation for Unity 6.

Overview Getting Started User Guide Game Flow Save Integration Troubleshooting

Getting Started

Use this workflow for the first installation of Zion Console Menu.

Setup Video

Watch the complete Zion Console Menu setup and runtime walkthrough before starting the installation steps below.

Open the Zion Console Menu setup video on YouTube →

Back up your project first. Import the package into a source-controlled project or create a manual backup before changing an existing production scene.

1. Check the Requirements

  • Unity 6
  • Unity UI Toolkit
  • Unity New Input System
  • Active Input Handling set to the New Input System

2. Import the Package

  1. Open the target Unity project.
  2. Import the Zion Console Menu package.
  3. Allow Unity to compile all scripts.
  4. Resolve any compile errors before continuing.

3. Open the Setup Wizard

Tools > Zion Console Menu > Setup Wizard

Open the scene that will contain the menu system before generating any objects.

4. Assign or Locate the Required Assets

The Setup Wizard can locate many project assets automatically. Confirm the following references before generating the setup:

  • Panel Settings
  • Main Menu UXML
  • Pause Menu UXML
  • Settings UXML
  • Controls UXML
  • Credits UXML
  • Loading-screen UXML
  • Input Action Asset
  • AudioMixer

5. Generate the Scene Setup

Press the Setup Wizard button that generates missing objects and connects safe references.

Review every generated object before saving the scene.

6. Run Full Validation

Run the built-in diagnostics after generation.

  • Resolve red errors before entering Play Mode.
  • Review warnings and confirm whether they apply to your project.
  • Copy the diagnostic report when requesting support.

Recommended UIDocument Sort Orders

UIDocument Recommended sort order
Menu screens 0
Input prompts 50
Loading screen 75
Virtual cursor 100

Every Zion Console Menu UIDocument should normally use the same Panel Settings asset.

Required Input Actions

  • UI/Navigate
  • UI/Submit
  • UI/Cancel
  • Optional: Player/Pause or UI/Pause
The EventSystem InputSystemUIInputModule and ZionInputRebindService must reference the same physical Input Action Asset.

First Play-Mode Test

  1. Confirm the Main Menu opens.
  2. Open Settings and return to the Main Menu.
  3. Open Credits and test controller scrolling.
  4. Start a game or test the New Game event.
  5. Open the Pause Menu.
  6. Confirm gameplay pauses.
  7. Open Settings from Pause.
  8. Return to Pause without resuming gameplay.
  9. Resume and confirm time is restored.
  10. Change audio and display settings.
  11. Rebind one control and restart Play Mode.
  12. Confirm the binding override persists.
Next: read the User Guide .