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

Domix's Guidebook

Simple Data-Driven Library for creating Guidebooks.

Загрузки
810
Подписчики
1
Обновлён
5 апреля 2026 г.
Лицензия
LGPL-3.0-only

Опубликован 18 марта 2026 г.

Исходный код

divider

Domix’s Guidebook is a simple, data-driven API for creating in-game guidebooks for Fabric mods.

It allows mod developers to define guidebook content entirely through JSON, including pages, images, items, and recipes, without needing to write custom UI or rendering code.

The API is designed to be lightweight, flexible, and easy to integrate. Mods can register their own guidebooks, provide custom assets, and extend the system with additional element types if needed.

The guidebook system was originally part of my Domix’s Creatures mod, and has since been reworked into a standalone API that can be reused across my own projects and integrated by other modders.

The guidebook is used by right-clicking an entity that has a corresponding entry, or by right-clicking while holding the guidebook in one hand and an item with an entry in the other. A small magnifying glass icon will appear under the cursor if an entry is available.

divider2

Ченджлог

1.0.0-releaseРелиз1.21.1 · 5 апреля 2026 г.

initial release

1.0.0-beta.5Бета1.21.1 · 27 марта 2026 г.

CHANGES

  • Removed the DomixsGuidebookDataGenerator class and the datagen entrypoint from fabric.mod.json, as datagen is not used
  • The cycling_item element now also supports block tags
1.0.0-beta.4Бета1.21.1 · 26 марта 2026 г.

ADDED

  • Added the GuidebookScreenHelper class
  • Added tag validation logging to GuideJsonHelper

FIXED

  • Fixed the tooltip not counting entries with discoverable: false as unlocked
  • Fixed a crash when running the mod on a server
1.0.0-beta.3Бета1.21.1 · 22 марта 2026 г.

ADDED

  • Added cycling_crafting_recipe and cycling_cooking_recipe elements
  • Added classes:
    • CyclingCraftingRecipeElement
    • CyclingCraftingRecipeElementType
    • CyclingCraftingRecipeElementRenderer
    • CyclingCookingRecipeElement
    • CyclingCookingRecipeElementType
    • CyclingCookingRecipeElementRenderer
  • Added GuideJsonHelper class

CHANGES

  • GuideMainScreen now uses guide.screen.title translation key only as a fallback if no categories are defined
  • Category names now show on top of the guidebook UI using guide.category.<book_namespace>.<book_path>.<category_id> for the category translation keys
  • Updated all element type parsers to use GuideJsonHelper for cleaner validation and logging
1.0.0-beta.2Бета1.21.1 · 19 марта 2026 г.

Fixes

  • Fixed an issue where the lang file failed to load due to a misplaced comma
1.0.0-beta.1Бета1.21.1 · 18 марта 2026 г.

Initial beta release

Комментарии

Загружаем…