Status HUD

This is a not-so-simple mod with the objective of relaying information to the player. If your character can feel it, then you should see it.

Description

Status HUD offers a collection of various elements to display on the HUD. The available elements are:

• altitude: displays the player's current height (in meters) in relation to sea level;
• armour: displays the equipped armour durability average (in %). If there is no armour equipped, this element is hidden;
• bodyheat: displays the player's current body heat (in %). If it is at 100%, this element is hidden;
• compass: displays the player's current facing direction (in degrees) in relation to the north;
• date: displays the current date (e.g. 1 Jul) and an icon for the current season (sprout for spring, sun for summer, leaf for autumn, and snowflake for winter);
• durability: displays the currently selected item's remaining durability. If there is no durability, this element is hidden;
• latitude: displays the player's current latitude (in degrees);
• light: displays the light level at the currently selected block. If no block is selected, this element is hidden;
• players: displays the number of players currently online;
• room: displays a house icon when the player is inside a room (house for large room, cabin for small room or cellar), and a sun icon above when inside a greenhouse. If the player is outside, this element is hidden;
• sleep: displays a countdown until the next time the player is able to sleep. If the player can sleep, this element is hidden;
• speed: displays the player's current speed (in m/s);
• stability: displays the temporal stability (e.g. 76%) at the player's position if it is below 150%. If the temporal stability is 150%, this element is hidden;
• tempstorm: displays a timer when a temporal storm is approaching or in progress. Otherwise, this element is hidden (★ New in v1.4.2!);
• time: displays the current time (e.g. 19:43) and an icon for the position of the sun relative to the horizon;
• time-local: displays the system's local time;
• weather: displays the current temperature (e.g. 24°C) and an icon for the current condition (clear, fair skies, cloudy, rain, snow or hail);
• weather-f: same as weather, but uses the Fahrenheit scale;
• wet: displays how wet (e.g. 72%) the player is. If the player is dry, this element is hidden;
• wind: displays the current wind speed (e.g. 20%) and direction at the player's position.

Active elements are bound to an identifier #. This number can be between -16 and 16 (inclusively), except 0. Only one element can be bound to an identifier at a time, and only one instance of an element can be active at a time.

Note: A default layout is installed on first run. Use the commands listed below to customize the elements to your liking.

Commands

The available commands are:

• .shud default

  Reverts to the default layout.

• .shud set [#] [element]

  Activates the element [element] and sets its identifier to [#].

  Variable	Description	Values
  [#]	Identifier.	Non-zero integer between -16 and 16
  [element]	Element name.	See Description section for list of possible values

• .shud unset [#]

  Deactivates the element with the identifier [#].

  Variable	Description	Values
  [#]	Identifier.	Non-zero integer between -16 and 16

• .shud clear

  Deactivates all elements from all identifiers at once.

• .shud pos [#] [halign] [x] [valign] [y]

  Sets the position of the element with the identifier [#].

  Variable	Description	Values
  [#]	Identifier.	Non-zero integer between -16 and 16
  [halign]	Horizontal alignment.	left, center or right
  [x]	Offset from horizontal alignment.	Any number
  [valign]	Vertical alignment.	top, middle or bottom
  [y]	Offset from vertical alignment.	Any number

• .shud repos [#]

  Resets the position of the element with the identifier [#].

  Variable	Description	Values
  [#]	Identifier.	Non-zero integer between -16 and 16

• .shud list

  Lists all currently active elements and their identifier.

• .shud info [element]

  Displays the element [element]'s description.

  Variable	Description	Values
  [element]	Element name.	See Description section for list of possible values

• .shud hidden [value]

  Shows or hides hidden elements.

  Variable	Description	Values
  [value]	Visibility value.	show or hide

• .shud help

  Displays a summary of these instructions and the list of available elements.

Configuration

Upon running the mod, a statushud.json config file will be created or updated in the game's ModConfig directory. The available options are:

Resources

Examples

These examples all use the identifier 1 for simplicity's sake, but you can use another identifier of your choice.

• To remove all default elements and start from scratch, use:
  .shud clear

• To restore the default layout, use:
  .shud default

• To recreate the Room Indicator mod with no changes, use:
  .shud clear
.shud set 1 room

• To display your computer's time in the bottom-right corner of the screen, use:
  .shud set 1 time-local
.shud pos 1 right 24 bottom 12