config.yml

Connection Settings

Configure settings for establishing a connection with the AudioConnect server

connection:
  # The user-id of your AudioConnect account (Minecraft UUID/Username)
  user-id: ''

  # The password of your AudioConnect account (Chosen when creating an account)
  user-password: ''

  # The ID for this server (Generated for each server added to your account)
  server-id: ''

Reconnect Settings

Configure settings for reconnecting to the AudioConnect server in the event of an unexpected disconnect.
If the reason for the disconnect was because the server refused the connection or if the client was manually disconnected, the client will not attempt to reconnect.

reconnect:
  # The number of milliseconds to delay before attempting to reconnect
  interval: 3000

  # The maximum number of milliseconds to delay a reconnect attempt
  max-interval: 30000

  # The rate of increase of the reconnect delay.
  # Allows reconnect attempts to back off when problems persist
  delay: 1.2

  # The maximum number of reconnect attempts that will be made before giving up. 
  # If -1, reconnect attempts will continue to be made forever.
  max-attempts: -1

Options

Configure various plugin options

options:
  # The locale language code to use for messages.
  # Supported locales: 'en' (english), 'de' (german), 'fr' (french)
  locale: 'en'

  # The Amount of time in seconds from the last executed command.
  # Prevents a player from executing any AudioConnect command too quickly.
  command-cooldown: 5

  # The frequency in seconds to send an announcement message the to non-connected players.
  # The announcement message is defined in the language file at:
  #   misc.announcement
  #   misc.connect-details
  # Use -1 to disabled announcements.
  announce-frequency: 2700

Define Audio Tracks

An audio track (or audio channel) is the target for playback of one or more audio sources.
Audio tracks have two main characteristics:

1. They determine the behavior of audio playback through their configured properties
2. They operate independently from each other

This allows audio tracks to be used for playing different audio types and layering multiple audio sources simultaneously such as with music and sound effects.

Audio Tracks can be defined following this format:

audio-tracks:
  <track-name>: #This can be any name containing at least 3 alphanumeric, '-', or '_' characters
    # When true, this track will be used when no track is specified for audio sources
    default: <true|false>
    # When true, this track will repeat through its audio sources.
    # Otherwise, it will play its audio sources at most one time each
    repeating: <true|false>
    # When true, this track will play its audio sources in random order.
    # Otherwise, it will play its audio sources sequentially in the order they were defined.
    random: <true|false>
    # When true, this track will fade in/out the volume of each audio source for smooth transitions.
    # Otherwise, it will play audio without any volume fading transitions.
    fading: <true|false>

The default audio-tracks can be renamed, removed, modified, or unmodified.

audio-tracks:
  primary:
    default: true
    repeating: true
    random: true
    fading: true
  background:
    repeating: true
    random: true
    fading: false
  complementary:
    repeating: false
    random: false
    fading: false