Skip to content

Compass ​

Description ​

Compass displays the current camera heading on the HUD. In the game options, players can adjust background color and opacity and show or hide letters and numbers. The center heading remains visible, and saved preferences are local to each client.

Configuration ​

Default configuration ​

Compass.json
json
{
    "m_Enable": 0,
    "m_RequiredCompassItem": 0,
    "m_RequiredCompassOpen": 1
}

Options ​

OptionTypeDescription
m_EnableboolWith 1, enables the HUD compass and its visual preferences. With 0, disables the module.
m_RequiredCompassItemboolWith 1, the module automatically shows the heading when the required compass is in the inventory. With 0, the keyboard shortcut controls visibility.
m_RequiredCompassOpenboolWhen the inventory compass is required, 1 also requires it to be open. With 0, it can be closed.

Controls ​

ControlAction
U (UAACCompass)Toggles the heading HUD when m_RequiredCompassItem is 0.

Released under the MIT License.