Mother DocsMother Docs
Buy me a Coffee
Steam Workshop
Discord
  • Mother OS (Ingame Script)
  • Mother GUI
  • Mother Autopilot System (MAPS)
  • Mother Core (Script Framework)
  • Cheatsheet
  • Brand Guidelines
Buy me a Coffee
Steam Workshop
Discord
  • Mother OS (Ingame Script)
  • Mother GUI
  • Mother Autopilot System (MAPS)
  • Mother Core (Script Framework)
  • Cheatsheet
  • Brand Guidelines
  • Cheatsheet
  • Mother OS (Ingame Script)
    • Getting Started

      • Upgrade Guide
      • Installation
      • Command Line Interface (CLI)
      • Configuration
      • Modules
    • Core Modules

      • Activity Monitor
      • Almanac
      • Block Catalogue
      • Intergrid Message Service
      • Local Storage
      • Merge Block Module
    • Extension Modules

      • Air Vent Module
      • Battery Module
      • Terminal Block Module
      • Cockpit Module
      • Connector Module
      • Display Module
      • Door Module
      • Gas Tank Module
      • Hinge Module
      • Landing Gear Module
      • Light Module
      • Piston Module
      • Programmable Block Module
      • Rotor Module
      • Screen Module
      • Sensor Module
      • Sorter Module
      • Sound Block Module
      • Thruster Module
      • Timer Block Module
      • Wheel Module
    • Compatibility
    • Examples
  • Mother GUI
    • Getting Started

      • Installation
      • Configuration
    • Commands
    • Menus
    • Views
  • Mother Autopilot System (MAPS)
    • Getting Started

      • Upgrade Guide
      • Installation
    • Modules

      • Flight Planning Module
      • Map Module
      • Flight Control Module
      • Attitude Module
      • Docking Module
  • Mother Core (Script Framework)
    • Getting Started

      • Upgrade Guide
      • Installation
      • Architecture Overview
      • Managing Script Size & Complexity
    • Building A Module
    • Mother CLI (Console)
    • Core Modules
      • Activity Monitor
      • Almanac
      • Block Catalogue
      • Clock
      • Command Bus
      • Configuration
      • Event Bus
      • Intergrid Message Service
      • Local Storage
      • Log
      • Terminal
    • Utilities

      • Color Helper
      • Number Helper
      • Security
      • Serializer
    • Tutorials
  • Powered By Mother
  • Brand Guidelines

Installation

  • Prerequisites
  • Setup
    • 1. Load Mother GUI into a programmable block
    • 2. Rename the programmable block
    • 3. Configure a display surface
    • 4. Add a menu definition
    • 5. Recompile or run the script
  • First Check

Prerequisites

To run Mother GUI, your grid should have:

  1. A programmable block with the Mother GUI script loaded.
  2. At least one screen-capable block you want Mother GUI to control.

Supported display targets include:

  • LCD panels and other text panels
  • Cockpit surfaces
  • Programmable block surfaces
  • Sound block surfaces

Setup

1. Load Mother GUI into a programmable block

Open a programmable block, select Edit, and choose the Mother GUI script from the script list.

2. Rename the programmable block

Give the block a clear name such as Mother GUI. This makes the block easier to find later when you are editing Custom Data or linking commands.

3. Configure a display surface

Open the Custom Data for the block that owns the surface you want to use and add a [surfaces] section.

Bridge LCD > Custom Data
[general]
scale=1.15

[surfaces]
0=MainMenu

If you are targeting a cockpit or another block with multiple surfaces, use the correct zero-based surface index.

Flight Seat > Custom Data
[surfaces]
0=MainMenu
1=RotorView "Port Rotor"

4. Add a menu definition

Define your main menu in the Mother GUI programmable block's Custom Data.

Mother GUI > Custom Data
[general]
defaultMenu=MainMenu

[menu:MainMenu]
Mechanical=
.Rotor=view/go self "RotorView" "Port Rotor"
.Piston=view/go self "PistonView" "Lift Piston"
.Door=view/go self "DoorView" "Hangar Door"

5. Recompile or run the script

After saving your changes, recompile the programmable block or run boot if needed. Mother GUI will rediscover configured displays and render the initial menu or view.

First Check

After setup, confirm that:

  1. Your target screen shows a Mother GUI menu or view.
  2. The programmable block compiles without errors.
  3. Menu entries that use view/go self ... open the expected view on the same display.

The next step is learning how Mother GUI reads Custom Data and how to structure menus and surfaces cleanly.

Last Updated: 5/12/26, 1:43 AM
Contributors: lukejamesmorrison
Next
Configuration