generated from jaredlll08/MultiLoader-Template
-
Notifications
You must be signed in to change notification settings - Fork 1
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
13 changed files
with
340 additions
and
13 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
2 changes: 1 addition & 1 deletion
2
...main/resources/META-INF/services/com.example.examplemod.platform.services.IPlatformHelper
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 |
---|---|---|
@@ -1 +1 @@ | ||
com.example.examplemod.platform.ForgePlatformHelper | ||
com.example.examplemod.platform.NeoPlatformHelper |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
package com.example.examplemod; | ||
|
||
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; | ||
|
||
import static com.example.examplemod.Constants.MOD_ID; | ||
|
||
// 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 = MOD_ID, 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(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 -> ForgeRegistries.ITEMS.getValue(new ResourceLocation(itemName))) | ||
.collect(Collectors.toSet()); | ||
} | ||
} |
128 changes: 128 additions & 0 deletions
128
neo/src/main/java/com/example/examplemod/ExampleMod.java
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,128 @@ | ||
package com.example.examplemod; | ||
|
||
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; | ||
|
||
import static com.example.examplemod.Constants.MOD_ID; | ||
|
||
// The value here should match an entry in the META-INF/mods.toml file | ||
@Mod(MOD_ID) | ||
public class 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<Block> BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MOD_ID); | ||
// Create a Deferred Register to hold Items which will all be registered under the "examplemod" namespace | ||
public static final DeferredRegister<Item> ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, MOD_ID); | ||
// 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, MOD_ID); | ||
|
||
// Creates a new Block with the id "examplemod: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 "examplemod: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() | ||
.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 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 ExampleMod() | ||
{ | ||
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"); | ||
|
||
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 = MOD_ID, 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()); | ||
} | ||
} | ||
} |
20 changes: 20 additions & 0 deletions
20
neo/src/main/java/com/example/examplemod/mixin/MixinTitleScreen.java
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,20 @@ | ||
package com.example.examplemod.mixin; | ||
|
||
import com.example.examplemod.Constants; | ||
import net.minecraft.client.Minecraft; | ||
import net.minecraft.client.gui.screens.TitleScreen; | ||
import org.spongepowered.asm.mixin.Mixin; | ||
import org.spongepowered.asm.mixin.injection.At; | ||
import org.spongepowered.asm.mixin.injection.Inject; | ||
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; | ||
|
||
@Mixin(TitleScreen.class) | ||
public class MixinTitleScreen { | ||
|
||
@Inject(at = @At("HEAD"), method = "init()V") | ||
private void init(CallbackInfo info) { | ||
|
||
Constants.LOG.info("This line is printed by an example mod mixin from NeoForge!"); | ||
Constants.LOG.info("MC Version: {}", Minecraft.getInstance().getVersionType()); | ||
} | ||
} |
26 changes: 26 additions & 0 deletions
26
neo/src/main/java/com/example/examplemod/platform/NeoPlatformHelper.java
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,26 @@ | ||
package com.example.examplemod.platform; | ||
|
||
import com.example.examplemod.platform.services.IPlatformHelper; | ||
import net.minecraftforge.fml.ModList; | ||
import net.minecraftforge.fml.loading.FMLLoader; | ||
|
||
public class NeoPlatformHelper implements IPlatformHelper { | ||
|
||
@Override | ||
public String getPlatformName() { | ||
|
||
return "Neo"; | ||
} | ||
|
||
@Override | ||
public boolean isModLoaded(String modId) { | ||
|
||
return ModList.get().isLoaded(modId); | ||
} | ||
|
||
@Override | ||
public boolean isDevelopmentEnvironment() { | ||
|
||
return !FMLLoader.isProduction(); | ||
} | ||
} |
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,72 @@ | ||
# 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="[47,)" #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="C0-1.0" | ||
# 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.neoforged.net/docs/misc/updatechecker/ | ||
#updateJSONURL="https://change.me.example.invalid/updates.json" #optional | ||
# A URL for the "homepage" for this mod, displayed in the mod UI | ||
#displayURL="https://change.me.to.your.mods.homepage.example.invalid/" #optional | ||
# A file name (in the root of the mod JAR) containing a logo for display | ||
logoFile = "multiloader.png" #optional | ||
# A text field displayed in the mod UI | ||
#credits="" #optional | ||
# A text field displayed in the mod UI | ||
authors="${mod_author}" #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) | ||
|
||
# The description text for the mod (multi line!) (#mandatory) | ||
description=''' | ||
This is a long form description of the mod. You can write whatever you want here | ||
''' | ||
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional. | ||
[[dependencies.${mod_id}]] #optional | ||
# the modid of the dependency | ||
modId="forge" #mandatory | ||
# Does this dependency have to exist - if not, ordering below must be specified | ||
mandatory=true #mandatory | ||
# The version range of the dependency | ||
versionRange="[47.1,)" #mandatory | ||
# An ordering relationship for the dependency - BEFORE or AFTER required if the dependency is not mandatory | ||
# 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" | ||
mandatory=true | ||
# This version range declares a minimum of the current minecraft version up to but not including the next major version | ||
versionRange="[1.20,1.21)" | ||
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,)" |
1 change: 1 addition & 0 deletions
1
...main/resources/META-INF/services/com.example.examplemod.platform.services.IPlatformHelper
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 @@ | ||
com.example.examplemod.platform.NeoPlatformHelper |
Oops, something went wrong.