Mother DocsMother Docs
Buy me a Coffee
Steam Workshop
Discord
  • Mother OS (Ingame Script)
Buy me a Coffee
Steam Workshop
Discord
  • Mother OS (Ingame Script)
  • Mother OS (Ingame Script)
    • Getting Started

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

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

      • Air Vent Module
      • Battery Module
      • Terminal Block Module
      • Cockpit Module
      • Connector Module
      • Display Module
      • Docking Module
      • Door Module
      • Flight Control Module
      • Gas Tank Module
      • Gyroscope Module
      • Hinge Module
      • Landing Gear Module
      • Light Module
      • Flight Planning Module
      • Piston Module
      • Programmable Block Module
      • Rotor Module
      • Sensor Module
      • Sound Block Module
      • Thruster Module
      • Timer Block Module
    • Command Cheatsheet
    • Compatibility
    • Examples
  • Powered By Mother

Almanac

Mother maintains a list of all grids in the world running Mother that are connected via an antenna network. The Almanac is used to track grid locations, status, and other information. It is automatically generated during boot, and updates as a result of certain interactions with other grids.

Note

Grids running Mother will periodically communicate, at which time the Almanac is updated with details specific to each grid.

To immediately refresh the Almanac, you can run the ping command.

Flight Plan Map

Why Do We Have It?

In order for grids to interoperate seamlessly, it is important for them to store key information about each other. This includes properties like their id, position and speed. Other modules can make use of this for secure communication, and sending remote commands.

Viewing the Map

Mother can render a map showing all grids and waypoints in the Almanac. Simply add [MMAP] to the end of your LCD name and Recompile Mother. The projection will automatically update.

You can target individual cockpit screens by targeting a screen index - [MMAP:1].

Almanac LCD

Configuration

KeyValueDescription
mapScaledecimalSet the map scale in meters. Defaults to 100m.
centerstringThe point that the map should center on. You can use the full GPS string, the X,Y,Z portions of a GPS string, or use the name of a grid/waypoint if present in the Almanac.
mode2D, 3DWhether the map should render in 2D or 3D.

NOTE: 3D map rendering is experimental and will change in future updates.

Example

LCD > Custom Data
[general]
mapScale=150

; full GPS String or;
center=GPS:Mothership:227039.09:226939.44:227134.75:#FF75C9F1:
; partial GPS String or;
center=227039.09:226939.44:227134.75
; grid name
center=Mothership

; render mode
mode=2D

Storing Information

By default, the Almanac uses LocalStorage to ensure the positions and information of grids and waypoints are not lost when Mother encounters an error, or the script is reloaded/recompiled. This means that the Almanac is persistent across reboots of the Programmable Block, preventing the loss of important data over time.

Last Updated:: 4/7/25, 8:09 PM
Contributors: Luke Morrison
Prev
Activity Monitor
Next
Block Catalogue