2024-05-12 11:05:39 +00:00
|
|
|
# ValioBungee
|
|
|
|
|
|
2024-05-12 11:31:54 +00:00
|
|
|
ValioBungee is RedisBungee Limework's Fork, name change is trying for us to be compliant with Redis Trademarks usage. Which will only effect
|
|
|
|
|
Repository name only, jar name *NOT PLUGIN Name*, but not internals etc...
|
2024-05-12 11:05:39 +00:00
|
|
|
|
2024-05-14 16:58:40 +00:00
|
|
|
|
|
|
|
|
This fork is backward compatible for bungeecord plugins that compiled with RedisBungee pre fork `0.5`,
|
|
|
|
|
so if you want to recompile using the new api you have to adapt the changes in the code if you still have
|
|
|
|
|
access to the code.
|
|
|
|
|
|
|
|
|
|
|
2024-05-12 11:05:39 +00:00
|
|
|
The original project of RedisBungee is no longer maintained, so we forked it.
|
|
|
|
|
ValioBungee is used to Synchronize players data between [BungeeCord](https://github.com/SpigotMC/BungeeCord)
|
|
|
|
|
or [Velocity](https://github.com/PaperMC/Velocity) proxies,
|
|
|
|
|
such as if player is online on the network, server and proxy player on, last online, uuid to name translation,
|
|
|
|
|
last server join on connect, etc.
|
2023-04-12 16:26:06 +00:00
|
|
|
|
2022-07-26 11:36:28 +00:00
|
|
|
|
0.12.0 (#86)
## NOTES
data system shouldn't effect anybody, unless you do any direct query to
Redis query data, you should adapt the changes, by viewing classes
`ProxyDataManager` and `PlayerDataManager`
# Changes
* RedisBungee is compiled with `java 17` now, Due java 11 support is
ending at end of September
* config version is now `2` which will reset your config if older
version
* Adventure API is included inside RedisBungee API
* new Language infrastructure for RedisBungee built-in messages #85
*commands not included yet*
* New data system which replaces Redis PubSub with Redis Streams *see
below*
* Ability to connect player to last server they where on using an config
option #84
* new environment variable `REDISBUNGEE_PROXY_ID` which can be set
before launch
* new environment variable `REDISBUNGEE_NETWORK_ID` which can be set
before launch
* RedisBungee requires redis version 6.2 or above #88
* Better command system
https://github.com/ProxioDev/RedisBungee/issues/93
## New data system
Due limitation of Redis PubSub in Cluster environment, Internals of
RedisBungee were changed to support Redis Streams
- Network Ids
- networks ids used to group network proxies
- example having 'test' network and 'main' network
- Networks in the same redis server / cluster share the same UUID cache
- Heartbeat system:
- RedisBungee old heartbeat system used hastset on redisbungee to store
the current unix time of the proxy to check what every proxy died or
not, now instead we publish the heartbeat using unix time, and online
count to proxy which proxy store it in their memory, which allow the
`get number of online players` to be faster than pooling whole list in
old data system.
- PubSub
- since redisbungee was initially designed with pubsub in mind,
registration no longer required now for event to fire, see the api
changes below.
## Commands System
* rewritten using [acf lib](https://github.com/aikar/commands) to be
platform independent
* new command `/rb` or `/redisbungee` with sub commands `help`, `info`,
'clean', 'show'.
* 'rb'
* '/rb' and '/rb info'
* '/rb show'
* configuration to disable or override each command from legacy to new
introduced one `/rb`
```yaml
# For redis bungee legacy commands
# either can be run using '/rbl glist' for example
# or if 'install' is set to true '/glist' can be used.
# 'install' also overrides the proxy installed commands
#
# In legacy commands each command got it own permissions since they had it own permission pre new command system,
# so it's also applied to subcommands in '/rbl'.
commands:
# Permission redisbungee.legacy.use
redisbungee-legacy:
enabled: false
subcommands:
# Permission redisbungee.command.glist
glist:
enabled: false
install: false
# Permission redisbungee.command.find
find:
enabled: false
install: false
# Permission redisbungee.command.lastseen
lastseen:
enabled: false
install: false
# Permission redisbungee.command.ip
ip:
enabled: false
install: false
# Permission redisbungee.command.pproxy
pproxy:
enabled: false
install: false
# Permission redisbungee.command.sendtoall
sendtoall:
enabled: false
install: false
# Permission redisbungee.command.serverid
serverid:
enabled: false
install: false
# Permission redisbungee.command.serverids
serverids:
enabled: false
install: false
# Permission redisbungee.command.plist
plist:
enabled: false
install: false
# Permission redisbungee.command.use
redisbungee:
enabled: true
```
## API changes
- Kick api Deprecated:
- `kickPlayer(String playerName, String message) `
- `kickPlayer(UUID playerUUID, String message) `
- newer where added using adventure api:
- `kickPlayer(String playerName, Component message) `
- `kickPlayer(UUID playerUUID, Component message) `
- PubSub registration api Deprecated:
```java
/**
* Register (a) PubSub channel(s), so that you may handle PubSubMessageEvent for it.
*
* @param channels the channels to register
* @since 0.3
* @deprecated No longer required
*/
@Deprecated
public final void registerPubSubChannels(String... channels) {
}
/**
* Unregister (a) PubSub channel(s).
*
* @param channels the channels to unregister
* @since 0.3
* @deprecated No longer required
*/
@Deprecated
public final void unregisterPubSubChannels(String... channels) {
}
```
# Contributors
* `summoncraft.us` for running this branch in production
* @SrBedrock for providing [Brazilian
Portuguese](https://en.wikipedia.org/wiki/Brazilian_Portuguese)
translation #87
# issues
closes #84
closes #88
closes #92
closes #81
closes #93
---------
Signed-off-by: mohammed jasem alaajel <xrambad@gmail.com>
Co-authored-by: ThiagoROX <51332006+SrBedrock@users.noreply.github.com>
2024-04-28 11:29:53 +00:00
|
|
|
## Downloads
|
2022-07-26 11:41:57 +00:00
|
|
|
|
2023-04-09 21:56:35 +00:00
|
|
|
[](https://modrinth.com/plugin/redisbungee)
|
2022-08-02 13:52:34 +00:00
|
|
|
|
2024-04-28 16:36:09 +00:00
|
|
|
## Wiki
|
|
|
|
|
|
2024-05-12 11:05:39 +00:00
|
|
|
https://github.com/ProxioDev/ValioBungee/wiki
|
2024-04-28 16:36:09 +00:00
|
|
|
|
2022-03-22 11:28:41 +00:00
|
|
|
## Support
|
|
|
|
|
|
2023-12-26 22:07:33 +00:00
|
|
|
open an issue with question button
|
2022-03-22 11:28:41 +00:00
|
|
|
|
2023-04-09 21:56:35 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
This project is distributed under Eclipse Public License 1.0
|
|
|
|
|
|
|
|
|
|
You can find it [here](https://github.com/proxiodev/RedisBungee/blob/master/LICENSE)
|
|
|
|
|
|
0.12.0 (#86)
## NOTES
data system shouldn't effect anybody, unless you do any direct query to
Redis query data, you should adapt the changes, by viewing classes
`ProxyDataManager` and `PlayerDataManager`
# Changes
* RedisBungee is compiled with `java 17` now, Due java 11 support is
ending at end of September
* config version is now `2` which will reset your config if older
version
* Adventure API is included inside RedisBungee API
* new Language infrastructure for RedisBungee built-in messages #85
*commands not included yet*
* New data system which replaces Redis PubSub with Redis Streams *see
below*
* Ability to connect player to last server they where on using an config
option #84
* new environment variable `REDISBUNGEE_PROXY_ID` which can be set
before launch
* new environment variable `REDISBUNGEE_NETWORK_ID` which can be set
before launch
* RedisBungee requires redis version 6.2 or above #88
* Better command system
https://github.com/ProxioDev/RedisBungee/issues/93
## New data system
Due limitation of Redis PubSub in Cluster environment, Internals of
RedisBungee were changed to support Redis Streams
- Network Ids
- networks ids used to group network proxies
- example having 'test' network and 'main' network
- Networks in the same redis server / cluster share the same UUID cache
- Heartbeat system:
- RedisBungee old heartbeat system used hastset on redisbungee to store
the current unix time of the proxy to check what every proxy died or
not, now instead we publish the heartbeat using unix time, and online
count to proxy which proxy store it in their memory, which allow the
`get number of online players` to be faster than pooling whole list in
old data system.
- PubSub
- since redisbungee was initially designed with pubsub in mind,
registration no longer required now for event to fire, see the api
changes below.
## Commands System
* rewritten using [acf lib](https://github.com/aikar/commands) to be
platform independent
* new command `/rb` or `/redisbungee` with sub commands `help`, `info`,
'clean', 'show'.
* 'rb'
* '/rb' and '/rb info'
* '/rb show'
* configuration to disable or override each command from legacy to new
introduced one `/rb`
```yaml
# For redis bungee legacy commands
# either can be run using '/rbl glist' for example
# or if 'install' is set to true '/glist' can be used.
# 'install' also overrides the proxy installed commands
#
# In legacy commands each command got it own permissions since they had it own permission pre new command system,
# so it's also applied to subcommands in '/rbl'.
commands:
# Permission redisbungee.legacy.use
redisbungee-legacy:
enabled: false
subcommands:
# Permission redisbungee.command.glist
glist:
enabled: false
install: false
# Permission redisbungee.command.find
find:
enabled: false
install: false
# Permission redisbungee.command.lastseen
lastseen:
enabled: false
install: false
# Permission redisbungee.command.ip
ip:
enabled: false
install: false
# Permission redisbungee.command.pproxy
pproxy:
enabled: false
install: false
# Permission redisbungee.command.sendtoall
sendtoall:
enabled: false
install: false
# Permission redisbungee.command.serverid
serverid:
enabled: false
install: false
# Permission redisbungee.command.serverids
serverids:
enabled: false
install: false
# Permission redisbungee.command.plist
plist:
enabled: false
install: false
# Permission redisbungee.command.use
redisbungee:
enabled: true
```
## API changes
- Kick api Deprecated:
- `kickPlayer(String playerName, String message) `
- `kickPlayer(UUID playerUUID, String message) `
- newer where added using adventure api:
- `kickPlayer(String playerName, Component message) `
- `kickPlayer(UUID playerUUID, Component message) `
- PubSub registration api Deprecated:
```java
/**
* Register (a) PubSub channel(s), so that you may handle PubSubMessageEvent for it.
*
* @param channels the channels to register
* @since 0.3
* @deprecated No longer required
*/
@Deprecated
public final void registerPubSubChannels(String... channels) {
}
/**
* Unregister (a) PubSub channel(s).
*
* @param channels the channels to unregister
* @since 0.3
* @deprecated No longer required
*/
@Deprecated
public final void unregisterPubSubChannels(String... channels) {
}
```
# Contributors
* `summoncraft.us` for running this branch in production
* @SrBedrock for providing [Brazilian
Portuguese](https://en.wikipedia.org/wiki/Brazilian_Portuguese)
translation #87
# issues
closes #84
closes #88
closes #92
closes #81
closes #93
---------
Signed-off-by: mohammed jasem alaajel <xrambad@gmail.com>
Co-authored-by: ThiagoROX <51332006+SrBedrock@users.noreply.github.com>
2024-04-28 11:29:53 +00:00
|
|
|
You can find the original RedisBungee is by [astei](https://github.com/astei) and project can be
|
|
|
|
|
found [here](https://github.com/minecrafter/RedisBungee) or spigot
|
|
|
|
|
page [here, but its no longer available](https://www.spigotmc.org/resources/redisbungee.13494/)
|
2021-05-23 20:45:13 +00:00
|
|
|
|
