Source-checkedLibraries & compatibility

Text HUD API

by DraygoKorvan · for Space Engineers

Allows modders to add text to the players screen. This mod must be loaded along side any other mod that uses it. Graphics update note: Post-Processing causes all HUD API text to be dark and blurry…

574KDownloads
5 yr agoLast updated
1 MBFile size
Steam WorkshopSource

About Text HUD API

From Steam Workshop

Allows modders to add text to the players screen. This mod must be loaded along side any other mod that uses it. Graphics update note: Post-Processing causes all HUD API text to be dark and blurry…

Allows modders to add text to the players screen. This mod must be loaded along side any other mod that uses it.

Graphics update note: Post-Processing causes all HUD API text to be dark and blurry unless it uses the PostPP blendtype.

Common Issue: If the mod is not working delete Steam\steamapps\workshop\content\244850\758597413 to force TextHUDAPI to redownload the latest version from steam.

Reference issue

'Reference issue detected (circular reference or wrong order)' in the log does not indicate a problem. All it means is that another mod already loaded this mod and it is skipping loading this mod a second (or third) time. Please look further in your log for a crash message that may indicate the real problem if your save is not loading.

Features: Add Text HUD elements Add Text to world Add Text attached to Entities. Add Billboards to HUD elements Adds an interactable mod menu. Fonts are fully modifable.

There is now a new API class that interfaces with this mod you can get it here:

[SteamLibrary folder]\steamapps\workshop\content\244850\758597413\Data\Scripts\HUDApi\HudAPIv2.cs

In a Session Component init the mod using the Init Method

TextAPI = new HudAPIv2(onRegisteredCallback);

Note: onRegisteredCallback method will be called when the API registers to this mod you can then declare all HUD/Menu elements in that method.

Note before using any class make sure Heartbeat is true. If you try to call a constructor while Heartbeat is false it will lead to a crash. Using the Callback method can help you avoid this issue.

Editing any class property will update it instantly, there is no longer any network messaging involved with the mod. This also means you have to now worry about thread safety.

Modders:

You can change the color of the text with the <color=colorname> tag. No closing tag is required. You can use multiple colors in the same message. <color=r,g,b> and <color=r,g,b,a> also supported. r = red [0-255] b = blue [0-255] g = green [0-255] a = alpha [0-255] <i> tag for italic text. end the tag with </i> ex. <i>this is italic text</i> <reset> will reset the formatting of the text back to the default. <color=red>a<i>b<reset>c

The Heartbeat property lets you know if the class has received a heartbeat, so you can be confident the player has the mod installed. If they do not then you can revert to any previous messaging scheme you had.

V3.1 Added custom font support. ( Example mod: https://steamcommunity.com/sharedfiles/filedetails/?id=2163222751 )

V3.0 Added BoxUI Fixed menu display order. Added InitialColor property for HUDMessages.

V2.6 Removed support for version 1.

V2.53 MenuColorPicker added

V2.52 Draw() Method added Performance improvements

V2.51 Included some performance improvements. Modders now can manually flush the cache by calling the Flush() method.

V2.5 Texture files eliminated, mod now uses a UV map to generate the font. Monospace font added Mod menu added

Thanks to Digi for pointing me in the right direction to get it working properly with 3rd person.

Localization complete, now supports all characters - Thanks Midspace!

Mod List: Notes (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=758966734 Easy Inventory (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=646796262 Aerodynamic Physics (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=571920453 Build Vision - http://steamcommunity.com/sharedfiles/filedetails/?id=756792814 Text Projector (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=762397930 Build Hints - http://steamcommunity.com/sharedfiles/filedetails/?id=762950855 Dock Assist (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=764754640 Stargate mod - http://steamcommunity.com/sharedfiles/filedetails/?id=754173702 Wormhole portal - http://steamcommunity.com/sharedfiles/filedetails/?id=377773977 Score Screen (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=767740490 Automatic Ore Pickup - http://steamcommunity.com/sharedfiles/filedetails/?id=657749341 Hunger and Thirst - http://steamcommunity.com/sharedfiles/filedetails/?id=591816613 Build Information - http://steamcommunity.com/sharedfiles/filedetails/?id=514062285 HudLcd - http://steamcommunity.com/sharedfiles/filedetails/?id=911144486

Highlights

From source data

Footprint

A 1 MB download, rated a light load on a server.

Last update

Its author last shipped an update 5 yr ago.

Text HUD API on Nxeon

From our catalogue
One-click install
Not available. One-click install isn't available for this game's mods yet. Download it and upload it to your server in Files.
Server load
light
Smallest plan we suggest
Space Engineers — 8 GB (8 GB RAM). This follows our own load rating above, not a benchmark.
Latest build
2022-02-23, released 2022-02-23, 1 MB

Game versions by loader

LoaderGame versionsNewest
Workshop

From 1 recorded build of Text HUD API.

Run Text HUD API on a Space Engineers server

Deploy a server above, then upload the file in Files.

What kind of mod it is

From the catalog
Listed on Steam Workshop as “Workshop”

Libraries & compatibility

Foundations and fixes other mods build on. Usually installed because something else needs it.

Compatibility

Game
Space Engineers
File size
1 MB

Verified at the source

  • ✓Steam WorkshopOfficial listing, checked 2026-10-10Open ↗
  • ✓AuthorDraygoKorvan, as published on Steam Workshop
  • ✓LicenseNot published by the sourceFree

Text HUD API, answered

Generated from the mod’s own source data.

Is it free?

Yes. Text HUD API is free to download from Steam Workshop.

How do I add it to my Nxeon server?

One-click install isn't available for this game's mods yet. Download Text HUD API from Steam Workshop and upload it to your Nxeon Space Engineers server in Files.

NxLabs

Run Text HUD API on a Space Engineers server.

Deploy in about a minute from $13.99 a month, then upload Text HUD API in Files.