A yeoman generator for scaffolding Readteractive interactive books.
We provide a command line interface to easily generate your project doing scaffolding, so you do not need to remember the syntax of each file and you can just focus on writing.
The Readteractive structure and files can be automatically generated using this CLI for your custom book.
It also provides a tool for visualization of your book with current chapters and the links between them, so you can have a general overview of the narrative branches of your book.
First, install Yeoman and generator-readteractive using npm (we assume you have pre-installed node.js).
npm install -g yo
npm install -g generator-readteractiveThen run the wizard inside the Readteractive folder and it will guide you:
yo readteractiveGenerate a new book.
yo readteractive:book
Generate a new chapter or rename an existing chapter identifier (updating all links on all referenced chapters).
yo readteractive:chapter
Building your book is easier with a wizard.
yo readteractive:build
Shows a graph of your book with current chapters and the links between them.
yo readteractive:graph
This displays the narrative branches in the terminal and generates a Graphviz DOT file (graph.dot). If Graphviz is installed, it also renders a graph.png image automatically.
That's all! Enjoy!
