Spigot Party API for Party and Friends

Party-API for Spigot-Plugins
Please read the installation guide!!

This plugin provides an API for spigot plugins to access parties from Party and Friends for Bungeecord/Velocity Extended Edition, Party and Friends for Bungeecord and Party and Friends for Velocity.

This plugin requires Spigot Friend API for Party and Friends to be installed.

You need to decide if you are going to use Redis or MySQL as a bridge between the Bungeecord and the Spigot server to transfer the party data. It is recommended to use Redis, as it is much faster and will save performance, but this will require a Redis Server.

Installation

Using MySQL as a bridge:

1. Install this plugin into your Bungeecord/Velocity plugins folder and restart your Bungeecord/Velocity
   
2. Install the Spigot Friend API into the spigot plugins folder. Restart the server and enter your mysql database info into the config file plugins/FriendsAPIForPartyAndFriends/config.yml. The mysql database needs to be the same as on the bungeecord
   
3. Install this plugin into the spigot plugins folder. Restart the server and set "PartyDataTransferMethod" to 'mysql' in "plugins\Spigot-Party-API-PAF\config.yml". After that, restart once more.

Using Redis as a bridge:

1. Install Redis, if you have not done so already (Linux version, macOS version, Windows version)
2. If you don't use RedisBungee already, then you need to install it. If needed, restart the server and enter your Redis information into the config file "plugins\RedisBungee\config.yml" (by default it should already be correct if your Redis server is running on the same server as the spigot server)
3. Install the Spigot Friend API into the spigot plugins folder. Restart the server and enter your MySQL database info into the config file plugins/FriendsAPIForPartyAndFriends/config.yml. The mysql database needs to be the same as on the Bungeecord
4. Install this plugin into the spigot plugins folder. Restart the server and set "PartyDataTransferMethod" to 'redis' in "plugins\Spigot-Party-API-PAF\config.yml" and enter your Redis information into the config file (by default it should already be correct if your Redis server is running on the same server as the Spigot server). After that, restart once more.

Minestom

A community made port for Minestom can be found here.

For Developers

Please follow this guide here to learn how to use the API and what maven dependencies to include.