Oracle Index

         

Tired of alt-tabbing to find information about mods? Oracle Index brings the wiki directly into your Minecraft world! This mod provides an in-game documentation viewer for both Neoforge and Fabric on Minecraft 1.21. It's designed with simplicity and compatibility in mind, using the same formatting and directory structure as ModdedMC.wiki. This means modders can create wiki content once and use it both in-game and online.

Key Features ✨

• Seamless In-Game Documentation: Access comprehensive guides and information about supported mods directly in the game.
• No Custom Books Needed: Open the Oracle Index with a customizable hotkey or directly from an item's tooltip.
• Smart Search Included: A semantic search that understands the meaning of your queries is built-in. It also supports math expressions!
• Familiar Markdown Support: Uses a basic markdown parser and supports custom HTML tags, ensuring compatibility with ModdedMC.wiki content.
• Item Linking: Define relevant items for each wiki page. Hover over the item and hold [ALT] to open the wiki page!
• ModdedMC.wiki Compatibility: Leverage existing documentation created for ModdedMC.wiki. No need to rewrite anything! 🚀
• Cross-Linking: Effortlessly navigate between pages and items within the wiki.
• Visually Appealing & Responsive: Enjoy a modern Minecraft-inspired design, smooth scrolling, and responsive layouts that adapt to your screen size.
• Easy to Use: Quick setup, so you can get to documenting fast!
• Unlock System: Designate some pages (or folders) as hidden/obfuscated. They can then be unlocked at runtime.

How it Works ⚙️

Oracle Index parses Markdown content organized in a directory structure similar to ModdedMC.wiki. Simply place your Markdown files in the designated location (check the mod's configuration for the exact path), and Oracle Index will handle the rest!

Content can be included either via a mods resources or via a resource pack. An example of a resource pack is on github in the oracle index repo: https://github.com/Rearth/Oracle-Index/tree/26.1.2/example_resource_pack

Why Oracle? 🤔

Oracle Index bridges the gap between online documentation and in-game accessibility. It provides a convenient and intuitive way for players to learn about mods, recipes, and mechanics without interrupting their gameplay.