uxmEssentials-Redis

What it does

uxmEssentials keeps cross-server state consistent over a small "this changed" bus rather than shipping full payloads around the network. This add-on is the Redis transport for that bus: point it at a Redis server and a plain set of backends sharing one database and one Redis instance sync directly, with no Velocity proxy in the middle.

When a player sets a home, deposits money, edits a vault, or trades across servers, the origin publishes a short notice over Redis pub/sub; every other backend drops its cached copy of that row and re-reads the authoritative value from the shared database. The database stays the single source of truth, and a change never travels as a full object.

What stays in sync

Homes, warps, player-warps, economy, vaults, trade, vanish, moderation, holograms, NPCs, the vote party, and the messaging ignore list every context uxmEssentials replicates across nodes that share one database.

Setup

1. Drop uxmEssentials-redis-0.8.0.jar into each backend's plugins/ folder, alongside the main uxmEssentials jar.

2. Point uxmEssentials at your Redis server and pick the transport in plugins/uxmEssentials/config.conf:

   network {
     enabled   = true
     server-id = "survival-1"     # unique per backend
     transport = "redis"          # velocity | redis | both
     redis {
       host     = "127.0.0.1"
       port     = 6379
       password = ""
       db       = 0
       channel  = "uxmessentials:bus"
     }
   }
   

3. Start the backends. Every node that shares the database and the Redis channel joins the bus automatically; with no Redis, proxy, or peer reachable it falls back cleanly to local-only, so single-server behaviour never changes.

Requirements

• Redis: any reachable Redis server (a single instance is enough).
• Backends: Paper 26.2 running uxmEssentials 0.8.0, all sharing one database. For a real network use MySQL / MariaDB / PostgreSQL SQLite is single-writer.
• Main jar required this add-on does nothing on its own; it is the transport for uxmEssentials.

Notes

Open source (GPL-3.0). Use this when you want cross-server sync without a Velocity proxy. If you already run Velocity, the Velocity add-on carries the same bus over plugin messaging instead.