almostunified/README.md

Almost Unified

A Minecraft mod to unify resources.

📖 Information

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 NeoForge or Fabric.
3. Drop the jar file into your mods folder.

🔗 Depending on the Mod

Maven

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

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

Common

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

Fabric

dependencies {
    modCompileOnly("com.almostreliable.mods:almostunified-fabric:<version>:api")
    modRuntimeOnly("com.almostreliable.mods:almostunified-fabric:<version>")
}

NeoForge

dependencies {
    compileOnly("com.almostreliable.mods:almostunified-neoforge:<version>:api")
    runtimeOnly("com.almostreliable.mods:almostunified-neoforge:<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 -> neoforge -> 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

The logo was made by mo_shark.

🎓 License

This project is All Rights Reserved. Forks should only be created with the intent of submitting changes to the upstream repository via pull requests.

The license applies exclusively to the project's source code. Versions published on CurseForge and Modrinth may be used for gameplay and modpack creation, provided they are downloaded directly from these platforms. GitHub releases are intended for private use or as a fallback if CurseForge and Modrinth are unavailable.

The project's API can be freely used in other mods, as long as this project is not an included dependency. This includes custom inclusion methods like Jar-in-Jar.

Redistribution of builds or rehosting is strictly prohibited.