# Grounds Docs

## Docs

- [CI / service-account tokens](https://docs.grounds.gg/build/ci-tokens.md): Long-lived, project-scoped API tokens for CI, scripts, and bots.
- [Auth](https://docs.grounds.gg/build/cli/auth.md): Login, logout, doctor — and how the CLI talks to Grounds Account.
- [Configuration](https://docs.grounds.gg/build/cli/configuration.md): Where the CLI looks for its config — files, env vars, and flag precedence.
- [Installing the CLI](https://docs.grounds.gg/build/cli/installation.md): Install the grounds CLI on macOS, Linux, or Windows.
- [grounds preview](https://docs.grounds.gg/build/cli/preview.md): List, inspect, and pin staging preview environments.
- [grounds push](https://docs.grounds.gg/build/cli/push.md): Build with Gradle, upload to forge, deploy to a target.
- [Preview environments](https://docs.grounds.gg/build/concepts/preview-environments.md): Ephemeral, public, per-push environments — the result of every staging deploy.
- [Projects & teams](https://docs.grounds.gg/build/concepts/projects-and-teams.md): Projects scope everything you do on the platform — pushes, previews, members, tokens.
- [Pushes](https://docs.grounds.gg/build/concepts/pushes.md): The lifecycle of a push — from upload to running pod.
- [Targets](https://docs.grounds.gg/build/concepts/targets.md): Where a push lands — dev, staging, or production.
- [groundsPush](https://docs.grounds.gg/build/gradle-plugin/groundsPush.md): The main upload + build + deploy task.
- [groundsPushRetry](https://docs.grounds.gg/build/gradle-plugin/groundsPushRetry.md): Re-run a failed pipeline without re-uploading the JAR.
- [groundsTestLocal](https://docs.grounds.gg/build/gradle-plugin/groundsTestLocal.md): Run Paper or Velocity locally with your plugin loaded — no cloud, no quota.
- [Setup](https://docs.grounds.gg/build/gradle-plugin/setup.md): Apply gg.grounds.push to your Gradle project.
- [Build for Grounds](https://docs.grounds.gg/build/index.md): Ship your Minecraft plugin or game mode to managed Grounds infrastructure — without touching Kubernetes.
- [Local development](https://docs.grounds.gg/build/local-development.md): Iterate on your plugin without round-tripping through the cloud.
- [Manifest reference](https://docs.grounds.gg/build/manifest.md): Every field in grounds.yaml, what it does, and what's optional.
- [Observability](https://docs.grounds.gg/build/observability.md): Where to look when something is wrong — logs, metrics, traces.
- [Portal](https://docs.grounds.gg/build/portal.md): The web UI at portal.platform.grnds.io — projects, members, pushes, previews.
- [Quickstart](https://docs.grounds.gg/build/quickstart.md): From zero to a public Minecraft server URL in five minutes.
- [Bundle Reference](https://docs.grounds.gg/build/test-environment/bundle-reference.md): Field-by-field reference for bundle.yaml and the Engineer-Override-File schema
- [Platform Test Environment](https://docs.grounds.gg/build/test-environment/index.md): Per-engineer copies of the Grounds platform stack — for iterating on plugins, gamemodes, or services in isolation
- [Troubleshooting](https://docs.grounds.gg/build/troubleshooting.md): Symptoms you'll hit, and what to check first.
- [Adding a New Chart](https://docs.grounds.gg/deploy/charts/adding-a-new-chart.md): Step-by-step guide to add a new Helm chart to the repository
- [Overview](https://docs.grounds.gg/deploy/charts/index.md): Helm charts for deploying Grounds.gg services to Kubernetes
- [Adding a New Container](https://docs.grounds.gg/deploy/containers/adding-a-new-container.md): Step-by-step guide to add a new container to the repository
- [dev-container-node](https://docs.grounds.gg/deploy/containers/dev-container-node.md): Node.js container for development in DevSpace environment
- [Overview](https://docs.grounds.gg/deploy/containers/index.md): Reusable Docker/OCI container images for the Grounds.gg platform
- [Paper](https://docs.grounds.gg/deploy/containers/paper.md): Minecraft Paper server container for Grounds.gg infrastructure
- [Velocity](https://docs.grounds.gg/deploy/containers/velocity.md): Minecraft Velocity proxy container for Grounds.gg infrastructure
- [Platform](https://docs.grounds.gg/deploy/index.md): Platform resources, infrastructure components, and supporting integrations
- [Configuration](https://docs.grounds.gg/deploy/keycloak-minecraft-idp/configuration.md): Configure the Keycloak Minecraft identity provider
- [Overview](https://docs.grounds.gg/deploy/keycloak-minecraft-idp/index.md): Keycloak identity provider plugin for Minecraft Java and Bedrock sign-in
- [Installation](https://docs.grounds.gg/deploy/keycloak-minecraft-idp/installation.md): Install and prepare the Keycloak Minecraft identity provider
- [Grounds documentation](https://docs.grounds.gg/index.md): Build Minecraft workloads, deploy the Grounds platform stack, and reference the APIs, plugins, and engineering conventions.
- [Licensing Model](https://docs.grounds.gg/licensing.md): How Grounds licenses core code, libraries, tooling, documentation, and assets
- [APIs](https://docs.grounds.gg/reference/apis/index.md): Explore the Grounds API and GRPC endpoints to integrate with your application
- [Overview](https://docs.grounds.gg/reference/development/gradle-plugin/index.md): Gradle plugin bundle providing standardized build configurations for Grounds projects
- [Usage](https://docs.grounds.gg/reference/development/gradle-plugin/usage.md): Step-by-step guide to install and configure the Gradle plugin bundle
- [Logging Conventions](https://docs.grounds.gg/reference/development/logging-conventions.md): How we write logs that are clear, consistent, and incident-ready
- [Repository and Project Naming Conventions](https://docs.grounds.gg/reference/development/naming-conventions.md): Guidelines for naming repositories in the Grounds organization
- [Agones Integration](https://docs.grounds.gg/reference/plugins/agones/index.md): Overview of plugin-agones across Paper, Velocity, and Minestom gameservers
- [Minestom](https://docs.grounds.gg/reference/plugins/agones/minestom.md): Embed plugin-agones-minestom as a library in your Minestom gameserver to sync Agones state
- [Paper](https://docs.grounds.gg/reference/plugins/agones/paper.md): Install plugin-agones on a Paper gameserver to report Agones state from player events
- [Velocity](https://docs.grounds.gg/reference/plugins/agones/velocity.md): Proxy-side Agones gameserver discovery, lobby routing, and operator command
- [Config API](https://docs.grounds.gg/reference/plugins/config-system/config-api.md): Backend service responsibilities, gRPC surfaces, and operational caveats for the Config API
- [Config Plugin (Paper/Velocity)](https://docs.grounds.gg/reference/plugins/config-system/config-plugin.md): Integrate typed runtime configuration into Paper and Velocity plugins with ConfigManager
- [Config System](https://docs.grounds.gg/reference/plugins/config-system/index.md): Overview of the Grounds Config System across the Config Plugin and Config API
- [Runtime Behavior](https://docs.grounds.gg/reference/plugins/config-system/runtime-behavior.md): Bootstrap, reconciliation, degraded startup, and best-effort NATS delivery in the Config System
- [Minecraft / Proxy Plugins](https://docs.grounds.gg/reference/plugins/index.md): Minecraft server and proxy plugins

## Optional

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