Universe is a distributed orchestrator that runs as a single fat JAR. Deploy one node as the Master (which exposes a REST API and routes tasks) and any number of nodes as Wrappers (which execute instances via Hazelcast). Runtimes are pluggable — run processes withDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/universeclouddev/Universe/llms.txt
Use this file to discover all available pages before exploring further.
screen or tmux out of the box, or extend to Docker and Kubernetes.
Quickstart
Get a Master node running and deploy your first instance in minutes.
Architecture
Understand the Master/Wrapper topology and Hazelcast task dispatch.
Configuration
Configure node identity, cluster settings, and instance definitions.
API Reference
Explore the full REST and WebSocket API with request/response schemas.
Key Features
Single JAR
Master and Wrapper run from the same artifact. Node role is determined by
config.json.Pluggable Runtimes
Built-in screen and tmux support. Docker and Kubernetes via drop-in extension JARs.
Template System
File-tree templates with dynamic variable replacement at instance creation time.
REST API
Full Ktor-based REST API with bearer authentication, rate limiting, and WebSocket streams.
Extension API
Register custom runtimes, storage backends, metrics exporters, and more.
Minecraft-Ready
First-class Paper, Spigot, Velocity, BungeeCord, and Folia plugin support.
How It Works
Run the JAR
Launch
universe-loader-*.jar on each node. The first run generates config.json and directory structure.Configure the cluster
Set
isMasterNode: true on one node and point Wrapper nodes at the Master’s Hazelcast address.Create templates and configurations
Place file trees in
./templates/<group>/<name>/ and define instance configurations in ./configuration/.Explore by Topic
Runtimes
Screen, tmux, Docker, and Kubernetes runtime configuration and setup guides.
Extensions
S3 storage, Tailscale networking, GitOps sync, ArgoCD, Discord, and metrics integrations.
Minecraft Integration
Paper, Spigot, Velocity, BungeeCord, and Folia plugins with auto-registration.
Operations
Console commands, networking, logging, and API key security.