Arcane Framework - Library for the Almanac Mods

Library for the Almanac mods. Adds an in-game book reader (Codex Engine) and a unified catalog (Codex Hub, key H) supporting Patchouli, GuideME, and Modopedia. Dependency only.
item image
item image
item image

Description

Q&A - ask a question here

Questions or ideas? Ask here: https://tally.so/r/GepONO

Arcane Framework: The Codex Hub and book reader

Arcane Framework is a core library mod required by the Almanac series and compatible guidebook addons. Install this mod only when another mod lists it as a dependency.

Supports Minecraft 1.21.1 (NeoForge) and Minecraft 1.20.1 (Forge).

⚠️ Early Development (v0.0.1): This is the first public release. Internal APIs and UI details may still evolve between 0.0.x versions.

The Codex Hub

Open it with H Unified settings

What It Adds

  • Codex Engine: A two-page spread book reader featuring a table of contents, full-text search, clickable page links, smooth page-turn wipes, and automatic reading-position memory.
  • Codex Hub: A unified catalog screen listing every available guidebook in one place—open it anytime with H (rebindable in Controls).
  • External Guidebooks in One Hub: Books from Patchouli, GuideME, and Modopedia (1.21.1) appear directly alongside Almanac books and open in their own native windows. All three are optional; the Hub only displays what you have installed.

Visuals & Quality-of-Life Features

  • Gold-Framed Codex Hub: Switch between two layouts (Grid + Detail or Shelves grouped by source mod), browse tabs for books and settings, and customize visual effects (soft background particles, glints, and cover hover glow: Off / Low / Full).
  • Reader Themes & Display Scaling: Choose between Dark and Parchment page styles, and configure window scaling and reader text size (Auto or Manual).
  • NEW Markers & Progress: Easily spot unread books and track reading progress across your collection.
  • Supported Books Catalog: Official Almanac volumes are always listed—greyed out with a direct download link if the mod is not yet installed.
  • Inventory Screen Shortcuts: Pin any book inside the Hub to place a draggable quick-access icon directly on your inventory screen.

Good to Know

  • Zero World Impact: Adds no items, blocks, mobs, or recipes—it changes nothing in your world generation or gameplay loop.
  • Standalone Core: Requires no external dependencies (including Patchouli, GuideME, or Modopedia) to function.
  • Safe Removal: Can be safely removed from an existing save once no installed mods depend on it.

Requirements & Mod Compatibility

📌 Requirements

  • NeoForge (1.21.1): Minecraft 1.21.1 + NeoForge 21.1.250+ (Java 21 required)
  • Forge (1.20.1): Minecraft 1.20.1 + Forge 47.4.10+ (Java 17 required)

📚 Same Author Mods & Ecosystem

🧩 Optional Guidebook Integrations

For Mod Authors

Integrate your mod's documentation directly into the framework instead of building custom reader UIs from scratch:

  • Register native guidebooks via RegisterNativeBooksEvent and build structured pages using BookContent.
  • Hook external guidebook systems into the Hub using RegisterBookProvidersEvent.
  • Layout rendering, interactive components, and search indexing are handled automatically.

Feedback, Notes & Permissions

  • Feedback & Suggestions: Have ideas for Codex features or API hooks? Leave a comment below or open an issue on GitHub.
  • AI Disclosure: Created with the assistance of AI tools.
  • Modpacks: Free to include in any modpack hosted on CurseForge or Modrinth!

The Almanac series

Spell's Atlas Bestiary Almanac

Artificer's Almanac Bookbinder's Almanac

Arcane Framework - Library for the Almanac Mods Team

profile avatar
  • 9
    Followers
  • 24
    Projects
  • 24.4K
    Downloads

More from SolJodowana211View all