# Gameye Documentation
# Canonical base: https://gameye.com/docs/
# This file is available at https://gameye.com/docs/llms.txt

> Gameye technical documentation. Full API reference, integration guides, and platform concepts for the Gameye game server orchestration platform.

Full text of every docs page in one file: https://gameye.com/docs/llms-full.txt
OpenAPI spec (client API): https://api.production-gameye.gameye.net/openapi.yaml

## AI agents (MCP server and skills)

- Use Gameye from AI agents: gameye-mcp server for Claude Code, Claude Desktop, Cursor and any MCP client (launch and stop sessions, check tags and regions, logs, artifacts, applications, tokens), plus twelve Gameye agent skills: https://gameye.com/docs/guides/using-gameye/ai-agents/
- gameye-mcp on npm (`npx -y gameye-mcp`, needs GAMEYE_API_TOKEN): https://www.npmjs.com/package/gameye-mcp
- gameye-mcp source and README: https://github.com/Gameye/gameye-mcp
- gameye-skills (`npx skills add gameye/gameye-skills --skill "*"`, or Claude Code plugin gameye@gameye): https://github.com/Gameye/gameye-skills

## Introduction and core concepts

- Introduction: https://gameye.com/docs/
- Core Concepts (Application, Session, Region, Resource Profile, TTL, Labels): https://gameye.com/docs/concepts/
- Platform Scope (API capabilities summary, session flow, infrastructure): https://gameye.com/platform-scope/

## Getting started

- Getting Started overview: https://gameye.com/docs/getting-started/
- 1. Set up Docker Hub: https://gameye.com/docs/getting-started/1-docker-hub/
- Getting started with GitHub Container Registry (GHCR) (alternative to step 1: publish, grant gameyedocker Read, create the application, webhook for new tags, first session): https://gameye.com/docs/getting-started/ghcr/
- 2. Create your Dockerfile: https://gameye.com/docs/getting-started/2-docker-file/
- 3. Admin Panel onboarding: https://gameye.com/docs/getting-started/3-admin-panel/
- 4. Start with the API: https://gameye.com/docs/getting-started/4-api-call/

## API V2 reference

- API V2 Overview: https://gameye.com/docs/api-v2/
- Authentication (Bearer token): https://gameye.com/docs/api-v2/authentication/
- Session Management: https://gameye.com/docs/api-v2/session-management/
- Available Locations: https://gameye.com/docs/api-v2/available-locations/
- Artifacts: https://gameye.com/docs/api-v2/artifacts/
- Log Streaming: https://gameye.com/docs/api-v2/log-streaming/
- Tag Verification: https://gameye.com/docs/api-v2/tag-verification/
- POST /session (create session): https://gameye.com/docs/api-v2/reference/post-session/
- GET /session (list sessions): https://gameye.com/docs/api-v2/reference/get-sessions/
- GET /session/{id} (describe session): https://gameye.com/docs/api-v2/reference/get-session-id/
- DELETE /session/{id} (terminate session): https://gameye.com/docs/api-v2/reference/delete-session/
- POST /session/player/join: https://gameye.com/docs/api-v2/reference/post-session-player-join/
- POST /session/player/leave: https://gameye.com/docs/api-v2/reference/post-session-player-leave/
- GET /location (available locations): https://gameye.com/docs/api-v2/reference/get-locations/
- GET /logs: https://gameye.com/docs/api-v2/reference/get-logs/
- GET /tag (tag verification): https://gameye.com/docs/api-v2/reference/check-tag/
- GET /artifact (download artifact): https://gameye.com/docs/api-v2/reference/download-artifact/

## Integration guides

- Matchmaker integration overview: https://gameye.com/docs/guides/integrations/
- Integrating Nakama (Fleet Manager, Go package): https://gameye.com/docs/guides/integrations/nakama/
- Integrating AWS FlexMatch: https://gameye.com/docs/guides/integrations/aws-flexmatch/
- Integrating PlayFab: https://gameye.com/docs/guides/integrations/playfab/
- Using Photon Fusion: https://gameye.com/docs/guides/integrations/photon-fusion/

## Using Gameye guides

- Migrate from Hathora: https://gameye.com/docs/guides/using-gameye/migrate-from-hathora/
- Gameye vs GameFabric: https://gameye.com/docs/guides/using-gameye/hathora-migration/
- Generating logs: https://gameye.com/docs/guides/using-gameye/generating-logs/
- Switch on Smarthost (BETA): https://gameye.com/docs/guides/using-gameye/smarthost/
- How Smarthost works: https://gameye.com/docs/guides/using-gameye/how-smarthost-works/
- Using variables (env vars): https://gameye.com/docs/guides/using-gameye/using-variables/
- Region selection: https://gameye.com/docs/guides/using-gameye/region-selection/
- Using container labels: https://gameye.com/docs/guides/using-gameye/using-container-labels/
- Selecting the correct build: https://gameye.com/docs/guides/using-gameye/selecting-correct-build/
- Deploy from GitHub Actions: https://gameye.com/docs/guides/using-gameye/github-actions/
- Use Gameye from AI agents (MCP): https://gameye.com/docs/guides/using-gameye/ai-agents/

## FAQs and support

- FAQs: https://gameye.com/docs/faqs/
- API authorisation: https://gameye.com/docs/faqs/api-authorisation/
- How Gameye scales: https://gameye.com/docs/faqs/how-gameye-scales/
- Location vs region: https://gameye.com/docs/faqs/location-vs-region/
- TTL billing: https://gameye.com/docs/faqs/ttl-billing/
- Windows container support: https://gameye.com/docs/faqs/windows-containers/
- Container registries: https://gameye.com/docs/faqs/container-registries/
- Getting support: https://gameye.com/docs/support/getting-support/

## Glossary

- Bare metal: https://gameye.com/docs/glossary/bare-metal/
- Container: https://gameye.com/docs/glossary/container/
- Flex metal: https://gameye.com/docs/glossary/flex-metal/
- Matchmaker: https://gameye.com/docs/glossary/matchmaker/
- Region: https://gameye.com/docs/glossary/region/