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

Go to file

EoD ba33d5271b fix advancement restore on brand new servers On a brand new server, there is no advancements directory throwing an IOException if we try to write a file to it.		2025-05-02 21:19:34 +00:00
.github	Merge pull request #48 from mlus-asuka/dependabot/github_actions/gradle/gradle-build-action-3	2025-05-02 00:29:59 +08:00
gradle/wrapper	bump gradlew and update mod config	2025-04-23 22:10:48 +00:00
src/main	fix advancement restore on brand new servers	2025-05-02 21:19:34 +00:00
.gitattributes	Initial commit	2022-12-08 16:59:20 +08:00
.gitignore	ignore vscode generated files	2025-04-23 22:37:51 +00:00
build.gradle	bump MySQL dependency to 8.0.33+20230506	2025-05-01 16:11:33 +00:00
docker-compose.yml	use volume for docker-compose db to persist data	2025-05-01 18:42:58 +00:00
gradle.properties	bump gradlew and update mod config	2025-04-23 22:10:48 +00:00
gradlew	bump gradlew and update mod config	2025-04-23 22:10:48 +00:00
gradlew.bat	bump gradlew and update mod config	2025-04-23 22:10:48 +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	bump gradlew and update mod config	2025-04-23 22:10:48 +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