# Glitchless docs

> Glitchless (glitchless.gg) documentation: the setup prompt for coding agents, guides for Unreal, Unity, Godot, GameMaker and web games, the MCP server, playtest bots, bug reports, share links, source maps, alerts, exporters, self-hosting with Docker and the API spec.

Website: https://www.glitchless.gg/docs.html

Most of the time your coding agent reads these for you: paste the setup prompt and it does the rest. They're here for when you want to know how something works.

## Start here

- [The setup prompt](https://www.glitchless.gg/index.md): Paste it into Claude Code, Codex, Cursor or any agent. It adds Glitchless to your game, connects the MCP server and builds a dashboard.
- [Glitchless Cloud](https://app.glitchless.gg): Sign in with Google or GitHub. Get started gives you the same prompt with your project's keys. Free for 5,000 play sessions a month.
- [Run it yourself](https://github.com/glitchless-gg/glitchless#run-it-on-a-server): One Docker container, or `npm run server`: the server, the dashboard and a file store, no other services.

## Engines

- [Unreal Engine](https://www.glitchless.gg/unreal.md): The C++ plugin for UE 5.7 and 5.8: settings, Blueprint nodes, crashes, `-glitchless-measure` and Unreal MCP.
- [Unity](https://www.glitchless.gg/unity.md): The package for Unity 6.3 LTS and later: setup, what it measures in each build type, bug reports.
- [Godot](https://www.glitchless.gg/godot.md): The addon for Godot 4.5 and later: autoload, hitch causes, errors, phones.
- [Web games](https://www.glitchless.gg/web.md): One npm package for Three.js, Phaser, Babylon.js and PlayCanvas, with WebMCP and an overlay.
- [GameMaker](https://github.com/glitchless-gg/glitchless/blob/main/gamemaker/README.md): GML scripts for GameMaker 2024.2 and later, as a local package or installed by a script.

## Coding agents

- [MCP server](https://github.com/glitchless-gg/glitchless/blob/main/packages/mcp/README.md): `npx -y glitchless-mcp`: 16 tools for findings, frame times, errors, death hotspots, bug reports, versions and playtests.
- [Claude Code plugin and skills](https://github.com/glitchless-gg/glitchless/tree/main/plugin/glitchless): The instrument, dashboard, triage and Steam Deck skills, which any agent can also read as plain files.
- [WebMCP](https://github.com/glitchless-gg/glitchless/blob/main/packages/sdk/README.md#webmcp): Tools a running web game gives your agent: measure frames, inspect the scene, take a screenshot.
- [Playtest bots](https://github.com/glitchless-gg/glitchless/blob/main/packages/playtest/README.md): `glitchless-playtest` plays fixed-seed runs and compares a change with a saved baseline.
- [Steam Deck](https://github.com/glitchless-gg/glitchless-deck): `glitchless-deck` sends a build to a Deck on your network, starts it and measures it there.

## Features

- [Dashboards and boards](https://github.com/glitchless-gg/glitchless/blob/main/docs/SPEC.md#3b-dashboards-and-boards): Every game's own pages, which your agent designs from the events the game sends.
- [Bug reports](https://github.com/glitchless-gg/glitchless/blob/main/packages/sdk/README.md#bug-reports): F8 or your own button: the player's note, a screenshot and the moments before it.
- [Share links](https://github.com/glitchless-gg/glitchless/blob/main/docs/SPEC.md#3c-share-links): One board, read only and signed out, optionally pinned to fixed dates, for dev logs and publishers.
- [Source maps](https://github.com/glitchless-gg/glitchless/blob/main/packages/sourcemaps/README.md): A CLI and a Vite plugin, so a minified web build's errors show the original file and line.
- [Alerts](https://github.com/glitchless-gg/glitchless#alerts-in-discord-or-slack): New errors, crash-free drops, frame-time regressions and new findings, to Discord, Slack or email.
- [Datadog and OpenTelemetry](https://github.com/glitchless-gg/glitchless#exporters-datadog-or-any-opentelemetry-backend): Send the same metrics and logs on to Datadog or any OpenTelemetry backend.
- [Privacy modes and retention](https://github.com/glitchless-gg/glitchless/blob/main/docs/SPEC.md#4b-privacy-levels): Anonymous by default; install mode adds a random player ID for D1, D7 and D30 retention.

## Reference

- [Technical spec](https://github.com/glitchless-gg/glitchless/blob/main/docs/SPEC.md): Every event and field, the query API, how the numbers are computed, keys and storage.
- [Wire format](https://github.com/glitchless-gg/glitchless/blob/main/docs/SPEC.md#2-wire-format): What an SDK sends to `/v1/intake`, for writing your own.
- [What the SDKs send](https://github.com/glitchless-gg/glitchless/blob/main/packages/sdk/PRIVACY.md): Every field in each privacy mode, with lines to adapt for your game's privacy policy.
- [Releases](https://github.com/glitchless-gg/glitchless/releases): The Unreal plugin and GameMaker package downloads, and what changed in each.

## For AI agents

- [llms.txt](https://www.glitchless.gg/llms.txt): An index of this site and the docs, for assistants and crawlers.
- [llms-full.txt](https://www.glitchless.gg/llms-full.txt): All the docs above in one plain-text file: guides, READMEs, skills and the spec.
- [Markdown copies](https://www.glitchless.gg/docs.md): Every page on this site has one: add `.md` to its address.