Lavender API
No reviews yet
A Guidebook API and alternative to Patchouli
Community voices
Reviews
Click once to include, again to exclude, again to clear
No reviews yet. Be the first to review this project!
Get it on
Available Platforms
Compatibility
Supported Environments
Must be installed on both the client and the server.
About
Project Details
For authors
Embed Badge
If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.
Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.
Identifiers
Platform IDs
About
Description
Lavender is tool allowing modders, modpack makers and everybody else to create player guides and other in-game documentation in the form of easy-to-read, intuitive guide books.
Everything is written using easy to learn, familiar and, most importantly, readable markdown with a bunch of special syntax to seamlessly integrate with the game. This is augmented with support for powerful macros and the entirety of the owo-ui framework at your fingertips
Further, for the first time in any guidebook mod (we believe), all books can be viewed in-game when placed in the offhand - extremely useful for referencing an entry while carrying out its instructions
Features
- Fully data-driven book authoring with near-instant hot reloading
- Optional grouping of entries into categories for easy discovery
- Deep linking between entries and categories
- Structure/Multiblock visualization and building assistance
- Gradual content unlocking, backed by the game's advancement system
- Built-in support for visualizing all vanilla recipe types and an easy framework for implementing custom ones
- Localization support
- Individual bookmarks for each save
- Support for extending another mod's books, extremely useful for seamlessly integrating your addon's documentation
Getting started
To start making your own Lavender book right now, complete the setup and then follow Getting Started in the comprehensive documentation over at https://docs.wispforest.io.
For reference, it might be helpful to check out Affinity's Wispen Testament as a solid example book made using Lavender
Credits
- The Patchouli team for making the original mod that inspired Lavender
- chyzman for inspiring a range of features, notably offhand viewing
Lavender is tool allowing modders, modpack makers and everybody else to create player guides and other in-game documentation in the form of easy-to-read, intuitive guide books.
Everything is written using easy to learn, familiar and, most importantly, readable markdown with a bunch of special syntax to seamlessly integrate with the game. This is augmented with support for powerful macros and the entirety of the owo-ui framework at your fingertips
Further, for the first time in any guidebook mod (we believe), all books can be viewed in-game when placed in the offhand - extremely useful for referencing an entry while carrying out its instructions
Features
- Fully data-driven book authoring with near-instant hot reloading
- Optional grouping of entries into categories for easy discovery
- Deep linking between entries and categories
- Structure/Multiblock visualization and building assistance
- Gradual content unlocking, backed by the game's advancement system
- Built-in support for visualizing all vanilla recipe types and an easy framework for implementing custom ones
- Localization support
- Individual bookmarks for each save
- Support for extending another mod's books, extremely useful for seamlessly integrating your addon's documentation
Getting started
To start making your own Lavender book right now, complete the setup and then follow Getting Started in the comprehensive documentation over at https://docs.wispforest.io.
For reference, it might be helpful to check out Affinity's Wispen Testament as a solid example book made using Lavender
Credits
- The Patchouli team for making the original mod that inspired Lavender
- chyzman for inspiring a range of features, notably offhand viewing
Screenshots
Gallery
-
A Lavender Book The landing page and categories of an example Lavender book
-
Offhand Book The same Lavender book as before, being held in the offhand and visible in-game
Versions
Files
Relations
Project Relations
More like this
Similar Mods
Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.
On ModDex
Community snapshot
By the numbers
Statistics
Want to reach Minecraft players?
We're looking for a server hosting partner to feature here and other parts of the site. Interested? Send us a message!
Get in touchGet it on
Available Platforms
On ModDex
Community snapshot
By the numbers