Limework/RedisBungee
2
0
Fork 0
mirror of https://github.com/proxiodev/RedisBungee.git synced 2024-11-05 04:48:02 +00:00
Code Releases Activity
b214e3dad7
RedisBungee/README.md

5.0 KiB
Raw Blame History

RedisBungee fork By Limework

Spigot link: click

The main project of RedisBungee is no longer maintained, so we have forked the plugin.

if you are here for transferring players to another proxy when the first proxy crashes or whatever this plugin won't do it, tell mojang to implement transfer packet

RedisBungee uses Redis to Synchronize players data between BungeeCord or Velocity* proxies

Velocity*: version 3.1.2 or above is only supported, any version below that might work but might be unstable #40

If you are looking to use Original RedisBungee without a change to internals, with critical bugs fixed, please use version 0.6.5 as its last version before internal changes.

Supported Redis versions

Redis version Supported
1.x.x ✖
2.x.x ✖
3.x.x ✖
4.x.x ✖
5.x.x ✖
6.x.x ✔
7.x.x ✔

Implementing RedisBungee in your plugin: RedisBungee Build

RedisBungee is distributed as a maven project.

By using jitpack

Setup jitpack repository

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

BungeeCord

add this in your project dependencies

	<dependency>
	    <groupId>com.github.limework.redisbungee</groupId>
	    <artifactId>RedisBungee-Bungee</artifactId>
	    <version>VERSION</version>
	    <scope>provided</scope>
	</dependency>

then in your project plugin.yml add RedisBungee to depends like this

name: "yourplugin"
main: your.main.class
version: 1.0.0-SNAPSHOT
author: idk
depends: [ RedisBungee ]

Velocity

	<dependency>
	    <groupId>com.github.limework.redisbungee</groupId>
	    <artifactId>RedisBungee-Velocity</artifactId>
	    <version>VERSION</version>
	    <scope>provided</scope>
	</dependency>

then to make your plugin depends on RedisBungee, make sure your plugin class Annotation have @Dependency(id = "redisbungee") like this

@Plugin(
  id = "myplugin",
  name = "My Plugin",
  version = "0.1.0-beta",
  dependencies = {
    @Dependency(id = "redisbungee")
  }
)
public class PluginMainClass {

}

Getting the latest commits to your code

If you want to use the latest commits without waiting for releases. first, install it to your maven local repo

git clone https://github.com/ProxioDev/RedisBungee.git
cd RedisBungee
mvn clean install

then use any of these in your project.

<dependency>
        <groupId>com.imaginarycode.minecraft</groupId>
        <artifactId>RedisBungee-Bungee</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
</dependency>

<dependency>
        <groupId>com.imaginarycode.minecraft</groupId>
        <artifactId>RedisBungee-Velocity</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
</dependency>

Javadocs

For current version 0.8.0

For legacy Version 0.6.5

Configuration

REDISBUNGEE REQUIRES A REDIS SERVER, preferably with reasonably low latency. The default config is saved when the plugin first starts.

License!

This project is distributed under Eclipse Public License 1.0

You can find it here

You can find the original RedisBungee by Tux here or spigot page here "NO LONGER WORKS"

Support

You can join our matrix room here

icon

YourKit

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler and YourKit YouMonitor.

YourKit