Music HUD

(See more in gallery)

A GUI-based, all situations (singleplayer/multiplayers) music mod/plugin designed with zero modifications to game mechanics

> Due to service scope provided by NetEase, this mod might not work well outside China

Related Links

GitHub

ModRinth

CurseForge (no longer update)

Third-party multi music platform (Incompatible with each other)

Third-party legacy Bukkit plugin (1.0.5 stable -)

Prerequisites

• ModernUI (only client, recommend to use mVUS fork on 1.21.9-11, this fork on 26.2 and 26.3)
• Forge Config API Port (only Fabric)
• Fabric API (only Fabric)
• ~~Architectury API~~ (Fabric / NeoForge, required by MusicHUD 1.2.0 and below)

Features

• With graceful GUI, providing an in-game operation interface and an easily configurable HUD.
• Can read NetEase Cloud Music account playlists for convenient song requests.
• The server does not retain user data; it is only temporarily stored during session.
• Streamed playback with no redundant client-side caching.
• Staggered lyrics auto scroll inspired by Apple Music
• HUD dynamic fluid background
• Windows SMTC / Linux MPRIS (have not fully tested yet) support (Powered by slightly modified JMTC)
• Using optimized high-quality audio pipeline based on OpenAL, supports NetEase Cloud Music's all quality options, and outputs 32-bit float audio and multichannel surround audio if device supports
• Connected mode: Synchronized server-wide play queue and progress.
• Isolated mode: Do all works on client, enjoy music yourself.
• Sharing same playback model between connected mode and isolated mode, easy to use
• Low network bandwidth / performance required for server side, audio stream downloading and processing is done on client side
• Fixes MC-265514 on 1.21.1 (exists from 23w31a to 1.21.4), which worsen the audio output quality

Functions

• Search for musics, playlists, albums and artists.
• Favorite/Unfavorite musics, subscribe/unsubscribe playlists, albums and artists.
• Vote for skipping current music
• Log in to NetEase Cloud Music account via QR code or SMS code to explore subscribed playlists, albums and artists.
• Scrobble your play record to NetEase Cloud Music account
• Manage your NetEase Cloud Music Cloud Drive
• Configure idle playback sources for automatic random song switching when music player is idle.
• Display lyrics, requesting player (or avatar) in the HUD and user interface.

Compatibility

• Mute Reactive Music when MusicHUD is playing
• Connected mode compatible with ViaVersion
• Adapted to Sound Physics Perfected, disabled its reverb applied to MusicHUD audio pipeline to improve audio quality
• Compatible with Raise Sound Limit Simplified while maintaining Blaze3D audio fix on 1.21.1

TO-DO List

• Customizable HUD layout [target 1.4.0]
• More music platform support (QQ Music, Kugou Music or more) [target 2.0.0]

Usage

Client

Single-player or LAN Multi-player Host

All you need is to configure or deploy an API server.

Multiplayer (join Server or LAN Multi-player)

Connected mode

You don't need to configure or deploy an API server, but the server or LAN multiplayer host needs to configure or deploy MusicHUD and API server.

Isolated mode

All you need is to configure or deploy an API server.

Server

All you need is to configure or deploy an API server.

How to Deploy an API Server

Deploy bound with mod (recommend for client)

> This method allows MusicHUD to manage lifecycle of api server. > > Due to some limitations, API Server may not be auto-closed when game exit abnormal (e.g., due to a critical crash)

Auto Deploy

You can find "Download API..." button in setting page, which will open a download guide, and download API backend from Netease Cloud Music API Enhanced's releases with optional GH Proxy speedup

Manual Deploy

1. Go to https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced/releases
2. Download platform binary artifacts matches to your pc/server platform
3. Uncompress the binary executable file from ZIP file to ...

• Mod edition: {corepath}/music-hud/ and rename it to api (api.exe on Windows)
• Plugin edition: {corepath}/plugins/MusicHud/ and rename it to api (api.exe on Windows)
• Or place it anywhere and modify config in game or option serverApiBinaryExecutablePath (absolute or relative path) in config file /config/music_hud-common.toml.

Deploy separately (recommend for server)

1. Deploy NetEase Cloud Music API Enhanced with guide in repository.
2. If not using the default port (3000) of NCM API Enhanced or deploying on another server, modify the serverApiBaseUrl property in the config file /config/music_hud-server.toml.