Adding org.apache Libraries To Mod

[Jack Richard]

I'm using version 1.15.2, and I'm trying to include Apache Commons Exec in my mod. 

From what I've read, you can't use it like a normal dependency. But, the Apache library is a prerequisite for the dependency I am adding, so I don't think I can simply relocate it.

How can I use this?

 

Thanks in advance.

[ChampionAsh5357]

  On 9/27/2020 at 6:53 PM, Jack Richard said:

so I don't think I can simply relocate it.

Expand  

Well technically, that's what you have to do by shadowing the jar into your own using Gradle. This allows others to use your mod without requiring some dependency that might or might not already be on their system.

[Jack Richard]

  On 9/27/2020 at 7:29 PM, ChampionAsh5357 said:

Well technically, that's what you have to do by shadowing the jar into your own using Gradle.

Expand  

I looked into shadowing, and I added the plugin to my Gradle file. Before, I was "shading" using this:

configurations.shade.each { dep ->
        from(project.zipTree(dep)){
            exclude 'META-INF', 'META-INF/**'
        }
    }

...but I'm guessing that isn't the same thing.

 

I needed to use version 4.0.4, because 6.0 didn't support the version of Gradle I'm using.

When I build the jar, the logs show a NoClassDefFoundError for the main package of the dependency.

 

All I've added to build.gradle is:

buildscript {
    repositories {
        maven { url = 'https://files.minecraftforge.net/maven' }
        maven { url = "https://plugins.gradle.org/m2/" }
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath group: 'net.minecraftforge.gradle', name: 'ForgeGradle', version: '3.+', changing: true
        classpath "com.github.jengelman.gradle.plugins:shadow:4.0.4"
    }
}
apply plugin: 'net.minecraftforge.gradle'
apply plugin: 'eclipse'
apply plugin: 'maven-publish'
apply plugin: "com.github.johnrengelman.shadow"

dependencies {
    minecraft 'net.minecraftforge:forge:1.15.2-31.2.36'

    shadow 'nameofdependency'
}

 

Maybe there is more configuration needed?

[ChampionAsh5357]

You shouldn't need to edit the buildscript at all. Plugins are applied using the plugins{} block although what you are doing will work as well. I believe the keyword to use is shade instead of shadow with shade being a configuration. You would also need a shadowJar{} block to specify where to relocate the files to.

[Jack Richard]

  On 9/27/2020 at 8:29 PM, ChampionAsh5357 said:

You shouldn't need to edit the buildscript at all. Plugins are applied using the plugins{} block although what you are doing will work as well.

Expand  

I changed it to use the plugins{} block instead.

  On 9/27/2020 at 8:29 PM, ChampionAsh5357 said:

I believe the keyword to use is shade instead of shadow with shade being a configuration.

Expand  

shade wasn't a valid option, so I stuck with shadow. But I see some examples just using compile, does that work anyway?

  On 9/27/2020 at 8:29 PM, ChampionAsh5357 said:

You would also need a shadowJar{} block to specify where to relocate the files to.

Expand  

Okay, here's my shadowJar{} block I added:

shadowJar {
    relocate 'org.apache', 'org.(modid).apache'
}

 

I'm still getting NoClassDefFoundError, though.

 

Thanks for your help so far.

[Jack Richard]

I'm trying to use this guide now. Forge doesn't seem to have srgExtra or extraLines anymore, is there an alternative?

[DaemonUmbra]

That guide is ANCIENT, throw it away.

I don't think that bit is needed now

[Jack Richard]

  On 9/28/2020 at 12:01 AM, DaemonUmbra said:

That guide is ANCIENT, throw it away.

I don't think that bit is needed now

Expand  

I'm guessing I still need to move the Apache library somehow, because I always get NoClassDefFoundError when calling it... If you still aren't allowed to use Apache libraries (I read old forum posts saying you can't include those normally), I guess that would explain the error. 

I couldn't figure out the Shadow plugin, it didn't seem to include any dependencies, so I used that guide, I'll try again with Shadow.

 

Thanks.

[Jack Richard]

At this point, I've reimplemented the Shadow plugin, but it makes no changes to the jar unless I use:

project.tasks.build.dependsOn shadowJar

which makes a much larger jar, and I assume my dependencies are somewhere in there, but Minecraft does not recognize it as a mod. 

When I used the dependencies{} block in the shadowJar{} block, and included my dependencies, it would generate a 1 KB jar, which is definitely not right at all.

 

Other than including the plugin, here's the code that Shadow effects:

dependencies {
    minecraft 'net.minecraftforge:forge:1.15.2-31.2.36'

    compile group: 'org.seleniumhq.selenium', name:'selenium-java', version:'3.141.59'
}

shadowJar {
    relocate 'org.apache.commons.exec', 'org.(modid).apache.commons.exec'
    classifier ''
}

 

Thanks all for your help.

[Jack Richard]

All my libraries are inside the jar now, but Minecraft does not recognize it as a mod anymore...

[ChampionAsh5357]

In the development environment or the finalized jar?

[Jack Richard]

  On 9/28/2020 at 2:29 PM, ChampionAsh5357 said:

In the development environment or the finalized jar?

Expand  

It runs fine with runClient, but when it's built, it's not recognized at all.

[ChampionAsh5357]

  On 9/28/2020 at 2:33 PM, Jack Richard said:

but when it's built, it's not recognized at all.

Expand  

Hmmm, my only guess is that it's iterating through the apache commons package directory and skipping yours. As for how to fix this, you might have to do something more with relocate, but that is the best I can think of.

[Jack Richard]

  On 9/28/2020 at 2:49 PM, ChampionAsh5357 said:

Hmmm, my only guess is that it's iterating through the apache commons package directory and skipping yours. As for how to fix this, you might have to do something more with relocate, but that is the best I can think of.

Expand  

 

I've relocated the Apache libraries now, but it's still not recognizing. When I recompile the jar, it appears that it has additionally copied all of Minecraft Forge's files. I think Shadow is picking up the:

minecraft 'net.minecraftforge:forge:1.15.2-31.2.36'

in dependencies{}...

 

I can't get exclude to work on this dependency, and I think this may be the solution.

[ChampionAsh5357]

  On 9/28/2020 at 3:47 PM, Jack Richard said:

 

I can't get exclude to work on this dependency, and I think this may be the solution.

Expand  

I believe you would need to set the configurations to only include whichever you need using configurations = [project_configs]. That's why I said create a configuration called shade before so that you could call that.

[Jack Richard]

  On 9/28/2020 at 3:54 PM, ChampionAsh5357 said:

I believe you would need to set the configurations to only include whichever you need using configurations = [project_configs]. That's why I said create a configuration called shade before so that you could call that.

Expand  

Now we're getting somewhere... here's my build.gradle:

configurations {
    provided
    compile.extendsFrom provided
}

dependencies {
    minecraft 'net.minecraftforge:forge:1.15.2-31.2.36'

    shadow group: 'org.seleniumhq.selenium', name:'selenium-java', version:'3.141.59'
}

shadowJar {
    configurations = [project.configurations.shadow]

    classifier ''

    relocate('org.apache', 'org.(modid).apache')
}

processResources {
    inputs.property "version", project.version
    inputs.property "mcversion", "1.15.2-31.2.36"

    from(sourceSets.main.resources.srcDirs) {
        include 'mcmod.info'
        expand 'version':project.version, 'mcversion': "1.15.2-31.2.36"
    }

    from(sourceSets.main.resources.srcDirs) {
        exclude 'mcmod.info'
    }
}

project.tasks.build.dependsOn shadowJar

 

The file size drastically shrinks, and Minecraft recognizes it as a mod! 

But now, I'm getting:

java.lang.NoClassDefFoundError: org/(modid)/apache/logging/log4j/LogManager

So there might be more work to do...

[ChampionAsh5357]

You seem to have copied the apache libraries that are already present in forge as well.

[Jack Richard]

  On 9/28/2020 at 4:19 PM, ChampionAsh5357 said:

You seem to have copied the apache libraries that are already present in forge as well.

Expand  

I used this to get the libraries back:

shadow group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.11.2'
shadow group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.11.2'

But now I'm getting this:

java.lang.NoSuchMethodError: com.google.common.util.concurrent.SimpleTimeLimiter.create(Ljava/util/concurrent/ExecutorService;)Lcom/google/common/util/concurrent/SimpleTimeLimiter;

 

[Jack Richard]

I changed my shadowJar config to this:

shadowJar {
    relocate('com.google', 'org.(modid).google')
    configurations = [project.configurations.shadow]

    classifier ''

    relocate('org.apache', 'org.(modid).apache')
}

And I have success!

[Jack Richard]

  On 9/28/2020 at 4:57 PM, Jack Richard said:

I changed my shadowJar config to this:

shadowJar {
    relocate('com.google', 'org.(modid).google')
    configurations = [project.configurations.shadow]

    classifier ''

    relocate('org.apache', 'org.(modid).apache')
}

And I have success!

Expand  

But now that I've entered the game, I've noticed a fatal flaw. None of my block or items registered. I think it's because of ignoring the Minecraft dependencies, so I'll need to keep on working.