Shell Modules

Reference pages for src/shell/ — the front-end/main-menu build of the engine (attract mode, splash screens, the online server browser, load screens) as opposed to Resident Modules’ in-game HUD context.

Status: new, first pass from static source reading only. Not confirmed by playing the game yet.

22 of these 28 files are byte-for-byte identical to an already-documented Resident Modules page — verified by hash comparison, not just similar-looking. Rather than duplicate those pages (and risk the two descriptions silently drifting apart from each other later), each identical file gets a short pointer page here noting its shell-context caller and linking to the existing Resident Modules page for the actual documentation. Only the 6 true shell-only files get the full Overview/Inheritance/Instance pattern/Functions/Events/Notes treatment:

• shell — the literal entry stub.
• ShellBootstrap — splash screens, auto-connect/auto-load branching, main-menu hand-off.
• MrxShellBootstrap — a small GUI-loaded readiness gate.
• MrxGui_ShellOnly — the shell’s own facade over MrxGuiBase (screen fades, a HUD-message stub).
• MrxGuiBootstrap_ShellOnly — the shell’s stubbed-out counterpart to resident/mrxguibootstrap (same function names, empty bodies — there’s no gameplay HUD to manage from the main menu).
• MrxSoundShellBootstrap — audio ducking/fade categories and music-cue bindings for the front end.

Given the small size (28 files total, most of them one-paragraph pointers) this section stays a flat list rather than splitting into further categories — use the sidebar or the search bar to find a specific module.

Modules in this category

• MrxGui — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGui_ShellOnly — A facade module that imports MrxGuiBase and re-exposes a large chunk of its widget API as flat globals (AddWidget, Widget, ImageWidget, GetWidgetByName, etc.), wired up in Init().
• MrxGuiAttractLayout — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiAttractMode — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiBase — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiBootstrap_ShellOnly — The shell build’s counterpart to MrxGuiBootstrap: same function names (ToggleHud, CreatePlayerHud, DeleteHud, DeleteAllHuds, SetSatelliteOverlay, SetOnGuiLoadedFunc), but every one of them is an empty stub here.
• MrxGuiCinematic — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiCinematicLayout — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiDialogBox — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiLoadLayout — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiLoadScreen — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiLTIPrecache — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiLtiPrecacheLayout — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiManager — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiNumericBox — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• mrxguishell — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiShellBootstrap — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxGuiShellLayout — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxMultipageMenu — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxMusic — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxShellBootstrap — A small readiness-gate module that tracks whether the shell’s GUI has finished loading and whether the local player has joined, so a caller can be notified once both are true.
• MrxSound — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxSoundBanks — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxSoundCategories — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• MrxSoundShellBootstrap — Sets up the front end’s audio: ducking/fade rules for five mix categories, 69 per-faction and per-region music-cue bindings, then calls MrxSound.Initialize().
• MrxUtilShell — Byte-for-byte identical to the linked resident/ module — see below for its shell-context role.
• Shell — Shell is the front-end build’s top-level entry module — the literal script the engine calls into to start the main-menu/attract-mode build, analogous to a level’s master script.
• ShellBootstrap — ShellBootstrap is the front-end build’s top-level startup orchestrator — it plays the EA/Pandemic splash movies, waits on an asset-precache gate, then routes into auto-connect, auto-lobby, auto-server, autoload, or the main menu proper.