# Ripple Effect

> Ripple Effect is a branching narrative and game design tool. A project is an ordinary folder on the author’s own disk: boards are JSON, passages are Markdown, components are JSON, each namespaced inside an ordinary extension. A story is drawn as a graph of typed nodes, played by a Rust engine, scripted in a Python subset, and exported either as a project copy or as a compiled campaign.

Notes for reading this documentation:

- The *Overviews* are one page per feature, in roughly the order somebody meets them; the *Reference* pages are the node catalog, the MCP tools, the diagnostic codes and the Python API.
- Python in this app is a restricted subset, not CPython. A component attribute is read as `component("X")["attr"]` and never as an attribute.
- A compiled campaign is played outside the app through the engine's bindings for JavaScript/TypeScript, C/C++, C# and Dart. They share one API: a campaign, a session whose verbs each return an ordered list of effects (the turn last), and an optional player loop.
- The app can be driven over MCP. Every tool it offers carries a link back to its own section of the MCP reference here, so a connected assistant never has to guess where a page is.

## Documentation Sets

- [Abridged documentation](https://docs.ripplefx.app/llms-small.txt): a compact version of the documentation for Ripple Effect, with non-essential content removed
- [Complete documentation](https://docs.ripplefx.app/llms-full.txt): the full documentation for Ripple Effect
- [Reference](https://docs.ripplefx.app/_llms-txt/reference.txt): the node catalog, the MCP tool list, the diagnostic codes, the Python API and the engine bindings
- [Engine bindings](https://docs.ripplefx.app/_llms-txt/engine-bindings.txt): playing a compiled campaign from your own program: the API design, how the engine ships, and the JavaScript, C/C++, C# and Dart bindings

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [Download Ripple Effect](https://ripplefx.app/download): installers for Linux, macOS and Windows
- [Support repository](https://github.com/ConnectingTheDots-DCWK/ripple_effect_support): issues, discussions and the licence