Installation and Configuration

Installation and Configuration

Installation

1. Ensure you have a PaperMC server (or a compatible fork).
2. Install the Simple Voice Chat plugin. Mixer will not work without it.
3. Download the latest Mixer-2.x.x-all.jar either from the Releases page or from the Modrinth.
4. Place the JAR file into your server's /plugins folder.
5. Restart your server.

The plugin will generate a config.yml and a database.db file, along with a lang folder.

config.yml

This file is for server admin settings.

# Mixer Configuration

# ===========================================
# LOCALIZATION
# ===========================================
# Set the default language for the plugin.
# Supported: "en", "uk"
lang: "en"

# ===========================================
# SYSTEM SETTINGS
# ===========================================
system:
  # Debug level for console logging.
  # "NONE"    - Suppress errors (not recommended).
  # "WARNING" - (Default) Print error messages without stack traces.
  # "ALL"     - Print full stack traces (useful for dev/debugging).
  debugLevel: "WARNING"

# ===========================================
# UPDATE NOTIFIER
# ===========================================
updateNotifier:
  # Check for updates on startup and display in the console?
  enabled: true
  # Notify players with 'mixer.update-notify' permission (and OPs) on join?
  on-join: true

# ===========================================
# PLUGIN SETTINGS
# ===========================================
mixer:
  # YouTube integration settings
  youtube:
    enabled: false
    useOAuth: false
    refreshToken: ""

  # Should the plugin notify players of playback errors?
  errorsNotifiers:
    notifyPlayer: false
    log: true

  # Default volume settings
  # This is a global multiplier. 50 = 50% volume.
  volume: 50

# ===========================================
# AUDIO SETTINGS | CHANGE ONLY OF YOU KNOW WHAT YOU'RE DOING
# ===========================================
  audio:
    # Sample rate (Hz). 48,000 is the standard.
    sampleRate: 48000
    # Buffer size
    bufferSize: 960
    # Frame buffer duration (ms)
    frameBufferDuration: 100

# ===========================================
# PORTABLE SPEAKER SETTINGS
# ===========================================
portableSpeakers:
  # Should the plugin enable the portable speakers feature?
  portableSpeaker: true
  # The range in blocks where portable speakers will work.
  portableSpeakerRange: 100
  # The block that will be used as a portable speaker.
  # Supported materials: https://jd.papermc.io/paper/1.21.11/org/bukkit/Material.html
  portableSpeakerItemMaterial: "NOTE_BLOCK"

database.db

This file is not for manual editing.