User: rednesto Date: 24 Jan 24 07:21 Revision: e23ddbd3b83a43380a29b1e50c3ae9bcae966255 Summary: NeoForge support (#2196) * NeoForged support * 2024 license * Add Parchment mappings * Fix NeoGradle integration * License * Fix ktlint error * Allow using parchment mappings for older versions * Address reviews * Quote mod_id placeholder in mods.toml template See 59677b86ece5864084819bbbe3c616636e9d37f8 TeamCity URL: https://ci.mcdev.io/viewModification.html?tab=vcsModificationFiles&modId=9047&personal=false The following binary files were skipped: src/main/resources/assets/icons/platform/NeoForge.png Index: readme.md =================================================================== --- readme.md (revision 47053d6936a459a88ae0973f04b49b3965015c2b) +++ readme.md (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -137,6 +137,7 @@ - [![Sponge Icon](src/main/resources/assets/icons/platform/Sponge_dark.png?raw=true) **Sponge**](https://www.spongepowered.org/) - [![Architectury Icon](src/main/resources/assets/icons/platform/Architectury.png?raw=true) **Architectury**](https://github.com/architectury/architectury-api) - [![Forge Icon](src/main/resources/assets/icons/platform/Forge.png?raw=true) **Minecraft Forge**](https://forums.minecraftforge.net/) +-

Sponge

Forge

NeoForge

Fabric

Architectury

Velocity

@@ -88,6 +89,7 @@ + @@ -108,6 +110,7 @@ + @@ -167,6 +170,7 @@ * Bukkit * Sponge * Forge + * NeoForge * Fabric * MCP * Mixin @@ -349,6 +353,18 @@ + + + + + + + + + + + + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Config.java.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Config.java.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Config.java.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,63 @@ +package ${PACKAGE_NAME}; + +import net.minecraft.core.registries.BuiltInRegistries; +import net.minecraft.resources.ResourceLocation; +import net.minecraft.world.item.Item; +import net.neoforged.bus.api.SubscribeEvent; +import net.neoforged.fml.common.Mod; +import net.neoforged.fml.event.config.ModConfigEvent; +import net.neoforged.neoforge.common.ModConfigSpec; + +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +// An example config class. This is not required, but it's a good idea to have one to keep your config organized. +// Demonstrates how to use Forge's config APIs +@Mod.EventBusSubscriber(modid = ${CLASS_NAME}.MODID, bus = Mod.EventBusSubscriber.Bus.MOD) +public class Config +{ + private static final ModConfigSpec.Builder BUILDER = new ModConfigSpec.Builder(); + + private static final ModConfigSpec.BooleanValue LOG_DIRT_BLOCK = BUILDER + .comment("Whether to log the dirt block on common setup") + .define("logDirtBlock", true); + + private static final ModConfigSpec.IntValue MAGIC_NUMBER = BUILDER + .comment("A magic number") + .defineInRange("magicNumber", 42, 0, Integer.MAX_VALUE); + + public static final ModConfigSpec.ConfigValue MAGIC_NUMBER_INTRODUCTION = BUILDER + .comment("What you want the introduction message to be for the magic number") + .define("magicNumberIntroduction", "The magic number is... "); + + // a list of strings that are treated as resource locations for items + private static final ModConfigSpec.ConfigValue> ITEM_STRINGS = BUILDER + .comment("A list of items to log on common setup.") + .defineListAllowEmpty("items", List.of("minecraft:iron_ingot"), Config::validateItemName); + + static final ModConfigSpec SPEC = BUILDER.build(); + + public static boolean logDirtBlock; + public static int magicNumber; + public static String magicNumberIntroduction; + public static Set items; + + private static boolean validateItemName(final Object obj) + { + return obj instanceof String itemName && BuiltInRegistries.ITEM.containsKey(new ResourceLocation(itemName)); + } + + @SubscribeEvent + static void onLoad(final ModConfigEvent event) + { + logDirtBlock = LOG_DIRT_BLOCK.get(); + magicNumber = MAGIC_NUMBER.get(); + magicNumberIntroduction = MAGIC_NUMBER_INTRODUCTION.get(); + + // convert the list of strings into a set of items + items = ITEM_STRINGS.get().stream() + .map(itemName -> BuiltInRegistries.ITEM.get(new ResourceLocation(itemName))) + .collect(Collectors.toSet()); + } +} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Config.java.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Config.java.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Config.java.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new config class for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Main Class.java.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Main Class.java.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Main Class.java.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,129 @@ +package ${PACKAGE_NAME}; + +import com.mojang.logging.LogUtils; +import net.minecraft.client.Minecraft; +import net.minecraft.core.registries.BuiltInRegistries; +import net.minecraft.core.registries.Registries; +import net.minecraft.world.food.FoodProperties; +import net.minecraft.world.item.BlockItem; +import net.minecraft.world.item.CreativeModeTab; +import net.minecraft.world.item.CreativeModeTabs; +import net.minecraft.world.item.Item; +import net.minecraft.world.level.block.Block; +import net.minecraft.world.level.block.Blocks; +import net.minecraft.world.level.block.state.BlockBehaviour; +import net.minecraft.world.level.material.MapColor; +import net.neoforged.api.distmarker.Dist; +import net.neoforged.bus.api.IEventBus; +import net.neoforged.bus.api.SubscribeEvent; +import net.neoforged.fml.ModLoadingContext; +import net.neoforged.fml.common.Mod; +import net.neoforged.fml.config.ModConfig; +import net.neoforged.fml.event.lifecycle.FMLClientSetupEvent; +import net.neoforged.fml.event.lifecycle.FMLCommonSetupEvent; +import net.neoforged.neoforge.common.NeoForge; +import net.neoforged.neoforge.event.BuildCreativeModeTabContentsEvent; +import net.neoforged.neoforge.event.server.ServerStartingEvent; +import net.neoforged.neoforge.registries.DeferredBlock; +import net.neoforged.neoforge.registries.DeferredHolder; +import net.neoforged.neoforge.registries.DeferredItem; +import net.neoforged.neoforge.registries.DeferredRegister; +import org.slf4j.Logger; + +// The value here should match an entry in the META-INF/mods.toml file +@Mod(${CLASS_NAME}.MODID) +public class ${CLASS_NAME} +{ + // Define mod id in a common place for everything to reference + public static final String MODID = "${MOD_ID}"; + // Directly reference a slf4j logger + private static final Logger LOGGER = LogUtils.getLogger(); + // Create a Deferred Register to hold Blocks which will all be registered under the "${MOD_ID}" namespace + public static final DeferredRegister.Blocks BLOCKS = DeferredRegister.createBlocks(MODID); + // Create a Deferred Register to hold Items which will all be registered under the "${MOD_ID}" namespace + public static final DeferredRegister.Items ITEMS = DeferredRegister.createItems(MODID); + // Create a Deferred Register to hold CreativeModeTabs which will all be registered under the "${MOD_ID}" namespace + public static final DeferredRegister CREATIVE_MODE_TABS = DeferredRegister.create(Registries.CREATIVE_MODE_TAB, MODID); + + // Creates a new Block with the id "${MOD_ID}:example_block", combining the namespace and path + public static final DeferredBlock EXAMPLE_BLOCK = BLOCKS.registerSimpleBlock("example_block", BlockBehaviour.Properties.of().mapColor(MapColor.STONE)); + // Creates a new BlockItem with the id "${MOD_ID}:example_block", combining the namespace and path + public static final DeferredItem EXAMPLE_BLOCK_ITEM = ITEMS.registerSimpleBlockItem("example_block", EXAMPLE_BLOCK); + + // Creates a new food item with the id "${MOD_ID}:example_id", nutrition 1 and saturation 2 + public static final DeferredItem EXAMPLE_ITEM = ITEMS.registerSimpleItem("example_item", new Item.Properties().food(new FoodProperties.Builder() + .alwaysEat().nutrition(1).saturationMod(2f).build())); + + // Creates a creative tab with the id "${MOD_ID}:example_tab" for the example item, that is placed after the combat tab + public static final DeferredHolder EXAMPLE_TAB = CREATIVE_MODE_TABS.register("example_tab", () -> CreativeModeTab.builder() + .withTabsBefore(CreativeModeTabs.COMBAT) + .icon(() -> EXAMPLE_ITEM.get().getDefaultInstance()) + .displayItems((parameters, output) -> { + output.accept(EXAMPLE_ITEM.get()); // Add the example item to the tab. For your own tabs, this method is preferred over the event + }).build()); + + // The constructor for the mod class is the first code that is run when your mod is loaded. + // FML will recognize some parameter types like IEventBus or ModContainer and pass them in automatically. + public ${CLASS_NAME}(IEventBus modEventBus) + { + // Register the commonSetup method for modloading + modEventBus.addListener(this::commonSetup); + + // Register the Deferred Register to the mod event bus so blocks get registered + BLOCKS.register(modEventBus); + // Register the Deferred Register to the mod event bus so items get registered + ITEMS.register(modEventBus); + // Register the Deferred Register to the mod event bus so tabs get registered + CREATIVE_MODE_TABS.register(modEventBus); + + // Register ourselves for server and other game events we are interested in + NeoForge.EVENT_BUS.register(this); + + // Register the item to a creative tab + modEventBus.addListener(this::addCreative); + + // Register our mod's ModConfigSpec so that FML can create and load the config file for us + ModLoadingContext.get().registerConfig(ModConfig.Type.COMMON, Config.SPEC); + } + + private void commonSetup(final FMLCommonSetupEvent event) + { + // Some common setup code + LOGGER.info("HELLO FROM COMMON SETUP"); + + if (Config.logDirtBlock) + LOGGER.info("DIRT BLOCK >> {}", BuiltInRegistries.BLOCK.getKey(Blocks.DIRT)); + + LOGGER.info(Config.magicNumberIntroduction + Config.magicNumber); + + Config.items.forEach((item) -> LOGGER.info("ITEM >> {}", item.toString())); + } + + // Add the example block item to the building blocks tab + private void addCreative(BuildCreativeModeTabContentsEvent event) + { + if (event.getTabKey() == CreativeModeTabs.BUILDING_BLOCKS) + event.accept(EXAMPLE_BLOCK_ITEM); + } + + // You can use SubscribeEvent and let the Event Bus discover methods to call + @SubscribeEvent + public void onServerStarting(ServerStartingEvent event) + { + // Do something when the server starts + LOGGER.info("HELLO from server starting"); + } + + // You can use EventBusSubscriber to automatically register all static methods in the class annotated with @SubscribeEvent + @Mod.EventBusSubscriber(modid = MODID, bus = Mod.EventBusSubscriber.Bus.MOD, value = Dist.CLIENT) + public static class ClientModEvents + { + @SubscribeEvent + public static void onClientSetup(FMLClientSetupEvent event) + { + // Some client setup code + LOGGER.info("HELLO FROM CLIENT SETUP"); + LOGGER.info("MINECRAFT NAME >> {}", Minecraft.getInstance().getUser().getName()); + } + } +} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Main Class.java.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Main Class.java.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Main Class.java.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new main class for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Mixins Config.json.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Mixins Config.json.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Mixins Config.json.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,14 @@ +{ + "required": true, + "minVersion": "0.8", + "package": "${PACKAGE_NAME}", + "compatibilityLevel": "JAVA_8", + "refmap": "${MOD_ID}.refmap.json", + "mixins": [ + ], + "client": [ + ], + "injectors": { + "defaultRequire": 1 + } +} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Mixins Config.json.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Mixins Config.json.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge Mixins Config.json.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new modid.mixins.json file for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge build.gradle.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge build.gradle.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge build.gradle.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,141 @@ +plugins { + id 'java-library' + id 'eclipse' + id 'idea' + id 'maven-publish' + id 'net.neoforged.gradle.userdev' version '7.0.74' +} + +version = mod_version +group = mod_group_id + +repositories { + mavenLocal() +} + +base { + archivesName = mod_id +} + +java.toolchain.languageVersion = JavaLanguageVersion.of(${JAVA_VERSION}) + +//minecraft.accessTransformers.file rootProject.file('src/main/resources/META-INF/accesstransformer.cfg') +//minecraft.accessTransformers.entry public net.minecraft.client.Minecraft textureManager # textureManager + +// Default run configurations. +// These can be tweaked, removed, or duplicated as needed. +runs { + // applies to all the run configs below + configureEach { + // 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. + systemProperty '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 + systemProperty 'forge.logging.console.level', 'debug' + + modSource project.sourceSets.main + } + + client { + // Comma-separated list of namespaces to load gametests from. Empty = all namespaces. + systemProperty 'forge.enabledGameTestNamespaces', project.mod_id + } + + server { + systemProperty 'forge.enabledGameTestNamespaces', project.mod_id + programArgument '--nogui' + } + + // This run config launches GameTestServer and runs all registered gametests, then exits. + // By default, the server will crash when no gametests are provided. + // The gametest system is also enabled by default for other run configs under the /test command. + gameTestServer { + systemProperty 'forge.enabledGameTestNamespaces', project.mod_id + } + + data { + // example of overriding the workingDirectory set in configureEach above, uncomment if you want to use it + // workingDirectory project.file('run-data') + + // Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources. + programArguments.addAll '--mod', project.mod_id, '--all', '--output', file('src/generated/resources/').getAbsolutePath(), '--existing', file('src/main/resources/').getAbsolutePath() + } +} + +// Include resources generated by data generators. +sourceSets.main.resources { srcDir 'src/generated/resources' } + + +dependencies { + // Specify the version of Minecraft to use. + // Depending on the plugin applied there are several options. We will assume you applied the userdev plugin as shown above. + // The group for userdev is net.neoforge, the module name is neoforge, and the version is the same as the neoforge version. + // You can however also use the vanilla plugin (net.neoforged.gradle.vanilla) to use a version of Minecraft without the neoforge loader. + // And its provides the option to then use net.minecraft as the group, and one of; client, server or joined as the module name, plus the game version as version. + // For all intends and purposes: You can treat this dependency as if it is a normal library you would use. + implementation "net.neoforged:neoforge:${neo_version}" + + // Example mod dependency with JEI + // The JEI API is declared for compile time use, while the full JEI artifact is used at runtime + // compileOnly "mezz.jei:jei-${mc_version}-common-api:${jei_version}" + // compileOnly "mezz.jei:jei-${mc_version}-forge-api:${jei_version}" + // runtimeOnly "mezz.jei:jei-${mc_version}-forge:${jei_version}" + + // Example mod dependency using a mod jar from ./libs with a flat dir repository + // This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar + // The group id is ignored when searching -- in this case, it is "blank" + // implementation "blank:coolmod-${mc_version}:${coolmod_version}" + + // Example mod dependency using a file as dependency + // implementation files("libs/coolmod-${mc_version}-${coolmod_version}.jar") + + // Example project dependency using a sister or child project: + // implementation project(":myproject") + + // For more info: + // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html + // http://www.gradle.org/docs/current/userguide/dependency_management.html +} + +// This block of code expands all declared replace properties in the specified resource targets. +// A missing property will result in an error. Properties are expanded using ${} Groovy notation. +// When "copyIdeResources" is enabled, this will also run before the game launches in IDE environments. +// See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html +tasks.withType(ProcessResources).configureEach { + var replaceProperties = [ + minecraft_version : minecraft_version, minecraft_version_range: minecraft_version_range, + neo_version : neo_version, neo_version_range: neo_version_range, + loader_version_range: loader_version_range, + mod_id : mod_id, mod_name: mod_name, mod_license: mod_license, mod_version: mod_version, + mod_authors : mod_authors, mod_description: mod_description, + ] + inputs.properties replaceProperties + + filesMatching(['META-INF/mods.toml']) { + expand replaceProperties + [project: project] + } +} + +// Example configuration to allow publishing using the maven-publish plugin +publishing { + publications { + register('mavenJava', MavenPublication) { + from components.java + } + } + repositories { + maven { + url "file://${project.projectDir}/repo" + } + } +} + +tasks.withType(JavaCompile).configureEach { + options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation +} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge build.gradle.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge build.gradle.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge build.gradle.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new build.gradle for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge gradle.properties.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge gradle.properties.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge gradle.properties.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,48 @@ +# Sets default memory used for gradle commands. Can be overridden by user or command line properties. +org.gradle.jvmargs=-Xmx2G +org.gradle.daemon=false +org.gradle.debug=false + +#[[##]]# Environment Properties +# You can find the latest versions here: https://projects.neoforged.net/neoforged/neoforge +# The Minecraft version must agree with the Neo version to get a valid artifact +minecraft_version=${MC_VERSION} +# The Minecraft version range can use any release version of Minecraft as bounds. +# Snapshots, pre-releases, and release candidates are not guaranteed to sort properly +# as they do not follow standard versioning conventions. +minecraft_version_range=[${MC_VERSION},${MC_NEXT_VERSION}) +# The Neo version must agree with the Minecraft version to get a valid artifact +neo_version=${NEOFORGE_VERSION} +# The Neo version range can use any version of Neo as bounds +neo_version_range=[${NEOFORGE_SPEC_VERSION},) +# The loader version range can only use the major version of FML as bounds +loader_version_range=[2,) + +#if (${PARCHMENT_VERSION}) +neogradle.subsystems.parchment.minecraftVersion=${PARCHMENT_MC_VERSION} +neogradle.subsystems.parchment.mappingsVersion=${PARCHMENT_VERSION} +#else +# Uncomment this to activate parchment +#neogradle.subsystems.parchment.minecraftVersion=${MC_VERSION} +#neogradle.subsystems.parchment.mappingsVersion=SET_ME +#end + +#[[##]]# Mod Properties + +# The unique mod identifier for the mod. Must be lowercase in English locale. Must fit the regex [a-z][a-z0-9_]{1,63} +# Must match the String constant located in the main mod class annotated with @Mod. +mod_id=${MOD_ID} +# The human-readable display name for the mod. +mod_name=${MOD_NAME} +# The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default. +mod_license=${LICENSE} +# The mod version. See https://semver.org/ +mod_version=${MOD_VERSION} +# The group ID for the mod. It is only important when publishing as an artifact to a Maven repository. +# This should match the base package used for the mod sources. +# See https://maven.apache.org/guides/mini/guide-naming-conventions.html +mod_group_id=${GROUP_ID} +# The authors of the mod. This is a simple text string that is used for display purposes in the mod list. +mod_authors=${AUTHOR_LIST} +# The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list. +mod_description=${DESCRIPTION} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge gradle.properties.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge gradle.properties.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge gradle.properties.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new gradle.properties file for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge mods.toml.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge mods.toml.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge mods.toml.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,87 @@ +# This is an example mods.toml file. It contains the data relating to the loading mods. +# There are several mandatory fields (#mandatory), and many more that are optional (#optional). +# The overall format is standard TOML format, v0.5.0. +# Note that there are a couple of TOML lists in this file. +# Find more information on toml format here: https://github.com/toml-lang/toml +# The name of the mod loader type to load - for regular FML @Mod mods it should be javafml +modLoader="javafml" #mandatory +# A version range to match for said mod loader - for regular FML @Mod it will be the the FML version. This is currently 47. +loaderVersion="${loader_version_range}" #mandatory +# The license for you mod. This is mandatory metadata and allows for easier comprehension of your redistributive properties. +# Review your options at https://choosealicense.com/. All rights reserved is the default copyright stance, and is thus the default here. +license="${mod_license}" +# A URL to refer people to when problems occur with this mod +#issueTrackerURL="https://change.me.to.your.issue.tracker.example.invalid/" #optional +# A list of mods - how many allowed here is determined by the individual mod loader +[[mods]] #mandatory +# The modid of the mod +modId="${mod_id}" #mandatory +# The version number of the mod +version="${mod_version}" #mandatory +# A display name for the mod +displayName="${mod_name}" #mandatory +# A URL to query for updates for this mod. See the JSON update specification https://docs.neoforge.net/docs/misc/updatechecker/ +#if (${UPDATE_URL}) +updateJSONURL="${UPDATE_URL}" #optional +#else +#updateJSONURL="https://change.me.example.invalid/updates.json" #optional +#end +# A URL for the "homepage" for this mod, displayed in the mod UI +#if (${WEBSITE}) +displayURL="${WEBSITE}" #optional +#else +#displayURL="https://change.me.to.your.mods.homepage.example.invalid/" #optional +#end +# A file name (in the root of the mod JAR) containing a logo for display +#logoFile="${MOD_ID}.png" #optional +# A text field displayed in the mod UI +#credits="" #optional +# A text field displayed in the mod UI +authors="${mod_authors}" #optional +# Display Test controls the display for your mod in the server connection screen +# MATCH_VERSION means that your mod will cause a red X if the versions on client and server differ. This is the default behaviour and should be what you choose if you have server and client elements to your mod. +# IGNORE_SERVER_VERSION means that your mod will not cause a red X if it's present on the server but not on the client. This is what you should use if you're a server only mod. +# IGNORE_ALL_VERSION means that your mod will not cause a red X if it's present on the client or the server. This is a special case and should only be used if your mod has no server component. +# NONE means that no display test is set on your mod. You need to do this yourself, see IExtensionPoint.DisplayTest for more information. You can define any scheme you wish with this value. +# IMPORTANT NOTE: this is NOT an instruction as to which environments (CLIENT or DEDICATED SERVER) your mod loads on. Your mod should load (and maybe do nothing!) whereever it finds itself. +#displayTest="MATCH_VERSION" # MATCH_VERSION is the default if nothing is specified (#optional) + +#if (${MIXIN_CONFIG}) +[[mixins]] +config="${MIXIN_CONFIG}" +#end + +# The description text for the mod (multi line!) (#mandatory) +description='''${mod_description}''' +# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional. +[[dependencies."${mod_id}"]] #optional +# the modid of the dependency +modId="neoforge" #mandatory +# The type of the dependency. Can be one of "required", "optional", "incompatible" or "discouraged" (case insensitive). +# 'required' requires the mod to exist, 'optional' does not +# 'incompatible' will prevent the game from loading when the mod exists, and 'discouraged' will show a warning +type="required" #mandatory +# Optional field describing why the dependency is required or why it is incompatible +# reason="..." +# The version range of the dependency +versionRange="${neo_version_range}" #mandatory +# An ordering relationship for the dependency. +# BEFORE - This mod is loaded BEFORE the dependency +# AFTER - This mod is loaded AFTER the dependency +ordering="NONE" +# Side this dependency is applied on - BOTH, CLIENT, or SERVER +side="BOTH" +# Here's another dependency +[[dependencies."${mod_id}"]] +modId="minecraft" +type="required" +# This version range declares a minimum of the current minecraft version up to but not including the next major version +versionRange="${minecraft_version_range}" +ordering="NONE" +side="BOTH" + +# Features are specific properties of the game environment, that you may want to declare you require. This example declares +# that your mod requires GL version 3.2 or higher. Other features will be added. They are side aware so declaring this won't +# stop your mod loading on the server for example. +#[features."${mod_id}"] +#openGLVersion="[3.2,)" Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge mods.toml.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge mods.toml.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge mods.toml.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new mods.toml for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge pack.mcmeta.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge pack.mcmeta.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge pack.mcmeta.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,11 @@ +{ + "pack": { + "description": "${MOD_ID} resources", + #if (${PACK_COMMENT} != "") + "pack_format": ${PACK_FORMAT}, + "_comment": "${PACK_COMMENT}" + #else + "pack_format": ${PACK_FORMAT} + #end + } +} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge pack.mcmeta.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge pack.mcmeta.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge pack.mcmeta.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new pack.mcmeta for NeoForge projects.

+ + Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge settings.gradle.ft =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge settings.gradle.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge settings.gradle.ft (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,11 @@ +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + maven { url = 'https://maven.neoforged.net/releases' } + } +} + +plugins { + id 'org.gradle.toolchains.foojay-resolver-convention' version '0.5.0' +} Index: src/main/resources/fileTemplates/j2ee/neoforge/NeoForge settings.gradle.html =================================================================== --- src/main/resources/fileTemplates/j2ee/neoforge/NeoForge settings.gradle.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) +++ src/main/resources/fileTemplates/j2ee/neoforge/NeoForge settings.gradle.html (revision e23ddbd3b83a43380a29b1e50c3ae9bcae966255) @@ -0,0 +1,25 @@ + + + + +

This is a built-in file template used to create a new settings.gradle for NeoForge projects.