minecraft-codev

A Gradle plugin that allows using Minecraft as a dependency with modules that allow mod development in Forge, Fabric, Quilt with any mappings.

Features

• Allows using customized Minecraft Jars in any configuration, rather than being implicitly added to existing configurations like implementation
• Allows Jar intersections to have common source sets between different versions and platforms
• Supports applying mixins directly to dependencies to give a better debugging and development experience.
• Supports custom Gradle version selectors like 1.16+, [1.16, 1.18], 1.19.3-SNAPSHOT

This project is currently heavily WIP, so many of the planned features are yet not fully implemented.

Examples

Simple Minecraft Example

plugins {
  id("minecraft-codev-remapper") version "1.0"
}

repositories {
  minecraft()
  mavenCentral()
}

dependencies {
  // Defined in gradle.properties
  val minecraftVersion: String by project

  // `mappings` is the default mappings configuration that `remapped` uses.
  mappings(minecraft(MinecraftType.ClientMappings, minecraftVersion))

  // `minecraft(MinecraftType.Client, minecraftVersion)` returns a client Jar, which transitively includes a common Jar.
  // `.remapped` returns a remapped version of the dependency.
  implementation(minecraft(MinecraftType.Client, minecraftVersion).remapped)
}

Forge Patched Minecraft Example

plugins {
  id("minecraft-codev-forge") version "1.0"
  id("minecraft-codev-remapper") version "1.0"
}

repositories {
  maven(url = "https://maven.minecraftforge.net/")
  minecraft()
  mavenCentral()
}

dependencies {
  val minecraftVersion: String by project
  val forgeVersion: String by project

  // `patches` is the default patches configuration that `patched` uses.
  //  The Forge userdev can be used in mappings as well to allow Forge's srg mappings to be applied.
  patches(mappings(group = "net.minecraftforge", name = "forge", version = "$minecraftVersion-$forgeVersion", classifier = "userdev"))

  mappings(minecraft(MinecraftType.ClientMappings, minecraftVersion))
  implementation(minecraft.patched(minecraftVersion).remapped)
}

Multiversion Example

plugins {
  id("minecraft-codev-remapper") version "1.0"
}

val mod16: SourceSet by sourceSets.creating // For 1.16
val mod18: SourceSet by sourceSets.creating // For 1.18
val mod19: SourceSet by sourceSets.creating // For 1.19

repositories {
  minecraft()
  mavenCentral()
}

dependencies {
  "mod16Mappings"(minecraft(MinecraftType.ClientMappings, "1.16+"))
  "mod16Implementation"(minecraft(MinecraftType.Client, "1.18+").remapped(mappingsConfiguration = "mod16Mappings"))

  "mod18Mappings"(minecraft(MinecraftType.ClientMappings, "1.18+"))
  "mod18Implementation"(minecraft(MinecraftType.Client, "1.18+").remapped(mappingsConfiguration = "mod18Mappings"))

  "mod19Mappings"(minecraft(MinecraftType.ClientMappings, "1.19+"))
  "mod19Implementation"(minecraft(MinecraftType.Client, "1.19+").remapped(mappingsConfiguration = "mod19Mappings"))
}

Split source sets Example

plugins {
  id("minecraft-codev-remapper") version "1.0"
}

val client: SourceSet by sourceSets.creating {
  // Extend main configurations
  configurations[compileClasspathConfigurationName].extendsFrom(configurations.compileClasspath)
  configurations[runtimeClasspathConfigurationName].extendsFrom(configurations.runtimeClasspath)
  configurations[mappingsConfigurationName].extendsFrom(configurations.mappings)

  // Add main output to classpaths
  compileClasspath += sourceSets.main.get().output
  runtimeClasspath += sourceSets.main.get().output
}

repositories {
  minecraft()
  mavenCentral()
}

dependencies {
  val minecraftVersion: String by project

  mappings(minecraft(MinecraftType.ServerMappings, minecraftVersion))
  implementation(minecraft(MinecraftType.Common).remapped)

  "clientMappings"(minecraft(MinecraftType.ClientMappings, minecraftVersion))
  "clientImplementation"(minecraft(MinecraftType.Client, minecraftVersion).remapped(mappingsConfiguration = "clientMappings"))
}