Getting started

Welcome to the RediVelocity docs. Here you can learn about the plugin itself and its features. Also when you should use it and when not.

Quick start

Before we start, make sure you are using Java 21+ and the latest version of Velocity. You won't get support if you are using outdated versions.

Download the latest version

The main source for downloading RediVelocity is Modrinth: https://modrinth.com/plugin/redivelocity

Install the plugin

After downloading the plugin, you need to install it. Place the downloaded file into your proxy's plugins folder and restart the proxy.

Configure the plugin

After installing the plugin, you need to configure it. Open the config.yml file in the plugin's folder and adjust the settings according to your needs.

This is a very simple setup process, and you should be up and running in no time. If you encounter any issues, feel free to check the documentation or reach out for support on the Discord server.

When should you use RediVelocity?

RediVelocity is a powerful tool for managing and connecting multiple proxies or interacting with them in your normal Bukkit or Paper plugins. You should use RediVelocity if:

You want to sync the playercount of your proxies.
You want to have access to certain events that get fired on the proxy via Redis.
You want to get insights into your proxies with the builtin commands.

If any of these scenarios apply to you, RediVelocity may be the right choice for your proxy.