StreamOverlays

Display real-time game stats on your stream using browser sources. Shows the player count, current moon, weather, day count, quota, ship loot, and average per day. Works with OBS, Streamlabs OBS, and similar software for Twitch, YouTube, TikTok, Kick, and more.

Who needs this mod installed for it to work? Only you!

This mod is fully client-side and works in vanilla lobbies.

This mod works in all game versions from v40 to v81

This mod has integration with the ShipInventoryUpdated and HQoL mod.

Features

This mod hosts a local website that you can use as a browser source in OBS, Streamlabs OBS, or other streaming applications.

The overlays provide real-time game data, including:

• Player count
• Current moon
• Current weather
• Day count
• Quota
• Loot on the ship
• Average collected scrap per day

Installation & Usage

Step 1: Installation

Install the mod using one of the following mod managers:

• Thunderstore Mod Manager
• r2modman
• Gale Mod Manager (Recommended)

Step 2: Launch the Game

Ensure the game is running. The overlays will not work otherwise.

Step 3: Add the Browser Source

1. Add this URL as a browser source in your streaming application (e.g., OBS, Streamlabs OBS):

   http://localhost:8080/overlay
   

   If you want an additional average collected scrap per day stat, use this URL:

   http://localhost:8080/overlay2
   

2. Adjust the browser source settings:
   • Width: Set to 1535 or 1920 (Flexible)
   • Height: Set to 75

Additional Notes & Troubleshooting:

• Can't see the overlay? If the overlay doesn't appear, refresh the browser source in your streaming application.
• Streaming from another PC? Replace localhost in the URL with the local IP address of the PC running the game (e.g., 192.168.X.X).
• Already using port 8080? You can change the HTTP and WebSocket ports in the config file.

Config Settings

This mod uses a global config file.

You can locate the config file at:

%localappdata%\..\LocalLow\ZeekerssRBLX\Lethal Company\StreamOverlays\global.cfg

Tip: You can use the LethalConfig mod to easily edit the config settings in-game.

Overlays

Choose from multiple overlays to customize your stream.

Tip: You can use multiple overlays simultaneously.

Compatibility & Integration

• This mod has integration with the LethalConfig mod.
  • Allows you to easily edit the config settings in-game.
    
    
• This mod has integration with the ShipInventoryUpdated mod.
  • Includes the total scrap value in the ship inventory in the loot stat.
    
    
• This mod has integration with the HQoL mod.
  • Includes the total scrap value in the ship storage in the loot stat.
    
    
• This mod has integration with the Wesleys Weathers mod.
  • Includes icons for all weathers.
    
    
• This mod has integration with the CodeRebirth mod.
  • Includes icons for all weathers.
    
    
• This mod has integration with the LegendWeathers mod.
  • Includes icons for all weathers.
    
    
• This mod has integration with the LethalElementsTheta mod.
  • Includes icons for all weathers.
    
    
• This mod has integration with the MrovWeathers mod.
  • Includes icons for all weathers.

Developer Contact

Report bugs, suggest features, or provide feedback:

• GitHub Issues Page: StreamOverlays

https://solo.to/crithaxxog

Credits

• Sun icons created by Good Ware - Flaticon - (None/Clear) Vanilla weather icon
• Flash icons created by Smashicons - Flaticon - (Stormy) Vanilla weather icon
• Zeta - Creating weather icons:
  • Vanilla: DustClouds, Eclipsed, Flooded, Foggy, and Rainy
  • CodeRebirth: MeteorShower and Tornado
  • LegendWeathers: BloodMoon and MajoraMoon
  • LethalElementsTheta: Blizzard, Heatwave, Snowfall, SolarFlare, and ToxicSmog
  • MrovWeathers: Blackout and Cloudy
  • WesleysWeathers: Earthquakes, Forsaken, Hallowed, and Hurricane

Screenshots

v1.6.2

• Updated description for Thunderstore.

v1.6.1

• Updated README.

v1.6.0

• Updated vanilla weather icons: DustClouds, Rainy, Foggy, Flooded, Eclipsed
• Updated weather icons for the Wesleys Weathers mod v1.2.11
• Added weather icons for the CodeRebirth mod v1.6.1
• Added weather icons for the LegendWeathers mod v2.2.1
• Added weather icons for the LethalElementsTheta mod v1.3.5
• Added weather icons for the MrovWeathers mod v0.0.7

Thanks to Zeta for creating all of the new weather icons.

v1.5.2

• Fixed a compatibility error with older versions of Lethal Company (regression introduced in v1.5.0)

v1.5.1

• Added compatibility with the Wesleys Weathers mod v1.2.10
  • Added icons for all weathers, thanks to Tomatobird8.

v1.5.0

• Added compatibility with the HQoL mod v1.0.8 (#3)
  • Includes the total scrap value in the ship storage in the loot stat.
• Fixed compatibility with the ShipInventoryUpdated mod v2.0.7
• Fixed the average collected scrap per day stat being out of sync for non-host clients.

v1.4.5

• Updated manifest to show that this mod works on v73+
• Hopefully fixed some bugs with the average collected scrap per day stat.

v1.4.4

• Fixed compatibility with the ShipInventoryUpdated mod v1.2.9+

v1.4.3

• Fixed compatibility with the ShipInventory mod v1.2.6+
• This mod is compatible with the ShipInventoryUpdated mod v1.2.8+

v1.4.2

• Fixed the server trying to start not stopping properly if another Lethal Company instance has already started the server on the same ports.
  • You can now join two or more clients in LAN mode with the AutoStart config setting enabled under the Server category.

v1.4.1

• Fixed compatibility with the ShipInventory mod v1.2.0+
• Dead player bodies will no longer influence the average scrap collected per day stat.

v1.4.0

• Added support for all game versions v40 to v69+
• Fixed the loot stat not updating after losing all your scrap.

v1.3.0

• Added networking to sync some values with clients.
  • This mod still works in vanilla lobbies.
  • You can still play with players that don't have this mod installed.
• The Day stat now shows the day number without counting days spent at the company.

v1.2.0

• Updated config settings.
• Added the ability to change the formatting of each stat in the config settings.
• Removed DayOffset config setting in the Overlays category.
• Added OnlyUpdateEndOfDay config setting to the Loot Stat category.
  • Description: If enabled, the Loot stat will only update when the day ends or if you are in orbit.
• Updated overlays.
• Other changes and improvements.

v1.1.0

• Added a new stat to display the average collected scrap per day.
• Added a new overlay.
  • URL: http://localhost:8080/overlay2
  • Displays: Crew, Moon, Day, Quota, Loot, Average per day
• Added standalone overlays for specific stats
  • Crew
    • URL: http://localhost:8080/crew
    • Displays: Player count
  • Moon & Weather
    • URL: http://localhost:8080/moon
    • Displays: Current moon and weather
  • Day
    • URL: http://localhost:8080/day
    • Displays: Day count
  • Quota
    • URL: http://localhost:8080/quota
    • Displays: Quota
  • Loot
    • URL: http://localhost:8080/loot
    • Displays: Loot on the ship
  • Average Per Day
    • URL: http://localhost:8080/averageperday
    • Displays: Average scrap collected per day

See the README for full details.

v1.0.4

• Fixed issue that prevented the overlay from connecting on other computers in the same network.

v1.0.3

• Added support for the ShipInventory mod.

v1.0.2

• Fixed issue with the overlay not working.

v1.0.1

• Initial release.