UXPLIMA Documentation / Proxy Setup

Proxy Setup

The proxy layer keeps islands in sync across multiple backend servers behind Velocity/BungeeCord. It's optional and off by default — enable it only when you run a network.

Copy Markdown

How It Works

All backends share one MySQL database (MySQL required).
Each island physically lives on one backend — the server it was created on (tracked by a server column).
/is home and /is visit <player> route the player to the right server when the island lives elsewhere, then teleport them in.
Island changes (members, roles, flags, level, bank, warps) are published over Redis so the other servers refresh that island from the database.
New islands are created on the least-full server in create-servers (balanced distribution).

        ┌─────────────┐
        │  Velocity   │
        └──────┬──────┘
     ┌─────────┼─────────┐
┌────┴───┐ ┌───┴────┐ ┌──┴─────┐
│skyblock│ │skyblock│ │ spawn  │
│  -1    │ │  -2    │ │  -1    │
└────┬───┘ └───┬────┘ └────────┘
     └────┬────┘
   ┌──────┴──────┐  ┌────────┐
   │   MySQL     │  │ Redis  │
   │ (islands)   │  │(pub/sub)│
   └─────────────┘  └────────┘

Configuration

proxy:
  enabled: true
  server-name: "skyblock-1"        # unique per backend!
  spawn-server: "spawn-1"
  create-servers:
    - "skyblock-1"
    - "skyblock-2"
  pending-teleport-seconds: 30
  debug: false
  redis:
    host: "localhost"
    port: 6379
    username: ""
    password: ""
    timeout-seconds: 2
    channel: "skyblock:proxy"

Key	Meaning
`enabled`	Turn the proxy layer on
`server-name`	This server's name in your Velocity/BungeeCord config — must differ on every backend
`spawn-server`	The lobby/spawn server for return routing
`create-servers`	Servers where new islands may be created (balanced). Empty = create locally
`pending-teleport-seconds`	How long a pending cross-server teleport/create stays valid
`debug`	Print detailed routing logs
`redis.*`	Redis connection; the channel must match on all servers

Setup Checklist

Velocity/BungeeCord running, with each backend registered.
All backends use MySQL with the same host/database.
A Redis server all backends can reach, same channel.
On each backend set proxy.enabled: true and a unique server-name matching the proxy config.
Set create-servers to the backends that should host new islands.

Migrate existing islands once:

UPDATE islands SET server = 'skyblock-1' WHERE server IS NULL;

Checking It Works

Run /is proxy (needs skyblock.admin) to see whether the proxy is enabled, this server's name, the create-server list, and which server a given island lives on.

Troubleshooting

Symptom	Likely cause
`/is visit` doesn't switch servers	Island's `server` column is NULL, or server names don't match the proxy
Changes don't appear on other servers	Redis is down or the `channel` differs between servers
New islands all land on one server	`create-servers` only lists one server
Player not teleported after switch	The pending record expired — raise `pending-teleport-seconds`

Turn on proxy.debug: true to log the routing decisions.

Module Sync

Modules like Chunklock reuse this same proxy layer — they ride the same database connection and Redis channel, so add-on data stays in sync across the network for free.

Was this page helpful?