MySQL Player Sync – Official Wiki

🚀 Welcome to the MySQL Player Sync Wiki! Here you’ll find everything you need to set up, configure, and troubleshoot the plugin.

📌 Table of Contents

1. 🔧 Installation

2. ⚙ Configuration

3. 💾 Database Setup

4. 🔄 How It Works

5. ❓ Troubleshooting

6. 📢 FAQ

7. 🎮 Compatibility

8. 📥 Downloads & Support

🔧 Installation

1. Download the latest version of MySQL Player Sync from SpigotMC.

2. Place the .jar file in the /plugins/ folder on your server.

3. Start your server to generate the config.yml file.

4. Edit config.yml with your MySQL database details.

5. Restart your server – done! 🎉

⚙ Configuration

The plugin comes with an easy-to-use config.yml file. Below is a breakdown of the settings:

language: "en" # Available: "en", "de"

mysql:
  host: "localhost"
  port: 3306
  database: "minecraft_db"
  user: "root"
  password: ""

settings:
  auto-save: true  # Automatically save player data on logout
  sync-on-join: true  # Load player data when they join

🔹 Supported Languages:

• en → English

• de → German

💾 Database Setup

1. MySQL Installation

If you don’t have MySQL installed, follow these steps:

• Windows: Download MySQL Server

• Linux: Install via terminal:

  sudo apt update && sudo apt install mysql-server

2. Creating a Database

Run the following commands in MySQL CLI or phpMyAdmin:

CREATE DATABASE minecraft_db;
CREATE USER 'root'@'localhost' IDENTIFIED BY 'yourpassword';
GRANT ALL PRIVILEGES ON minecraft_db.* TO 'root'@'localhost';
FLUSH PRIVILEGES;

🔄 How It Works

• 🟢 When a player joins → The plugin loads their saved data from the database.

• 🔴 When a player leaves → The plugin automatically saves their inventory, XP, health, and game mode.

• 🔁 Cross-server support → Players will have the same data across multiple servers if connected to the same database.

❓ Troubleshooting

1. Connection Issues

❌ Error: Could not connect to MySQL ✔ Solution:

• Check your config.yml for correct MySQL details.

• Ensure your MySQL server is running.

• Allow remote connections if your database is on another machine.

2. Player Data Not Saving

❌ Error: No data is saved when players leave. ✔ Solution:

• Ensure auto-save: true is enabled in config.yml.

• Check the console/logs for errors.

📢 FAQ

❓ Does this plugin work with BungeeCord or Velocity? ➡ No, this plugin is designed for Spigot/Paper servers only.

❓ Can I sync data between multiple servers? ➡ Yes, as long as they use the same MySQL database.

❓ Which Minecraft versions are supported? ➡ Minecraft 1.21 – 1.21.4

🎮 Compatibility

✔ Minecraft Versions: 1.21 – 1.21.4 ✔ Server Software: Spigot, Paper, Purpur ✔ Database: MySQL, MariaDB

📥 Downloads & Support

🔹 Download: SpigotMC Plugin Page 💬 Need Help? Join our Discord