Feyflower

Feyflower is a guidebook API built with Lavender's Markdown parser and owo's Braid UI. While not a fork of Lavender, it shares many similarities as this project was created to replace it as a dependency of Trickster.

Features

• Fully data-driven (hot reloading is planned but not yet implemented)
• Injections, which allow extending or inserting pages into existing entries (implemented, but cannot be targeted by links yet)
• Advancement-locked entries, categories, and injections with support for complex conditions
  • By default, Feyflower shows a toast when the contents of a book have changed in response to advancements
• Page tags which links and injections can use to target a page without knowing its index
• Templates with a clean syntax, optional arguments, and full access to the Markdown compiler
  • Templates can insert arbitrary Braid widgets, automatically add tags, and more
• Custom Markdown extensions via LavenderMD's feature system (planned but not yet implemented)
• Localization support, with a book-defined fallback language
• Book extensions for addons to add entries, categories, and injections to an existing book
• Built-in support for generating a web version of a book (planned but not yet implemented)
• Offhand book rendering

Getting Started

Feyflower is still in very early alpha as we begin to port Trickster's book. Once it has stabilized a bit more, we will begin writing public-facing documentation.

Credits

Huge thanks to glisco for Braid UI and Lavender.