Skip to main content

Documentation Index

Fetch the complete documentation index at: https://grounds-feat-grounds-runtime-libraries.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Grounds is a developer platform for Minecraft modders. You write a Paper plugin, Velocity plugin, or full game mode; we handle the cluster, the registry, the routing, and the lifecycle.

What you get

One-command deploys

grounds push --target=dev builds your JAR, ships it to a private OCI registry, and rolls out a fresh server in your personal namespace.

Ephemeral preview environments

grounds push --target=staging spins up a throwaway preview env per push with a public URL — perfect for sharing a build with playtesters or your team.

Managed Minecraft routing

Players connect to <your-mode>-<handle>.mc.grnds.io directly — no port forwarding, no proxy config. Service-type workloads get HTTPS at <name>-<handle>.dev.grnds.io.

Multi-project isolation

Group related deployments under a project. Invite teammates with owner/editor/viewer roles. Each project gets its own resource quotas + network policies.

Who this is for

You probably want this if you:
  • maintain a Paper or Velocity plugin and need a place to test it against real player traffic
  • are building a custom game mode (Minestom, Paper) and want preview links you can share
  • run a small studio/community where multiple devs want to publish their work without each running their own VPS
You probably don’t want this (yet) if you:
  • need control over the host OS or Java runtime version (we pin these)
  • want to run mods that require a runtime source that is not in the platform base image catalog yet
  • expect free tier with persistent always-on servers — Grounds auto-pauses idle dev clusters after a few hours

Internal developer path

If you work on Grounds plugins or platform-adjacent repos, start here:

Internal quickstart

Set up a local workspace, authenticate the CLI, and push with local plugin overrides.

Local plugin workspaces

Map independent plugin repos into grounds push --local and --with-local.

Multi-plugin stacks

Test Paper, Velocity, or gamemode stacks with multiple plugins in one push.

Debug pushes

Work through local build, upload, Forge build, and deployment failures.

Get started in five minutes

1

Install the CLI

brew install --cask groundsgg/tap/grounds
Linux/Windows + scripts: see Quickstart → Install.
2

Sign in

grounds login
Browser opens to Grounds Account; sign in with your Grounds Account, approve the device code, and you’re back at the terminal.
3

Push your project

From any Gradle project that has id("gg.grounds.push") applied:
grounds push --target=dev
Forge builds and signs the OCI image, applies the manifest, and prints the public URL when ready.
Full quickstart →

What’s under the hood

Grounds runs on a self-hosted Kubernetes cluster (Talos on bare metal). Key building blocks:
  • forge — the control-plane API. Receives pushes, runs Kaniko + Cosign, applies manifests, manages dev-cluster lifecycle.
  • grounds-push Gradle plugin — packages your JAR + manifest into a multipart upload to forge.
  • grounds CLI — thin wrapper for auth, manual push, status, preview env management.
  • Portal — web UI at portal.platform.grnds.io for browsing pushes, deployments, members, and preview envs.
You don’t need to know any of this to ship — but it’s there if you want to peek behind the curtain.