Folios

✨ About

Guide books for mods, written as JSON in a resource pack. Folios gives your mod a manual players actually want to open: a book on the screen, or held open in their hands in the world, with recipes, builds, quests and more.

Books are plain files in assets/<namespace>/folios/<book>/, so resource packs can add, translate and restyle them, and F3 + T reloads them while you write.

📖 Two ways to read

• Screen books: a flat book in the middle of the screen with the world dimmed around it, ribbon tabs for its parts, bookmarks, search and light or dark paper.
• Handheld books: raised from the hotbar and opened in your hands, its leaves turning in the world, its pages pressed with the pointer. Players nearby see you reading and can read along.

🧩 Every kind of page

Text with a small Markdown, spotlights, images, crafting, smelting, stonecutting and smithing recipes, turning 3D scenes of entities and builds, maps of linked places, quests and your own page types.

🏗️ Builds you can follow

A build page shows its blocks needed and, with one click, stands the build in the world as ghost blocks to place, layer by layer, with a panel tracking what is left.

🏆 Quests and progress

Objectives followed live (advancements, entries read, items carried, flags from code), toasts when a quest is done, and celebrations when a category or the whole book is mastered. Entries can be locked behind advancements or flags.

✍️ Make your own

Start from the book template, a complete example resource pack with every kind of page and a README of every key. Mods can open books from code, give players book items and add their own page types and reveal effects.

📖 Documentation · 📦 Book template · 🐛 Issues

📦 Versions

Requires CoolCatLib (and Fabric API on Fabric).

📜 License

Folios is under the Folios License. In short:

• ✅ Modpacks are welcome, free or monetized through the platform’s own rewards.
• ✅ Addons, resource packs, books, data packs and translations are welcome, under any license you choose.
• ✅ Reusing its code, forks and ports are welcome, with credit: name Folios and ixDarkLorD with a link on your project page, in your README and in your mod’s metadata.
• ✅ The book template is public domain (CC0): copy it freely.
• ✅ Videos, streams and reviews are welcome.
• ❌ No re-uploads of Folios unchanged, and a fork needs its own name and mod id.