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

Go to file

dependabot[bot] c4e18e61a8 Bump gradle/actions from 5 to 6 Bumps [gradle/actions](https://github.com/gradle/actions) from 5 to 6. - [Release notes](https://github.com/gradle/actions/releases) - [Commits](https://github.com/gradle/actions/compare/v5...v6) --- updated-dependencies: - dependency-name: gradle/actions dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>		2026-04-01 21:02:27 +00:00
.github	Bump gradle/actions from 5 to 6	2026-04-01 21:02:27 +00:00
.vscode	add vscode setting for IntelliJ-like imports	2025-06-17 23:53:15 +00:00
gradle/wrapper	migrate from ForgeGradle to ModDevGradle legacy	2025-05-02 22:40:39 +00:00
src/main	Merge pull request #166 from mlus-asuka/1.20.1-dev	2026-02-24 00:24:45 +08: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	backpack dirty mark test	2025-11-26 15:42:29 +08:00
docker-compose.yml	use volume for docker-compose db to persist data	2025-05-01 18:42:58 +00:00
gradle.properties	update version	2026-02-06 11:21:05 +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	migrate from ForgeGradle to ModDevGradle legacy	2025-05-02 22:40:39 +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