Synchronize data between BungeeCord proxies
Go to file
mohammed Alteniji b16a7d4cbc
Update README.md
2022-07-26 15:36:28 +04:00
.github Upload other artifacts (#41) 2022-07-19 04:30:39 +04:00
RedisBungee-API remove else when checking if password is null 2022-07-26 15:14:14 +04:00
RedisBungee-Bungee move PlayerUtils and change the name 2022-07-26 12:49:44 +04:00
RedisBungee-Velocity move PlayerUtils and change the name 2022-07-26 12:49:44 +04:00
.gitignore removed .png file, updated gitignore 2022-06-29 17:47:25 +04:00
LICENSE Relicensing under the Eclipse Public License. 2015-10-18 19:52:46 -04:00
README.md Update README.md 2022-07-26 15:36:28 +04:00
makeJavadocs.sh add to makeJavaDocs 2022-07-16 02:22:46 +04:00
pom.xml change versioning scheme on both velocity + bungeecord 2022-07-15 09:57:30 +04:00

README.md

RedisBungee fork By Limework

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

compiability with original RedisBungee

This fork ensures compiability with old plugins, so it should work as drop replacement, but since Api has been split from the platform there some changes that have to be done, so your plugin might not work if:

  • your plugin has used Internal classes of RedisBungee like getting the JedisPool or something else. because RedisBungee is no longer an Plugin for example:
// this will be broken
RedisBungee plugin = ...;
JedisPool jedisPool = plugin.getPool();

  • your plugin have used the Method RedisBungeeAPI#getServerFor(UUID player) as it was returning net.md_5.bungee.api.config.ServerInfo now it returns String.

information

RedisBungee uses Redis with Java client Jedis 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 and java docs For legacy Version 0.6.5 as its last version before internal changes. please note that you will not get support for any old builds unless critical bugs effecting both 0.6.5 and 0.7.0 or above.

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 Click here, for more information about transfer packet

SpigotMC resource page: click

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

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 is by astei and project can be found here or spigot page here, but its no longer available

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