Guide API — Guide
Mechanics and Navigation
The Guide-API interface is designed for ease of use and high readability. It features several key mechanical components:
- Categories: Content is grouped into high-level categories (e.g., "Basics," "Rituals," "Tools"). Each category has its own icon and title.
- Entries: Within each category, players find specific entries. An entry is a collection of pages focused on a single topic, such as a specific block or mechanic.
- Search Bar: A built-in search functionality allows players to quickly filter through entries by typing keywords, significantly reducing the time spent looking for specific information.
- Navigation Controls: The GUI includes standard forward and back buttons for page turning, as well as a "Home" button to return to the category selection screen.
- Automatic Formatting: The API automatically handles line wrapping and page breaks. This ensures that localized text (translations) fits perfectly within the book's margins without manual adjustment by the developer.
Page Types
Guide-API supports a variety of page types to convey information effectively. These pages can display static text, dynamic recipes, or even 3D models.
| Page Type | Description |
|---|---|
| Text Page | Displays standard text with support for formatting codes (colors, bold, etc.). |
| Image Page | Displays a custom texture or image, often used for diagrams or screenshots. |
| Shaped Recipe | Shows a standard 3x3 crafting grid with the required items for a shaped recipe. |
| Shapeless Recipe | Displays the items required for a shapeless crafting recipe. |
| Smelting Recipe | Shows the input, output, and fuel slot for furnace-based recipes. |
| Entity Page | Renders a live 3D model of a mob or entity that the player can rotate and inspect. |
| Sound Page | Plays a specific sound effect or music track when the page is opened. |
Recipe Examples
Integration
As a library mod, Guide-API does not add mobs, biomes, or structures of its own. Instead, it is the engine that powers the documentation for other mods. Notable mods that utilize Guide-API for their in-game manuals include:
- Blood Magic: Uses the API for the "Sanguine Scientiem."
- Vampirism: Provides a comprehensive guide for becoming a vampire or hunter.
- Sanguimancy: An expansion for Blood Magic that adds its own documentation entries.
- Overlord: Documentation for managing skeleton armies.
- Crossroads: Technical documentation for its complex machinery and alchemy systems.