V2 Usage Docs
V2 Usage Docs
The current page is generated by Google Translate
Introduction
This is a powerful music system that supports the following functions.
- Full server song
- Play alone
- Lyrics display
- Lyrics translation display
- Multiple search sources (Netease Cloud/Kuwo/Bilibili)
- Keyword search
- Personal playlist
- Full server playlist
- Playlist play (NetEase Cloud)
- Volume adjustment (1.12 and above support)
- Support BungeeCord
Client Mod Description
This plug-in requires the client to install the supporting Mod to play normally
- For 1.8-1.11 clients, please install AudioBuffer Mod
- For 1.12.2-1.19 clients, please install ZMusic Mod
BungeeCord description
- BungeeCord currently only supports 1.9-1.16 server
- BungeeCord does not currently support economic systems
- For subservers to display Papi variables, progress prompts and other functions, the ZMusic-Addon plug-in needs to be installed
Video
Click to go to Bilibili to view the demo video
Feedback
- Go to Gitee or Github to submit Issues
- Join the exchange group: 1032722724 feedback
Command
Main command
/zm
main command /zm help
View help /zm play
play music /zm music
All server order songs /zm search
Search music /zm playlist
playlist system
Play
Search for a music by song name and play it directly
Command
/zm play [search source] [song name]
[Search source description](#Search source description)
Example
/zm play netease your cat
Song
Search for a piece of music by song name, after sending it to the whole server, the player clicks to play
Command
/zm music [search source] [song name]
[Search source description](#Search source description) Song name ID description
Example
/zm music netease your cat
search for
Search for a music by song name, return a list of ten music
Command
/zm search [search source] [song title]
[Search source description](#Search source description) Song name ID description
Example
/zm search netease your cat
song list
By importing the playlist and storing it on the server, it is convenient to play the playlist.
Command
/zm playlist [platform] [subcommand]
Currently supports the following platforms
- netease/163-Netease Cloud Music
If the platform is type, set the playlist play mode. Currently supports
- normal-play in sequence
- loop-loop playback
- random-random play
Example: /zm playlist type random
If the platform is global, it is the global playlist mode.
- The subcommand is the same as the normal mode
Example: /zm playlist global netease list
Subcommand
corresponds to the subcommand of the platform
import
Import playlist via playlist link- Parameters
Playlist link
corresponds to the playlist link of the platform
- Parameters
list
retrieve the playlist list of the specified platformplay
plays the playlist through the playlist ID (available from list)- Parameters
Playlist ID
Specify the playlist ID of the platform
- Parameters
Example
Import:
/zm playlist 163 import https://music.163.com/#/playlist?id=363046232
Play:
/zm playlist netease play 1937967578
/zm playlist 163 play 363046232
Administrator
Administrator-related operations, full server mandatory playback, reload configuration, etc.
Command
/zm palyall [search source] [song name]
Mandatory full server play /zm stopAll
Force stop all server playback /zm reload
reload configuration file
[Search source description](#Search source description) Song name ID description
Example
/zm playAll netease your cat
Permission
Ordinary player permissions
zmusic.use
can use ordinary commands such as play and stop`
Administrator permissions
zmusic.admin
can use playAll, stopAll and other administrator commands
Configuration file
{
/// Configuration file version (do not modify)
"version": 9,
/// Whether to automatically download plugin updates
"update": false,
/// Plug-in prompt message display prefix
"prefix": "&bZMusic &e>>> &r",
/// Whether to enable debugging mode
"debug": false,
/// API settings
"api": {
/// NetEase Cloud Music API address
///
/// Use the open source project NeteaseCloudMusicApi
/// Self-deployment is recommended, Node.js environment is required
/// Address: https://github.com/Binaryify/NeteaseCloudMusicApi
"netease": "https://netease.api.zhenxin.xyz/"
},
/// Account Settings
"account": {
/// NetEase Cloud Music
/// Please use /zm login to login your account.
"netease": {
/// Whether to follow the author's NetEase Cloud Music account
"follow": true
},
/// Bilibili
"bilibili": {
/// Because Bilibili is m4a audio format
/// The server is required for conversion
/// So Bilibili playback function charges 5 yuan/permanent
/// Contact the author for authorization
///
/// Authorize QQ
"qq": "1307993674",
/// Authorization Key
"key": "none"
}
},
/// VOD settings
"music": {
/// Gold coins deducted from song (set to 0, no deduction)
/// Players with zmusic.bypass ignore the deduction
"money": 10,
/// The cooling time of song (set to 0, no cooling)
/// Players with zmusic.bypass ignore the cooldown
"cooldown": 5
},
/// Lyrics settings
"lyric": {
/// Whether to enable lyrics
"enable": true,
/// Whether to display lyrics translation
"showLyricTr": true,
/// Lyric color
"color": "&b",
/// The following are display mode settings, which can be enabled at the same time
/// Whether to use BossBar to display lyrics (1.8 and below are not supported)
"bossBar": true,
/// Whether to use ActionBar to display lyrics
"actionBar": false,
/// Whether to use Title to display lyrics
"subTitle": false,
/// Whether to use chat information to display lyrics
"chatMessage": false,
/// Hud settings (only support 1.12 and above)
"hud": {
/// Whether to enable Hud
"enable": true,
/// X coordinate of information
"infoX": 2,
/// Y coordinate of information
"infoY": 12,
/// X coordinate of lyrics
"lyricX": 2,
/// The Y coordinate of the lyrics
"lyricY": 72
}
}
}
Variable
%zmusic_playing_name%
Get the name of the currently playing music %zmusic_playing_singer%
Get the currently playing music singer %zmusic_playing_lyric%
Get the lyrics displayed at the current time %zmusic_time_current%
Get the time of the currently playing music %zmusic_time_max%
Get the maximum time of the currently playing music %zmusic_playing_platform%
-Get the currently playing music platform %zmusic_playing_source%
-Get the currently playing music source
Front plugin
Use all versions
PlaceholderAPI
[Optional] If you want to use the above variables, please install Vault
[Optional] If you need to use song deduction, please install
1.5, 1.6 version use
AudioBuffer
[Required] It is used to play music, there is a matching Mod client in the sticker, which needs to be installed
1.4 and below version use
AudioBuffer
[Required] It is used to play music, there is a matching Mod client in the sticker, which needs to be installedBossBarAPI
[Optional] If you want to use BossBar to display lyrics, please installActionBarAPI
[Optional] If you want to use ActionBar to display lyrics, please install
Search source description
Search Source
is the platform you want to search for music Currently supports the following platforms
- netease/163-Netease Cloud Music
- kuwo-Kuwo Music
- bilibili-Bilibili music
Song name ID description
Replace the song name with -id:music ID
Currently supports Netease Cloud Bilibili Music Example: /zm play bilibili -id:374305