Skip to Content
DocumentationIntroduction

Modded Minecraft Wiki Author Guide

The Wiki documentation is a work in progress and certain parts may still be missing.
If you encounter any issues, please let us know on Discord  or GitHub .

Learn how to document your project using the Modded Minecraft Wiki !

This documentation will guide you through the process of creating setting up your project, writing documentation pages, all the way up to publishing it on the Wiki website.

We’ll introduce you to the festures, page format, components and game data integration, allowing you to write dynamic and interactive content pages.

Read below to get started!

Prerequisites

In order to start hosting documentation on our wiki, your project only needs to meet a few minimal requirements:

  • Be hosted on a Git repository (both private and public repositories work)

  • Be approved on either Modrinth  or CurseForge 

  • At the time of registration, projects must have the Git repository linked as the project’s source code url (this is currently required to verify project ownership)

    • Modrinth projects can also be easily verified by linking your Modrinth account in the Wiki’s user settings

Building & Publishing

  1. Navigate to the Getting Started page to quickstart your project

  1. Explore the Folder Structure to learn about available features and how you can customize your documentation

  1. Integrate your project with in-game data and find handy tools in the Features section

  1. Publish your project on the Wiki

In-game documentation

Interested in viewing Wiki docs in-game? Check out Oracle Index !

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

In-game preview

*Please note that Oracle Index is not developed by the Wiki. Check their website for information on how to receive support and report issues.

Integration

We provide an excellent set of tools for authors that can help you focus on writing on what’s important without having to do the boring work of looking up and copying in-game information to the Wiki.

With our tools, you can:

  • Get a local real-time, accurate preview of your documentation in the exact same look as it will have once uploaded to the wiki

  • Automatically generate asset renders of inventory models for all mod items and export game meta information

  • Re-deploy documentation after publishing

Learn more on each tool’s dedicated page:

Last updated on
Getting Started