Problems with shadowing JavaFX(openjfx) into my mod-jar

[OfficialGoat]

Hello, as the title said, I'm having trouble with shading JavaFX into my mod jar. I spend the last few days trying basically everything I could find on this forum and on google, but nothing seemed to work. As suggested a lot of times before on this forum, I use the gradle shadow plugin. I compared my output jar with other mods using shadowing and found that is seems quite "polluted" with a lot of dll's etc.  So maybe transitive dependencies cause a lot of stuff to be included wich should not be included. Also I am not sure if my attempt at relocating the openjfx libraries did work in any way. 

Since this is my first time working with pretty much any of this stuff I am really quite unexperienced and at my wits end. I hope some of you can point me in the right direction. : )

(And yes, I am sure that I want to use JavaFX. Besides several other reasons, I want to learn it while using it in this project.)

 

Here my build.gradle 

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'}
        maven {url = "https://plugins.gradle.org/m2/"}
    }
    dependencies {
        classpath group: 'net.minecraftforge.gradle', name: 'ForgeGradle', version: '5.1.+', changing: true
        classpath 'org.openjfx:javafx-plugin:0.0.10'
    }
}
plugins {
    id 'com.github.johnrengelman.shadow' version '6.1.0'
}

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'
apply plugin: 'org.openjfx.javafxplugin'

javafx {
    version = '16'
    modules = [ 'javafx.controls' ]
}

version = '1.0'
group = 'com.github.maptool' // http://maven.apache.org/guides/mini/guide-naming-conventions.html
archivesBaseName = 'maptool'

// Mojang ships Java 16 to end users in 1.17+ instead of Java 8 in 1.16 or lower, so your mod should target Java 16.
java.toolchain.languageVersion = JavaLanguageVersion.of(16)

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.17.1'

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

    // Default run configurations.
    // These can be tweaked, removed, or duplicated as needed.
    runs {
        client {
            workingDirectory project.file('run')

            // 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 {
                examplemod {
                    source sourceSets.main
                }
            }


        }

        server {
            workingDirectory project.file('run')

            // 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 {
                examplemod {
                    source sourceSets.main
                }
            }
        }

        data {
            workingDirectory project.file('run')

            // 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'

            // Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
            args '--mod', 'examplemod', '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')

            mods {
                examplemod {
                    source sourceSets.main
                }
            }
        }
    }
}

configurations {
    shade
}


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

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.17.1-37.0.73'

    // 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


    //shade 'org.openjfx:javafx-base:16'
    //shade 'org.openjfx:javafx-controls:16'
    //shade 'org.openjfx:javafx-graphics:16'
}

shadowJar {
    //configurations =  [project.configurations.shade]
    archiveClassifier.set('shadow')
    dependencies {
        include(dependency('org.openjfx:javafx-base:16:win'))
        include(dependency('org.openjfx:javafx-graphics:16:win'))
        include(dependency('org.openjfx:javafx-controls:16:win'))
    }
    relocate 'org.openjfx', "maptool.shaded.shadedjfx"
}

// Example for how to get properties into the manifest for reading at runtime.
jar {
    manifest {
        attributes([
                "Specification-Title"     : "examplemod",
                "Specification-Vendor"    : "examplemodsareus",
                "Specification-Version"   : "1", // We are version 1 of ourselves
                "Implementation-Title"    : project.name,
                "Implementation-Version"  : project.jar.archiveVersion,
                "Implementation-Vendor"   : "examplemodsareus",
                "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"
        }
    }
}


reobf {
    shadowJar {}
}

tasks.build.dependsOn shadowJar
shadowJar.finalizedBy('reobfShadowJar')

task printConfigNames {
    doLast {
        configurations.each {println it.name}
    }
}

Also here a picture, of what's included in the shadowed jar:

[Majd123mc]

EDIT: This method no longer works.

Quote

 

I was facing the same issues trying to make a fat jar (that is what it is called). So instead I used the META-INF/libraries method.

Forge automatically loads libraries from META-INF/libraries.

Put the following code above your dependencies block in build.gradle:
 

configurations {
    include
}

dependencies {
    implementation '<javafx maven string goes here, I never used it before>'
    include '<javafx maven string>'
}

jar { // Include libraries into jar
    from(configurations.include) {
        into 'META-INF/libraries'
    }

    def deps = configurations.include.collect { it.name }
    println deps.join(' ')
    manifest {
        attributes([
                'ContainedDeps': deps.join(' ')
        ])
    }
}

NOTE: Make sure to actually change <javafx maven string...> with the maven url string thing for it.

 

Edited February 6, 2022 by Majd123mc