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

81 lines
2.9 KiB
Markdown
Raw Normal View History

2021-01-07 17:23:31 +00:00
# Limework fork of RedisBungee
2013-09-29 20:22:52 +00:00
2021-05-22 14:15:32 +00:00
[![RedisBungee Build](https://github.com/Limework/RedisBungee/actions/workflows/maven.yml/badge.svg)](https://github.com/Limework/RedisBungee/actions/workflows/maven.yml) [![](https://jitpack.io/v/limework/redisbungee.svg)](https://jitpack.io/#limework/redisbungee)
2021-05-14 11:15:45 +00:00
2021-01-10 19:38:14 +00:00
Spigot link: [click](https://www.spigotmc.org/resources/redisbungee.87700/)
2021-05-14 10:51:41 +00:00
The maintainer of RedisBungee has became inactive, so we have taken the development of the plugin.
2021-01-07 17:23:31 +00:00
2021-05-31 01:33:00 +00:00
RedisBungee uses [Redis](https://redis.io) to Synchronize data between [BungeeCord](https://github.com/SpigotMC/BungeeCord) proxies
2021-01-07 17:23:31 +00:00
2021-05-14 10:53:00 +00:00
This is currently deployed on [Govindas Limework!](https://Limework.net)
2021-01-07 17:23:31 +00:00
2021-06-22 00:07:02 +00:00
![image](https://limework.net/logo.png)
2021-06-23 23:54:06 +00:00
## Notice: about older versions of redis than redis 6.2
2021-06-21 21:33:33 +00:00
2021-06-23 23:54:06 +00:00
As of now Version 0.6.4-SNAPSHOT is only supporting redis 6.2 and above!
2021-06-21 21:33:33 +00:00
2013-09-29 20:22:52 +00:00
## Compiling
2021-01-07 20:20:37 +00:00
Now you can use maven without installing it using Maven wrapper [github?](https://github.com/takari/maven-wrapper) :)
2021-01-07 17:23:31 +00:00
2021-05-22 14:17:28 +00:00
RedisBungee is distributed as a [maven](https://maven.apache.org) project.
To compile and installing to in your local Maven repository:
2021-01-07 17:23:31 +00:00
git clone https://github.com/Limework/RedisBungee.git
2013-09-29 20:22:52 +00:00
cd RedisBungee
2021-01-07 17:23:31 +00:00
mvnw clean install
2021-05-22 14:17:28 +00:00
mvnw package
2021-05-14 10:51:41 +00:00
2021-05-19 12:58:45 +00:00
And use it in your pom file.
<dependency>
<groupId>com.imaginarycode.minecraft</groupId>
<artifactId>RedisBungee</artifactId>
2021-06-12 10:49:29 +00:00
<version>0.6.4-SNAPSHOT</version>
2021-05-19 12:58:45 +00:00
<scope>provided</scope>
</dependency>
2021-01-07 17:32:24 +00:00
2021-05-22 14:15:32 +00:00
Or if you want to use the jitpack maven server
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
And use it in your pom file.
<dependency>
<groupId>com.github.limework</groupId>
<artifactId>redisbungee</artifactId>
<version>0.6.3</version>
</dependency>
2021-05-13 19:12:40 +00:00
## Javadocs
2021-05-14 10:51:41 +00:00
Hosted on limework website. Version 0.6.0 (note: any version 0.6.* will not have API changes.)
https://limework.net/JavaDocs/RedisBungee/
2021-01-07 17:32:24 +00:00
2013-09-29 20:22:52 +00:00
## Configuration
2021-05-14 11:55:33 +00:00
**REDISBUNGEE REQUIRES A REDIS SERVER**, preferably with reasonably low latency. The default [config](https://github.com/limework/RedisBungee/blob/master/src/main/resources/example_config.yml) is saved when the plugin first starts.
2021-01-07 17:28:50 +00:00
2021-01-07 17:32:24 +00:00
## License!
2021-01-07 17:28:50 +00:00
This project is distributed under Eclipse Public License 1.0
2021-01-07 17:28:50 +00:00
2021-05-14 10:51:41 +00:00
You can find it [here](https://github.com/Limework/RedisBungee/blob/master/LICENSE)
2021-01-07 17:28:50 +00:00
2021-05-14 10:51:41 +00:00
You can find the original RedisBungee by minecrafter [here](https://github.com/minecrafter/RedisBungee) or spigot page [here](https://www.spigotmc.org/resources/redisbungee.13494/)
2021-05-23 20:45:13 +00:00
## 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](https://www.yourkit.com/java/profiler/), [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/) and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/).
![YourKit](https://www.yourkit.com/images/yklogo.png)