Installation

This installation tutorial applies to all minigame plugins based on MinigamesAPI

If you encounter any problems during installation or you don't know how to do something create a ticket on my discord server: http://discord.gg/AQhUVfm

Spigot installation

If you want to use the plugin only on one server follow these steps:

Put downloaded plugin in your server's plugins folder and start the server.
Edit your config file (and optionally messages file) as you want and restart the server. If you don't know what each config section is for, the comments (lines started by #) will help you (if you don't have them check Config explanation wiki page).
And you are done! You can start creating your arenas now!

Bungeecord/Velocity installation

All bungee settings also apply to Velocity. So both bungee-mode and simple-bungee-mode will also work with Velocity. The term "proxy server" in this tutorial refers to Bungeecord or Velocity, depending on what you are using.

There are two ways to use this plugin on multiple spigot servers connected by Bungeecord or Velocity proxy.

bungee-mode (multiple servers, each with one or more arenas, all arenas available form all servers, additional configuration needed)
simple-bungee-mode (one server = one arena, no access to the arenas from other servers, easier to set up)

bungee-mode is super powerful, proprietary sollution for proxy servers, which will make all arenas accessible from each server connected to the proxy. After setting it up, you will be able to access all your arenas and players' stats from all servers, which have the plugin installed, using signs, commands and menus. You can set up your arenas on multiple servers and then access them from your lobby, as if they were on the same server! After joining the arena, you will be sent to the right server and automatically join the selected game.

simple-bungee-mode is a classic bungee mode, which can often be seen in other minigame plugins. Each server can have only one arena and players joining this server automatically join this arena. You cannot use signs, menu or quickjoin command to join this arena from another server (lobby). Arena status is displayed on motd.

bungee-mode

Put downloaded plugin in each spigot server's plugin folder and in you proxy server's plugin folder.
Start your proxy server. Communication between servers is based on sockets and if you'd like to change your socket server port (default is 3000) do it in connection-proxy.yml file in your proxy server's plugin folder and restart the server.
Start spigot server to generate the files, then stop it and go to the plugin folder.
Firstly edit connection.yml file: set your server name to be the same as in your proxy config, set your bungeecord server's hostname and your socket server port (that you have set in step 2). Read the comments in the files carefully!
Then edit config.yml file: enter your mysql server details to database section and set database-stats to true, set bungee-mode in bungee section to true and put the name of your lobby server in the lobby-server field. Finally you can edit other things in your config.yml
Repeat steps 3-5 for all your spigot servers
And you are done! Now you can start all your servers and start creating arenas!

simple-bungee-mode

Install the plugin on all your spigot servers according to the spigot instalation section. DO NOT install the plugin on your proxy server.
Enable simple-bungee-mode on all your spigot servers. DO NOT enable bungee-mode
And you are done! After you create an arena on your server, when players join it, they will automatically join the arena. Server will use it's MOTD to display arena state.

PreviousWelcome NextConfig explanation

Last updated 18 days ago

Spigot installation

If you want to use the plugin only on one server follow these steps:

Put downloaded plugin in your server's plugins folder and start the server.

Edit your config file (and optionally messages file) as you want and restart the server. If you don't know what each config section is for, the comments (lines started by #) will help you (if you don't have them check Config explanation wiki page).

And you are done! You can start creating your arenas now!

Bungeecord/Velocity installation

There are two ways to use this plugin on multiple spigot servers connected by Bungeecord or Velocity proxy.

bungee-mode (multiple servers, each with one or more arenas, all arenas available form all servers, additional configuration needed)

simple-bungee-mode (one server = one arena, no access to the arenas from other servers, easier to set up)

bungee-mode

Put downloaded plugin in each spigot server's plugin folder and in you proxy server's plugin folder.

Start your proxy server. Communication between servers is based on sockets and if you'd like to change your socket server port (default is 3000) do it in connection-proxy.yml file in your proxy server's plugin folder and restart the server.

Start spigot server to generate the files, then stop it and go to the plugin folder.

Firstly edit connection.yml file: set your server name to be the same as in your proxy config, set your bungeecord server's hostname and your socket server port (that you have set in step 2). Read the comments in the files carefully!

Then edit config.yml file: enter your mysql server details to database section and set database-stats to true, set bungee-mode in bungee section to true and put the name of your lobby server in the lobby-server field. Finally you can edit other things in your config.yml

Repeat steps 3-5 for all your spigot servers

And you are done! Now you can start all your servers and start creating arenas!

simple-bungee-mode

Install the plugin on all your spigot servers according to the spigot instalation section. DO NOT install the plugin on your proxy server.

Enable simple-bungee-mode on all your spigot servers. DO NOT enable bungee-mode

And you are done! After you create an arena on your server, when players join it, they will automatically join the arena. Server will use it's MOTD to display arena state.