Oracle-Index

A minecraft fabric / neoforge client-side documentation viewer mod, intended to be used with wikis alongside moddedmc.wiki

Explore the docs»

Report Bug . Request Feature

---

---

About The Project

A simple ingame wiki / documentation viewer, built for neoforge and fabric 1.21. Uses the same formatting / directory layout as https://moddedmc.wiki/, so mod wikis can be created for both ingame usage and online view without having to rewrite the pages.

Includes a basic markdown parser for the content, and support for some custom html tags similar to moddedmc.wiki. Relevant items can be defined per wiki page, allowing the users to directly open the relevant wiki pages from the items tooltip.

Features:

• Easy to view ingame documentation.
• No custom books required, the Oracle Index can be opened through either a hotkey or from an item tooltip.
• Smooth scrolling, modern minecraft-y design elements
• Compatibility for documentations created for moddedmc.wiki
• Cross-Linking between pages and items
• Responsive layouts

Built With / Depends on:

• Owo lib (for all the GUIs, config, and much more)
• Architectury

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request