← Назад к ресурсам

Lavender

A Guidebook API and alternative to Patchouli

Modrinth library utility

Описание

![The landing page of a Lavender book](https://cdn.modrinth.com/data/D5h9NKNI/images/ed7daa42a82c61305de1d4ba5e19c7627adaad01.png) 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](https://docs.wispforest.io/lavender/markdown-syntax) to seamlessly integrate with the game. This is augmented with support for powerful macros and the entirety of the [owo-ui framework](https://docs.wispforest.io/owo/ui) 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 ![A Lavender book being displayed in the offhand](https://cdn.modrinth.com/data/D5h9NKNI/images/b8d3950ba69601e57ee80dd569083a755dbc335a.png) ## 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](https://docs.wispforest.io/lavender/setup) and then follow [Getting Started](https://docs.wispforest.io/lavender/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](https://github.com/wisp-forest/affinity/tree/main/src/main/resources/assets/affinity/lavender) as a solid example book made using Lavender ## Credits - [The Patchouli team](https://modrinth.com/mod/patchouli) for making the original mod that inspired Lavender - [chyzman](https://modrinth.com/user/chyzman) for inspiring a range of features, notably offhand viewing