diff --git a/TEMPLATE_LICENSE.txt b/LICENSE.txt similarity index 89% rename from TEMPLATE_LICENSE.txt rename to LICENSE.txt index b64bc64b..86774466 100644 --- a/TEMPLATE_LICENSE.txt +++ b/LICENSE.txt @@ -1,9 +1,6 @@ MIT License -Copyright (c) 2023 NeoForged project - -This license applies to the template files as supplied by github.com/NeoForged/MDK - +Copyright (c) 2023 Direwolf20-MC Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index d4a8ac61..e5dd7ee5 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,3 @@ +# Just Dire Things -Installation information -======= - -This template repository can be directly cloned to get you started with a new -mod. Simply create a new repository cloned from this one, by following the -instructions at [github](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template). - -Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse. - -> **Note**: For Eclipse, use tasks in `Launch Group` instead of ones founds in `Java Application`. A preparation task must run before launching the game. NeoGradle uses launch groups to do these subsequently. - -If at any point you are missing libraries in your IDE, or you've run into problems you can -run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything -{this does not affect your code} and then start the process again. - -Mapping Names: -============ -By default, the MDK is configured to use the official mapping names from Mojang for methods and fields -in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this -license, if you do not agree with it you can change your mapping names to other crowdsourced names in your -build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here: -https://github.com/NeoForged/NeoForm/blob/main/Mojang.md - -Additional Resources: -========== -Community Documentation: https://docs.neoforged.net/ -NeoForged Discord: https://discord.neoforged.net/ +Just some things Direwolf20 wanted to have... diff --git a/build.gradle b/build.gradle index 6a9606a5..1c4873d8 100644 --- a/build.gradle +++ b/build.gradle @@ -11,6 +11,31 @@ group = mod_group_id repositories { mavenLocal() + + maven { //Patchouli && JEI + url 'https://maven.blamejared.com' + content { + includeGroup "vazkii.patchouli" + includeGroup "mezz.jei" + } + } + + maven { //Curios + url = "https://maven.theillusivec4.top/" + content { + includeGroup "top.theillusivec4.curios" + } + } + + maven { // mek + url = 'https://modmaven.dev/' + content { + includeGroup "mekanism" + includeGroup "appeng" + } + } + + maven { url = "https://www.cursemaven.com" } // curse mods } base { @@ -86,7 +111,7 @@ dependencies { // 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}" + runtimeOnly "mezz.jei:jei-1.20.4-neoforge:${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 diff --git a/gradle.properties b/gradle.properties index 296c5e7e..bd409330 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ # Sets default memory used for gradle commands. Can be overridden by user or command line properties. -#org.gradle.jvmargs= +org.gradle.jvmargs=-Xmx3G org.gradle.daemon=false org.gradle.debug=false @@ -16,7 +16,7 @@ minecraft_version=1.20.4 # as they do not follow standard versioning conventions. minecraft_version_range=[1.20.4,1.21) # The Neo version must agree with the Minecraft version to get a valid artifact -neo_version=20.4.80-beta +neo_version=20.4.161-beta # The Neo version range can use any version of Neo as bounds neo_version_range=[20.4,) # The loader version range can only use the major version of FML as bounds @@ -26,18 +26,20 @@ loader_version_range=[2,) # 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=examplemod +mod_id=justdirethings # The human-readable display name for the mod. -mod_name=Example Mod +mod_name=Just Dire Things # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default. -mod_license=All Rights Reserved +mod_license=MIT # The mod version. See https://semver.org/ -mod_version=1.0.0 +mod_version=0.0.1 # 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=com.example.examplemod +mod_group_id=com.direwolf20.justdirethings # The authors of the mod. This is a simple text string that is used for display purposes in the mod list. -mod_authors=YourNameHere, OtherNameHere +mod_authors=Direwolf20 # The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list. -mod_description=Example mod description.\nNewline characters can be used and will be replaced properly. \ No newline at end of file +mod_description=Just some things that Direwolf20 wanted. +#Dependencies +jei_version=17.3.0.48 \ No newline at end of file diff --git a/src/main/java/com/direwolf20/justdirethings/JustDireThings.java b/src/main/java/com/direwolf20/justdirethings/JustDireThings.java new file mode 100644 index 00000000..f89b5952 --- /dev/null +++ b/src/main/java/com/direwolf20/justdirethings/JustDireThings.java @@ -0,0 +1,29 @@ +package com.direwolf20.justdirethings; + +import com.direwolf20.justdirethings.setup.ClientSetup; +import com.direwolf20.justdirethings.setup.Config; +import com.direwolf20.justdirethings.setup.ModSetup; +import com.direwolf20.justdirethings.setup.Registration; +import com.mojang.logging.LogUtils; +import net.neoforged.bus.api.IEventBus; +import net.neoforged.fml.common.Mod; +import net.neoforged.fml.loading.FMLLoader; +import org.slf4j.Logger; + +// The value here should match an entry in the META-INF/mods.toml file +@Mod(JustDireThings.MODID) +public class JustDireThings { + public static final String MODID = "justdirethings"; + private static final Logger LOGGER = LogUtils.getLogger(); + + public JustDireThings(IEventBus modEventBus) { + + Registration.init(modEventBus); + Config.register(); + ModSetup.CREATIVE_MODE_TABS.register(modEventBus); + + if (FMLLoader.getDist().isClient()) { + modEventBus.addListener(ClientSetup::init); + } + } +} diff --git a/src/main/java/com/direwolf20/justdirethings/setup/ClientSetup.java b/src/main/java/com/direwolf20/justdirethings/setup/ClientSetup.java new file mode 100644 index 00000000..7956201c --- /dev/null +++ b/src/main/java/com/direwolf20/justdirethings/setup/ClientSetup.java @@ -0,0 +1,31 @@ +package com.direwolf20.justdirethings.setup; + + +import com.direwolf20.justdirethings.JustDireThings; +import net.neoforged.api.distmarker.Dist; +import net.neoforged.bus.api.SubscribeEvent; +import net.neoforged.fml.common.Mod; +import net.neoforged.fml.event.lifecycle.FMLClientSetupEvent; +import net.neoforged.neoforge.client.event.EntityRenderersEvent; + +@Mod.EventBusSubscriber(modid = JustDireThings.MODID, value = Dist.CLIENT, bus = Mod.EventBusSubscriber.Bus.MOD) +public class ClientSetup { + public static void init(final FMLClientSetupEvent event) { + //NeoForge.EVENT_BUS.addListener(KeyBindings::onClientInput); + + //Register our Render Events Class + //NeoForge.EVENT_BUS.register(RenderLevelLast.class); + //NeoForge.EVENT_BUS.register(EventKeyInput.class); + + //Screens + /*event.enqueueWork(() -> { + MenuScreens.register(Registration.TemplateManager_Container.get(), TemplateManagerGUI::new); // Attach our container to the screen + });*/ + } + + @SubscribeEvent + public static void registerRenderers(EntityRenderersEvent.RegisterRenderers event) { + //Register Block Entity Renders + //event.registerBlockEntityRenderer(Registration.RenderBlock_BE.get(), RenderBlockBER::new); + } +} diff --git a/src/main/java/com/direwolf20/justdirethings/setup/Config.java b/src/main/java/com/direwolf20/justdirethings/setup/Config.java new file mode 100644 index 00000000..96a898b4 --- /dev/null +++ b/src/main/java/com/direwolf20/justdirethings/setup/Config.java @@ -0,0 +1,41 @@ +package com.direwolf20.justdirethings.setup; + +import net.neoforged.fml.ModLoadingContext; +import net.neoforged.fml.config.ModConfig; +import net.neoforged.neoforge.common.ModConfigSpec; + +public class Config { + public static final ModConfigSpec.Builder CLIENT_BUILDER = new ModConfigSpec.Builder(); + public static final ModConfigSpec.Builder COMMON_BUILDER = new ModConfigSpec.Builder(); + public static final ModConfigSpec.Builder SERVER_BUILDER = new ModConfigSpec.Builder(); + + public static final String CATEGORY_GENERAL = "general"; + + public static void register() { + //registerServerConfigs(); + registerCommonConfigs(); + //registerClientConfigs(); + } + + private static void registerClientConfigs() { + + ModLoadingContext.get().registerConfig(ModConfig.Type.CLIENT, CLIENT_BUILDER.build()); + } + + private static void registerCommonConfigs() { + COMMON_BUILDER.comment("General settings").push(CATEGORY_GENERAL); + generalConfig(); + COMMON_BUILDER.pop(); + + ModLoadingContext.get().registerConfig(ModConfig.Type.COMMON, COMMON_BUILDER.build()); + } + + private static void registerServerConfigs() { + + ModLoadingContext.get().registerConfig(ModConfig.Type.SERVER, SERVER_BUILDER.build()); + } + + private static void generalConfig() { + + } +} diff --git a/src/main/java/com/direwolf20/justdirethings/setup/ModSetup.java b/src/main/java/com/direwolf20/justdirethings/setup/ModSetup.java new file mode 100644 index 00000000..3e2eb174 --- /dev/null +++ b/src/main/java/com/direwolf20/justdirethings/setup/ModSetup.java @@ -0,0 +1,27 @@ +package com.direwolf20.justdirethings.setup; + +import net.minecraft.core.registries.Registries; +import net.minecraft.network.chat.Component; +import net.minecraft.world.item.CreativeModeTab; +import net.minecraft.world.item.CreativeModeTabs; +import net.minecraft.world.item.Item; +import net.minecraft.world.item.Items; +import net.neoforged.neoforge.registries.DeferredHolder; +import net.neoforged.neoforge.registries.DeferredRegister; + +import static com.direwolf20.justdirethings.JustDireThings.MODID; + +public class ModSetup { + public static final DeferredRegister CREATIVE_MODE_TABS = DeferredRegister.create(Registries.CREATIVE_MODE_TAB, MODID); + public static final DeferredHolder TAB_JUSTDIRETHINGS = CREATIVE_MODE_TABS.register(MODID, () -> CreativeModeTab.builder() + .title(Component.literal("Just Dire Things")) + .withTabsBefore(CreativeModeTabs.SPAWN_EGGS) + .icon(() -> Items.DIRT.getDefaultInstance()) //Todo Proper Item + .displayItems((parameters, output) -> { + Registration.ITEMS.getEntries().forEach(e -> { + Item item = e.get(); + output.accept(item); + }); + }).build()); + +} diff --git a/src/main/java/com/direwolf20/justdirethings/setup/Registration.java b/src/main/java/com/direwolf20/justdirethings/setup/Registration.java new file mode 100644 index 00000000..87a5a1fb --- /dev/null +++ b/src/main/java/com/direwolf20/justdirethings/setup/Registration.java @@ -0,0 +1,23 @@ +package com.direwolf20.justdirethings.setup; + +import net.minecraft.core.registries.Registries; +import net.minecraft.world.inventory.MenuType; +import net.minecraft.world.level.block.entity.BlockEntityType; +import net.neoforged.bus.api.IEventBus; +import net.neoforged.neoforge.registries.DeferredRegister; + +import static com.direwolf20.justdirethings.JustDireThings.MODID; + +public class Registration { + public static final DeferredRegister.Blocks BLOCKS = DeferredRegister.createBlocks(MODID); + public static final DeferredRegister.Items ITEMS = DeferredRegister.createItems(MODID); + private static final DeferredRegister> BLOCK_ENTITIES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, MODID); + private static final DeferredRegister> CONTAINERS = DeferredRegister.create(Registries.MENU, MODID); + + public static void init(IEventBus eventBus) { + BLOCKS.register(eventBus); + ITEMS.register(eventBus); + BLOCK_ENTITIES.register(eventBus); + CONTAINERS.register(eventBus); + } +} diff --git a/src/main/java/com/example/examplemod/Config.java b/src/main/java/com/example/examplemod/Config.java deleted file mode 100644 index 38dcbcd8..00000000 --- a/src/main/java/com/example/examplemod/Config.java +++ /dev/null @@ -1,63 +0,0 @@ -package com.example.examplemod; - -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 = ExampleMod.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()); - } -} diff --git a/src/main/java/com/example/examplemod/ExampleMod.java b/src/main/java/com/example/examplemod/ExampleMod.java deleted file mode 100644 index 9096c03e..00000000 --- a/src/main/java/com/example/examplemod/ExampleMod.java +++ /dev/null @@ -1,133 +0,0 @@ -package com.example.examplemod; - -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.network.chat.Component; -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(ExampleMod.MODID) -public class ExampleMod -{ - // Define mod id in a common place for everything to reference - public static final String MODID = "examplemod"; - // 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 "examplemod" namespace - public static final DeferredRegister.Blocks BLOCKS = DeferredRegister.createBlocks(MODID); - // Create a Deferred Register to hold Items which will all be registered under the "examplemod" namespace - public static final DeferredRegister.Items ITEMS = DeferredRegister.createItems(MODID); - // Create a Deferred Register to hold CreativeModeTabs which will all be registered under the "examplemod" namespace - public static final DeferredRegister CREATIVE_MODE_TABS = DeferredRegister.create(Registries.CREATIVE_MODE_TAB, MODID); - - // Creates a new Block with the id "examplemod: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 "examplemod: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 "examplemod: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 "examplemod: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() - .title(Component.translatable("itemGroup.examplemod")) //The language key for the title of your CreativeModeTab - .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 ExampleMod(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. - // Note that this is necessary if and only if we want *this* class (ExampleMod) to respond directly to events. - // Do not add this line if there are no @SubscribeEvent-annotated functions in this class, like onServerStarting() below. - 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()); - } - } -}