PlayerSync

PlayerSync is a Minecraft mod that keeps your player data synchronized across multiple servers. Seamlessly move between servers in your network without losing your inventory, experience, advancements, or modded items.

---

Features

• Inventory Sync: Your main inventory, armor, ender chest, and offhand items are always up to date on every server.
• Experience & Stats: XP, health, food, and score are preserved as you travel between servers.
• Advancement Sync: Your achievements and advancements follow you everywhere.
• Potion Effects: Active potion effects are restored when you join a new server.
• Mod Support:
  • Curios API: Curios slots and items are synchronized.
  • Sophisticated Backpacks: Backpack contents are kept in sync.
  • Cobblemon:
    Party, PC and Podex are supported(Only 1.21.1).
• Placeholder Items: If a modded item is missing on a server, a placeholder is created so nothing is lost.
• Chat Sync (Optional): Synchronize chat messages between servers (can be enabled in config).

---

How It Works

PlayerSync uses a central MySQL or MariaDB database to store your player data. When you join a server, your data is loaded from the database. When you leave or your data is saved, it is updated in the database. This ensures your progress is always up to date, no matter which server you play on.

---

Getting Started

1. Install the Mod:
   Download the PlayerSync mod and place it in the mods folder of each server you want to synchronize.

2. Configure the Database:
   Generate config file by starting server at first.Edit the playersync.toml config file in the config folder to set your database connection details.
   Each server should have a unique Server_id.

3. Start Your Servers:
   PlayerSync will automatically create the necessary tables and keep your data in sync.

4. (Optional) Enable Chat Sync:
   Enable chat synchronization in the config if you want messages to be shared between servers.

---

Configuration Options

All options are found in the playersync.toml file in your server’s config folder.

Database Settings

• host
  The address of your MySQL/MariaDB database server.
  Default: "localhost"

• db_port
  The port for your database server.
  Default: 3306

• use_ssl
  Whether to use SSL for the database connection.
  Default: false

• user_name
  The username for your database.
  Default: "playersync"

• password
  The password for your database.

• db_name
  The name of the database to use.
  Default: "playersync"

• Server_id
  This value distinguishes each server in your network. Each server must have a unique integer here!
  Default: Randomly generated.

Synchronization Options

• sync_advancements
  Whether to synchronize advancements (achievements) between servers.
  Default: true

Serialization Options

• use_legacy_serialization
  Use the old (pre-Base64) serialization format for writing data to the database.
  Set to true ONLY if you have mod versions older than 1.35 reading the same database.
  Default: false

Placeholder Item Options

• item_placeholder_title_override
  Override the title of placeholder items (for missing modded items).
  Default: "" (uses default translation)

• item_placeholder_description_override
  Override the description of placeholder items.
  Default: "" (uses default translation)

---

FAQ

Q: What happens if I have modded items and join a server without that mod?
A: PlayerSync will create a placeholder item so your original item is not lost. When you return to a server with the mod, your item will be restored.

Q: Is my data safe?
A: Yes! All data is stored in a central database and is not lost when switching servers.

Q: Does this work for singleplayer?
A: PlayerSync is designed for multi-server networks. It is not needed for singleplayer.

Q: What mods are supported?
A: Curios API and Sophisticated Backpacks are supported out of the box. More mod support may be added in the future.

---

Support

If you have questions or need help, please contact us via Github or Discord.

---

Enjoy seamless play across all your servers with PlayerSync!