Lavender
The Lavender framework provides modders, pack creators, and regular players with tools to create in-game guides and documentation in the form of easy-to-read reference books.
All content is formatted using familiar Markdown syntax that's easy to learn and, most importantly, ensures excellent readability. The system is extended with special syntax constructs for deep integration with gameplay, supports powerful macros, and is fully compatible with the owo-ui framework.
Notably, all created guides can be read directly in the offhand slot - this is very convenient when you need to quickly check instructions while performing various actions.
Key Features
- Book creation is fully configurable through configuration files with instant reloading of changes
- Optional categorization of materials for easy navigation
- Built-in cross-referencing system between sections and individual entries
- Visualization of structures and multiblock constructions with assembly hints
- Gradual content unlocking synchronized with the game's achievement system
- Native support for displaying all standard recipes and simple integration of custom ones
- Full localization support
- Individual bookmarks for each game save
- Ability to extend books from other modifications, perfect for adding documentation to addons
Getting Started
To start creating your own Lavender book, complete the initial setup and then refer to the getting started guide in the project's comprehensive documentation.
As an implementation example, you can examine the Wispen Testament from the Affinity modification - this is a well-made demonstration book created using this framework.
Credits
- The Patchouli team for the original modification that inspired Lavender's development
- Chyzman for ideas for several features, particularly the offhand viewing mode
