Splash Screen of Java not loading from FatCapsule Task jar

[faizanahemad]

Capsule Plugin Version

1.0.2

Gradle Version

2.13

Expected Behavior

Splash screen configured in Manifest of jar task should display when running the fatjar

Actual Behavior

Splash screen does not load.
Calling SplashScreen.getSplashScreen(); returns Null

Gradle Build Script(s)

build.gradle
gradle.properties
setting.gradle
SplashDemo.java
If you clone the repo you can use ./gradlew clean build fatCapsule shadowJar for building, then go to build/libs execute java -jar splash-screen-0.0.1-shadow.jar to see Shadow Jar running. You can see the Capsule plugin jar output by ./splash-screen-0.0.1-release.jar. The shadow plugin jar does show the Splash screen.

Content of Capsule JAR (jar tf <jar file> - post link to GIST if too long)

META-INF/
META-INF/MANIFEST.MF
Capsule.class
splash-screen-0.0.1-all.jar

More Details

Another Plugin-Gradle ShadowJar Plugin does work correctly for this.

For debugging I added

ClassLoader CLDR = sd.getClass().getClassLoader();
InputStream is = CLDR.getResourceAsStream("loader.gif");
System.out.println("Stream File Size: "+is.available());

And my jar manifest attribute in build.gradle contains 'SplashScreen-Image': 'loader.gif'
Output I got: Stream File Size: 24055 which means the classLoader is able to find the loader.gif.

Jar and FatCapsule in build.gradle

jar {
    classifier = 'all'
    manifest {
        attributes 'Implementation-Title': title,
                'Implementation-Version': version,
                'Main-Class': mainClassFile,
                'SplashScreen-Image': 'loader.gif'
    }
    include{sourceSets.main.output.classesDir}
    zip64 true

}

task fatCapsule(type: FatCapsule) {
    applicationClass mainClassFile
    classifier = 'release'
    reallyExecutable
    capsuleManifest {
        systemProperties['logs'] = './logs'
        minJavaVersion = '1.8.0'
        args = ['-splash:loader.gif']
    }
}

Removing args = ['-splash:loader.gif'] from fatCapsule has no effect. Also I have tried multiple paths like /loader.gif or resources/loader.gif or /resources/loader.gif. Nothing seems to be working while the shadow plugin works with just 'SplashScreen-Image': 'loader.gif'

[jonas-l]

Your problem is related to Capsule rather than this Gradle plugin. Capsule executes your jar using command similar to java -classpath <path-to-jar> your.main.Class. The argument -splash:... only supports files which are in file system (as opposed to stored in jar file).

It looks like there might be a workaround to achieve what you want: use _JAVA_SPLASH_JAR and _JAVA_SPLASH_FILE environment variables. I haven't tried it myself, but it looks like a possible solution.

[faizanahemad]

Hey Jonas thanks for replying. As mentioned in my initial issue, I try to use the splash screen by providing it in Jar Manifest (check the Jar task) itself rather than using -splash.... And the technique of specifying the splash in Manifest works with Shadow plugin. Also as I have checked that the file is available to the classloader itself. See the More Details section of the issue for reference.

The line args = ['-splash:loader.gif'] inside the task fatCapsule(type: FatCapsule) is completely irrelevant, please ignore that. I will try the other approach as well but I see that the issue still remains and another plugin is able to do that. I don't know how capsule works so I will check that out as well.

[pron]

Instead of using the SplashScreen-Image manifest attribute, try putting loader.gif in the capsule's root, and adding '-splash:loader.gif' not to args (which are passed to the application's main) but to jvmArgs (which sets the JVM-Args attribute). If that doesn't work, please open a Capsule issue.