Important: This document only matters to you if you want to build Yarn Spinner from source. In almost all cases, you'll be totally fine with downloading a build, and using that in your project.
To build Yarn Spinner on Windows or Mac, you'll need MonoDevelop. You can download MonoDevelop for your OS from the MonoDevelop site.
To build Yarn Spinner on Linux, you can either
- use xbuild and nuget.
- Then ensure you have the correct packages installed by nuget,
nuget restore YarnSpinner.sln. - See the build.sh script for further information on how using mono to build. or
- use Flatpak, you can download MonoDevelop from the MonoDevelop site.
- Open YarnSpinner.sln.
- Open the Build menu, and choose Build All.
- Open the Unity/Assets/Yarn Spinner folder. You'll find a copy of YarnSpinner.dll there.
- Copy that DLL file wherever you need it.
Yarn Spinner uses Doxygen to generate DocBook, HTML, LaTeX, RTF, and XML documentation. GNU GLOBAL is also used.
Basic steps to clean out existing documentation, generate new documentation and check the new documentation for generation errors. Note that some ocurrences of the word 'error' will be due to classes/methods etc. of YarnSpinner itself and not an actual error in the documentation.
rm -fr Documentation/{docbook,html,latex,rtf,xml}
doxygen Documentation/Doxyfile > doxyoutput.txt 2>&1
grep -i error doxyoutput.txt
MarkDown documentation is available via conversion of the XML output to Markdown using third party tools such as Pandoc or doxygen2md