📖 Vellumli
Accessible, data-driven, dependency-free in-game guidebooks — no Java required.
✨ Overview
|
Vellumli lets modders and pack makers write in-game guidebooks for their content using nothing but data files — categories, entries and pages are defined in JSON and rendered as a fully navigable in-game book. It has no gameplay dependency on any other mod: any mod or datapack can ship its own book by adding data, not code. A fork of Patchouli by Vazkii and williewillus, rebranded and maintained by Stalking Dragons. Not affiliated with or endorsed by the Patchouli authors. |
|
📚 Data-Driven Books
Define categories, entries and pages entirely as JSON. Books, categories and entries can be added or overridden by datapacks and resource packs without touching Java code.
🧭 Rich Page Types
Built-in page types for text, crafting / smelting / smithing / blasting / campfire recipe turn-ins, images, spotlight items, entity previews, relations, links and quests — enough to document almost any mod without custom code. Custom component and template systems allow reusable, parameterised layouts.
🧩 In-Game Navigation
A full book GUI with a landing page, category browsing, entry search, bookmarks and history — players find the documentation they need without leaving the game.
🔓 Advancement-Gated Content
Lock entries and categories behind advancements so documentation unlocks progressively as the player advances.
🧱 Mod Structure
| Area | What it provides |
|---|---|
api | The public surface other mods build against: the book/entry/page model, custom-component and multiblock hooks, and the render-context interfaces. |
common/book | Book loading, the datapack/resourcepack registry, and folder discovery. |
client/book | The book GUI, the page renderers, text layout and the bookmark/history system. |
common/item | The guide-book item, its book data component and completion model property. |
compat/jei | JEI subtype interpreter so each mod's book is a distinct, searchable ingredient. Optional. |
xplat / neoforge | The platform abstraction layer and its NeoForge implementation (networking, mod list, events). |
📋 Requirements
| Minecraft / NeoForge / Java | see Available Versions below |
| Dependencies | None — Vellumli is dependency-free by design |
| JEI | Optional (searchable-book compat only) |
| Side | Client and Server (required on both) |
📦 Available Versions
| Minecraft | NeoForge | Java | Latest build | Status |
|---|---|---|---|---|
| 26.2 | 26.2.0.57+ | 21 | 1.2.0 | Stable |
| 1.21.1 | 21.1.249+ | 21 | 1.0.0 | Stable |
Both versions share this CurseForge project. Pick the file that matches your Minecraft version.
🎮 How to Use
- Install the mod on both client and server.
- Craft or obtain a book item associated with a Vellumli-powered book (added by another mod or your datapack).
- Author your own book by adding category / entry / page JSON files under a datapack — the format matches Patchouli's.
🙏 Credits & License
Vellumli is a fork of Patchouli by Vazkii and williewillus, rebranded and maintained by Stalking Dragons. The 1.21.1 build is a re-fork from the upstream Patchouli 1.21.x sources.
License: CC BY-NC-SA 3.0, the same license as Patchouli. This is a ShareAlike requirement inherited from the original project: Vellumli (and any of its own forks) must stay under this license, credit Vazkii and williewillus, and may not be used for commercial purposes. The full licence text and attribution ship in the jar and the repository LICENSE file.
https://codex.skdragons.com/
Codex Stalking Dragons — Minecraft Modding
The Vellumli Team
