ORK 4 RPG Framework Logo
  • ORK 4 GUIDE
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 GUIDE
    • Documentation
    • Tutorials
    • API
  • Support
  • Forum
  • Get ORK

ORK 4 Documentation

  • Getting Started
    • Welcome
    • First Steps (Unity)
  • Features
    • The Status System
    • Schematics
    • Schematic Nodes
    • Dialogue Importer
    • Variables
    • Selected Data
  • Components
    • Battle Components
    • Combatant Components
    • Control Components
    • Cursor Prefab Components
    • Game Starters
    • Interactable Components
    • Move AI Components
    • Scene Setup Components
  • Editor
    • The ORK 4 Editor
    • Sections & Sub-Sections
    • Node Editor
    • Schematic Editor
    • Asset Sources
    • Unity Overlay Toolbar
  • Section: System
    • System Settings
    • Languages
    • Organizer Types
    • Game States & Conditions
    • General Condition Templates
    • Object Pools
    • Prefab Savers
    • Scene Connections
  • Section: Controls
    • Game Controls
    • Interaction Settings
    • Player Controls
    • Camera Controls
    • Input Keys
    • Control Maps
    • Camera Positions
    • Battle Camera
  • Section: Gameplay
    • Game Settings
    • Formulas
    • Difficulties
    • Shortcut Slots & Settings
    • Custom Settings & Global Custom Settings
    • Global Machines
    • Machine Templates
  • Section: Status
    • Status Values
    • Status Effects
    • Attack Modifiers
    • Defence Modifiers
    • Abilities & Ability Developments
    • Status Developments
    • Research Trees
    • Damage Types
    • Status Bonuses & Templates
    • Status Condition Templates
  • Section: Inventory
    • Inventory Settings
    • Inventory Containers
    • Currencies
    • Items
    • AI Rulesets
    • Crafting Recipes
    • Equipment Slots & Slot Set Templates
    • Equipment & Available Equipment Templates
    • Shops
    • Loot
  • Section: Combatants
    • Combatants
    • Combatant Groups
    • Class Slots
    • Classes
    • Factions & Faction Benefits
    • Animations
    • Move AIs
    • Formations
    • Action Combos
  • Section: Battles
    • Battle Systems
    • Turn Based Battles
    • Active Time Battles
    • Real Time Battles
    • Phase Battles
    • Battle Spots
    • Battle AIs
    • Battle Actions Settings
    • Special Commands Settings
    • Target Settings
    • Target Selection Templates
    • Battle Range Templates
    • Battle Grid Settings
    • Battle Grid Highlights
    • Battle Grid Cell Types
    • Battle Grid Formations
  • Section: Content
    • Content Types
    • Music
    • Sound Templates
    • Areas
    • Teleports
    • Quests & Quest Tasks
    • Logs & Log Texts
    • Object Contents
  • Section: UI
    • UI Settings
    • UI Layers
    • UI Layouts
    • UI Boxes
    • HUDs
    • Notifications
    • Cursor Settings
  • Section: Menus
    • Start Menu
    • Save Game Settings
    • Option Categories
    • Menu Screens
    • Menu Requirements
    • Battle Menus
    • Loot Dialogues
    • Item Collection
    • Combatant Selections
    • Quantity Selections
    • Shop Layouts
  • Section: Texts
    • Text Settings
    • Formatting Settings
    • Flying Texts
    • Use Cost Display
    • Status Preview Display
    • Bonus Display
    • Status Change Display
    • Console Settings & Console Types
    • Text Codes
  • Sections: Editor
    • Editor Settings
    • Backups
    • Variables
    • Plugins
  • Scripting
    • Access Handler
    • Custom Nodes
    • Custom Save Data
    • Custom Component Save Data

ORK 4 Tutorials

  • ORK 4 Unity Quickstart Tutorials (3D)
    • ORK 4 Unity Quickstart 3D
    • 01 Initial ORK Setup
    • 02 Player Setup
    • 03 Music & Scenes
    • 04 UI System Setup
    • 05 UI Boxes
    • 06 Flying Texts
    • 07 Status Values
    • 08 Status Effects
    • 09 First Abilities
    • 10 Fighter Setup
    • 11 First Enemies & Battle AI
    • 12 Battle System Setup
    • 13 Animating Battle Start and End
    • 14 Random Battles
    • 15 Animating Actions
    • 16 Player Battle HUD
    • 17 Elemental Attacks
    • 18 Animating More Actions
    • 19 Inventory & Loot
    • 20 Equipment
    • 21 Loot, Start Equipment & Viewers
    • 22 Magic Abilities
    • 23 Caster Setup
    • 24 More Enemies
    • 25 Start Menu & Save Games
    • 26 Menu Screens
    • 27 Interactions
    • 28 Item Collectors
    • Quickstart Extended
  • Battle Tutorials
    • Active Time Battles
    • Phase Battles
    • Real TT 01 Real Time Battles & Tab Targeting
    • Real TT 02 Control Map, Use Ranges & Battle Area
    • Real TT 03 Camera Control, Battle AI & Reuse Time
    • Real TT 04 Damage Detection, Action Animation & Player HUD
    • Real TT 05 Switch Player & Final Adjustments
    • Hit & Miss
    • Critical Hits
    • Cast Time
    • Reuse Time
    • Grid 01: Battle Grid Setup
    • Grid 02: Highlights
    • Grid 03: Cell Types
    • Grid 04: Move Command
    • Grid 05: Scene Grid Setup
    • Grid 06: Battle Ready
    • Grid 07 Use & Affect Ranges
    • Grid 08: Better Camera Control
  • Gameplay Tutorials
    • Multiple Interaction Controllers
    • Player Group Spawn & Follow
    • Spawn Hunting Enemies
    • Gamepad Controls (Unity Input System)
    • Combined Inputs
    • Control Map for Keyboard (Shortcuts)
    • Control Map for Gamepad (Shortcuts)
    • Quests 01: Menu Screen
    • Quests 02: Hunting
    • Quests 03: Collect Potion Materials
    • Quests 04: Collect Equipment Materials
    • Quests 05: Quest Mark HUDs
    • Crafting 01: Menu Screen
    • Crafting 02: Materials & Recipes
    • Crafting 03: Getting Materials
    • Crafting 04: Proficiency & Critical Outcome
    • Shop
    • Inventory Containers
  • Schematics Tutorials
    • UI Animation Schematics
    • Flying Text Animation Schematics
    • HUD Conditional Schematics
  • UI Tutorials
    • Unity UI: Initial Setup
    • Unity UI: Status Value UI Setup
    • Unity UI: Status Effect UI Setup
    • Unity UI: Shortcut UI Setup
    • Unity UI: Dragging Notification
    • Unity UI: Interaction HUD
    • Unity UI: Shortcut HUD
    • Unity UI: Turn Order HUD
    • Unity UI: Cast Time HUD
    • Unity UI: Quest HUD
    • Unity UI: Tooltip HUD
    • Unity UI: Move Range HUD
    • Menus 01 UI Box Setup
    • Menus 02 Template HUDs
    • Menus 03 Menu Setup
    • Menus 04 Main Menu
    • Menus 05 Inventory
    • Menus 06 Equipment
    • Menus 07 Ability
    • Menus 08 Group
    • Menus 09 Quest
    • Menus 10 Crafting
  • Module 01: Status System
    • Introduction to Modular Tutorials
    • M01.1: Status Values
      • Introduction to Status Values
      • Health
      • Mana
      • Barrier
      • Base Experience
      • Class Experience
      • Spendable Experience
      • Normal Stats
    • M01.2: Modifiers
      • Introduction to Modifiers
      • Element
      • Attack Type
      • Size
      • Race
    • M01.3: Status Effects
      • Introduction to Status Effects
      • Buffs
      • Debuffs
      • Poison
      • Regeneration
      • Blind
      • Stun
      • Sleep
      • Silence
      • Enchants
      • Charm
      • Doom
      • Reflect
  • Module 02: Actions
    • Introduction to Actions
    • M02.1: Formulas
      • Introduction to Formulas
      • Physical Damage Formula
      • Magical Damage Formula
      • Hit Chance
      • Critical Chance
    • M02.2: Abilities
      • Introduction to Abilities
      • Base Attack
      • Elemental Magic Spells
      • Steal Ability
      • Drain
      • Healing Spell
      • Cure
      • Buff Abilities
      • Debuff Abilities

ORK 4 Extensions

  • Plugins
    • Save Game Compression Plugin
  • Schematic Nodes
    • Footstepper Nodes (Unity)
  • Scripts
    • A* Pathfinding Movement Component (Unity)
    • PolyNav 2D Movement Component (Unity)
    • Cinemachine Camera Control Type (Unity)
    • Rewired Input Key (Unity)
    • Unity Legacy Input Key (Unity)
    • Core GameKit Wrapper (Unity)
    • Pool Boss Wrapper (Unity)
View Categories
  • Guide
  • ORK 4
  • ORK 4 Tutorials
  • UI Tutorials

Menus 04 Main Menu

0:00 / 5:56
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)

In this tutorial we’ll set up the main menu screen.

This tutorial is part 4 of a mini-series covering menu screens. You can find the start of this series here.

We’ll set up the Main menu screen, i.e. the menu screen that’ll we called via the Menu input key. The main menu will act as a menu navigation, calling the other menus, showing the information of all player group members and another information box with the current area, game time and currency in the player’s inventory.

This tutorial is based on the ORK 4 Unity Quickstart 3D tutorials, but can be used in any project.

Main Menu Screen #

Open the ORK editor and navigate to Menus > Menu Screens, we’ll add a new menu screen. If you haven’t set up a menu screen yet, you can also change the Default one.

  • Name
    Set to: Main Menu

Settings #

  • Remember Selection
    Enable
  • Single Screen
    Enable
    The menu screen can only be displayed alone instead of combined with other screens.
    This is the default setup for new menu screens.

We’ll set up our menus to block showing notifications or flying texts, e.g. using an item or healing magic in the menu will not show flying texts.

  • Pause Notifications
    Enable
    Already displayed notifications will be paused and hidden.
  • Block Notifications
    Enable
  • Block Flying Texts
    Enable

We’ll also pause the game.

  • Pause Game
    Enable
  • Freeze Pause
    Enable
    This’ll set the time scale to 0, halting all animation and other time-related functionality.

Settings > Call Screen Key #

Beside using a call key, we’ll also play a sound when opening the menu using the key.

  • Use Call Key
    Enable
  • Input Key
    Select: Menu
  • Audio Type
    Select: Custom
  • Audio Asset
    Select: chainmail1

You can optionally use a Menu Requirement to limit the menu call to certain conditions. However, menu screens can only be called when the player can be controlled, so that’s enough for now.

In case you’ve set up the menu screens of the quickstart 3D tutorials, make sure to disable using the call key in the original Overview menu screen that was set up in the tutorials.

Button List Part #

With our base setup of the menu screen done, we can start adding menu screen parts to it. A part adds specific functionality to the menu, e.g. Inventory part will add an inventory menu.

The Button List part is used to display multiple buttons, each having different functionality – e.g. we’ll add buttons to close the menu, open other menu screens (in the next tutorials) or exit the game.

Scroll down to the bottom of the settings to see the Add Menu Part button.

Click on the Add Menu Part button and select Button List.

  • UI Box
    Select: Blue Top Right Fit

Click on Add Menu Item to add a button to the part.

  • Type
    Select: Close
  • Text (Button Content)
    Set to: Close

Click on Add Menu Item.

  • Type
    Select: Save
  • Text (Button Content)
    Set to: Save

Click on Add Menu Item.

  • Type
    Select: Exit Game
  • Show Exit Question
    Enable
  • Text (Button Content)
    Set to: Exit Game

We’ll add new buttons for each menu screen we’ll add to the system.

Combatant Part #

The Combatant part is used to display information of one or multiple combatants. When displaying multiple, each combatant will be displayed using an input (button).

Scroll down to the bottom of the settings to see the Add Menu Part button.

Click on the Add Menu Part button and select Combatant.

  • UI Box
    Select: Blue Menu Center Scroll
  • Combatant Scope
    Select: Group Battle Sorted
    This’ll show all group members, but lists the battle group members first.
  • Custom Input Prefab
    Select: Empty Button

Entry Page 0 #

The Combatant part can show multiple pages of information, e.g. to create a status information menu, cycling through various content.

We’ll just use one page, so change the settings of the already added Entry Page 0.

  • Add HUD
    Enable
  • HUD
    Select: Template: Combatant Information EXP

Information Part #

The Information part is used to display any kind of information. We’ll use it to show the current area, gold and game time.

Scroll down to the bottom of the settings to see the Add Menu Part button.

Click on the Add Menu Part button and select Information.

  • UI Box
    Select: Blue Bottom Left Fit
  • Auto Update
    Enable
    We’ll display the game time, this’ll periodically update the text for us.
  • Update Every
    Set to: 0.1
    This controls how often the update happens, you can leave it at the default setup.

Information Page 0 #

Like the Combatant part, the Information part can show multiple pages of information.

We’ll just use one page, so change the settings of the already added Information Page 0.

  • Text (Message Content)
    Set to: <area.current.name><currency.inventory=YOUR_GOLD_GUID> <currency.name=YOUR_GOLD_GUID><time>

Please note that the YOUR_GOLD_GUID is just a placeholder for using your own currency’s GUID, so please use the buttons above the text editor to add that information.

While editing text, click on Data to show all available data that’s set up in the editor.

  • First Dropdown
    Select: Currency
  • Second Dropdown
    Select: Gold
  • Third Dropdown
    Select: In Inventory

Click on Add to add the In Inventory text code for gold.

  • Third Dropdow
    Select: Name

Click on Add to add the Name text code for gold.

Tip!

You can also change the GUIDs of your data by using the edit buttons beside the GUID information at the top of their settings.

And with that, our first menu screen is completed.

Save Changes #

And that’s it!

Don’t forget to save your changes by clicking on Save Settings at the bottom of the editor.

Testing #

Hit play and use the Menu input key to call the main menu.

The main menu works, we can’t do much yet, though.

Also, if you haven’t added areas to your game yet (e.g. the quickstar 3D tutorials don’t add them), the current area text code will be replaced by an empty text, so no information is shown.

The next part of the menus mini-series will set up the inventory menu screen.

Table of Contents
  • Main Menu Screen
    • Settings
    • Settings > Call Screen Key
    • Button List Part
    • Combatant Part
      • Entry Page 0
    • Information Part
      • Information Page 0
  • Save Changes
  • Testing
Sitemap
  • Showcase
  • ORK 4 Guide
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 Guide
    • Documentation
    • Tutorials
    • API
  • ORK 2 Hub
    • Tutorials
    • Plugins
    • API
  • Support
  • Forum
  • Get ORK
  • Contact
  • Blog
  • Makinom
  • gamingislove.com
Categories
  • News (75)
  • ORK 2 (137)
    • Tutorial (137)
      • Game tutorial (50)
      • Gameplay (32)
      • How-to (55)
  • Release (158)
Search

© 2015 Gaming is Love e.U.

Disclosure: This site may contain affiliate links, which means I may receive a commission if you click a link and purchase something that I have recommended. While clicking these links won’t cost you any money, they will help me fund my development projects while recommending great assets!