Music Hud

A GUI-based Full Server Song Request Mod

Due to service scope provided by Netease, this mod might not working good outside China

Prerequisites

• ModernUI
• Forge Config API Port
• Architectury API

Features

• GUI-based, providing an in-game operation interface and a relatively aesthetic, 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 login.
• Streamed playback with no redundant client-side caching.

Functions

• Search for music.
• Log in to NetEase Cloud Music account via QR code to request songs from user playlists.
• Synchronized server-wide playlist.
• Configure playlists as idle playback sources for automatic random song switching.
• Display lyrics, requesting player (with avatar) in the HUD and user interface.
• Display the playlist in the user interface.

Usage

Client

Currently not supported in single-player mode.

Place the prerequisite mods (Architectury API, ModernUI, and Forge Config API Port—required only for Fabric) and the MusicHud jar file into the mods folder.

Server

1. Deploy Netease Cloud Music API Enhanced (https://github.com/neteasecloudmusicapienhanced/api-enhanced).
2. If not using the default port (3000) of NCM API Enhanced or deploying on another server, modify the serverApiBaseUrl property in the configuration file.

Configuration file location: /config/music_hud-server.toml

Default configuration file content:

#Server API Base URL configuration
serverApiBaseUrl = "http://localhost:3000"
#Music Pusher's vote additional rate when voting for skip music configuration (0.0 ~ 1.0, total rate larger than or equals to 0.5 means to skip)
# Default: 0.5
# Range: 0.0 ~ 1.0
pusherVoteAdditionalRate = 0.5
#Use random Chinese IP provided by api server
useRandomCnIp = true

Known Issues

• When not logged in, due to the use of audio source replacement, some music may have audio artifacts.
• Brief segment repetition may occur once before playback pauses during network disconnection or lag.

CN version description

一个 GUI 化的全服点歌模组

前置依赖

• ModernUI
• Forge Config API Port
• Architectury API

特点

• GUI 化， 提供游戏内操作界面，以及较为美观易配置的 HUD
• 可读取网易云账户歌单，方便点歌
• 服务端不保留用户数据，仅在登录时暂存
• 流式播放，无赘余的客户端缓存

功能

• 搜索音乐
• 通过二维码登录网易云账户，从用户歌单点歌
• 全服同步播放列表
• 配置歌单作为空闲播放源，服务器随机切歌，解放双手（？）
• 在 HUD 和用户界面中展示歌词，点歌玩家（/头像）
• 在用户界面中展示播放列表

使用

客户端

目前不支持在单人游戏中使用

在 mods 文件夹中放入 Architectury API, ModernUI 和 Forge Config API Port (仅Fabric需要) 这几个前置 mod 和 MusicHud 的 jar 文件即可

服务端

1. 部署 Netease Cloud Music API Enhanced (https://github.com/neteasecloudmusicapienhanced/api-enhanced)
2. 如果不使用 NCM API Enhanced 的默认端口 ( 3000 ) 或在其他服务器上部署，需要修改配置文件的 serverApiBaseUrl 属性

配置文件位置 /config/music_hud-server.toml

配置文件默认内容

#Server API Base URL configuration
serverApiBaseUrl = "http://localhost:3000"
#Music Pusher's vote additional rate when voting for skip music configuration (0.0 ~ 1.0, total rate larger than or equals to 0.5 means to skip)
# Default: 0.5
# Range: 0.0 ~ 1.0
pusherVoteAdditionalRate = 0.5
#Use random Chinese IP provided by api server
useRandomCnIp = true

已知问题

• 未登录时，由于使用音源替换，部分音乐可能会出现音频瑕疵
• 网络断开或卡顿时暂停播放前可能出现短时片段重复播放一次