2
0
mirror of https://github.com/proxiodev/RedisBungee.git synced 2024-11-23 04:28:01 +00:00
RedisBungee/README.md

72 lines
2.8 KiB
Markdown
Raw Normal View History

2022-04-13 08:22:35 +00:00
# RedisBungee By Limework
2022-03-22 12:57:07 +00:00
2022-04-13 08:22:35 +00:00
[![RedisBungee Build](https://github.com/proxiodev/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/)
2022-04-13 08:22:35 +00:00
The main project of RedisBungee is no longer maintained, so we have forked 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
2022-03-22 12:57:07 +00:00
## Notice 1: about older versions of redis than redis 6.0
2021-06-21 21:33:33 +00:00
2022-04-13 08:22:35 +00:00
any versions of redis-bungee 0.6.4 or above only supports 6.0
Do not Open issues regarding it.
2021-06-21 21:33:33 +00:00
2022-03-22 12:57:07 +00:00
## Notice 2: users on git.limework.net
2022-04-13 08:22:35 +00:00
please create the issues on GitHub as its main project source.
2022-03-22 12:57:07 +00:00
2013-09-29 20:22:52 +00:00
## Compiling
2021-05-22 14:17:28 +00:00
RedisBungee is distributed as a [maven](https://maven.apache.org) project.
2022-04-13 08:28:10 +00:00
To compile the plugin:
2021-05-22 14:17:28 +00:00
git clone https://github.com/Limework/RedisBungee.git .
2022-04-13 08:28:10 +00:00
mvn clean package
mvn clean install # to install it in your maven local repo
then you should find it in target folder.
2022-04-13 08:28:10 +00:00
if you want to use it on your project considering you have installed it in your local repo
2021-05-19 12:58:45 +00:00
<dependency>
<groupId>com.imaginarycode.minecraft</groupId>
<artifactId>RedisBungee</artifactId>
2022-04-13 08:22:35 +00:00
<version>VERSION</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
2021-05-13 19:12:40 +00:00
## Javadocs
2022-04-13 08:22:35 +00:00
~~Hosted on limework website. Version 0.6.0~~
~~https://limework.net/JavaDocs/RedisBungee/~~
Check out our Java docs on github pages
https://proxiodev.github.io/RedisBungee-JavaDocs/0.6.5-SNAPSHOT
2021-01-07 17:32:24 +00:00
2013-09-29 20:22:52 +00:00
## Configuration
2022-04-13 08:22:35 +00:00
**REDISBUNGEE REQUIRES A REDIS SERVER**, preferably with reasonably low latency. The default [config](https://github.com/proxiodev/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
2022-04-13 08:22:35 +00:00
You can find it [here](https://github.com/proxiodev/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
2022-03-22 11:28:41 +00:00
## Support
You can join our matrix room [here](https://matrix.to/#/!zhedzmRNSZXfuOPZUB:govindas.net?via=govindas.net&via=matrix.org)
![icon](https://matrix.org/images/matrix-logo-white.svg)
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)