Please disclose if any significant portion of your mod was created using AI tools by adding the 'AI Generated' category. Failing to do so may result in the mod being removed from Thunderstore.
LyricDisplay
Shows boombox song lyrics as an in-game HUD above the inventory bar, with bilingual translations, track headers and multi-boombox support.
By BiliBiliMOXL
| Last updated | an hour ago |
| Total downloads | 2 |
| Total rating | 1 |
| Categories | Mods Client-side AI Generated |
| Dependency string | BiliBiliMOXL-LyricDisplay-1.0.0 |
| Dependants | 0 other packages depend on this package |
This mod requires the following mods to function
BepInEx-BepInExPack
BepInEx pack for Mono Unity games. Preconfigured and ready to use.
Preferred version: 5.4.2305
baer1-CustomBoomboxMusic
The quickest, easiest and most reliable mod for adding music to the boombox
Preferred version: 2.4.2README
LyricDisplay
Shows the lyrics of the music currently playing on a boombox as an in-game HUD element right above the inventory bar.
Works with the vanilla boombox tracks and custom tracks added by CustomBoomboxMusic (CBM). Lyric files are .lrc files matched to the audio track by their base file name, using the CBM track naming convention (Artist - Title (Album)).
Prerequisites (Dependencies)
| Mod | Required | Purpose |
|---|---|---|
| BepInEx-BepInExPack-5.4.2305 | Yes | BepInEx plugin loader. LyricDisplay will not load without it. |
| baer1-CustomBoomboxMusic-2.4.2 | Recommended | Adds custom music to the boombox. LyricDisplay supports its tracks out of the box. Vanilla tracks still work without it. |
Installation
- Install the dependencies listed above (BepInExPack, and CustomBoomboxMusic if you use custom songs).
- Install LyricDisplay with your mod manager (r2modman / Thunderstore Mod Manager / manual drop into
BepInEx/plugins). - (Required for CJK text) The bundled font ships inside the package at
BepInEx/plugins/Fonts. After installing, ensure theFontsfolder ends up next to the plugin atBepInEx/plugins/LyricDisplay/Fonts(the mod reads its font from the same directory as the plugin). If the folder is missing the renderer falls back to system CJK fonts. - (Optional) Place lyric files:
- Local lyrics:
BepInEx/plugins/LyricDisplay/Lyrics/ - CustomBoomboxMusic lyrics: inside any
CustomBoomboxMusicfolder underBepInEx/plugins(any depth).
- Local lyrics:
Lyric files are discovered recursively under the entire BepInEx/plugins tree: every folder named CustomBoomboxMusic or Lyrics, no matter which mod folder it lives in or how deeply it is nested, is scanned for .lrc files.
Lyric File Format
- Plain text in
.lrcformat:[mm:ss.xx] line text - File name must match the audio track base name, e.g.
Artist - Title (Album).lrc - To show a bilingual translation, add a second line with the same timestamp (or a translation-only line). Lines sharing a timestamp are rendered as original + translation.
- Priority when the same song exists in several places:
CustomBoomboxMusicfolders first, then the localLyricsfolder.
Configuration
Generated as BepInEx/config/LyricDisplay.cfg on first launch.
| Section | Key | Default | Description |
|---|---|---|---|
| General | Enabled |
true |
Enable the lyric HUD. |
| General | ToggleDisplayKey |
End |
Key to show/hide the HUD (Unity KeyCode name, e.g. F9, End). |
| Display | VerticalOffset |
0.26 |
Height of the lyrics from the bottom of the screen (0–1). |
| Display | HorizontalOffset |
0 |
Shift the panel left/right as a fraction of screen width. Negative = left, positive = right. |
| Display | FontSize |
22 |
Font size of the lyrics. |
| Display | ShowNextLine |
true |
Show the next lyric line below the current one. |
| Display | BackgroundAlpha |
0.55 |
Background darkness (0 = transparent, 1 = solid). |
| Display | HoldAfterEnd |
4 |
How long the last line stays after the music stops (seconds). |
| Display | TextAlign |
Center |
Align text inside the panel: Left, Center or Right. |
| Display | ShowHeader |
true |
Show Title - Artist - Album above the lyrics (unknown when missing). |
| Display | ShowInSpectate |
true |
Show lyrics while spectating after death. |
| Distance | MaxAudioDistance |
35 |
Max distance to show a boombox's lyrics. Farther boomboxes are ignored. |
| Distance | MaxSimultaneousSources |
3 |
Max number of boomboxes shown at once (closest first). |
Features
- HUD display above the inventory bar (in-game scenes only; never shown in the main menu or loading screens)
- CBM custom track recognition and built-in Source 2 built-in track names
- Bilingual lyrics via translation lines
- Per-boombox distance filtering and multi-boombox stacking (up to
MaxSimultaneousSourcessources) - Hide/show toggle (
ToggleDisplayKey, defaultEnd) - Optional track header, next-line preview, spectator support
- Chinese-capable rendering with a bundled Source Han Sans (思源黑体) font
- Left/center/right alignment and horizontal offset for panel positioning
Changelog
See CHANGELOG.md.
Credits
- CustomBoomboxMusic by baer1 for the CBM track system this mod hooks into.
- Source Han Sans (思源黑体) font license included in the mod folder.
