Перейти к содержимому
Mineforgian

Lavender

A Guidebook API and alternative to Patchouli

Загрузки
2.4M
Подписчики
137
Обновлён
20 января 2025 г.
Лицензия
MIT

Опубликован 15 января 2024 г.

Исходный кодСообщить об ошибке

The landing page of a Lavender book

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

A Lavender book being displayed in the offhand

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

Ченджлог

0.1.15+1.21.4Релиз1.21.4 · 20 января 2025 г.

Additions

Fixes

  • Recipes with empty slots in their subgrid (eg. the vanilla clock or stairs recipes) no longer cause a crash when displayed in a book
0.1.15+1.21Релиз1.21, 1.21.1 · 20 января 2025 г.

Additions

  • Lavender can now display toasts when a new entry is unlocked in a book (backported by enjarai). To configure this for a book, add a new_entries_toast object to the book definition and populate it as follows:
    "new_entries_toast": {
  "icon_stack": "mymod:my_book_item",
  "book_name": "A Book Title",
  "background_sprite": "mymod:a_sprite_id" // this is optional, lavender supplies a unique texture by default
}
  • Entries now support declaring extra search terms in an array under additional_search_terms in the entry frontmatter (implemented by enjarai)
0.1.14+1.21.4Релиз1.21.4 · 29 декабря 2024 г.

This is a straightforward port to 1.21.4 - support for older versions will be dropped

0.1.14+1.21.2Бета1.21.2, 1.21.3 · 8 ноября 2024 г.

This is a straightforward port to 1.21.2 - support for older versions will be dropped

0.1.14+1.21Релиз1.21, 1.21.1 · 3 ноября 2024 г.

Fixes

  • Wrapping of the entry index on the landing page should now work correctly in the presence of nested categories
0.1.13+1.21Релиз1.21 · 25 августа 2024 г.

Fixes

  • Lavender now bundles a newer version of the lavender-md markdown library to fix parsing of multiple parameters in the owo-ui template syntax
0.1.12+1.21Релиз1.21 · 18 августа 2024 г.

Fixes

  • Lavender book items now check for invalid book IDs on the client, removing the constant " tried to open unknown book with id " logging on servers
  • The get-lavender-book command is now client-side (to make it work properly when playing on a dedicated server) and expands to an appropriate invocation of the vanilla /give command when executed
0.1.11+1.21Релиз1.21 · 3 июля 2024 г.

Fixes

  • Resource condition matching for book contents (entries and categories), which was disabled during the port to 1.21, has been readded

Комментарии

Загружаем…