Ripple Effect documentation

The documentation is split by what you need to do next. Choose the card that matches.

Learn

You are new to Ripple Effect. Your first story goes from an empty folder to a playable branch in a few minutes; the tutorials page lists them all.

Do

You have a task. The how-to guides start with installing the app on each platform, and go on to connecting an MCP client such as Claude Code, Claude Desktop, Cursor or any other client, building a board and playing a campaign.

Look up

You need a fact. Start with every node; beside it are the Python reference, the MCP tools an agent can call and the diagnostics the messages panel shows with a code on them. The Python reference holds every function a script, a passage or the console may call, what it answers and what it refuses.

Understand

You want to know why it works as it does. Start with boards, nodes and macros, then how a story runs. What Ripple Effect is says what the app is for.