From b25a618663d479d86325f67f7bc603fa5dd5f76a Mon Sep 17 00:00:00 2001 From: glowredman <35727266+glowredman@users.noreply.github.com> Date: Mon, 15 Jan 2024 19:18:51 +0100 Subject: [PATCH] Deprecate `gradleTokenModId`, `gradleTokenModName` and `gradleTokenGroupName` (#253) --- build.gradle | 19 ++++++++++++++++--- gradle.properties | 7 +++---- .../java/com/myname/mymodid/CommonProxy.java | 2 +- src/main/java/com/myname/mymodid/MyMod.java | 5 +++-- 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/build.gradle b/build.gradle index 3eb19a26..75ed9d16 100644 --- a/build.gradle +++ b/build.gradle @@ -428,18 +428,31 @@ minecraft { for (f in replaceGradleTokenInFile.split(',')) { tagReplacementFiles.add f } + out.style(Style.Info).text('replaceGradleTokenInFile is deprecated! Consider using generateGradleTokenClass.').println() } if (gradleTokenModId) { - injectedTags.put gradleTokenModId, modId + if (replaceGradleTokenInFile) { + injectedTags.put gradleTokenModId, modId + } else { + out.style(Style.Failure).text('gradleTokenModId is deprecated! The field will no longer be generated.').println() + } } if (gradleTokenModName) { - injectedTags.put gradleTokenModName, modName + if (replaceGradleTokenInFile) { + injectedTags.put gradleTokenModName, modName + } else { + out.style(Style.Failure).text('gradleTokenModName is deprecated! The field will no longer be generated.').println() + } } if (gradleTokenVersion) { injectedTags.put gradleTokenVersion, modVersion } if (gradleTokenGroupName) { - injectedTags.put gradleTokenGroupName, modGroup + if (replaceGradleTokenInFile) { + injectedTags.put gradleTokenGroupName, modGroup + } else { + out.style(Style.Failure).text('gradleTokenGroupName is deprecated! The field will no longer be generated.').println() + } } if (enableGenericInjection.toBoolean()) { injectMissingGenerics.set(true) diff --git a/gradle.properties b/gradle.properties index 714d3d45..b3f1ebb1 100644 --- a/gradle.properties +++ b/gradle.properties @@ -36,12 +36,11 @@ enableModernJavaSyntax = true # Turns most publicly visible List, Map, etc. into proper List, Map types enableGenericInjection = false -# Generate a class with String fields for the mod id, name, version and group name named with the fields below +# Generate a class with a String field for the mod version named as defined below. +# If generateGradleTokenClass is empty or not missing, no such class will be generated. +# If gradleTokenVersion is empty or missing, the field will not be present in the class. generateGradleTokenClass = com.myname.mymodid.Tags -gradleTokenModId = MODID -gradleTokenModName = MODNAME gradleTokenVersion = VERSION -gradleTokenGroupName = GROUPNAME # [DEPRECATED] # Multiple source files can be defined here by providing a comma-seperated list: Class1.java,Class2.java,Class3.java # public static final String VERSION = "GRADLETOKEN_VERSION"; diff --git a/src/main/java/com/myname/mymodid/CommonProxy.java b/src/main/java/com/myname/mymodid/CommonProxy.java index d5df8022..dfdfe53c 100644 --- a/src/main/java/com/myname/mymodid/CommonProxy.java +++ b/src/main/java/com/myname/mymodid/CommonProxy.java @@ -13,7 +13,7 @@ public void preInit(FMLPreInitializationEvent event) { Config.synchronizeConfiguration(event.getSuggestedConfigurationFile()); MyMod.LOG.info(Config.greeting); - MyMod.LOG.info("I am " + Tags.MODNAME + " at version " + Tags.VERSION); + MyMod.LOG.info("I am MyMod at version " + Tags.VERSION); } // load "Do your mod setup. Build whatever data structures you care about. Register recipes." (Remove if not needed) diff --git a/src/main/java/com/myname/mymodid/MyMod.java b/src/main/java/com/myname/mymodid/MyMod.java index 316b563a..b6f6735d 100644 --- a/src/main/java/com/myname/mymodid/MyMod.java +++ b/src/main/java/com/myname/mymodid/MyMod.java @@ -10,10 +10,11 @@ import cpw.mods.fml.common.event.FMLPreInitializationEvent; import cpw.mods.fml.common.event.FMLServerStartingEvent; -@Mod(modid = Tags.MODID, version = Tags.VERSION, name = Tags.MODNAME, acceptedMinecraftVersions = "[1.7.10]") +@Mod(modid = MyMod.MODID, version = Tags.VERSION, name = "MyMod", acceptedMinecraftVersions = "[1.7.10]") public class MyMod { - public static final Logger LOG = LogManager.getLogger(Tags.MODID); + public static final String MODID = "mymodid"; + public static final Logger LOG = LogManager.getLogger(MODID); @SidedProxy(clientSide = "com.myname.mymodid.ClientProxy", serverSide = "com.myname.mymodid.CommonProxy") public static CommonProxy proxy;