1.18.1 How to add external dependency to ForgeGradle.

[matezz]

Hello,

how can I add external dependency to my 1.18.1 project? Implementation and other things like compile don't works and I need to do:
 

dependencies {
    implementation 'org.reflections:reflections:0.10.2'
}

Tried everything - shadowJar, shade, nothing works, or just I am doing something wrong.
And there is no documentation about it anywhere.

Thanks

[matezz]

I was trying to find in other mods' source code, but everything that worked there didn't work in my project. Now I stand with:

buildscript {
    repositories {
        maven { url = 'https://maven.minecraftforge.net' }
        maven {url='https://repo.spongepowered.org/repository/maven-public/'}
        mavenCentral()
    }
    dependencies {
        classpath group: 'net.minecraftforge.gradle', name: 'ForgeGradle', version: '5.1.+', changing: true
        classpath 'org.spongepowered:mixingradle:0.7-SNAPSHOT'
    }
}

plugins {
    id 'java-library'
    id "com.github.johnrengelman.shadow" version "7.1.0"
}

apply plugin: 'net.minecraftforge.gradle'
apply plugin: 'eclipse'
apply plugin: 'maven-publish'
apply plugin: 'org.spongepowered.mixin'

version = '3.1'
group = 'net.matez.wildnature'
archivesBaseName = 'wildnature'

java.toolchain.languageVersion = JavaLanguageVersion.of(17)
compileJava.options.encoding = 'UTF-8'

println('Java: ' + System.getProperty('java.version') + ' JVM: ' + System.getProperty('java.vm.version') + '(' + System.getProperty('java.vendor') + ') Arch: ' + System.getProperty('os.arch'))
minecraft {
    // The mappings can be changed at any time and must be in the following format.
    // Channel:   Version:
    // snapshot   YYYYMMDD   Snapshot are built nightly.
    // stable     #          Stables are built at the discretion of the MCP team.
    // official   MCVersion  Official field/method names from Mojang mapping files
    //
    // You must be aware of the Mojang license when using the 'official' mappings.
    // See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
    //
    // Use non-default mappings at your own risk. They may not always work.
    // Simply re-run your setup task after changing the mappings to update your workspace.
    mappings channel: 'official', version: '1.18.1'

    // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg') // Currently, this location cannot be changed from the default.

    runs {
        client {
            workingDirectory project.file('run')
            arg "-mixin.config="+archivesBaseName+".mixins.json"
            property 'mixin.env.disableRefMap', 'true'

            // Recommended logging data for a userdev environment
            // The markers can be added/remove as needed separated by commas.
            // "SCAN": For mods scan.
            // "REGISTRIES": For firing of registry events.
            // "REGISTRYDUMP": For getting the contents of all registries.
            property 'forge.logging.markers', 'REGISTRIES'

            // Recommended logging level for the console
            // You can set various levels here.
            // Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
            property 'forge.logging.console.level', 'debug'

            mods {
                wildnature {
                    source sourceSets.main
                }
            }
        }

        server {
            workingDirectory project.file('run')
            arg "-mixin.config="+archivesBaseName+".mixins.json"
            property 'mixin.env.disableRefMap', 'true'

            property 'forge.logging.markers', 'REGISTRIES'

            property 'forge.logging.console.level', 'debug'

            mods {
                wildnature {
                    source sourceSets.main
                }
            }
        }

        data {
            workingDirectory project.file('run')
            arg "-mixin.config="+archivesBaseName+".mixins.json"
            property 'mixin.env.disableRefMap', 'true'

            property 'forge.logging.markers', 'REGISTRIES'

            property 'forge.logging.console.level', 'debug'

            args '--mod', 'wildnature', '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')

            mods {
                wildnature {
                    source sourceSets.main
                }
            }
        }
    }
}

sourceSets.main.resources { srcDir 'src/generated/resources' }

configurations {
    include
    implementation.extendsFrom(include)
}

repositories {
    // Put repositories for dependencies here
    // ForgeGradle automatically adds the Forge maven and Maven Central for you

    // If you have mod jar dependencies in ./libs, you can declare them as a repository like so:
    // flatDir {
    //     dir 'libs'
    // }
}

dependencies {
    // Specify the version of Minecraft to use. If this is any group other than 'net.minecraft', it is assumed
    // that the dep is a ForgeGradle 'patcher' dependency, and its patches will be applied.
    // The userdev artifact is a special name and will get all sorts of transformations applied to it.
    minecraft 'net.minecraftforge:forge:1.18.1-39.0.9'
    annotationProcessor 'org.spongepowered:mixin:0.8.5:processor'
    include 'org.reflections:reflections:0.10.2'

    // Real mod deobf dependency examples - these get remapped to your current mappings
    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}:${jei_version}:api") // Adds JEI API as a compile dependency
    // runtimeOnly fg.deobf("mezz.jei:jei-${mc_version}:${jei_version}") // Adds the full JEI mod as a runtime dependency
    // implementation fg.deobf("com.tterrag.registrate:Registrate:MC${mc_version}-${registrate_version}") // Adds registrate as a dependency

    // Examples using mod jars from ./libs
    // implementation fg.deobf("blank:coolmod-${mc_version}:${coolmod_version}")

    // For more info...
    // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
    // http://www.gradle.org/docs/current/userguide/dependency_management.html
}

// Example for how to get properties into the manifest for reading at runtime.
jar {
    manifest {
        attributes([
                "Specification-Title"     : "wildnature",
                "Specification-Vendor"    : "matez",
                "Specification-Version"   : "1", // We are version 1 of ourselves
                "Implementation-Title"    : project.name,
                "Implementation-Version"  : project.jar.archiveVersion,
                "Implementation-Vendor"   : "matez",
                "Implementation-Timestamp": new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
        ])
    }
}

jar.finalizedBy('reobfJar')

publishing {
    publications {
        mavenJava(MavenPublication) {
            artifact jar
        }
    }
    repositories {
        maven {
            url "file://${project.projectDir}/mcmodsrepo"
        }
    }
}

shadowJar {
    archiveFileName = jar.archiveFileName
    configurations = [project.configurations.include]
}

reobf {
    shadowJar {}
}

jar.dependsOn("shadowJar")

And it's okay in my dev environment, means IntelliJ says that this dependency exists. But when I launch runClient, throws error:
 

Caused by: java.lang.NoClassDefFoundError: org/reflections/Reflections

and

Caused by: java.lang.ClassNotFoundException: org.reflections.Reflections

I'm trying to solve it for the whole day and nothing works.

[matezz]

I tried other libraries too, also didn't work. From Apache, so code should be valid.

I need this to scan all classes and find annotated ones. From here: https://stackoverflow.com/a/50955914/15411013

[matezz]

Hmmm, interesting. I can use it.

However would be cool if it would be fixed/documented, because I can't really add ANY dependency to my project. Future wise.

[matezz]

Ah, I didn't read the whole sentence.
Yes it is in my jar.

org/reflections/...

[matezz]

Here:

https://github.com/zmatez/dependency_mod_problem

[matezz]

Alright, makes sense. How can I solve this then?

[matezz]

Excluded like so:

    include ('org.reflections:reflections:0.10.2') {
        transitive = false
    }

Still the same problem.

Anyway I will use FML yeah, just wanted to figure it out for future, cause I already had problems adding Apache Async HTTP dependency.

Edited December 29, 2021 by matezz

[matezz]

  On 12/29/2021 at 11:21 AM, diesieben07 said:

I made that change in the repository you provided. Then I ran reobfShadowJar. The resulting Jar file loaded up just fine.

Expand  

How? I did the same thing. Transistive + reobfShadowJar + runClient and same error occurs.

 

  On 12/29/2021 at 11:21 AM, diesieben07 said:

Since Java 11 Java includes a HttpClient class that can also do asynchronous requests based on CompletableFuture.

Expand  

Yeah that's how I figured it out later

[Majd123mc]

  On 12/29/2021 at 11:42 AM, diesieben07 said:

runClient does not use the jar file... So the problem is just with the development environment, but I don't know how to fix that.

 

Expand  

And.... that's exactly the problem I'm facing.

Well, at least thanks diesieben07 for pointing to me to use ModList.get().getAllScanData which solves my problem.

As for the dependency issue, I guess I'll wait until I really need a solution.

Thanks!

[Dayo]

In my case, (I did that on 1.12.2 so I'm not sure it works on 1.13+)

I make external mod for dependency with shadejar and set that mod to my dependency.

This is example(1.12.2) https://github.com/dayo05/kotlinmod

[Majd123mc]

Yes, but that does not solve the issue that when running the runClient task, it COMPLETELY ignores all dependencies. ALL of them.

Your example is in 1.12.2, which does not exhibit this issue. It only seems to be there in 1.18.1.

Hate to disturb you, but @diesieben07, if you have any idea why and how to solve this issue I will be greatly appreciative. 

[Majd123mc]

@matezz

I had the same problem where it would not load my dependencies in runClient, and the following code in build.gradle did it for me:
(I've edited the code here from the old one since this one is more reliable, scroll down a little for the older code)

// Fix the classpath the right way and once and for all
afterEvaluate {
    // Collect deps in runtimeClasspath but NOT in minecraft
    def deps = (configurations.runtimeClasspath - configurations.minecraft).join(';')
    // Add deps to classpath
    minecraft.runs.each { run ->
        run.token 'minecraft_classpath', deps
    }
}

Older worse code:

  Reveal hidden contents

 

task fixClassPath {
    delete {
        delete files("$buildDir/classpath/runClient_minecraftClasspath.txt")
    }
    doLast {
        def cpf = new File("$buildDir/classpath/runClient_minecraftClasspath.txt")
        configurations.YOUR_EMBED_CONFIGURATION_HERE.each {
            cpf.append("\n$it")
        }
    }
}


tasks.compileJava.dependsOn fixClassPath

 

 

Edited February 12, 2022 by Majd123mc
Changed code

[matezz]

Oo that could work, I resolved my problem already but for future it'd be brilliant

Edited February 9, 2022 by matezz

[Majd123mc]

  On 2/9/2022 at 8:40 PM, matezz said:

Oo that could work, I resolved my problem already but for future it'd be brilliant

Expand  

May I ask what your solution was?

 

Unless you mean you used ModList instead.

[Majd123mc]

After researching for a while in the source code of ForgeGradle, I have found this code to be a lot more realiable:
 

// Fix the classpath the right way and once and for all
afterEvaluate {
    // Collect deps in runtimeClasspath but NOT in minecraft
    def deps = (configurations.runtimeClasspath - configurations.minecraft).join(';')
    // Add deps to classpath
    minecraft.runs.each { run ->
        run.token 'minecraft_classpath', deps
    }
}

 

[NeutrinoKillerino]

  On 2/12/2022 at 1:22 PM, Majd123mc said:

After researching for a while in the source code of ForgeGradle, I have found this code to be a lot more realiable:
 

// Fix the classpath the right way and once and for all
afterEvaluate {
    // Collect deps in runtimeClasspath but NOT in minecraft
    def deps = (configurations.runtimeClasspath - configurations.minecraft).join(';')
    // Add deps to classpath
    minecraft.runs.each { run ->
        run.token 'minecraft_classpath', deps
    }
}

 

Expand  

Hi Majd123mc, would you mind posting your whole build.gradle? I'm struggling to add an external library (jeromq).

Thanks.

[Hypervisor]

I had the same problem with adding external dependencies. Thankfully, I was able to fix it. The solution is documented here. Kindly follow each step carefully. Regards.

[Majd123mc]

  On 3/6/2022 at 9:12 PM, NeutrinoKillerino said:

Hi Majd123mc, would you mind posting your whole build.gradle? I'm struggling to add an external library (jeromq).

Thanks.

Expand  

Excuse me for the lateness! I have notifications turned off.

What @Hypervisor linked is another solution that could work.

What I did was I put the code before processResources like this:
 

  Reveal hidden contents

buildscript {
    repositories {
        // These repositories are only for Gradle plugins, put any other repositories in the repository block further below
        maven { url = 'https://maven.minecraftforge.net' }
        mavenCentral()
    }
    dependencies {
        classpath group: 'net.minecraftforge.gradle', name: 'ForgeGradle', version: '5.1.+', changing: true
    }

}

plugins {
//    id "com.github.johnrengelman.shadow" version "7.1.2"
    id "groovy"
}

apply plugin: 'net.minecraftforge.gradle'
// Only edit below this line, the above code adds and enables the necessary things for Forge to be setup.
apply plugin: 'eclipse'
apply plugin: 'maven-publish'

def author = 'XXXXX'
version = '1.0'
group = 'XXXXX' // http://maven.apache.org/guides/mini/guide-naming-conventions.html
archivesBaseName = 'XXXXX'

// Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17.
java.toolchain.languageVersion = JavaLanguageVersion.of(17)

println('Java: ' + System.getProperty('java.version') + ' JVM: ' + System.getProperty('java.vm.version') + '(' + System.getProperty('java.vendor') + ') Arch: ' + System.getProperty('os.arch'))
minecraft {
    mappings channel: 'official', version: '1.18.1'

    runs {
        client {
            workingDirectory project.file('run')

            property 'forge.logging.markers', 'REGISTRIES'
            property 'forge.logging.console.level', 'debug'

            mods {
                caa {
                    source sourceSets.main
                }
            }
        }

        server {
            workingDirectory project.file('run')

            property 'forge.logging.markers', 'REGISTRIES'
            property 'forge.logging.console.level', 'debug'

            mods {
                caa {
                    source sourceSets.main
                }
            }
        }

        data {
            workingDirectory project.file('run')

            property 'forge.logging.markers', 'REGISTRIES'
            property 'forge.logging.console.level', 'debug'

            args '--mod', 'XXXXX', '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')

            mods {
                caa {
                    source sourceSets.main
                }
            }
        }
    }
}

// Include resources generated by data generators.
sourceSets.main.resources { srcDir 'src/generated/resources' }

repositories {
    mavenCentral()
}

configurations {
}

afterEvaluate {
    println configurations.runtimeClasspath.extendsFrom
}

dependencies {
    //implementation 'junit:junit:4.13.1'
    //implementation 'org.junit.jupiter:junit-jupiter:5.7.0'
    minecraft 'net.minecraftforge:forge:1.18.1-39.0.59'
    implementation 'org.reflections:reflections:0.10.2'
}

// ====================================

// Fix the classpath the right way and once and for all
afterEvaluate {
    // Collect deps in runtimeClasspath but NOT in minecraft
    def deps = (configurations.runtimeClasspath - configurations.minecraft).join(';')
    // Add deps to classpath
    minecraft.runs.each { run ->
        run.token 'minecraft_classpath', deps
    }
}

// ====================================

// Exclude GIMP image files
processResources {
    exclude '**/*.xcf'
}

// Example for how to get properties into the manifest for reading at runtime.
jar {
    //noinspection GroovyAssignabilityCheck
    manifest {
        attributes([
                "Specification-Title"     : project.name,
                "Specification-Vendor"    : author,
                "Specification-Version"   : "1", // We are version 1 of ourselves
                "Implementation-Title"    : project.name,
                "Implementation-Version"  : project.jar.archiveVersion,
                "Implementation-Vendor"   : author,
                "Implementation-Timestamp": new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
        ])
    }
}

// Example configuration to allow publishing using the maven-publish plugin
// This is the preferred method to reobfuscate your jar file
jar.finalizedBy('reobfJar')
// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing
// publish.dependsOn('reobfJar')

publishing {
    publications {
        mavenJava(MavenPublication) {
            artifact jar
        }
    }
    repositories {
        maven {
            url "file://${project.projectDir}/mcmodsrepo"
        }
    }
}

 

 

Edited March 26, 2022 by Majd123mc