Broken Chronicles

Broken Chronicles adds a collection journal that gathers the fragmented stories scattered across the world. Find readable fragments — paper scraps, old books, and words carved onto items — read them, and they are recorded into your chronicle forever, even if the item is destroyed.

Features

• Three record types — page (single-sheet fragments), book (multi-page tomes), tag (text bound to an item; the item keeps working normally, you can still eat that apple or swing that sword)
• Read & collect — right-click to read, or press N while hovering an item in your inventory. Reading automatically unlocks the entry in your journal
• Light-up entries — revealable entries show as ??? until discovered; optionally auto-unlocked on login
• Writing ink — craft Lost Ink (ink sac + glow ink sac + feather) and write your own pages, books, or item tags with a full multi-page editor (vanilla book & quill UI)
• Library — inject entries into any loot table, so fragments and books appear in dungeons, villages, and more
• Fully data-driven — add entries via datapacks (data/<ns>/shards/<page|book|tag>/<id>.json), per-page textures, multi-language texts, markdown formatting, and item icons
• Mod integration API — use Broken Chronicles as a dependency and register your own entries from code (ShardEntries.register(ShardEntry.builder(...)))

Requirements

• Minecraft 1.21.1
• NeoForge 21.1.248 or later

Installation

Put the jar into your mods folder. Requires the listed NeoForge version.

Content creation

See docs/data-format.md and docs/api-integration.md in the repo for entry formats, loot table injection, and the integration API.

License

CC BY-NC 4.0 (Attribution-NonCommercial 4.0 International)