I was originally doing this automagically with JSDoc, but it made the source code a mess. So here it all is redone by hand in markdown.

I do my best to keep this up-to-date, but the source code is the ultimate reference.

This file is meant to be dry technical documentation of the class implementation for reference purposes. For a more friendly treatise on using the library, please see the Tutorial.

The class hierarchy is divided into a number of namespaces, documented separately:

• LibEcho.Apparel
• LibEcho.Grammar
• LibEcho.Inventory
• LibEcho.People
• LibEcho.Persistence
• LibEcho.Transformable
• LibEcho.Util

1. Be running some kind of Unix-like OS with Bash installed (the build scripts use bash).
2. Install node-js (used for compiling the classes).
3. Create a “Tweego” project in your workspace and install the Tweego binary and story-formats into it.
4. Check out the project from SVN.
5. Watch it build automatically.

1. Be running some kind of Unix-like OS with Bash installed (the build scripts use bash).
2. Install node-js (used for compiling the classes).
3. cd build && npm install
4. You now have all the dependencies installed.
5. Whenever you want to (re)build the library: cd build && ./build.sh

If you want to write a build script for Windows or whatever, feel free to send it to me and I'll include it in the repo.