# Welcome

## Welcome to Unimined

Welcome to **Unimined**, a unified Minecraft modding environment that supports both modern and legacy environments. Whether you're working with the latest Minecraft versions or exploring older builds, Unimined provides a comprehensive set of tools to help you build and manage mods with ease.

### Features

* **Unified Modding Environment**: Supports various Minecraft mod loaders and offers tools for a seamless experience across different modding platforms.
* **Legacy Environment Support**: Keep your mods running on older Minecraft versions while maintaining compatibility with newer features.
* **Custom Loader Support**: Create and integrate your own loaders with the flexibility of Unimined.

For detailed instructions on usage, check out the USAGE.md.

### Key Highlights

#### LTS Branch

The **LTS branch** is designed to provide long-term support for stable builds. When breaking changes are introduced, a new minor version will be released, and bug fixes will be maintained for previous versions. This ensures that snapshots on the LTS branch remain relatively stable.

#### Supported Loaders

Unimined supports a wide variety of Minecraft mod loaders, including:

* Fabric
* Quilt
* Forge
* Neoforge
* Modloader
* [JarModAgent](https://github.com/unimined/JarModAgent)
* [Flint Loader](https://flintloader.net)
* Plain Jarmodding
* Rift

#### Planned Loaders

We are continuously expanding our support for other Minecraft modding platforms, including:

* Bukkit Derivatives (e.g., Paper)
* LiteLoader
* Sponge
* NilLoader

#### Custom Loaders

Creating your own custom loaders is easy with Unimined! Check out the [PrcraftExampleMod](https://github.com/prcraft-minecraft/PrcraftExampleMod) for guidance on how to set up custom loaders.

### Upcoming Features

* **Artifactural** replacement
* **MCPConfig** runner overhaul
* Support for **VSCode** and **Eclipse** launch configurations
* **Minecraft Dev Login** support
* **Datagen** support (Forge, Fabric, Quilt)
* **Neoforge Yarn** fixes and more!

### Setup Guide

#### Recommended Setup

1. Download a version from testing.
2. Remove `includeBuild('../../')` from `settings.gradle`.
3. Set a proper version number for the plugin in `build.gradle`.

#### Alternative Setups

**Arch-Loom Style**

You can port **arch-loom** projects directly without changing the directory structure. More instructions coming soon...

**Third-Party Templates**

* Arch Style: [fdd-xplat](https://github.com/firstdarkdev/fdd-xplat) or [examplemod](https://github.com/LegacyModdingMC/examplemod)

### Join the Community

We’re excited to have you on board! Whether you’re a modder, developer, or enthusiast, Unimined provides everything you need to create powerful Minecraft mods. Feel free to explore, contribute, and share your feedback. Happy modding!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://unimined.gitbook.io/docs/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.