Installation and Configuration

Installation and Configuration

Requirements

• Paper or a compatible fork for Minecraft 1.21.4 through 26.2.
• Java 21 at minimum. Use the newer Java runtime required by your Paper build; Paper 26.2 compatibility is tested with Java 25.
• Simple Voice Chat 2.6.x, required.
• PlaceholderAPI, optional.

Installation

1. Download the latest Mixer-2.x.x-all.jar from GitHub Releases or Modrinth.
2. Put Mixer and Simple Voice Chat in the server's plugins directory.
3. Optionally install PlaceholderAPI.
4. Restart the server. Avoid using /reload for plugin installation or upgrades.

Mixer creates plugins/Mixer/config.yml, the lang directory, and an H2 database file such as database.mv.db. The audio directory is created when a track is saved locally. Do not edit database files while the server is running.

config.yml

# Mixer Configuration

lang: "en"

system:
  # NONE, WARNING, or ALL
  debugLevel: "WARNING"
  metrics: true

updateNotifier:
  enabled: true
  on-join: true

mixer:
  youtube:
    enabled: false
    useOAuth: false
    refreshToken: ""

  errorsNotifiers:
    notifyPlayer: false
    log: true

  # Global volume percentage. Values outside 0-200 fall back to 50.
  volume: 50

  # true: put the disc into the jukebox; false: right-click to play it.
  disc-inserted: true

  burnRequirements:
    enabled: false
    # Bukkit material name, or ANY.
    material: "ANY"
    # -1 disables this check.
    customModelData: -1
    # Paper item-model key; an empty value disables this check.
    itemModel: ""

  audio:
    sampleRate: 48000
    bufferSize: 960
    frameBufferDuration: 100

portableSpeakers:
  portableSpeaker: true
  portableSpeakerRange: 100
  portableSpeakerItemMaterial: "NOTE_BLOCK"

Localization

lang selects the bundled en or uk language file. Mixer keeps language files in plugins/Mixer/lang.

Debugging and metrics

• system.debugLevel: NONE, WARNING, or ALL.
• system.metrics: enables bStats metrics.
• updateNotifier.enabled: checks for new versions on startup.
• updateNotifier.on-join: notifies operators and players with mixer.update-notify when they join.

Burning requirements

When mixer.burnRequirements.enabled is false, the held item must be a normal music disc. When enabled, Mixer accepts an item only if every configured requirement matches:

• material: a Bukkit material such as PAPER, or ANY.
• customModelData: the required integer, or -1 to ignore it.
• itemModel: a namespaced key such as mythic:discs/radio, or an empty string to ignore it. Keys without a namespace use minecraft:.

Disc insertion

With mixer.disc-inserted: true, a custom disc is physically inserted into the jukebox and can be ejected normally. With false, right-click starts playback without removing the disc from the player's hand.

Reloading

Use /mixer reload after changing config.yml or language files. A full restart is recommended after upgrading the plugin or changing dependencies.