V2 Usage Docs

The current page is generated by Google Translate and edited by humans.

Introduction

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

• Full server music playing
• Standalone or individual song play
• Lyrics display
• Lyrics translations display
• Multiple search sources (Netease Music / Kuwo Music / Bilibili Music / QQ Music)
• Search songs by keyword
• Personal playlists
• Full server playlists
• Play songs from custom playlists (Netease Cloud)
• Volume adjustment (Minecraft 1.12 and above)
• Support for BungeeCord

About Client Mod

The ZMusic plugin requires the client to install the matching mod to play music normally.

• For Minecraft 1.8-1.11 clients, please install the AudioBuffer mod
• For Minecraft 1.12.2-1.19 clients, please install the ZMusic mod

BungeeCord Description

• Currently only BungeeCord server versions 1.9-1.16 are supported
• Economy systems are not currently supported on BungeeCord
• To display PlaceholderAPI variables or progress prompts on subservers, install the ZMusic-Addon plugin on those subservers

Video

Click to view the demo video

Feedback

• Submit issues on Gitee or GitHub
• Join our Discord: https://discord.gg/twQgJNufYn

Command

Main commands

/zm Base command /zm help View help /zm play Play music /zm music All-server song request /zm search Search for music /zm playlist Playlist system

Play

Search for music by song name and play it directly.

Command

/zm play [search source] [song name]

Search source description

Example

/zm play netease Is There Someone Else

Song Request

Search for a song by name. The search returns options and players can click one to play it.

Command

/zm music [search source] [song name]

Search source description Song name ID description

Example

/zm music netease your cat

Search

Search for music by song name and return a list of ten songs.

Command

/zm search [search source] [song title]

Search source description Song name ID description

Example

/zm search netease your cat

Playlist

Import playlists into the server for easier playback.

Command

/zm playlist [platform] [subcommand]

The playlist option currently supports the following platforms:

• netease / Netease Music

You can also choose the playlist play mode. Supported values:

• 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 in the normal mode

Example: /zm playlist global netease list

Subcommand corresponds to the platform subcommand:

• import Import a playlist via the playlist link
• Parameters: Playlist link
• list Retrieve the playlist list of the specified platform
• play Play a playlist by playlist ID
• Parameters: Playlist ID

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, such as forced full-server playback and configuration reloads.

Command

/zm playall [search source] [song name] Force all players to play the song /zm stopAll Force-stop playback for the whole server /zm reload Reload the configuration file

Search source description Song name ID description

Example

/zm playAll netease your cat

Permissions

Regular player permissions

zmusic.use allows common commands such as play and stop

Administrator permissions

zmusic.admin allows administrative commands such as playAll and stopAll

Configuration File Example

{
  "version": 11,
  "check-update": true,
  "prefix": "&bZMusic &e>>> &r",
  "debug": false,
  "api": {
    "netease": "https://ncm.zhenxin.me/"
  },
  "netease-follow": true,
  "vip": {
    "account": "",
    "secret": ""
  },
  "music": {
    "money": 10,
    "cooldown": 5
  },
  "lyric": {
    "enable": true,
    "showLyricTr": true,
    "color": "&b",
    "bossBar": true,
    "actionBar": false,
    "subTitle": false,
    "chatMessage": false,
    "hud": {
      "enable": true,
      "infoX": 2,
      "infoY": 12,
      "lyricX": 2,
      "lyricY": 72
    }
  }
}

Variables

%zmusic_playing_name% Get the name of the currently playing music %zmusic_playing_singer% Get the singer of the currently playing music %zmusic_playing_lyric% Get the lyric displayed at the current time %zmusic_time_current% Get the current playback time %zmusic_time_max% Get the maximum playback time %zmusic_playing_platform% Get the current playback platform %zmusic_playing_source% Get the current playback source

Optional Dependency Plugins

Plugins for all versions of ZMusic

PlaceholderAPI [Optional] Install if you need to use the variables above Vault [Optional] Install if you need charge-based song requests

Plugins for versions 1.5 and 1.6 (Deprecated)

AudioBuffer [Required] Used for music playback and requires the matching client mod

Plugins for version 1.4 and below (Deprecated)

AudioBuffer [Required] Used for music playback and requires the matching client modBossBarAPI [Optional] Install if you want to display lyrics with BossBarActionBarAPI [Optional] Install if you want to display lyrics with ActionBar

Search Source Description

Search Source is the platform you want to search music from. The following platforms are supported:

• 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, and Bilibili Music.

Example: /zm play bilibili -id:374305