MusicHud-Bukkit

The Bukkit/Spigot/Paper server-side plugin implementation of MusicHud.

You must install the mod on the client before using this plugin!!!

• Mod project link: https://github.com/Etern-34520/MusicHud
• Modrinth: https://modrinth.com/mod/music-hud

Features

• Communicates with the client mod via Plugin Messaging and synchronizes playback status
• Supports song request queue and vote-to-skip
• Supports idle playlist playback
• Supports anonymous / Cookie login

Installation

1. Put the built artifact into the server plugins/ directory
2. Start the server to generate the configuration files
3. Modify the configuration as needed and restart the server or execute the reload command
4. Deploy Netease Cloud Music API Enhanced (https://github.com/neteasecloudmusicapienhanced/api-enhanced). Please follow the api-enhanced README for deployment instructions
5. If you do not use the default port (3000) of NCM API Enhanced or deploy it on another server, you need to modify the base-url property in the configuration file

Configuration

Configuration file location: plugins/MusicHud-Bukkit/config.yml

Key configuration options:

• api.base-url: Netease Cloud Music API address (default http://localhost:3000)
• api.timeout: API request timeout (milliseconds)
• playback.interval: Interval between songs (milliseconds)
• playback.enable-idle-playlist: Whether to enable idle playlist playback
• vote-skip.enabled: Whether to enable vote-to-skip
• vote-skip.required-ratio: Required vote ratio to skip
• vote-skip.min-votes: Minimum number of votes
• debug.enabled: Debug logging

Commands

• /musichud status: View current playback status
• /musichud queue: View the playback queue
• /musichud skip: Force skip the current song (permission required)
• /musichud start: Start the music service (permission required)
• /musichud stop: Stop the music service (permission required)
• /musichud reload: Reload the configuration (permission required)
• /musichud help: Show help

Permissions

• musichud.admin: Administrative permission (default OP)
• musichud.use: Basic usage permission
• musichud.queue: Song request queue permission
• musichud.skip: Vote-to-skip permission
• musichud.playlist: Idle playlist management permission

---

MusicHud 的 Bukkit/Spigot/Paper 服务端插件实现。

你需要先在客户端安装mod才能使用这个插件！！！

• Mod 项目链接：https://github.com/Etern-34520/MusicHud
• Modrinth: https://modrinth.com/mod/music-hud

功能简介

• 与客户端 Mod 通过 Plugin Messaging 通讯并同步播放状态
• 支持点歌队列与投票切歌
• 支持空闲歌单播放
• 支持匿名/Cookie 登录

安装

1. 将构建产物放入服务器 plugins/ 目录
2. 启动服务器生成配置文件
3. 按需修改配置并重启或执行重载命令
4. 部署 Netease Cloud Music API Enhanced (https://github.com/neteasecloudmusicapienhanced/api-enhanced)，请自行参考api-enhanced的readme进行部署
5. 如果不使用 NCM API Enhanced 的默认端口 ( 3000 ) 或在其他服务器上部署，需要修改配置文件的 base-url 属性

配置

配置文件位置：plugins/MusicHud-Bukkit/config.yml

关键配置项：

• api.base-url：网易云音乐 API 地址（默认 http://localhost:3000）
• api.timeout：API 请求超时（毫秒）
• playback.interval：歌曲间隔（毫秒）
• playback.enable-idle-playlist：是否启用空闲歌单
• vote-skip.enabled：是否启用投票切歌
• vote-skip.required-ratio：投票切歌比例
• vote-skip.min-votes：最小票数
• debug.enabled：调试日志

指令

• /musichud status：查看当前播放状态
• /musichud queue：查看播放队列
• /musichud skip：强制跳过当前音乐（需要权限）
• /musichud start：启动音乐服务（需要权限）
• /musichud stop：停止音乐服务（需要权限）
• /musichud reload：重载配置（需要权限）
• /musichud help：显示帮助

权限

• musichud.admin：管理权限（默认 OP）
• musichud.use：基础使用权限
• musichud.queue：点歌队列权限
• musichud.skip：投票切歌权限
• musichud.playlist：空闲歌单管理权限