2
0
mirror of https://github.com/proxiodev/RedisBungee.git synced 2024-09-19 23:28:00 +00:00
Commit Graph

108 Commits

Author SHA1 Message Date
74d2862e4f
update readme 2024-05-18 15:11:08 +04:00
85b48e219c
update readme to include info about the rename 2024-05-18 15:11:08 +04:00
4d435a3fb4
update Readme 2024-05-18 15:11:07 +04:00
7b90a34fae
Update README.md 2024-04-28 20:36:09 +04:00
1593c2d628
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'

![image](https://github.com/ProxioDev/RedisBungee/assets/34905970/70796ab0-b5fd-4578-8c93-c976e517df95)

  * '/rb show'
  

![image](https://github.com/ProxioDev/RedisBungee/assets/34905970/56332c37-701f-43e0-946b-6894b845fab3)

* 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 15:29:53 +04:00
dd4cc2a5bb
remove matrix support 2023-12-27 02:07:33 +04:00
mohammed Alteniji
9a583369e8
oops forgot to fix repo for gradle kotlin dsl 2023-04-16 23:02:36 +04:00
mohammed Alteniji
d9e5a21c14
Update README.md 2023-04-16 22:58:41 +04:00
mohammed Alteniji
c5040c9348
Update README.md 2023-04-12 20:26:06 +04:00
mohammed Alteniji
9ca72ff921
Update README.md 2023-04-10 01:56:35 +04:00
mohammed Alteniji
5b5f748cc9
fix wrong maven publishing error 2023-04-06 19:26:37 +04:00
mohammed Alteniji
47127c8520
Javadocs links update (#67) 2023-03-25 19:46:22 +04:00
mohammed Alteniji
b857bdb771
update to gradle (#66) 2023-03-23 15:42:59 +04:00
87a2b93537
update jitpack location 2022-11-01 10:13:36 +04:00
a51ff98909 update readme 2022-08-02 17:52:34 +04:00
80a4791d12 api changes in events, move Listener serialization into Util class 2022-07-30 22:36:29 +04:00
17897bc112 make RedisBungeeAPI class platform dependant and make Abstract version of it 2022-07-27 17:43:51 +04:00
576bcc39d2 update readme 2022-07-26 20:52:42 +04:00
508125023e update readme 2022-07-26 20:46:32 +04:00
43b2d20e39 update readme 2022-07-26 20:45:39 +04:00
64af12044e Change Plugin instance of Bungeecord to RedisBungee to maintain old plugin compatibility 2022-07-26 18:42:29 +04:00
mohammed Alteniji
f303f2c202
Update README.md 2022-07-26 15:43:56 +04:00
mohammed Alteniji
4e46dc5536
Update README.md 2022-07-26 15:41:57 +04:00
mohammed Alteniji
b58e503ec7
Update README.md 2022-07-26 15:38:01 +04:00
mohammed Alteniji
b16a7d4cbc
Update README.md 2022-07-26 15:36:28 +04:00
e4012a8d7b change config in readme, move config-version below 2022-07-22 16:12:56 +04:00
5d1167c20f change original author name, and include it in velocity version 2022-07-21 16:37:32 +04:00
79694fcbb2 fix some typos in readme 2022-07-21 16:26:16 +04:00
1d889f28b9 update readme 2022-07-21 16:23:07 +04:00
b0ab5e3cb4 readd support for redis versions below 6, change method of the summoner 2022-07-17 05:25:50 +04:00
e986d5f1fb change something again in readme 2022-07-16 07:09:04 +04:00
ce93bd5e07 change section of usage 2022-07-16 07:06:30 +04:00
870e6113db readme: fix refernce to the closed pull request 2022-07-16 06:49:10 +04:00
86b0904546 readme: add disclaimer to support version of velocity, fix typo in velocity setup 2022-07-16 06:48:00 +04:00
78ae6ff7b6 update readme javadocs section 2022-07-16 02:33:58 +04:00
933fceba9d add velocity maven setup, update bungeecord section 2022-07-16 02:12:05 +04:00
mohammed Alteniji
ea600c5b44
Update README.md 2022-07-09 23:53:50 +04:00
70d1aadd56 remove no support 2022-07-08 08:19:50 +04:00
183c227b77 update readme again, intellji markdown preview is bad :/ 2022-07-08 08:17:15 +04:00
640b26067a update readme 2022-07-08 08:15:42 +04:00
660bb239bb update readme 2022-07-08 08:14:22 +04:00
dd9c9e368d update readme 2022-07-08 08:07:50 +04:00
Booquefius
28d1667fe9
typo 2022-07-03 19:33:44 -04:00
mohammed Alteniji
839c8cd615
Update README.md 2022-07-03 17:31:38 +04:00
mohammed Alteniji
83dff6b280
Update README.md 2022-07-01 01:25:39 +04:00
mohammed Alteniji
0b868ffd6f
Update README.md 2022-07-01 01:24:48 +04:00
mohammed Alteniji
d7c8544b99
Update README.md 2022-06-30 15:03:16 +04:00
a39c4654fb center 2022-06-17 06:10:29 +04:00
2ceac5a079 move supported redis versions up 2022-06-17 06:03:56 +04:00
814dabbb6a update supported redis versions 2022-06-17 06:02:20 +04:00