Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/minebench/syncinv

Paper cross server player data syncing using redis and OpenInv | Provided without support nor warranty! (See point 15. in GPLv3 license) So do not use this if you can't support it yourself/don't have a support arrangement with me!
https://github.com/minebench/syncinv

bukkit-plugin data-sync inventory-sync minecraft paper-plugin

Last synced: about 2 months ago
JSON representation

Paper cross server player data syncing using redis and OpenInv | Provided without support nor warranty! (See point 15. in GPLv3 license) So do not use this if you can't support it yourself/don't have a support arrangement with me!

Awesome Lists containing this project

README

        

# SyncInv
Paper cross server player data syncing using redis and (optionally) [OpenInv](https://github.com/jikoo/OpenInv).

Provided without any (implied) support nor warranty! (See [GPLv3 license](https://github.com/Minebench/SyncInv/blob/master/LICENSE#L589))

## Requirements

- At least Java 21
- [Paper](https://papermc.io) Minecraft server software (tested on 1.20.6+, should be the same version on all synced
servers)
- [redis](https://redis.io) pub-sub
- [OpenInv](https://github.com/jikoo/OpenInv) (optionally, for a more smooth experience)

## Setup

1. Install redis, Paper, SyncInv (and optionally OpenInv).
2. Configure the SyncInv [`config.yml`](https://github.com/Minebench/SyncInv/blob/master/src/main/resources/config.yml):
1. Specify the `server-name` for each server as set in your proxy config
2. Setup the values for the pub-sub connection to your redis server in the `redis` section
3. Toggle the types of data you want to sync in the `sync` section
4. Familiarize yourself with all the [other settings](https://github.com/Minebench/SyncInv/blob/master/src/main/resources/config.yml) and adjust if necessary (the most important one probably beeing the `required-servers` list and the `server-group` name if you want multiple different sync groups in your network)

## Download

Pre-build plugin jars can be downloaded from the [Minebench.de build server](https://ci.minebench.de/job/SyncInv/).

## License

```
SyncInv - Cross server player data syncing
Copyright (C) 2021 Max Lee aka Phoenix616 ([email protected])

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .
```