V2 Usage Docs

1/19/26About 4 min

V2 Usage Docs

The current page is generated by Google Translate & Edited By Humans

Introduction

ZMusic is a powerful music system that supports the following functions.

Full server music playing
Standalone/Individual song play
Lyrics display
Lyrics translations display
Multiple search sources (Netease Music / Kuwo Music / Bilibili Music / QQ Music)
Search Song By Keyword
Personal playlists
Full server playlists
Play songs on custom playlist (NetEase Cloud)
Volume adjustment (Minecraft Versions 1.12 and above are supported)
Support for BungeeCord

About Client Mod

The ZMusic plug-in REQUIRES the client to install the Zmusic Mod as a dependency to play music normally

For 1.8-1.11 clients, please install AudioBuffer Mod
For 1.12.2-1.19 clients, please install ZMusic Mod

BungeeCord description

Currently only BungeeCord server versions 1.9-1.16 are supported
Economic systems for this plugin are not currently supported on BungeeCord
For subservers to display Papi variables, progress prompts and other functions, the ZMusic-Addon plug-in needs to be installed

Feedback

Go to Gitee or Github to submit Issues
Join the QQ group: 1032722724 for feedback

Command

Main commands

/zm Base command /zm help View help /zm play Play music /zm music All server order songs /zm search Search for music /zm playlist Use playlist

Play

Search for 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 Is There Someone Else

Song

Search for any music by song name, the search will return 10 options, then click on any appearing options to play

Command

/zm music [search source] [song name]

[Search source description](#Search source description) Song name ID description

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

Song List

By importing the playlist and storing it on the server, it is more convenient to play the playlist.

Command

/zm playlist [platform] [subcommand]

The playlist option currently supports the following platforms:

netease / Netease Music

You can also choose the playlist play mode. Currently supporting:

normal / play in sequence
loop / loop playback
random / random playback

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
list retrieve the playlist list of the specified platform
play plays the playlist through the playlist ID (available from list)
- Parameters
  - Playlist ID Specify the playlist ID of the platform

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 playall [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

Permissions

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 Example

{
  /// 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
    }
  }
}

Variables

%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

Optional Dependency Plugins

Plugins with support for all versions of Zmusic

PlaceholderAPI [Optional] If you want to use the above variables, please install Vault [Optional] If you need to use song deduction, please install

Plugins with support for version 1.5, 1.6 (Deprecated)

~~AudioBuffer [Required] It is used to play music, there is a matching Mod client in the sticker, which needs to be installed~~

Plugins with support for version 1.4 and below (Deprecated)

~~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 / Netease Music
kuwo / Kuwo Music
bilibili / Bilibili Music

Song name ID description

Replace the song name with -id:music ID This plugin currently supports: Netease Music, Kuwo Music, Bilibili Music Example: /zm play bilibili -id:374305