-
Notifications
You must be signed in to change notification settings - Fork 186
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
350 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
src/main/resources/fileTemplates/j2ee/forge/Forge (1.20.6+) Main Class.java.ft
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
package ${PACKAGE_NAME}; | ||
|
||
import com.mojang.logging.LogUtils; | ||
import net.minecraft.client.Minecraft; | ||
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.minecraftforge.api.distmarker.Dist; | ||
import net.minecraftforge.common.MinecraftForge; | ||
import net.minecraftforge.event.BuildCreativeModeTabContentsEvent; | ||
import net.minecraftforge.event.server.ServerStartingEvent; | ||
import net.minecraftforge.eventbus.api.IEventBus; | ||
import net.minecraftforge.eventbus.api.SubscribeEvent; | ||
import net.minecraftforge.fml.ModLoadingContext; | ||
import net.minecraftforge.fml.common.Mod; | ||
import net.minecraftforge.fml.config.ModConfig; | ||
import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent; | ||
import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent; | ||
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; | ||
import net.minecraftforge.registries.DeferredRegister; | ||
import net.minecraftforge.registries.ForgeRegistries; | ||
import net.minecraftforge.registries.RegistryObject; | ||
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<Block> BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MODID); | ||
// Create a Deferred Register to hold Items which will all be registered under the "${MOD_ID}" namespace | ||
public static final DeferredRegister<Item> ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, MODID); | ||
// Create a Deferred Register to hold CreativeModeTabs which will all be registered under the "examplemod" namespace | ||
public static final DeferredRegister<CreativeModeTab> 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 RegistryObject<Block> EXAMPLE_BLOCK = BLOCKS.register("example_block", () -> new 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 RegistryObject<Item> EXAMPLE_BLOCK_ITEM = ITEMS.register("example_block", () -> new BlockItem(EXAMPLE_BLOCK.get(), new Item.Properties())); | ||
|
||
// Creates a new food item with the id "examplemod:example_id", nutrition 1 and saturation 2 | ||
public static final RegistryObject<Item> EXAMPLE_ITEM = ITEMS.register("example_item", () -> new Item(new Item.Properties().food(new FoodProperties.Builder() | ||
.alwaysEdible().nutrition(1).saturationModifier(2f).build()))); | ||
|
||
// Creates a creative tab with the id "examplemod:example_tab" for the example item, that is placed after the combat tab | ||
public static final RegistryObject<CreativeModeTab> 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()); | ||
|
||
public ${CLASS_NAME}() { | ||
IEventBus modEventBus = FMLJavaModLoadingContext.get().getModEventBus(); | ||
|
||
// 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 | ||
MinecraftForge.EVENT_BUS.register(this); | ||
|
||
// Register the item to a creative tab | ||
modEventBus.addListener(this::addCreative); | ||
|
||
// Register our mod's ForgeConfigSpec so that Forge 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"); | ||
LOGGER.info("DIRT BLOCK >> {}", ForgeRegistries.BLOCKS.getKey(Blocks.DIRT)); | ||
|
||
if (Config.logDirtBlock) | ||
LOGGER.info("DIRT BLOCK >> {}", ForgeRegistries.BLOCKS.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()); | ||
} | ||
} | ||
} |
25 changes: 25 additions & 0 deletions
25
src/main/resources/fileTemplates/j2ee/forge/Forge (1.20.6+) Main Class.java.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- | ||
Minecraft Development for IntelliJ | ||
https://mcdev.io/ | ||
Copyright (C) 2024 minecraft-dev | ||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU Lesser General Public License as published | ||
by the Free Software Foundation, version 3.0 only. | ||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
You should have received a copy of the GNU Lesser General Public License | ||
along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
--> | ||
|
||
<html> | ||
<body> | ||
<p>This is a built-in file template used to create a new main class for Forge projects 1.20.6 and above</p> | ||
</body> | ||
</html> |
64 changes: 64 additions & 0 deletions
64
src/main/resources/fileTemplates/j2ee/forge/Forge (1.21+) Config.java.ft
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
package ${PACKAGE_NAME}; | ||
|
||
import net.minecraft.resources.ResourceLocation; | ||
import net.minecraft.world.item.Item; | ||
import net.minecraftforge.common.ForgeConfigSpec; | ||
import net.minecraftforge.eventbus.api.SubscribeEvent; | ||
import net.minecraftforge.fml.common.Mod; | ||
import net.minecraftforge.fml.event.config.ModConfigEvent; | ||
import net.minecraftforge.registries.ForgeRegistries; | ||
|
||
import java.util.Collections; | ||
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 ForgeConfigSpec.Builder BUILDER = new ForgeConfigSpec.Builder(); | ||
|
||
private static final ForgeConfigSpec.BooleanValue LOG_DIRT_BLOCK = BUILDER | ||
.comment("Whether to log the dirt block on common setup") | ||
.define("logDirtBlock", true); | ||
|
||
private static final ForgeConfigSpec.IntValue MAGIC_NUMBER = BUILDER | ||
.comment("A magic number") | ||
.defineInRange("magicNumber", 42, 0, Integer.MAX_VALUE); | ||
|
||
public static final ForgeConfigSpec.ConfigValue<String> 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 ForgeConfigSpec.ConfigValue<List<? extends String>> ITEM_STRINGS = BUILDER | ||
.comment("A list of items to log on common setup.") | ||
.defineListAllowEmpty("items", List.of("minecraft:iron_ingot"), Config::validateItemName); | ||
|
||
static final ForgeConfigSpec SPEC = BUILDER.build(); | ||
|
||
public static boolean logDirtBlock; | ||
public static int magicNumber; | ||
public static String magicNumberIntroduction; | ||
public static Set<Item> items; | ||
|
||
private static boolean validateItemName(final Object obj) | ||
{ | ||
return obj instanceof final String itemName && ForgeRegistries.ITEMS.containsKey(ResourceLocation.parse(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 -> ForgeRegistries.ITEMS.getValue(ResourceLocation.parse(itemName))) | ||
.collect(Collectors.toSet()); | ||
} | ||
} |
25 changes: 25 additions & 0 deletions
25
src/main/resources/fileTemplates/j2ee/forge/Forge (1.21+) Config.java.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- | ||
Minecraft Development for IntelliJ | ||
https://mcdev.io/ | ||
Copyright (C) 2024 minecraft-dev | ||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU Lesser General Public License as published | ||
by the Free Software Foundation, version 3.0 only. | ||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
You should have received a copy of the GNU Lesser General Public License | ||
along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
--> | ||
|
||
<html> | ||
<body> | ||
<p>This is a built-in file template used to create a new config class for Forge projects 1.21 and above</p> | ||
</body> | ||
</html> |
Oops, something went wrong.