Skip to content

self-crafted/velocity-sync

Repository files navigation

velocity-sync

standard-readme compliant GitHub GitHub Repo stars GitHub forks GitHub release (latest SemVer) GitHub all releases Modrinth Downloads

Dead simple sync between Minecraft Velocity proxies.

velocity-sync adds no commands to interface with it. Events and information available to one proxy get synced to all others using MQTT.

Caution

I used AI (Claude) to generate the starting point of the code.

Table of Contents

Install

Download a release from GitHub, Modrinth or build the plugin from source.

Put the .jar into the plugins/ directory of the proxy.

Usage

The file allowlist.txt is read every 10 seconds. So simply drop the UUIDs of friends and family in there. You can write comments starting the line with # or //. Player names can't be used. The plugin will accept UUIDs only.

# valid comment
<valid UUID>
// another valid comment
  <valid UUID>

Build from source

You can compile the plugin yourself using the following commands under Linux.

git clone https://github.com/self-crafted/velocity-sync.git
cd velocity-sync
./gradlew build

The plugin jar will be located at build/libs/velocity-sync-<VERSION>.jar.

Note that for compiling you should use JDK 21, the minimum version for Velocity build 600 (latest at 30th May 2026).

Maintainers

@offby0point5

Contributing

If you've got suggestions, feel free to open an issue.

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

This project is licensed under the MIT license.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors