ZionGames Docs

Home / Zion Modules / Zion Console Menu

๐ŸŽฎ Zion Console Menu

Version 1.1.0 โ€” a complete, controller-ready UI Toolkit menu foundation for Unity 6.

Getting Started

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

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; Version 1.1.0 has been tested with Unity 6.0, 6.3 and 6.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
  • Save Game UXML
  • Load Game UXML
  • Confirmation Dialog 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.

Confirm that the generated setup includes:

  • SaveMenu registered with Screen Id save
  • LoadMenu registered with Screen Id load
  • A reusable Confirmation Dialog using the shared Panel Settings

6. Assign the Save/Load Provider

Assign the same component implementing IZionSaveSlotProvider to Provider Source on both SaveMenu and LoadMenu. This keeps both screens synchronized with the same slot state.

When the Demo folder is installed and no provider exists, Generate Missing Setup can create Demo Save Provider (Demo Only) and connect it to both screens for immediate testing.

The demo provider is not a production save system. It uses three PlayerPrefs-backed test slots to demonstrate Save, Load, Delete and Continue availability. Replace it with your own IZionSaveSlotProvider implementation for production.

7. 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
Confirmation Dialog 90
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. Confirm Quit, Return to Main Menu and Reset to Defaults open confirmation dialogs.
  10. Cancel each dialog with B or Escape and confirm focus returns to the originating control.
  11. Confirm destructive dialogs focus Cancel first.
  12. Open Save Game from Pause and confirm all three demo slots populate.
  13. Save into an empty slot, then confirm saving over it requests overwrite confirmation.
  14. Open Load Game and confirm empty slots cannot load or delete.
  15. Delete an occupied slot and confirm a destructive confirmation appears.
  16. Confirm Save and Delete refresh the slot display and Continue availability.
  17. Resume and confirm time is restored.
  18. Change audio and display settings.
  19. Rebind one control and restart Play Mode.
  20. Confirm the binding override persists.