Howdy. Welcome to the SmutBook documentation.
SmutBook is a free and open-source library for Sugarcube 2 (a story format for Twine/Twee), intended to help prospective authors with the technical implementation of Erotic Transformation Games.
However, even if TF-pr0n isn't your thing, much of the library is also quite useful for any Twine/Twee game.
Too often, we see potential authors having to reinvent the wheel time and time again (vis-a-vis inventory, apparel, and transformation mechanics). They end up burning out on these technical details before they can complete their story, resulting in many dead-end projects. It is my hope that this library can help alleviate that problem, so that we can all bring many more delicious TF-pr0n games into the world. :D
SmutBook is released under the 4-clause BSD license.
This library is intended to be used with the Tweego tweecode compiler. The graphical Twine utility's library inclusion mechanics are too primitive to be able to include all of the needed types of data that SmutBook requires to work properly. Don't let that get you down though! Tweego is very very easy to use once you get it set up, and far easier to use than the graphical Twine utilities once you get used to it. In the Tutorial, we'll guide you through setting up Tweego and a skeleton game project, so that you can get started easily.
The current implementation provides: