Skip to main content
Version: 5.x

AI Coding Assistants

If you use an AI coding assistant (Claude Code, OpenAI Codex, Cursor, GitHub Copilot, or similar) to work on your game, you can point it at the Redwood docs that ship with the backend. They match your installed version exactly, so the assistant uses the right class names, config keys, and commands instead of guessing or remembering an older version of Redwood.

What Ships with the Backend​

The RedwoodBackend folder contains:

FileWhat it is
docs/This documentation as markdown, for the version of the backend in that folder (backend and Unreal plugins share version numbers)
AGENTS.mdA guide written for coding assistants: which docs page to read for each kind of task, the mistakes assistants commonly make with Redwood, and how to work in the backend source
CLAUDE.mdLoads AGENTS.md for Claude Code, which reads CLAUDE.md instead of AGENTS.md
note

These files ship with backend releases after 5.0.0. If your RedwoodBackend folder doesn't have them, update to the latest 5.x release. With the Custom License (a git clone), docs/ is a submodule; if it's empty, run git submodule update --init docs.

Pointing Your Game Project at It​

Coding assistants automatically read instruction files like AGENTS.md and CLAUDE.md from the folder they're opened in and its parent folders. Most Redwood integration work happens in your Unreal project, and the backend usually sits next to it, so an assistant opened in your project never sees the backend's AGENTS.md.

To fix that, add a short Redwood section to your game project's own instruction file. Copy the version for your assistant and change the paths to match your setup:

  • ../RedwoodBackend: where the backend is, relative to your project folder
  • Plugins/RedwoodPlugins: where the Unreal plugins are
  • Config/Backend/my-game: your project's config environment, wherever you keep it

Add this to AGENTS.md in your project's root folder (create the file if it doesn't exist):

## Redwood

This game uses the Redwood multiplayer backend and its Unreal plugins.

- Backend: `../RedwoodBackend`
- Unreal plugins: `Plugins/RedwoodPlugins`
- This project's backend config environment: `Config/Backend/my-game`

Before working on anything that touches Redwood (login, characters, servers, matchmaking, persistence, social features, or backend config), read `../RedwoodBackend/AGENTS.md` and follow it. Paths in that file are relative to `../RedwoodBackend`. Answer Redwood questions from the docs in `../RedwoodBackend/docs/`, which match the installed version, rather than from memory.
tip

Even if the backend is inside your project folder, add the section anyway. Assistants generally only load instruction files from subfolders when they happen to open files there, so they may not see Redwood's guide until it's too late to help.

Tips​

  • Keep the backend and plugins on the same version. The docs in RedwoodBackend/docs describe both, so they're only accurate when the versions match. When you upgrade the backend, the docs update with it and the section above keeps working as is.
  • Let the assistant read pages as needed. The docs are large; AGENTS.md tells the assistant which page to open for each task, so there's no need to paste docs into your instruction file.
  • Tell the assistant which license you have if it asks. Some steps differ between the Standard License (prebuilt services, customized through config) and the Custom License (full source). AGENTS.md explains how to tell them apart from the backend folder.
  • Review config and code changes like any other. In particular, backend config changes need a backend restart, and the Dev Initiator deletes the local databases on every start by default.