Tags:

Utility Tools Server-Specific

Author:

imtsubaki

Side:

Server

Created:

Jun 10th at 6:30 PM

Last modified:

Jun 10th at 6:37 PM

Downloads:

17

For testers:
Nimbus-v0.1.0.zip

Nimbus is a proxy for Vintage Story that sits in front of your game servers and routes players across multiple backend worlds from a single public address, similar to what Velocity does for Minecraft networks.

This mod (Nimbus.ServerMod) is the backend piece. It runs on each of your VS game servers and connects them to the Nimbus proxy.

What you can do with it

• Run multiple VS game servers (hub, survival, creative, events…) all accessible from one IP and port
• Move players between servers at runtime - no reconnect required on the player's end
• Enforce that players must connect through the proxy - direct connections to backend servers are blocked automatically
• Get the player's real IP address on your backend servers, even though connections arrive through the proxy
• Set servers to maintenance mode to take them offline cleanly without kicking existing sessions
• Manage your network from the command line with nimctl, or from in-game with /nimbus commands

How it works

The Nimbus proxy runs as a standalone process on your host. Players connect to the proxy address, they never see or connect to your individual game servers directly. This mod registers each backend with the proxy, sends heartbeats so the proxy knows the server is alive, and handles player arrivals by consuming a cryptographically-signed reservation minted by the proxy. That reservation carries the player's real IP address and identity, verified and tamper-proof.

When a player is moved to another server triggered by an in-game command, a mod, or a network admin, the proxy handles the reconnect transparently. The player sees a brief loading screen and lands on the new server.

This mod does not stand alone

You need the Nimbus proxy running alongside your servers. The mod and proxy are both bundled inside the .zip! Place the mod in your server's mod folder and the Nimbus proxy folder wherever you please.

• GitHub - proxy, server mod, and all source code
• Getting Started guide
• Server Mod configuration reference
• How player identity forwarding works
• Discord - support and discussion

In-game commands

Once the mod is running and connected to the proxy, players and admins get:

• /server <name> / /join <name> - move yourself to another server on the network
• /nimbus send <player> <server> - move another player (requires controlserver privilege)
• /nimbus servers - list all servers on the network with player counts
• /nimbus status - show this backend's connection state and last heartbeat

Plugin API

Nimbus has a plugin system for extending proxy behaviour with your own code. Plugins are .NET class libraries that hook into proxy events, intercept connections, reroute players, block by IP, log transfers, build custom load balancers, and more. Plugins are hot-reloadable without restarting the proxy.

• Plugin Development guide
• Example plugins

Requirements

• Vintage Story server 1.19+
• The RedirectFix client mod distributed to your players (prevents a vanilla client crash on server transfers)