Lavender API
Lavender is a powerful tool that provides mod developers, pack creators, and regular players with the ability to create in-game guides and documentation in the form of easy-to-read interactive reference books.
Core Capabilities
Content is written using the intuitive Markdown markup language with additional extensions that allow seamless integration of content into the gameplay. The system is enhanced with support for powerful macros and full access to the owo-ui framework functionality.
One of the unique features is the ability to view any book directly in the game when it's held in the character's offhand. This is especially convenient when you need to refer to instructions while performing them.
Key Features
- Data-driven book creation with near-instant reloading
- Organization of entries into categories for easy navigation
- Deep linking system between sections and categories
- Visualization of structures and multiblock constructions with assembly hints
- Gradual content unlocking linked to the game's achievement system
- Built-in support for displaying all standard recipes and a simple framework for creating custom ones
- Full localization support
- Individual bookmarks for each save
- Ability to extend other mods' books, perfect for integrating addon documentation
Getting Started
To start creating your own books with Lavender, perform the initial setup and review the getting started guide in the detailed documentation.
For implementation examples, you can study the "Wispen Testament" book from the Affinity mod, which demonstrates all the system's capabilities.
Credits
- The Patchouli team for creating the original mod that inspired Lavender's development
- User chyzman for ideas that formed the basis of many features, including offhand viewing
