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.

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

This mod has integration with the ShipInventory 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

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
   

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

Additional Notes:

• Streaming from another PC? Replace localhost in the URL with the local IP address of the PC running the game (e.g., 192.168.0.1).
• Troubleshooting: If the overlay doesn't appear, refresh the browser source in your streaming application.

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 ShipInventory mod.
  • Includes the total scrap value in the ship inventory in the loot stat.

Developer Contact

Report bugs, suggest features, or provide feedback:

• GitHub Issues Page: StreamOverlays

• Email: [email protected]
• Twitch: CritHaxXoG
• YouTube: Zehs

Credits

• Sun icons created by Good Ware - Flaticon
• Cloudy icons created by bqlqn - Flaticon
• Rain icons created by bqlqn - Flaticon
• Flash icons created by Smashicons - Flaticon
• Climate icons created by Freepik - Flaticon
• River icons created by Freepik - Flaticon
• Eclipse icons created by Muhamad Ulum - Flaticon

Screenshots

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.