almostunified/README.md

Almost Unified

A Minecraft mod to unify resources.

Discord | Wiki | CurseForge | Modrinth

📖 Wiki

For an in-depth explanation of the mod, its functionality, config descriptions, FAQs and more, check out the wiki.

🔧 Manual Installation

1. Download the latest mod jar from the releases, from CurseForge or Modrinth.
2. Install Minecraft Forge or Fabric.
3. Drop the jar file into your mods folder.

🔗 Depending on the Mod

Maven

Every release of this project is built and published to the BlameJared maven.

repositories {
    maven { 
        url = 'https://maven.blamejared.com'
        name = 'BlameJared Maven'
    }
}

Common

dependencies {
    modApi("com.almostunified.mods:almostunified-common:<version>")
}

Fabric

dependencies {
    modApi("com.almostunified.mods:almostunified-fabric:<version>")
}

Forge

dependencies {
    modApi(fg.deobf("com.almostunified.mods:almostunified-forge:<version>"))
}

Examples

For code examples on how to use the API, check out the wiki.

🖥️ Dev Environment Setup

1. Clone the repository
2. Import into IntelliJ (VSCode and Eclipse are not tested)
3. Run

• gradle -> common -> Tasks -> fabric -> genSources
• gradle -> fabric -> Tasks -> fabric -> genSources
• gradle -> forge -> Tasks -> loom -> genSources
• gradle -> Tasks -> buildconfig -> generateBuildConfig

4. Restart the IDE

The common module uses fabric-loom. This allows to use ParchmentMC.
Do not use Fabric related features inside the common module!

💚 Credits

This project is using the MultiLoader Template by Jared.
The logo was made by mo_shark.

🎓 License

This project is licensed under the GNU Lesser General Public License v3.0.