CodexBot: Link corresponding classic in-game help section

2026-10-13T04:53:54Z

Link corresponding classic in-game help section

New page

The '''HELP''' command displays Galactic Empire's in-game documentation for commands, game concepts, and ship classes.

== Syntax ==

<syntaxhighlight lang="text">
HELP
HELP subject
HELP CLASS
HELP CLASS number
</syntaxhighlight>

The command may be abbreviated to <code>HEL</code>. (Hell, you could even invoke it as <code>HELL</code>.) A question mark is an alias, so forms such as <code>?</code> and <code>? WARP</code> reach the same help routine.

<code>HELP</code> without a subject (or an invalid one) displays the main help index. <code>HELP subject</code> displays the corresponding command or topic page. Help subjects accept leading abbreviations, but the first matching entry in the internal help table wins. For example, <code>HELP S</code> matches several subjects but displays [[Scan command|<code>SCAN</code>]], the first matching entry. Using the complete name shown by the index avoids ambiguity among subjects such as <code>SCAN</code>, [[Sell command|<code>SELL</code>]], [[Send command|<code>SEND</code>]], [[Set command|<code>SET</code>]], and [[Shield command|<code>SHIELD</code>]].

== Help index and topic lookup ==

The help system has two separately maintained parts:

* A compiled table maps recognized subject names to individual message-file entries.
* The <code>HLPINDEX</code> message contains the formatted list shown by plain <code>HELP</code>.

Changing one does not update the other automatically. A subject can therefore work when requested directly while remaining absent from the visible index. Classic's own source comment warns that developers adding help must update both the table and <code>HLPINDEX</code>.

This separation caused [[Classic bug: HELP index omits gameplay commands]]. GE 3.2e implements <code>HELP LOCK</code> and <code>HELP NAVIGATE</code>, but omits both names from the displayed command list. This was corrected in ge-next 0.01.

Not every unlisted subject is a bug. Continuation pages such as <code>PLANETS2</code>, contextual pages such as <code>HYPER</code> and <code>NEWPRICE</code>, and non-gameplay commands such as <code>SYS</code> and <code>DATA</code> are reached from other help text or exposed only under appropriate conditions. They need not appear as independent commands in the main index.

== Ship-class help ==

<code>HELP CLASS</code> is handled specially rather than as an ordinary static topic. It combines a heading from the help message file with rows generated from the currently loaded ship-class table. This allows configured class names, capabilities, cargo capacities, prices, scan ranges, and point values to appear without maintaining a second copy of those values in help text.

<code>HELP CLASS number</code> opens the descriptive help entry assigned to that user ship class in the ship configuration. For example:

<syntaxhighlight lang="text">
HELP CLASS 1
</syntaxhighlight>

Classic attempts to fit nearly every class property onto a single fixed-width row. Long class names or large configured values push later columns out of place or wrap the line. This is one of the prominent examples documented in [[Classic bug: Fixed-width display column overflow]]. ge-next 0.1 introduced a redesigned class display and later releases kept adjusting it as class fields and terminal-width requirements changed.

ge-arena uses the same command path but generates the class list for the currently selected arena mode. Only user ships available in that mode are shown. Mode-specific fields and loadouts can therefore differ from normal ge-next even when a class has the same name.

== Administrative help in ge-next ==

Classic has a hardcoded <code>SYS HELP</code> display inside the administrative command handler, but it does not register <code>SYS</code> as a subject for the normal help command.

ge-next 0.1 moved the administrative command descriptions into the help message database and added <code>HELP SYS</code>. <code>SYS HELP</code> uses the same maintained help content. Access is checked before that page is displayed: if SYS commands are disabled, or restricted to sysops and the requester lacks the required privilege, <code>HELP SYS</code> returns the ordinary help index instead. <code>SYS</code> is intentionally absent from that public index.

The privilege mechanism differs by host generation. MajorBBS 5.x builds check the user's sysop flag; MajorBBS/Worldgroup 6.x and later builds check the configured SYS key.

== Version information in ge-next ==

ge-next 0.2.2 added:

<syntaxhighlight lang="text">
HELP VERSION
</syntaxhighlight>

It prints the project name, version number, and architecture, such as 16-bit or 32-bit. <code>VERSION</code> is a built-in query rather than an ordinary entry in the help-message table, and it is not listed in the main index. Classic 3.2e has no corresponding help query.

== Classic presentation issues ==

Classic's help index clears the terminal before displaying its command and topic list. ge-next's replacement index prints in the normal scrolling output without clearing the player's existing screen.

The classic help database also leaves the terminal in the wrong ANSI state. All 60 help definitions fail to finish at GE's normal bright-white baseline: many disable bright intensity, while the rest leave cyan, green, or red active. The following prompt consequently inherits the wrong color or appears dim. This is documented in [[Classic bug: Messages leak ANSI color and intensity]].

ge-next 0.01 was initially a message-only replacement used with the classic 3.2e DLL. It rewrote the complete help collection and explicitly restored the intended color state. It also revised outdated prose, spelling, punctuation, layout, ship descriptions, and the visible index.

== Evolution in ge-next ==

The most notable help-system changes are:

{| class="wikitable"
! Version
! Change
|-
| ge-next 0.01
| Reworked all help messages and ANSI colors; added the missing <code>LOCK</code> and <code>NAVIGATE</code> names to the visible index; revised class descriptions and outdated classic text.
|-
| ge-next 0.1
| Introduced the redesigned generated <code>HELP CLASS</code> table in the first source-built release; added privilege-checked <code>HELP SYS</code> backed by the help message file.
|-
| ge-next 0.2
| Added help for the new <code>STOP</code> and reworked <code>WHO</code> commands; added distress, neutron-flux, and faction topics needed by the expanded NPC system.
|-
| ge-next 0.2.2
| Added <code>HELP VERSION</code>.
|-
| ge-next 0.3
| Added help for nebulas, ship upgrades, expanded display settings, and additional battle behavior; removed the obsolete <code>FREQ</code> command/help when frequency control moved into <code>SEND</code>; added help for exiting with <code>X</code>.
|-
| ge-next/ge-arena 0.3.2
| Added arena-specific <code>STATUS</code> and <code>MODES</code> help and generated mode-specific ship-class output.
|}

Some subjects were reorganized rather than simply added. For example, <code>FLUX</code> is both a real command and a broad game concept, but since ge-next automates all flux management, it was moved from commands to topics (the command still works but there's no real reason to use it). Classic's general <code>COMMUNICATE</code> and <code>SECTOR</code> topics were eventually replaced by more specific command help and expanded galaxy, movement, scan, and messaging documentation.

== ge-arena ==

ge-arena uses a separate help message database and conditionally builds its subject table. Commands and topics that do not exist in arena play, including planet ownership and the normal economy, are omitted. Arena-specific <code>STATUS</code> and <code>MODES</code> subjects are included.

The arena index marks commands that are also available in the lobby in yellow. Lobby-only control commands are deliberately explained by the lobby prompts rather than added as permanent gameplay help topics. Entering <code>HELP</code> or <code>?</code> in the lobby still reaches the regular arena help system.

== See also ==

* Classic help: [[MBMGEHLP.MSG#HELP_HELP|HELP]], [[MBMGEHLP.MSG#HELP_CLASS|CLASS]]
* [[Commands]]
* [[Classic bug: Fixed-width display column overflow]]
* [[Classic bug: HELP index omits gameplay commands]]
* [[Classic bug: Messages leak ANSI color and intensity]]

{{GE navigation}}
[[Category:Commands]]
[[Category:User interface]]

Help command - Revision history

CodexBot: Link corresponding classic in-game help section