How to install OpenAudioMc on your server.

Preparing your server

  1. Make sure you have a Spigot server running on 1.12 or higher. We do not support CraftBukkit. (1.8.8 is supported, but requires extra steps)
  2. Make an account on the OpenAudioMc registration page. This account will be used to manage your server, link up with support and verify your identity. Players will not go through this process.

Installing on Spigot, Paper, etc

  1. Download the latest OpenAudioMc version from our official Spigot page.
  2. Place the downloaded jar file in your plugins folder
  3. Restart your server
  4. Create an account on the OpenAudioMc registration page and follow the instructions to claim your server.

Some free hosts do not work out of the box, if that's the case, then you can try the following:

  1. Find the config.yml in the plugin fold (plugins/OpenAudioMc/config.yml)
  2. Set force-online-mode to true
  3. Restart your server

Networks with a proxy (BungeeCord, Waterfall, etc)

This depends. If you want a single server to be able to use OpenAudioMc, follow the steps above and set force-online-mode to true in the config. Otherwise, follow the steps below for a full network setup.

  1. Download the latest OpenAudioMc version from our official Spigot page.
  2. Place the downloaded jar file in your plugins folder within your proxy (BungeeCord, Waterfall, etc)
  3. Place the downloaded jar file in your plugins folder of all the sub-servers where you want to use VoiceChat, Regions, etc
  4. Restart your sub-servers where you installed the plugin
  5. Claim your server using /oa link in game

Networks with multiple proxies

We do support these setups, but they require a reliable Redis instance with low I/O latency (as we only use pub-sub) and the ability to set up standalone service workers. You can read more about this in our advanced vistas guide.

Networking safety

OpenAudioMc DOES NOT require an open port on your server. It uses a secure connection to our servers to communicate with the web client. This means that you can safely use OpenAudioMc on your server without having to worry about leaking your own box IP or undoing the work of your normal anti DDoS measures.

Additional notes

  • Be sure to also install the plugin in your BungeeCord (if you have one). You might need to give yourself the ‘openaudiomc.*’ permission in your bungeecord.
  • If you install the plugin in all your Spigot servers, and your BungeeCord server, it will automatically enter BungeeCord mode and link the servers together in a proxy. Players will then be able to use one OpenAudioMc web client instance across your whole network, without needing to re-open it. Due to the magical inner workings of OpenAudioMc, you can still use Command Blocks, Regions, and Speakers in all of your servers. There’s no manual config, everything will just work! Please remember to keep your OpenAudioMc the same across your entire network for everything to stay supported. For changing messages, URL’s and more you should use the config.yml in your BungeeCord OpenAudioMc plugin folder.
  • Be sure to use Spigot or one of the many forks, we do not support craft bukkit.