Music Hud

Request music in whole server powered by Netease Cloud Music (NCM) | 一个基于网易云的全服点歌模组

1,10k

Quick challenge

How far can you run before the mobs catch you?

Music Hud

Banner

Home View

A GUI-based Full Server Song Request Mod / Plugin

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

Prerequisites

- ModernUI (only client) - Forge Config API Port (only fabric) - ~~Architectury API~~ (Mod edition, 1.2.0 and below)

Features

- With graceful GUI, providing an in-game operation interface and a 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. - Staggered lyrics auto scroll inspired by Apple Music - HUD dynamic fluid background

Functions

- Search for musics, playlists, albums and artists. - Log in to NetEase Cloud Music account via QR code or SMS code to explore subscribed playlists, albums and artists. - Synchronized server-wide play quque. - Configure idle playback sources for automatic random song switching when server is idle. - Display lyrics, requesting player (or avatar) in the HUD and user interface.

TO-DO List

- Customizable HUD layout [target 1.3.0/1.4.0] - More music platform support (QQ Music, Kugou Music) [target 2.0.0]

Usage

Client

First of all, place the prerequisite mods and the MusicHud jar file into the mods folder.

Single-player or LAN Multi-player Host

> Currently experimentally supported.

All you need is to deploy an API server

Multiplayer (join Server or LAN Multi-player)

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

Server

All you need is to deploy an API server

How to Deploy an API server

There are 2 methods to deploy

Deploy bound with mod (recommend for client)

> This method allows to MusicHUD 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 crash)

1. Login to GitHub (Important, otherwise can NOT download artifacts) and go to https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced/actions/workflows/build-and-pr.yml 2. Click latest action runs in type "build-and-pr" and download platform binary artifacts matches to your pc/server platfrom 3. Uncompress the binary executable file from ZIP file to {corepath}/music-hud/ and rename it to `api` (`api.exe` on Windows)

> Default path for plugin versions is `{corepath}/api(.exe)`. > Or place it in anywhere and modify config `startupBinaryApiServerWhenLaunch` in game or in config file `music_hud-server.toml`

Deploy separately (recommend for 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 config file. > Configuration file location: `/config/music_hud-server.toml`.

---

CN version description

一个 GUI 化的全服点歌模组/插件

前置依赖

- ModernUI （仅客户端） - Forge Config API Port （仅 Fabric） - ~~Architectury API~~ （模组版，1.2.0 以及更低版本）

特点

- 具有优雅的 GUI，提供游戏内操作界面，以及易配置的 HUD - 可读取网易云账户歌单，方便点歌9 - 服务端不保留用户数据，仅在登录时暂存 - 流式播放，无赘余的客户端缓存 - 受 Apple Music 启发的歌词交错滚动与逐字歌词 - HUD 动态流体背景

功能

- 搜索音乐、歌单、专辑和歌手 - 通过二维码或短信验证码登录网易云账户，查看收藏的歌单、专辑和歌手 - 全服同步播放队列 - 配置空闲播放源，服务器空闲时随机切歌 - 在 HUD 和用户界面中展示歌词，点歌玩家（或头像）

大饼待办清单

- 可自定义的 HUD 布局 [目标 1.3.0/1.4.0] - 更多音乐平台支持(QQ音乐, 酷狗音乐) [目标 2.0.0]

使用

客户端

首先在 mods 文件夹中放入前置 mod 和 MusicHud 的 jar 文件

单人模式或局域网联机主机

> 目前对单人游戏和局域网联机主机提供实验性支持

只需要部署 API 服务器

加入服务器或加入局域网世界

不需要部署 API 服务器但是需要服务器/局域网主机部署 MusicHUD 和 API 服务器

服务端

只需要部署 API 服务器

如何部署 API 服务器

两种方法

与 mod 绑定（推荐客户端使用）

> 这个方法会让 MusicHUD 管理 API 服务器生命周期 > > 由于一些限制，在游戏非正常退出时（如崩溃）无法自动结束 API 服务器进程

1. 登录到 GitHub（重要，否则无法下载工件） 并跳转到 https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced/actions/workflows/build-and-pr.yml 2. 在 actions 类型中选择 "build-and-pr" 并进入最新的构建中根据你的平台下载对应的二进制构建产物 3. 解压下载得到的压缩包并将其中的二进制可执行文件放置到 {核心目录}/music-hud/ and renames to `api` (`api.exe` on Windows)

> 对应插件版本则是 {核心目录}/api(.exe) > 或者放在任意处并在游戏内或配置文件中修改选项 `serverApiBinaryExecutablePath` 对应目录

独立部署（推荐服务端使用）

1. 部署 Netease Cloud Music API Enhanced (https://github.com/neteasecloudmusicapienhanced/api-enhanced) 2. 如果不使用 NCM API Enhanced 的默认端口 ( 3000 ) 或在其他服务器上部署，需要修改配置文件的 serverApiBaseUrl 属性 > 配置文件位置 `/config/music_hud-server.toml`#### Deploy bound with mod (recommend for client) > This method will allows MusicHUD to manage lifecycle by itself > > Due to some limitations, API Server may not be auto-closed when game exit abnormal as crashes

1. Login to GitHub (Important! Otherwise it's not allowed to download artifacts) and goes to https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced/actions/workflows/build-and-pr.yml 2. Click latest action runs in type "build-and-pr" and download platform binary artifacts matches to your pc/server 3. Uncompress the binary executable file from ZIP file to... Mod edition: {corepath}/music-hud/ and renames to `api` (`api.exe` on Windows) Plugin edition: {corepath}/api(.exe) Or place it in anywhere and modify config `startupBinaryApiServerWhenLaunch` in game or in config file `music_hud-common.toml`

Deploy seperately (recommend for 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 config file. > Configuration file location: `/config/music_hud-server.toml`

---

CN version description

一个 GUI 化的全服点歌模组/插件

前置依赖

- ModernUI （仅客户端） - Forge Config API Port （仅 Fabric） - Architectury API （非插件版，1.2.0 以及更低版本）

特点

- GUI 化，提供游戏内操作界面，以及较为美观易配置的 HUD - 可读取网易云账户歌单，方便点歌 - 服务端不保留用户数据，仅在登录时暂存 - 流式播放，无赘余的客户端缓存 - 受 Apple Music 启发的歌词交错滚动和逐字歌词 - HUD 动态流体背景

功能

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

大饼待办清单

- 可自定义的 HUD 布局 [目标 1.3.0/1.4.0] - 更多音乐平台支持(QQ音乐, 酷狗音乐) [目标 2.0.0]

使用

客户端

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

单人模式或局域网联机主机

> 目前对单人游戏和局域网联机主机提供实验性支持

只需要部署 API 服务器

加入服务器或加入局域网世界

不需要部署 API 服务器但是需要服务器/局域网主机部署 MusicHUD 和 API 服务器

服务端

只需要部署 API 服务器

如何部署

两种方法

绑定在 mod 中（推荐客户端使用）

> 这个方法会让 MusicHUD 管理 API 服务器生命周期 > > 由于一些限制，在游戏非正常退出时（如崩溃）无法自动结束进程

1. 登录到 GitHub (重要，否则无法下载工件) 并跳转到 https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced/actions/workflows/build-and-pr.yml 2. 在 actions 类型中选择 "build-and-pr" 并进入最新的构建中根据你的平台下载对应的二进制构建产物 3. 解压下载得到的压缩包并将其中的二进制可执行文件放置到... mod 版：{核心目录}/music-hud/ 并重命名为 `api` (对于 Windows 为 `api.exe`) 插件版: {核心目录}/api(.exe) 或者放在任意处并在游戏内或配置文件`/config/music_hud-common.toml`中修改选项 `serverApiBinaryExecutablePath` 对应(绝对/相对)目录

独立部署（推荐服务端使用）

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

Music Hud

How far can you run before the mobs catch you?

Confirm your run

Music Hud

Music Hud

A GUI-based Full Server Song Request Mod / Plugin

Related Links

Prerequisites

Features

Functions

TO-DO List

Usage

Client

Single-player or LAN Multi-player Host

Multiplayer (join Server or LAN Multi-player)

Server

How to Deploy an API server

Deploy bound with mod (recommend for client)

Deploy separately (recommend for server)

CN version description

一个 GUI 化的全服点歌模组/插件

相关链接

前置依赖

特点

功能

~~大饼~~ 待办清单

使用

客户端

单人模式 或 局域网联机主机

加入服务器 或 加入局域网世界

服务端

如何部署 API 服务器

与 mod 绑定（推荐客户端使用）

独立部署（推荐服务端使用）

Deploy seperately (recommend for server)

CN version description

一个 GUI 化的全服点歌模组/插件

相关链接

前置依赖

特点

功能

~~大饼~~ 待办清单

使用

客户端

单人模式 或 局域网联机主机

加入服务器 或 加入局域网世界

服务端

如何部署

绑定在 mod 中（推荐客户端使用）

独立部署（推荐服务端使用）

Gallery

大饼待办清单

单人模式或局域网联机主机

加入服务器或加入局域网世界

大饼待办清单

单人模式或局域网联机主机

加入服务器或加入局域网世界