A Minecraft Forge mod that synchronizes player data across multiple servers using a MySQL backend.

Go to file

EoD 02de6b50d2 make all config variables final the classes never change, even if the config is modified. Only the values we read with get() inside the classes change.		2025-07-31 23:59:14 +00:00
.github	use PAT in backport action	2025-05-18 17:32:38 +00:00
.vscode	add vscode setting for IntelliJ-like imports	2025-06-17 23:52:11 +00:00
gradle/wrapper	migrate from ForgeGradle to ModDevGradle legacy	2025-05-02 22:40:39 +00:00
src/main	make all config variables final	2025-07-31 23:59:14 +00:00
.gitattributes	Initial commit	2022-12-08 16:59:20 +08:00
.gitignore	add support for Minecraft 1.20.4 with ModDevGradle	2025-05-04 18:43:11 +00:00
build.gradle	add support for Minecraft 1.20.4 with ModDevGradle	2025-05-04 18:43:11 +00:00
docker-compose.yml	use volume for docker-compose db to persist data	2025-05-01 18:42:58 +00:00
gradle.properties	Fix error when no player in server	2025-06-06 13:09:32 +08:00
gradlew	migrate from ForgeGradle to ModDevGradle legacy	2025-05-02 22:40:39 +00:00
gradlew.bat	migrate from ForgeGradle to ModDevGradle legacy	2025-05-02 22:40:39 +00:00
LICENSE	Create LICENSE	2022-12-08 17:11:47 +08:00
README.md	readme: add section on how to setup a dev env	2025-05-01 16:59:05 +00:00
settings.gradle	add support for Minecraft 1.20.4 with ModDevGradle	2025-05-04 18:43:11 +00:00

README.md

PlayerSync

PlayerSync is a Minecraft Forge mod that synchronizes player data across multiple servers using a MySQL backend. It allows players to maintain their inventory, equipment, experience, advancements, and more when moving between servers in a network.

Mod Support

Any other mods support is also possible.

Development Setup

Database Setup (Docker)

A docker-compose.yml file is provided for easily setting up a MariaDB database instance for development testing.

Make sure Docker is installed.
Inside your work directory run:
```
docker compose up -d
```
This will download the MariaDB image (if not already present) and start a database container in the background.
Stoppinng the Database
```
docker compose down
```

Data Persistence: The database uses a Docker volume, ensuring your data persists even if you stop and restart the containers.

Database Management Tool

The docker-compose.yml also includes an Adminer service, a lightweight database management tool.

Access Adminer in your web browser at http://localhost:8080.
Log in using the server with
- username: playersync
- database: playersync
- password: see docker-compose.yml

For debugging purposes, you can enable use_legacy_serialization to have readable database fields. This can cause crashes and unintended side-effects. Do not enable this on a production server if not absolutely necessary!

Running the Mod

The project uses Gradle for building and running. Use the provided Gradle wrapper (gradlew for Linux/macOS, gradlew.bat for Windows).

Make sure that the MySQL database you configured is running.
Run the Server
```
./gradlew runServer
```
or on Windows:
```
.\gradlew.bat runServer
```
This task compiles the mod and starts a dedicated Minecraft server instance with the mod loaded in the run directory.

Run the Client

./gradlew runClient

or on Windows:

.\gradlew.bat runClient