https://github.com/wisp-forest/lavender

A Guidebook API and alternative to Patchouli
https://github.com/wisp-forest/lavender

documentation fabric-mod minecraft-mod

Last synced: 2 months ago
JSON representation

A Guidebook API and alternative to Patchouli

• Host: GitHub
• URL: https://github.com/wisp-forest/lavender
• Owner: wisp-forest
• License: mit
• Created: 2023-04-27T22:47:11.000Z (over 1 year ago)
• Default Branch: 1.21
• Last Pushed: 2024-08-25T21:25:27.000Z (4 months ago)
• Last Synced: 2024-10-01T08:21:36.106Z (3 months ago)
• Topics: documentation, fabric-mod, minecraft-mod
• Language: Java
• Homepage: https://modrinth.com/mod/lavender
• Size: 1.23 MB
• Stars: 17
• Watchers: 2
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![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

## 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