Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.87 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.87 KB
Raw

gradle-specialsource

A Gradle plugin for remap name definitions in java bytecode using md-5's SpecialSource.

Initial use-case was, using Mojang mapping for Spigot 1.17+ development, then remap back to Spigot mapping for distribution.

Here md-5's post to see what changed in 1.17+.

Usage

plugins {
    id("io.typecraft.gradlesource.spigot") version "1.0.0"
}

dependencies {
    // Requires BuildTools to run with `--remapped` option to use this local dependency.
    compileOnly("org.spigotmc:spigot:1.17.1-R0.1-SNAPSHOT:remapped-mojang")
}

spigotRemap {
    spigotVersion.set("1.17.1")
    sourceJarTask.set(tasks.jar) // or `tasks.shadowJar` if you use Shadow plugin.
}

Developer notes

Incremental build

This is a performance improvement to avoid redoing already completed job, skip gradle tasks if it's input not changed.

To remap java .class files, it should be a task input.

But currently, RemapTask just checking a .jar file not .class files, therefore it remaps all classes even just a single class modified.

The reason why we can't check classes instead of jar is, this plugin depends on md5's SpecialSource which makes hard to doing that.

This limitation is same with the SpecialSourceMP which for Maven, and it doesn't support any incremental!

To improve this, we should refactor SpecialSource or just create a new one including only pure functions.

References

What changed in 1.17: https://www.spigotmc.org/threads/spigot-bungeecord-1-17.510208/#post-4184317

SpecialSource: https://github.com/md-5/SpecialSource

SpecialSource Maven plugin: https://github.com/agaricusb/SpecialSourceMP