kryo-player-sync is combination of a Velocity proxy plugin and a Paper plugin which syncs player related data such as their inventory, coins and more.
kryo-player-sync needs the following services to be installed and configured to function properly:
It is not recommended using the root user of the MariaDB server for kryo-player-sync. Please create an extra database with an extra user that is limited to that database.
The following images illustrate the workflow when a player joins the network and when a player switches from one Paper server to another.
To install the Velocity plugin just copy the JAR-file into the plugin directory.
A startup command of Velocity could look like the following:
java -Xms128M -Xmx1024M -XX:+UseG1GC -XX:G1HeapRegionSize=4M -XX:+UnlockExperimentalVMOptions -XX:+ParallelRefProcEnabled -XX:+AlwaysPreTouch -XX:MaxInlineLevel=15 -jar velocity.jarTo install the Paper plugin just copy the JAR-file into the plugin directory.
Furthermore, the Paper plugin needs some environment variables. Those can also be provided as startup parameters if the usage of environment variables is not possible.
| Environment variable | Start parameter | Description |
|---|---|---|
| CONNECTION_STRING | -DCONNECTION_STRING | Connection String for connecting to the MariaDB database |
| RABBITMQ_ADDRESS | -DRABBITMQ_ADDRESS | Address and port of the RabbitMQ message broker |
| RABBITMQ_USERNAME | -DRABBITMQ_USERNAME | Username of the RabbitMQ message broker |
| RABBITMQ_PASSWORD | -DRABBITMQ_PASSWORD | Password of the RabbitMQ message broker |
A startup command of Paper could look like the following:
java -XX:MaxRAMPercentage=90.0 -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 -XX:G1NewSizePercent=30 -XX:G1MaxNewSizePercent=40 -XX:G1HeapRegionSize=8M -XX:G1ReservePercent=20 -XX:InitiatingHeapOccupancyPercent=15 -Dusing.aikars.flags=https://mcflags.emc.gs -Daikars.new.flags=true -DSERVER_NAME=xxx -DCONNECTION_STRING=jdbc:mariadb://127.0.0.1:3306/database?user=user&password=password -DRABBITMQ_ADDRESS=127.0.0.1:5672 -DRABBITMQ_USERNAME=guest -DRABBITMQ_PASSWORD=guest -jar server.jar noguikryo-player-sync is built with Gradle. We recommend using the included wrapper script (./gradlew) to ensure you use the same Gradle version as we do.
To build production-ready JAR files it is sufficient to run ./gradlew shadowJAR.
You can find the JAR files in ./velocity/build/libs/*-all.JAR and ./paper/build/libs/*-all.JAR.
kryo-player-sync uses JUnit 5 and Mockito for testing.
To run all tests just execute ./gradlew test