zmusic-plugin

文档 | QQ 群 | Discord

简体中文 | English | 日本語

简介

这是一个功能强大的音乐系统，当前支持以下功能。

• Bukkit / Spigot / Paper / Folia 适配
• BungeeCord 适配
• Velocity 适配
• 基础命令
• TOML 配置
• 插件消息通道
• 运行时依赖加载
• 关键词搜索
• 播放控制

文档

点击查看使用文档

API 实时连接

Plugin 使用设备授权流程签发的 device_token 连接 ZMusic API，并同步服务器、在线玩家和播放状态。管理员可通过 API 向全部服务器、指定服务器或指定玩家下发播放和停止命令。

首次启动后编辑插件数据目录中的 config.toml：

[plugin-message]
channel = "zmusic:packet"

[api]
enabled = true
websocket-url = "wss://api.example.com/api/v1/plugin/ws"
device-token = "设备授权流程签发的 device_token"

生产环境应使用 wss。zmusic:packet 是当前 Mod 与 Plugin 的统一协议通道，不应单独修改一端。

开源协议

本项目使用 GPL-3.0 协议开放源代码

ZMusic - Powerful Music System
Copyright (C) 2026 StarHui Technology
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

鸣谢

核心技术

• Kotlin - 现代化的 JVM 编程语言
• Gradle - 强大的构建自动化工具

主要依赖

• Night Config - 轻量级的配置库
• Kyori Adventure - Minecraft 文本组件库
• bStats - 插件统计服务

特别感谢

• TabooLib - 依赖动态加载机制的灵感来源

贡献者