Mod Page Template¶

Copy the blocks below when creating a new mod section. Replace everything in ( ) with real content.

How to add a new mod¶

Create a folder: docs/mods/YOUR-MOD-NAME/
Copy the files below into it
Fill in the placeholders
Add the mod to docs/mods/index.md table
Open PR for navs. Maintainers will add navigation.
Open a pull request

If that sounds like too much, open an issue and we'll set it up for you.

`index.md`¶

---
tags:
  - mod
---

# (Mod Name)

(One sentence description. You can also paste from your curseforge/modrinth page.)

!!! abstract "At a glance"
    - **Loaders:** Fabric / Forge / NeoForge
    - **Minecraft Versions:** 1.21.1/1.20.1
    - **Download:** [Modrinth](URL) · [CurseForge](URL) · [GitHub](URL)

---

## Overview

(Two to three paragraphs. What does the mod do? What problem does it solve?
What makes it different from similar mods? Is it client-side, server-side, or both?)

## Requirements

- Minecraft `1.x.x`
- (Loader) `x.x.x` (version not always required)
- (Any required dependencies with links)

## Pages

- [Getting Started](getting-started.md) — installation and first setup
- [Configuration](configuration.md) — all config options explained
- [Changelog](changelog.md) — version history

`getting-started.md`¶

# Getting Started

## Installation

=== "Modrinth App"
    1. Open the Modrinth App
    2. Search for **(Mod Name)**
    3. Click Install

=== "Manual"
    1. Download the latest `.jar` from [Modrinth](URL) or [CurseForge](URL)
    2. Drop it in `.minecraft/mods/`
    3. Launch the game

!!! warning "Dependencies"
    (List any required mods here, with links.)

---

## First Launch

(What happens when the mod loads for the first time?
New files created? Config generated? Any first-time prompts?)

---

## Basic Usage

(Walk through the most common use case step by step.)

`configuration.md`¶

# Configuration

Config file location: `.minecraft/config/(mod-id).toml`

---

## Options

### `option_name`
- **Type:** `string` / `boolean` / `integer`
- **Default:** `(default value)`
- **Description:** (What this option does.)

(Example if helpful:)
```toml
option_name = "value"

Missing an option?

Click Edit this page to add it!

---

## `changelog.md`

```markdown
# Changelog

## Unreleased
- (upcoming)

## (version number) — (date)
- (changes)

Official Resources¶

- [Website](Link)
- [Modrinth](Link)
- [CurseForge](Link)
- [GitHub](Link)
- [Discord](Link)

Copyright

Do not copy documentation, images, or assets from official wikis or websites unless permission has been granted. Summaries written in your own words are encouraged.