Skip to content
Feyflower

Quick rating

Community listing page, reviews may not be monitored by the author.

Feyflower

By Trans Fish

No reviews yet

A guidebook library designed to be powerful for developers, built on owo's Braid UI.

Mod Loaders
Minecraft

About

Description

Feyflower

download on modrinth download on curseforge

view source code on codeberg 0% artificial "intelligence" 100% actual idiocy

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.

an example book

Features

  • Fully data-driven, with in-UI hot reloading
  • Injections, which allow extending or inserting pages into existing entries
  • 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, with entry-specific overrides
    • 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
    • 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.