!MultiProxySync banner

🚀 MultiProxySync

!GitHub release !Maven Central !License !Velocity !Redis !MiniPlaceholders

Synchronize player counts and player lists across multiple Velocity proxies.

📖 About

MultiProxySync is designed for distributed Velocity proxy networks.

It uses Redis to keep player counts, player lists, and proxy states synchronized across multiple Velocity proxies, allowing every entry point to share the same network-wide online data.

With periodic synchronization and Redis Pub/Sub, player and proxy state changes are synchronized in real time while inactive proxies are automatically detected and removed from the active proxy list.

---

📷 Preview

!Image displaying server MOTD information

---

✨ Features

• Multi-Proxy Player Sync Synchronizes player counts and player lists across multiple Velocity proxies and keeps them up to date.

• Consistent Global Player Count Synchronizes the network-wide online count across different proxy entry points and keeps it consistent.

• Redis Pub/Sub Synchronizes player join, leave, and proxy state changes in milliseconds and keeps data updated in real time.

• Automatic Proxy Detection Automatically detects active and inactive proxies and keeps the proxy list up to date.

• MiniPlaceholders Support Automatically provides the synchronized global player count through MiniPlaceholders when installed.

• Update Checker & bStats Checks for new versions and collects anonymous usage statistics.

---

📦 Requirements

• Velocity 3.x+
• Redis

Optional

• MiniPlaceholders

---

🛠️ Installation

1. Set up a Redis server.
2. Download the latest multiproxysync-plugin.
3. Place it in the plugins directory of every Velocity proxy.
4. Start the proxies and edit the generated config.yml.
5. Make sure every MultiProxySync instance connects to the same Redis server.

---

📄 Configuration

plugin:
  serverName: Proxy-01
  enabled: true

redis:
  host: 127.0.0.1
  port: 6379
  password: YourPassword

Notes

• serverName must be unique for each proxy.
• All proxies must connect to the same Redis instance.
• enabled controls whether MultiProxySync is initialized.

---

🔤 MiniPlaceholders

When MiniPlaceholders is installed, MultiProxySync automatically registers:

<multiproxysync_global_player_count>

Example:

Global online: <multiproxysync_global_player_count>

The placeholder returns the synchronized network-wide online player count.

---

🗺️ Version Roadmap

2.3.x

The 2.3.x release line focuses exclusively on player count and player list synchronization.

Future 2.3.x releases will mainly include bug fixes, stability improvements, and maintenance related to the existing synchronization functionality.

3.0.0+

Starting with 3.0.0, MultiProxySync will expand beyond player synchronization and introduce additional network synchronization features.

If you only need player count and player list synchronization, you can continue using the 2.3.x release line.

---

🔧 For Developers

MultiProxySync provides a read-only API for accessing synchronized proxy and player data.

Starting with 2.3.0, the API uses:

Maven Group ID: net.time-cloud
Java Package:   net.timecloud

API method signatures remain unchanged from previous versions.

For dependency examples and usage documentation, see the GitHub repository:

https://github.com/User-Time/MultiProxySync

---

💬 Feedback

If you encounter an issue or have a suggestion, feedback is welcome:

https://github.com/User-Time/MultiProxySync/issues