# Flockbay documentation

Flockbay is the Godot editor with an AI agent and an MCP server built in. Compatible with Godot 4.x.

Source: https://flockbay.com/docs/ · Updated 2026-11-18

Docs for agents: [llms.txt](/llms.txt). Every page also has a Markdown copy at its address plus `.md`, and Copy page on the page itself.

Start with the [Quickstart](/docs/quickstart/), [Open your existing Godot project](/docs/open-an-existing-godot-project/), or [Connect your agent (MCP)](/docs/connect-your-own-agent/).

## Before you start

- 64-bit Windows 10 or 11, macOS 15 or later on Apple Silicon, or 64-bit Linux.
- A GPU with Vulkan 1.0 or Direct3D 12 for Forward+, or OpenGL 3.3 for the Compatibility renderer.
- An internet connection while you build.
- Optional: Claude Code, Codex or Cursor, or an API key, to build on your own AI.

[System requirements](/docs/system-requirements/) has the rest.

## Connect your own agent

Paste this into Claude Code, Codex or Cursor. Your agent connects Flockbay and reads your project, and changes nothing until you ask. Agents can fetch it from .

[Who makes Flockbay](/about/) · [Security: what leaves your machine](/security/) ·

[Godot 4 answers, verified](/godot/)

## Common tasks

[Connect Claude Code](/docs/claude-code-codex-and-cursor/) Your Claude Code session runs the game, reads stdout and the debugger, sends input and captures the viewport, through Flockbay’s MCP server.

[Connect Codex](/docs/connect-your-own-agent/) The same server in Codex, with the two config keys that put every Flockbay tool in what Codex sends the model.

[Open an existing Godot project](/docs/quickstart-existing-project/) Four steps with your own project: open it, have the agent explain it, pick one of three small changes, then review and revert.

[Review an agent’s changes](/docs/what-director-1-does/#reviewing-what-a-turn-changed) The receipt, the per-file diff, Review changes with Revert per hunk, and Revert this turn.

[Run headless](/docs/what-director-1-does/#it-plays-its-own-work) The agent runs the game headless, reads stdout and the debugger, GDScript parse errors included, and captures the viewport.

[Export a build](/docs/export-your-game/) Windows, macOS, Linux or the Web, from your project’s export presets.

## Get started

[Install on Windows](/docs/install-on-windows/) On Windows, flockbay.com gives you a small code-signed installer that downloads Flockbay and runs its setup. Flockbay installs for your user account, with no administrator password, and includes the Godot 4.7.2 editor your games run on.

[Install on macOS](/docs/install-on-mac/) Flockbay for macOS is a signed, notarized disk image for Apple Silicon, downloaded from flockbay.com. It is the same app as on Windows, with the Godot 4.7.2 editor your games run on included.

[Install on Linux and ChromeOS](/docs/install-on-linux/) Flockbay for Linux is one AppImage for 64-bit Intel or AMD PCs, for Ubuntu 22.04, Debian 12, Fedora 39 (glibc 2.35) or newer. A Chromebook with an Intel or AMD processor runs the same AppImage in ChromeOS’s Linux development environment.

[System requirements](/docs/system-requirements/) Flockbay is a desktop app for 64-bit Windows, macOS on Apple Silicon and 64-bit Linux, and a Chromebook with Linux turned on runs the Linux build. Godot 4.7.2, standard and .NET, is included. There is no phone version.

[Quickstart](/docs/quickstart/) Install Flockbay, open your Godot project or make a new one, pick the AI that builds, connect your own agent over MCP if you use one, and press F5. Five steps, a few minutes.

[Quickstart: your existing Godot project](/docs/quickstart-existing-project/) Open your project, have Flockbay explain its scenes, autoloads and main loop, ask for three small changes and pick one, then review the diff, run the game and revert the turn if it is wrong. Two prompts to copy.

[Your account](/docs/your-account/) Downloading Flockbay needs no account, and neither does building. On first launch Flockbay gives the install a guest account, with no browser and no email, and builds on it from your first message. Play and the editor ask for nothing more. Save your account is a free sign-in, needed to share a play link, make a Community profile, or buy a plan. Your AI and keys are in Connectors.

## Projects

[Open your existing Godot project](/docs/open-an-existing-godot-project/) A Godot project you made elsewhere opens in Flockbay. Flockbay asks once before it writes anything into it, records everything it adds, and takes it all out again when you ask.

[Import a Unity project](/docs/import-from-unity/) Import from Unity makes a new Godot 4 project from a Unity project, without opening or installing Unity. Scenes, prefabs, models, sprites, tilemaps and settings convert on import; the Port report lists what is left, and the AI ports it with you.

[New project: blank or template](/docs/first-launch/) Flockbay opens on Home: open a Godot project you have, or make a new one. New project asks what Godot’s own Create New Project asks, plus a template and an optional description. Create makes the project with no AI call; a description becomes the first message in its chat, on Flockbay’s hosted AI, which is free to start, unless you pick your own Claude or ChatGPT.

[Projects on disk](/docs/where-your-project-lives/) A project is a Godot project folder on your computer, where you made or opened it. Flockbay keeps no copy of it elsewhere. Its own data and logs are in a separate app data folder.

[Open without Flockbay](/docs/open-your-project-in-godot/) Every project is a Godot project, and it opens in the Godot editor with Flockbay’s chat docked beside it. Open without Flockbay opens it in the Godot editor without Flockbay’s plugin, with the chat in Flockbay’s own window.

[Godot versions and engines](/docs/godot-versions-and-engines/) Flockbay works with Godot 4.6+. It includes Godot 4.7.2 in its standard and .NET builds, and runs your projects on it. Your own Godot editors are listed in Settings › Godot versions, and a project from another version can stay on one of them.

[Version control with Git and GitHub](/docs/version-control-with-git-and-github/) A Flockbay game is a Godot project in a folder, so it works with Git. The Version control panel sets the repository up, publishes it to GitHub, and syncs it with the people you work with. Flockbay keeps no copy of your game.

## AI and agents

[How Flockbay’s agent works](/docs/what-director-1-does/) Flockbay’s agent works in turns: you send a message, it calls tools in your project, and the reply ends with a receipt of every file it changed. How much it may do without asking is the chat’s permission mode.

[Asking for a change](/docs/asking-for-a-change/) Ask in the chat. Each turn lists its steps; open a step for its command, output or diff, and the turn ends with a receipt of the files it changed. Then press Play and judge the game.

[Managing context](/docs/managing-context/) A chat’s context window holds Flockbay’s instructions and tools, then the messages, tool results and pictures in the chat, which go with each request. A game outlives any one chat: keep its plan and conventions in project files, give each task its own chat, and compact between tasks.

[Models](/docs/which-models-can-i-use/) Each chat runs on the model picked in the menu beside Send. A new chat runs on Flockbay’s AI, free to start and the same on every plan. The menu also lists your own Claude Code and ChatGPT models, and the models your API keys reach.

[Claude Code](/docs/build-with-your-claude-plan/) Flockbay runs Claude Code, Anthropic’s coding agent, on your own paid Claude account and shows its work in Flockbay’s chat. You pay Anthropic for the subscription you already have, and Flockbay nothing. On Windows, macOS and Linux; on a Mac it uses the Claude Code you have installed or installs it with Homebrew, and on Linux it uses the Claude Code you have installed.

[Codex (ChatGPT)](/docs/build-with-your-chatgpt-plan/) Sign in with ChatGPT and Flockbay’s chat runs on your own ChatGPT account, through the Codex engine that comes with the app. You pay OpenAI for the plan you already have, if it is a paid one, and Flockbay nothing for your first build; after that, a plan keeps you building.

[Start here if you use Claude Code, Codex or Cursor](/docs/claude-code-codex-and-cursor/) Your agent already reads and writes your GDScript. Connected to Flockbay over MCP, it also runs the game, reads stdout and the debugger, sends input events, captures the viewport and edits scenes through the open Godot editor. Setup is one line or one prompt.

[Setup prompt for your agent](/docs/agent-setup-prompt/) Paste this into Claude Code, Codex or Cursor in your game’s folder. Your agent connects Flockbay’s MCP server, checks it, reads the project with flockbay_project_info, and changes nothing until you ask.

[Connect your agent (MCP)](/docs/connect-your-own-agent/) The Flockbay app runs an MCP server for the game you have open. Turn it on in Connectors, copy the setup line for your agent, and Claude Code, Codex, Cursor or any other MCP client builds in that game with Flockbay’s tools.

[Steam market research in Claude and ChatGPT](/docs/market-research-connector/) Flockbay’s Steam market research runs as a remote MCP server that Claude, ChatGPT and other AI assistants can use with no Flockbay account. Ask about a game idea and your assistant finds comparable Steam games, how they sold and how often games with those tags do well. When you want to build the idea, it saves it with a link that opens it in Flockbay.

[The modeler](/docs/the-modeler/) The modeler is how your AI makes a 3D model without a generation key. It writes a spec of blended shapes, and Flockbay builds a rigged, game-ready model from it on your computer. It costs nothing per model.

## Editor

[The editor: Minimal, Standard and Full views](/docs/the-editor/) Flockbay opens your project in the Godot editor that comes with it, with Flockbay’s chat docked beside it. Every project opens in the Minimal view, the chat and the Game screen, until you choose Standard, Godot’s editor without three docks, or Full, all of Godot’s editor. Play belongs to the app in every view.

[Plugins](/docs/plugins/) Plugins lists the free plugins on the Godot Asset Store that fit the project you have open, and installs one into it when you press Install. Terrain, sky, water, weather and character controllers come from plugins.

## Play and debug

[Play, Stop and the Game screen](/docs/play-and-debug/) Play runs your game in the Game screen, attached to the editor’s debugger as Godot’s own runner attaches it: F5 plays the main scene, F6 the open scene, F7 breaks and F8 stops. Prints go to Output, a script error stops at its line, and breakpoints stop the game.

[Multiplayer: test rooms and Steam](/docs/multiplayer/) Flockbay builds online games on Godot’s high-level multiplayer. While you build, Play hosts a test room that a second instance or a friend’s playtest joins with a code. Rooms run only in copies Flockbay opens: the game you export has none. For online play in the game you ship, ask Flockbay to add Steam multiplayer.

[Twitch chat in your Godot game](/docs/twitch/) Ask Flockbay for Twitch chat and it writes it into your game: one autoload that reads the streamer’s chat, and the chat play in your own scripts, such as a vote on the next room, commands that spawn enemies, or viewers joining the game. It signs in with your own Twitch app and talks to Twitch only, with no server in between. By default the stream shows votes and counts, never chat text.

## Publishing tools

[Export](/docs/export-your-game/) Publishing tools › Export builds your game for Windows, macOS, Linux or the Web from your project’s export presets, as a release or with Export With Debug. A preset’s own template, signing and .pck layout are kept, and Export in Godot… opens Godot’s own Project › Export….

[Publishing tools: playtests, Steam page, website and launch tools](/docs/ship/) Publishing tools is a screen for one game, with tabs for Launch plan, Market, Steam page, Website, Video studio, Social posts, Ads and Playtests, and Export beside them. Some of its tools are paid features, and the rest are free on every account.

[Sell your project](/docs/sell-your-project/) Sell a Godot project on itch.io or Gumroad, or share it free on GitHub. Flockbay takes no cut and hosts nothing: you pack the project, put it up where you sell it, and check the licence of each asset in it.

## Reference

[MCP tool reference](/docs/mcp-tool-reference/) Every tool Flockbay’s MCP server lists to your agent once the app serves it, by group, with its arguments. Until then the server lists one tool, flockbay_status, which says what to do.

[Keyboard shortcuts](/docs/keyboard-shortcuts/) Every key Flockbay binds, by where it works: Flockbay’s window, the chat and the Godot editor. Help › Keyboard shortcuts shows the same list in the app, with a filter. Flockbay’s editor commands rebind in Editor Settings › Shortcuts › Flockbay.

[Command line](/docs/command-line/) Flockbay takes three flags, for a script or an agent that wants a project open in the editor, and the MCP connection on, without anyone at the window. The launch prints what the app did and exits 0, or 1 when it could not.

[Plans and usage](/docs/plans-and-usage/) Flockbay is free to start. Every account gets free hosted AI for its first build, and plans add more. You can also build on your Claude or ChatGPT plan, your own agent over MCP, or your own API key.

[Privacy: what leaves your computer](/docs/privacy/) Your projects stay on your computer, and Flockbay keeps no copy of them. What leaves depends on what builds and what you share: this page lists each case, and where to turn it off.

[Troubleshooting and support](/docs/troubleshooting/) Start with Help: Report a bug on Discord, and Send logs to Flockbay… with the failure attached. Every failure card has Copy details. The rest of this page covers the failures people meet most.

## Questions

[How do I undo an agent’s change?](/docs/how-do-i-undo-an-agents-change/) Press Revert this turn on the turn’s receipt, or type /undo for the newest turn. Revert on a file’s row takes back that file, and Review changes (Ctrl+Shift+R) takes back one hunk. Redo puts a reverted turn back.

[How do I review what the agent changed?](/docs/how-do-i-review-what-the-agent-changed/) Every turn that changes files ends with a receipt, "Changed 3 files +42 −7", and a row per file with its diff. Review changes (Ctrl+Shift+R) opens every file the turn changed in one scroll, beside the chat.

[How do I commit the agent’s changes to Git?](/docs/how-do-i-commit-the-agents-changes-to-git/) Open Version control (Ctrl+Shift+G). Changes lists every uncommitted file with its diff, the commit message is drafted from what you asked Flockbay since the last commit, and Ctrl+Enter commits. Push and Pull are at the top of the panel.

[How do I see Godot’s output and errors in Flockbay?](/docs/how-do-i-see-godots-output-in-flockbay/) Press Play (F5): the game is attached to the Godot editor’s debugger, prints show in Output, and errors with their stack traces under Debugger › Errors. When Flockbay runs the game itself, its step in the chat shows Godot’s Output and the exit code.

[How do I get Godot’s Scene dock and Inspector back?](/docs/how-do-i-get-godots-docks-back/) Every project opens in the Minimal view: the chat and the Game screen. The switch at the right end of the editor’s title bar picks Standard, which adds the Scene and Node docks, the Inspector, FileSystem, the Script editor and the bottom panel, or Full, all of Godot’s editor. It applies at once.

[How do I open my project in VS Code or a terminal?](/docs/how-do-i-open-a-project-in-vs-code/) The project menu has Open in your code editor, Open in Terminal and Show in Explorer, each at the project’s folder. Settings › Developer › External editor picks the editor, and every res:// path and error line in the chat opens there at its line.

[Does Flockbay change my Godot project?](/docs/does-flockbay-change-my-godot-project/) Only after you say yes. For a project made elsewhere, a card asks Add Flockbay to and the project’s name, and lists everything it writes before it writes it. Open without Flockbay writes nothing, and Uninstall Flockbay from project… takes it all out again.

[How do I connect Claude Code to Godot?](/docs/how-do-i-connect-claude-code-to-godot/) Open your Godot project in Flockbay, then Connectors › Connect your agent (MCP) › Set up › Turn on. Pick Claude Code, press Copy, and paste the command in a terminal. In a new Claude Code session, /mcp lists flockbay.
