Interface RenamerExtension

public interface RenamerExtension
The extension interface for the Renamer Gradle plugin.

  • Field Details

  • Method Details

    • mappings

      default void mappings(String channel, String version)

    • mappings

      void mappings(String artifact)

    • mappings

      void mappings(org.gradle.api.artifacts.Dependency dependency)

    • mappings

      void mappings(org.gradle.api.provider.Provider<?> dependency)

    • mappings

      void mappings(org.gradle.api.tasks.TaskProvider<?> task)

    • mappings

      default void mappings(org.gradle.api.provider.ProviderConvertible<?> dependency)

    • setMappings

      void setMappings(org.gradle.api.file.FileCollection files)

    • getMappings

      org.gradle.api.file.ConfigurableFileCollection getMappings()

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(org.gradle.api.tasks.bundling.AbstractArchiveTask input)

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(org.gradle.api.tasks.bundling.AbstractArchiveTask input, org.gradle.api.Action<? super RenameJar> action)

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input)

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input, org.gradle.api.Action<? super RenameJar> action)

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(String name, org.gradle.api.tasks.bundling.AbstractArchiveTask input)

    • classes

      org.gradle.api.tasks.TaskProvider<RenameJar> classes(String name, org.gradle.api.tasks.bundling.AbstractArchiveTask input, org.gradle.api.Action<? super RenameJar> action)

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(String name, org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input)

    • classes

      org.gradle.api.tasks.TaskProvider<RenameJar> classes(String name, org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input, org.gradle.api.Action<? super RenameJar> action)

    • classes

      default org.gradle.api.tasks.TaskProvider<RenameJar> classes(String name)

    • classes

      org.gradle.api.tasks.TaskProvider<RenameJar> classes(String name, org.gradle.api.Action<? super RenameJar> action)

    • sources

      default RenameSources sources(org.gradle.api.tasks.SourceSet input)

    • sources

      default RenameSources sources(org.gradle.api.tasks.SourceSet input, org.gradle.api.Action<? super RenameSources> action)

    • sources

      default RenameSources sources(String name, org.gradle.api.tasks.SourceSet input, org.gradle.api.Action<? super RenameSources> action)

    • sources

      default RenameSources sources(org.gradle.api.tasks.bundling.AbstractArchiveTask input)

    • sources

      default RenameSources sources(org.gradle.api.tasks.bundling.AbstractArchiveTask input, org.gradle.api.Action<? super RenameSources> action)

    • sources

      default RenameSources sources(String name, org.gradle.api.tasks.bundling.AbstractArchiveTask input, org.gradle.api.Action<? super RenameSources> action)

    • sources

      default RenameSources sources(org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input)

    • sources

      default RenameSources sources(org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input, org.gradle.api.Action<? super RenameSources> action)

    • sources

      default RenameSources sources(String name, org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.tasks.bundling.AbstractArchiveTask> input, org.gradle.api.Action<? super RenameSources> action)

    • sources

      RenameSources sources(String name, org.gradle.api.Action<? super RenameSources> action)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.Action<? super ConvertMappings> action)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.provider.Provider<?> input)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.provider.Provider<?> input, org.gradle.api.Action<? super ConvertMappings> action)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.provider.Provider<?> input, String format)

    • convert

      org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.provider.Provider<?> input, String format, org.gradle.api.Action<? super ConvertMappings> action)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.tasks.TaskProvider<?> input)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.tasks.TaskProvider<?> input, org.gradle.api.Action<? super ConvertMappings> action)

    • convert

      default org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.tasks.TaskProvider<?> input, String format)

    • convert

      org.gradle.api.tasks.TaskProvider<ConvertMappings> convert(String name, org.gradle.api.tasks.TaskProvider<?> input, String format, org.gradle.api.Action<? super ConvertMappings> action)

    • chain

      default org.gradle.api.tasks.TaskProvider<ChainMappings> chain(String name)

    • chain

      org.gradle.api.tasks.TaskProvider<ChainMappings> chain(String name, org.gradle.api.Action<? super ChainMappings> action)

    • merge

      default org.gradle.api.tasks.TaskProvider<MergeMappings> merge(String name)

    • merge

      org.gradle.api.tasks.TaskProvider<MergeMappings> merge(String name, org.gradle.api.Action<? super MergeMappings> action)

    • dependency

      default org.gradle.api.provider.Provider<org.gradle.api.artifacts.Dependency> dependency(String coordinates)

      Used for deobfuscating dependencies. This does not support source file deobfuscation

      If the net.minecraftforge.gradle gradle plugin is also applied, then we also default

      • naiveSrg to true
      • reverse to true

    • dependency

      org.gradle.api.provider.Provider<org.gradle.api.artifacts.Dependency> dependency(String coordinates, org.gradle.api.Action<? super RenameJar> action)

      Used for deobfuscating dependencies. This does not support source file deobfuscation

      If the net.minecraftforge.gradle gradle plugin is also applied, then we also default

      • naiveSrg to true
      • reverse to true

    • enableMixinRefmaps

      default MixinConfig enableMixinRefmaps()
      Enable Mixin reference mapping, "mixin magic" as seen here

      For a more in depth explanation:

      • Source sets

        Each source set can be individually configured, outputting a refmap.json to be used at runtime. Main Annotation Processor compilation args added:

        • "-AmappingTypes=tsrg"
        • "-AdefaultObfuscationEnv=searge"
        • "-AreobfTsrgFile" set to the path of the .tsrg mappings file,sourced from the minecraft dependency
        • "-AoutRefMapFile" a path to where this source set's refmap.json will be output by the AP
      • Run configs

        Adds the "--mixin.config" run config argument(s), so that developer environment testing will have mixins applied when running the game

      • Jar output

        Copies over the refmaps into the output Jar, and fills out the "MixinConfigs" manifest entry, allowing for the application of Mixins in a production environment

    • enableMixinRefmaps

      MixinConfig enableMixinRefmaps(org.gradle.api.Action<MixinConfig> action)
      Enable and configure Mixin reference mapping, "mixin magic" as seen here

      For a more in depth explanation:

      • Source sets

        Each source set can be individually configured, outputting a refmap.json to be used at runtime. Main AP compilation args added:

        • "-AmappingTypes=tsrg"
        • "-AdefaultObfuscationEnv=searge"
        • "-AreobfTsrgFile" set to the path of the .tsrg mappings file,sourced from the minecraft dependency
        • "-AoutRefMapFile" a path to where this source set's refmap.json will be output by the AP
      • Run configs

        Adds the "--mixin.config" run config argument(s), so that developer environment testing will have mixins applied when running the game

      • Jar output

        Copies over the refmaps into the output Jar, and fills out the "MixinConfigs" manifest entry, allowing for the application of Mixins in a production environment

    • getMixin

      MixinConfig getMixin()
      Configure Mixin setup, see enableMixinRefmaps()