Documentation for Yarn Spinner is under active development. Please submit any suggestions you may have.
Yarn Spinner API documentation is generated automatically by the Doxygen system.
The documentation is currently automatically generated every time a commit is made to the Master branch on GitHub. The documentation is availabe on our GitHub Page in HTML and in our Github Repository in Latex, PDF, RTF, and XML formats.
If you are working on the Development branch, the build.sh script is capable of generating documents for you locally by utilising the -d switch.
Yarn Spinner is automatically built by Travis Continual Integration system. For information on how to build it yourself, please refer to the Building document.
For information on how to write dialogue for Yarn Spinner, refer to the Usage document. We are currently expanding this documentation for writers, and we have a document on how to create the dialogue for the Simple Example and are currently working on covering the more complex example
At this point in time, only examples for the Unity game engine are available. We hope to include a more generic example in the future. Please refer to the Yarn Spinner Unity documents for more information.
For information on how to extend Yarn Spinner's functionality, please refer to the Extending Yarn Spinner document.