# Grounds Docs

## Docs

- [Grounds documentation](https://grounds-docs-scene-editor-design.mintlify.site/index.md): Build Minecraft workloads, deploy the Grounds platform stack, and reference the APIs, plugins, and engineering conventions.
- [Licensing Model](https://grounds-docs-scene-editor-design.mintlify.site/licensing.md): How Grounds licenses core code, libraries, tooling, documentation, and assets
- [Build for Grounds](https://grounds-docs-scene-editor-design.mintlify.site/build/index.md): Ship your Minecraft plugin or game mode to managed Grounds infrastructure — without touching Kubernetes.
- [Internal developer quickstart](https://grounds-docs-scene-editor-design.mintlify.site/build/quickstart.md): Set up an internal Grounds workspace, push a plugin, and test local plugin overrides.
- [Local development](https://grounds-docs-scene-editor-design.mintlify.site/build/local-development.md): Iterate on your plugin without round-tripping through the cloud.
- [Work with local plugin and module workspaces](https://grounds-docs-scene-editor-design.mintlify.site/build/local-plugin-workspaces.md): Override release plugin sources and Minestom module dependencies with local repositories.
- [Test multi-plugin stacks](https://grounds-docs-scene-editor-design.mintlify.site/build/multi-plugin-stacks.md): Bundle multiple Paper, Velocity, or gamemode plugins into one Grounds push.
- [Share staging previews](https://grounds-docs-scene-editor-design.mintlify.site/build/share-staging-previews.md): Push a build to staging, share it with teammates, and manage preview lifetime.
- [Debug pushes and deployments](https://grounds-docs-scene-editor-design.mintlify.site/build/debug-pushes.md): Diagnose failed local builds, uploads, Forge builds, and deployments.
- [Projects & teams](https://grounds-docs-scene-editor-design.mintlify.site/build/concepts/projects-and-teams.md): Projects scope everything you do on the platform — pushes, previews, members, tokens, and Minecraft access.
- [Targets](https://grounds-docs-scene-editor-design.mintlify.site/build/concepts/targets.md): Where a push lands — dev, staging, or production.
- [Pushes](https://grounds-docs-scene-editor-design.mintlify.site/build/concepts/pushes.md): The lifecycle of a push — from upload to running pod.
- [Base images](https://grounds-docs-scene-editor-design.mintlify.site/build/concepts/base-images.md): How Grounds selects, syncs, and audits runtime images for pushes.
- [Preview environments](https://grounds-docs-scene-editor-design.mintlify.site/build/concepts/preview-environments.md): Ephemeral, public, per-push environments — the result of every staging deploy.
- [Manifest reference](https://grounds-docs-scene-editor-design.mintlify.site/build/manifest.md): Every field in grounds.yaml, what it does, and what's optional.
- [Installing the CLI](https://grounds-docs-scene-editor-design.mintlify.site/build/cli/installation.md): Install the grounds CLI on macOS, Linux, or Windows.
- [Auth](https://grounds-docs-scene-editor-design.mintlify.site/build/cli/auth.md): Login, logout, doctor — and how the CLI talks to Grounds Account.
- [grounds push](https://grounds-docs-scene-editor-design.mintlify.site/build/cli/push.md): Build with Gradle, upload to forge, deploy to a target.
- [Local plugin workspaces](https://grounds-docs-scene-editor-design.mintlify.site/build/cli/workspace.md): Use local plugin builds as opt-in overrides for multi-plugin pushes.
- [grounds preview](https://grounds-docs-scene-editor-design.mintlify.site/build/cli/preview.md): List, inspect, and pin staging preview environments.
- [Configuration](https://grounds-docs-scene-editor-design.mintlify.site/build/cli/configuration.md): Where the CLI looks for its config — files, env vars, and flag precedence.
- [Setup](https://grounds-docs-scene-editor-design.mintlify.site/build/gradle-plugin/setup.md): Apply gg.grounds.push to your Gradle project.
- [groundsPush](https://grounds-docs-scene-editor-design.mintlify.site/build/gradle-plugin/groundsPush.md): The main upload + build + deploy task.
- [groundsPushRetry](https://grounds-docs-scene-editor-design.mintlify.site/build/gradle-plugin/groundsPushRetry.md): Re-run a failed pipeline without re-uploading the JAR.
- [groundsTestLocal](https://grounds-docs-scene-editor-design.mintlify.site/build/gradle-plugin/groundsTestLocal.md): Run Paper or Velocity locally with your plugin loaded — no cloud, no quota.
- [CI / service-account tokens](https://grounds-docs-scene-editor-design.mintlify.site/build/ci-tokens.md): Long-lived, project-scoped API tokens for CI, scripts, and bots.
- [Portal](https://grounds-docs-scene-editor-design.mintlify.site/build/portal/index.md): The web UI at portal.platform.grnds.io — projects, apps, members, Minecraft access, pushes, previews, platform access, and platform base images.
- [Control Center access](https://grounds-docs-scene-editor-design.mintlify.site/build/portal/control-center-access.md): Manage platform users, access roles, permissions, identity mappings, and platform access audit events.
- [Control Center step-up](https://grounds-docs-scene-editor-design.mintlify.site/build/portal/control-center-step-up.md): Configure Keycloak LoA step-up for Grounds Control Center access mutations.
- [Observability](https://grounds-docs-scene-editor-design.mintlify.site/build/observability.md): Where to look when something is wrong — logs, metrics, traces.
- [Troubleshooting](https://grounds-docs-scene-editor-design.mintlify.site/build/troubleshooting.md): Symptoms you'll hit, and what to check first.
- [Platform Test Environment](https://grounds-docs-scene-editor-design.mintlify.site/build/test-environment/index.md): Per-engineer copies of the Grounds platform stack — for iterating on plugins, gamemodes, or services in isolation
- [Bundle Reference](https://grounds-docs-scene-editor-design.mintlify.site/build/test-environment/bundle-reference.md): Field-by-field reference for bundle.yaml and the Engineer-Override-File schema
- [Platform](https://grounds-docs-scene-editor-design.mintlify.site/deploy/index.md): Platform resources, infrastructure components, and supporting integrations
- [Overview](https://grounds-docs-scene-editor-design.mintlify.site/deploy/containers/index.md): Reusable Docker/OCI container images for the Grounds.gg platform
- [dev-container-node](https://grounds-docs-scene-editor-design.mintlify.site/deploy/containers/dev-container-node.md): Node.js container for development in DevSpace environment
- [Paper](https://grounds-docs-scene-editor-design.mintlify.site/deploy/containers/paper.md): Minecraft Paper server container for Grounds.gg infrastructure
- [Velocity](https://grounds-docs-scene-editor-design.mintlify.site/deploy/containers/velocity.md): Minecraft Velocity proxy container for Grounds.gg infrastructure
- [Adding a New Container](https://grounds-docs-scene-editor-design.mintlify.site/deploy/containers/adding-a-new-container.md): Step-by-step guide to add a new container to the repository
- [Overview](https://grounds-docs-scene-editor-design.mintlify.site/deploy/charts/index.md): Helm charts for deploying Grounds.gg services to Kubernetes
- [Adding a New Chart](https://grounds-docs-scene-editor-design.mintlify.site/deploy/charts/adding-a-new-chart.md): Step-by-step guide to add a new Helm chart to the repository
- [Overview](https://grounds-docs-scene-editor-design.mintlify.site/deploy/keycloak-minecraft-idp/index.md): Keycloak identity provider plugin for Minecraft Java and Bedrock sign-in
- [Installation](https://grounds-docs-scene-editor-design.mintlify.site/deploy/keycloak-minecraft-idp/installation.md): Install and prepare the Keycloak Minecraft identity provider
- [Configuration](https://grounds-docs-scene-editor-design.mintlify.site/deploy/keycloak-minecraft-idp/configuration.md): Configure the Keycloak Minecraft identity provider
- [APIs](https://grounds-docs-scene-editor-design.mintlify.site/reference/apis/index.md): Explore the Grounds API and GRPC endpoints to integrate with your application
- [Minecraft / Proxy Plugins](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/index.md): Minecraft server and proxy plugins
- [Config System](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/config-system/index.md): Overview of the Grounds Config System across the Config Plugin and Config API
- [Config Plugin (Paper/Velocity)](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/config-system/config-plugin.md): Integrate typed runtime configuration into Paper and Velocity plugins with ConfigManager
- [Config API](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/config-system/config-api.md): Backend service responsibilities, gRPC surfaces, and operational caveats for the Config API
- [Runtime Behavior](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/config-system/runtime-behavior.md): Bootstrap, reconciliation, degraded startup, and best-effort NATS delivery in the Config System
- [Agones Integration](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/agones/index.md): Overview of plugin-agones across Paper, Velocity, and Minestom gameservers
- [Velocity](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/agones/velocity.md): Proxy-side Agones and static server discovery, lobby routing, and operator command
- [Paper](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/agones/paper.md): Install plugin-agones on a Paper gameserver to report Agones state from player events
- [Minestom](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/agones/minestom.md): Embed plugin-agones-minestom as a library in your Minestom gameserver to sync Agones state
- [In-Game Permissions](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/in-game-permissions/index.md): Manage Minecraft network authorization and integrate local permission checks in Grounds runtimes.
- [Manage In-Game Permissions](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/in-game-permissions/administration.md): Create Minecraft roles, map Keycloak groups, grant player exceptions, and inspect effective access in Portal.
- [Integrate In-Game Permissions](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/in-game-permissions/runtime-integration.md): Configure the Grounds Velocity plugin or Minestom module and evaluate player permissions from local snapshots.
- [Register Permission Nodes](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/in-game-permissions/permission-catalog.md): Publish a workload permission catalog and manage custom in-game permission entries.
- [In-Game Permissions Infrastructure](https://grounds-docs-scene-editor-design.mintlify.site/reference/plugins/in-game-permissions/infrastructure.md): Understand production, stage, and project permission environments, identity propagation, and runtime security boundaries.
- [Overview](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/gradle-plugin/index.md): Gradle plugin bundle providing standardized build configurations for Grounds projects
- [Usage](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/gradle-plugin/usage.md): Step-by-step guide to install and configure the Gradle plugin bundle
- [Service Registry](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/jvm-modules/service-registry.md): Publish and consume typed JVM module services without string lookups at call sites.
- [Minestom Runtime](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/minestom-runtime/index.md): Compose Grounds Minestom servers from lifecycle-aware runtime modules.
- [Runtime Modules](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/minestom-runtime/modules.md): Write Grounds modules for Minestom servers with descriptors, lifecycle hooks, and typed service contracts.
- [Runtime Composition](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/minestom-runtime/composition.md): Discover and select provider-backed Grounds modules in a Minestom server.
- [Local Minestom Modules](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/minestom-runtime/local-modules.md): Replace released Minestom module dependencies with local repositories during grounds push.
- [Repository and Project Naming Conventions](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/naming-conventions.md): Guidelines for naming repositories in the Grounds organization
- [Logging Conventions](https://grounds-docs-scene-editor-design.mintlify.site/reference/development/logging-conventions.md): How we write logs that are clear, consistent, and incident-ready

## Optional

- [Website](https://grounds.gg)