DSMPMusic

Play MP3 / OGG audio in‑game via Simple Voice Chat, with Voice Messages integration, local music & remote URL playback.

📖 About

DSMPMusic is a Paper server plugin that streams audio files through Simple Voice Chat. You can play local MP3/OGG music, stream audio from remote URLs, download music to server storage, pause/resume/stop playback, send music as in‑game voice messages via Voice Messages, and add custom timestamp‑based lyrics.

⚠️ Mandatory Dependency: Simple Voice Chat must be installed on your server. Voice Messages is an optional soft‑dependency only required for /dmc vmsg.

✨ Features

• Play local music for yourself, a specific player, or all online players
• Stream audio directly from HTTP/HTTPS remote URLs
• Download remote audio files into the server music folder
• Pause, resume and stop audio playback
• Integrate with Voice Messages: send music as playable voice messages
• Manual custom timed‑lyric system (plugin does NOT auto‑generate lyrics)
• Built‑in multi‑language support: English (en_US), Chinese (zh_CN)
• Configurable volume, audio duration limits, network timeouts, bypass voice‑chat group isolation
• Load‑order safety: works even if Simple Voice Chat loads after DSMPMusic

📋 Requirements

• Server: Paper 1.21.11
• Java Version: 21
• Required Plugin: Simple Voice Chat
• Optional Plugin: Voice Messages (for /dmc vmsg subcommand)

🎮 Commands

Aliases: dsmpmusic, dmusic, dmc

Command	Description
/dmc play <me|player|all> <filename>	Play local music file
/dmc url <url> <me|player|all>	Play audio from remote URL
/dmc stop [me|player|all]	Stop currently playing music
/dmc download <url> <name>	Download audio to local music folder
/dmc pause [me|player|all]	Pause or resume playback
/dmc vmsg <file>	Send music as Voice Messages voice message
/dmc list	List all local music files
/dmc reload [config|lang]	Reload configuration or language files
/dmc help	Show command help

🔐 Permissions

dsmpmusic.play.me: Play music for yourself (default: true)
dsmpmusic.play.other: Play music for other players or everyone (default: op)
dsmpmusic.url: Play audio from remote URL (default: op)
dsmpmusic.stop.me: Stop your own music playback (default: true)
dsmpmusic.stop.other: Stop other players' or global music (default: op)
dsmpmusic.download: Download remote audio files (default: op)
dsmpmusic.reload: Reload plugin config and language files (default: op)
dsmpmusic.vmsg: Use Voice Messages music message feature (default: true)
dsmpmusic.pause: Pause/resume your own playing music (default: true)
dsmpmusic.pause.other: Pause/resume music for others or all players (default: op)
dsmpmusic.list: List local music files (default: op)

📂 Plugin Folder Structure (plugins/dsmpmusic/)

dsmpmusic/
├─ config.yml           # Main plugin configuration
├─ lang/                # Language resource files (zh_CN.yml / en_US.yml)
├─ music/               # Place your MP3 / OGG audio files here
├─ cache/               # Temporary directory for network downloads
└─ word/                # Lyric storage folder
   └─ template.yml      # Lyric file template

🎵 Lyric Instructions

The plugin cannot generate lyrics automatically. All lyric files must be written manually.

1. Copy word/template.yml
2. Rename the copied file to match your audio filename: e.g. music/song.mp3 → word/song.yml
3. Set start(seconds), end(seconds), text for each lyric line.
4. Time ranges without lyric entries will automatically become instrumental sections (intro, interlude, outro).

⚙️ Important Configuration Options (config.yml)

• language: Switch language, zh_CN or en_US
• playback.volume: Global playback volume multiplier
• playback.bypass-group-isolation: Bypass Simple Voice Chat group separation
• playback.max-audio-seconds: Maximum allowed duration for normal music playback
• vmsg.enabled: Toggle Voice Messages integration
• vmsg.max-seconds: Maximum audio length limit for voice‑message sending
• network: Connection timeout, read timeout, maximum download size limit

📝 Notes

1. Supported audio formats: MP3, OGG.
2. For URL playback, you must use a direct raw audio resource link.
3. Built‑in load‑order handling, you do not need to modify plugin load priority.
4. /dmc vmsg will be disabled if Voice Messages plugin is missing or turned off in config.

---

DSMPMusic

通过 Simple Voice Chat 在游戏内播放 MP3 / OGG 音频，支持 Voice Messages 集成、本地音乐与网络URL播放。

📖 项目简介

DSMPMusic 是一款 Paper 服务端插件，可以将音频流输出到 Simple Voice Chat。 支持播放本地 MP3/OGG 音乐、网络URL音频、下载音频至服务器、暂停/恢复/停止播放；可对接 Voice Messages 将音乐发送为游戏语音消息；支持手动编写时间轴歌词。

⚠️ 强制依赖：服务端必须安装 Simple Voice Chat。 Voice Messages 为可选依赖，仅用于 /dmc vmsg 功能。

✨ 功能特性

• 播放本地音乐给自己、指定玩家或全部在线玩家
• 通过 HTTP/HTTPS 网络链接直接播放远程音频
• 将网络音频下载到服务器本地音乐文件夹
• 支持暂停、恢复、停止音频播放
• 对接 Voice Messages，发送可播放的音乐语音消息
• 自定义时间轴歌词系统（插件不会自动生成歌词）
• 内置多语言：英文(en_US)、中文(zh_CN)
• 可配置播放音量、音频时长限制、网络超时、绕过语音群组隔离
• 插件启动顺序兼容：即使 Simple Voice Chat 加载晚于本插件也不会报错

📋 运行要求

• 服务端：Paper 1.21.11
• Java版本：21
• 必须安装：Simple Voice Chat
• 可选安装：Voice Messages（提供 /dmc vmsg 子命令）

🎮 指令

别名：dsmpmusic、dmusic、dmc

指令	说明
/dmc play <me|玩家|all> <文件名>	播放本地音乐
/dmc url <url> <me|玩家|all>	播放网络音频
/dmc stop [me|玩家|all]	停止正在播放的音乐
/dmc download <url> <名称>	下载音频到本地音乐文件夹
/dmc pause [me|玩家|all]	暂停或恢复播放
/dmc vmsg <文件>	将音乐发送为 Voice Messages 语音消息
/dmc list	列出全部本地音乐文件
/dmc reload [config|lang]	重载配置或语言文件
/dmc help	查看指令帮助

🔐 权限

dsmpmusic.play.me: 播放音乐给自己 (默认: true)
dsmpmusic.play.other: 为其他玩家/全体播放音乐 (默认: op)
dsmpmusic.url: 通过网络URL播放音频 (默认: op)
dsmpmusic.stop.me: 停止自己播放的音乐 (默认: true)
dsmpmusic.stop.other: 停止其他人或全局音乐 (默认: op)
dsmpmusic.download: 下载网络音频文件 (默认: op)
dsmpmusic.reload: 重载插件配置与语言文件 (默认: op)
dsmpmusic.vmsg: 使用 Voice Messages 音乐消息功能 (默认: true)
dsmpmusic.pause: 暂停/恢复自己播放的音乐 (默认: true)
dsmpmusic.pause.other: 暂停/恢复其他或全体玩家音乐 (默认: op)
dsmpmusic.list: 列出本地音乐文件 (默认: op)

📂 插件目录结构 (plugins/dsmpmusic/)

dsmpmusic/
├─ config.yml           # 插件主配置文件
├─ lang/                # 语言资源文件 (zh_CN.yml / en_US.yml)
├─ music/               # MP3 / OGG音频文件放置目录
├─ cache/               # 网络下载临时缓存目录
└─ word/                # 歌词存放文件夹
   └─ template.yml      # 歌词模板文件

🎵 歌词使用说明

插件不会自动生成歌词，所有歌词文件需要手动编写。

1. 复制 word/template.yml
2. 将复制出来的文件重命名，和音频文件名保持一致：例 music/song.mp3 → word/song.yml
3. 为每一行歌词填写 start(秒)、end(秒)、text。
4. 没有歌词定义的时间区间自动作为器乐段落（前奏、间奏、尾奏）。

⚙️ 主要配置项 (config.yml)

• language: 切换语言，可选 zh_CN、en_US
• playback.volume: 全局播放音量倍率
• playback.bypass-group-isolation: 是否绕过 Simple Voice Chat 群组隔离
• playback.max-audio-seconds: 普通播放最大允许音频时长
• vmsg.enabled: 是否开启 Voice Messages 集成
• vmsg.max-seconds: 语音消息模式最大音频时长限制
• network: 连接超时、读取超时、最大下载大小限制

📝 注意事项

1. 支持音频格式：MP3、OGG。
2. URL播放需要使用直接指向音频资源的原始链接。
3. 内置启动顺序兼容，无需手动修改插件加载优先级。
4. 如果未安装 Voice Messages 或者配置关闭集成，/dmc vmsg 将不可用。