almostunified/README.md
2024-08-22 23:32:23 +02:00

5.4 KiB

Preview

Almost Unified

A Minecraft mod to unify resources.

Workflow Status License

Version Total Downloads CF Total Downloads MR

Discord Wiki

📖 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'
    }
}
dependencies {
    modCompileOnly("com.almostreliable.mods:almostunified-common:<version>:api")
}
dependencies {
    modCompileOnly("com.almostreliable.mods:almostunified-fabric:<version>:api")
    modRuntimeOnly("com.almostreliable.mods:almostunified-fabric:<version>")
}
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
  1. 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.