LyricDisplay

LyricDisplay

English

LyricDisplay is a BepInEx plugin for Lethal Company that renders the lyrics of the music currently playing on a boombox as a HUD element right above the inventory bar. It works with the vanilla boombox and with custom tracks added by CustomBoomboxMusic (CBM), and it shows the lyrics of several boomboxes at once when they are in range.

The lyrics come from.lrc files that sit next to the music. Nothing is fetched from the network and no audio is analysed: the plugin looks up the lyric file whose base file name matches the track and walks it with the boombox playback clock.

At a glance

| Item | Value |

| --- | --- |

| Version | 1.0.4 |

| Game | Lethal Company |

| Loader | BepInEx 5.4.2305 (BepInExPack) |

| Required mods | CustomBoomboxMusic 2.4.2 or later, Lyriclib 1.0.0 |

| Config file | BepInEx/config/LyricDisplay.cfg (written on first launch) |

| Lyric folders | BepInEx/plugins/LyricDisplay/Lyrics (a folder named Lyric is accepted as well), plus every folder named CustomBoomboxMusic, Lyrics or Lyric under BepInEx/plugins |

| HUD toggle key | End (ToggleDisplayKey) |

| Default renderer | the game's own HUD text (UseNativeHudLyrics = true) |

What's new in 1.0.4

• The LethalConfig Reload button now actually appears. Its reflective registration only accepted a button item whose callback parameter was a System.Action; LethalConfig 1.4.x passes a delegate of its own (GenericButtonOptions.GenericButtonHandler, void()) instead, so no constructor matched, the bridge logged a warning and skipped the button - the entry never showed up on this mod's page. The registration now accepts that delegate shape, and adds the button through the AddConfigItem(BaseConfigItem, Assembly) overload with this plugin's assembly, so the entry lands on this mod's page rather than depending on Assembly.GetCallingAssembly() behind a reflection invoke.
• The button is diagnosable. If a later LethalConfig version changes the shape again, the warning in BepInEx/LogOutput.log now prints the constructor signatures the bridge found instead of only saying that nothing usable was there.

• A Reload button on the LethalConfig page. With LethalConfig installed, this mod's page carries a button that re-reads the lyric and the music folders inside the running game: songs and.lrc files copied in while the game is up are indexed on the spot, with no restart. It goes through the same code path the mod already uses to catch up with a folder whose contents changed, so the result is identical to what the next boombox playback would have produced.
• Optional music-folder preload (PreloadMusicFolders, off by default). Switched on, the lyric and music folders are read while the game is still on its way to the main menu - before the online / LAN mode is chosen - instead of waiting for the first boombox to play. It exists for troubleshooting a folder or index problem; every session with the switch on logs the warning again, because the folders are read earlier than the game itself would and the cost (loading time and memory) is paid even by a session that never plays a boombox: Do not use this feature unless you know what you are doing.
• The version numbers are in sync again. Plugin.PLUGIN_VERSION, the csproj ` and manifest.json` all report 1.0.4; the project file used to still say 1.0.3.

Earlier release highlights (1.0.3):

• The game's own HUD draws the lyrics now. UseNativeHudLyrics (on by default) is the new renderer and the default one: the lyrics are mounted inside the HUD the game builds - next to the weight counter - and drawn with the HUD's own font, layer, camera and scaling, so they look like the rest of the HUD. Chinese lyrics come out with the Chinese glyphs the game itself uses, so an installed Chinese localisation or font pack is picked up automatically, with nothing to configure.
• The mod's own overlay became an option. UseUiLyrics (off) brings back this mod's own screen space overlay canvas for anyone who wants t