MinecraftForge

https://docs.minecraftforge.net/en/1.20.1/
Admin
MinecraftForge is a modding API and framework for Minecraft that provides tools and documentation...
Tokens:51,325
Snippets:695
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example comapFlatMap results

Source: https://docs.minecraftforge.net/en/1.20.1/datastorage/codecs

Input examples for the integer codec.

```text
// Will return 5
"5"

// Will error, not an integer
"value"
```

--------------------------------

### Access Transformer Configuration Examples

Source: https://docs.minecraftforge.net/en/1.20.1/advanced/accesstransformers

Various examples demonstrating how to modify visibility and final flags for classes, fields, and methods.

```text
# Makes public the ByteArrayToKeyFunction interface in Crypt
public net.minecraft.util.Crypt$ByteArrayToKeyFunction

# Makes protected and removes the final modifier from 'random' in MinecraftServer
protected-f net.minecraft.server.MinecraftServer f_129758_ #random

# Makes public the 'makeExecutor' method in Util,
# accepting a String and returns an ExecutorService
public net.minecraft.Util m_137477_(Ljava/lang/String;)Ljava/util/concurrent/ExecutorService; #makeExecutor

# Makes public the 'leastMostToIntArray' method in UUIDUtil,
# accepting two longs and returning an int[]
public net.minecraft.core.UUIDUtil m_235872_(JJ)[I #leastMostToIntArray
```

--------------------------------

### Run Gradle Setup Task

Source: https://docs.minecraftforge.net/en/1.20.1/forgedev

Command to execute the setup task via the Gradle command window in older IntelliJ versions.

```bash
gradle setup
```

--------------------------------

### Example range codec results

Source: https://docs.minecraftforge.net/en/1.20.1/datastorage/codecs

Input examples for the range codec.

```text
// Will be valid, inside [0, 4]
4

// Will error, outside [0, 4]
5
```

--------------------------------

### Implement batch setup and test execution

Source: https://docs.minecraftforge.net/en/1.20.1/misc/gametest

Use @BeforeBatch to perform setup tasks for a specific batch, ensuring the batch string matches the one defined in the @GameTest annotation.

```java
public class ExampleGameTests {
  @BeforeBatch(batch = "firstBatch")
  public static void beforeTest(ServerLevel level) {
    // Perform setup
  }

  @GameTest(batch = "firstBatch")
  public static void exampleTest2(GameTestHelper helper) {
    // Do stuff
  }
}
```

--------------------------------

### Example Profiling Output

Source: https://docs.minecraftforge.net/en/1.20.1/misc/debugprofiler

A sample of the hierarchical performance data found in the profiling.txt file.

```text
[00] levels - 96.70%/96.70%
[01] |   Level Name - 99.76%/96.47%
[02] |   |   tick - 99.31%/95.81%
[03] |   |   |   entities - 47.72%/45.72%
[04] |   |   |   |   regular - 98.32%/44.95%
[04] |   |   |   |   blockEntities - 0.90%/0.41%
[05] |   |   |   |   |   unspecified - 64.26%/0.26%
[05] |   |   |   |   |   minecraft:furnace - 33.35%/0.14%
[05] |   |   |   |   |   minecraft:chest - 2.39%/0.01%
```

--------------------------------

### Example of Package Collision

Source: https://docs.minecraftforge.net/en/1.20.1/gettingstarted/structuring

Demonstrates how two different JAR files containing the same class path can lead to loading issues.

```text
a.jar
  - com.example.ExampleClass
b.jar
  - com.example.ExampleClass // This class will not normally be loaded
```

--------------------------------

### Add chainable configuration methods

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/client/modelproviders

Example of adding custom configuration methods to a loader builder.

```java
// In ExampleLoaderBuilder
public ExampleLoaderBuilder<T> exampleInt(int example) {
  // Set int
  return this;
}

public ExampleLoaderBuilder<T> exampleString(String example) {
  // Set string
  return this;
}
```

--------------------------------

### Define BlockState Variants

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/client/modelproviders

Examples demonstrating how to use partial states, forAllStates, and forAllStatesExcept to map block properties to models.

```java
// In some BlockStateProvider#registerStatesAndModels

// EXAMPLE_BLOCK_1: Has Property BlockStateProperties#AXIS
this.getVariantBuilder(EXAMPLE_BLOCK_1) // Get variant builder
  .partialState() // Construct partial state
  .with(AXIS, Axis.Y) // When BlockState AXIS = Y
    .modelForState() // Set models when AXIS = Y
    .modelFile(yModelFile1) // Can show 'yModelFile1'
    .nextModel() // Adds another model when AXIS = Y
    .modelFile(yModelFile2) // Can show 'yModelFile2'
    .weight(2) // Will show 'yModelFile2' 2/3 of the time
    .addModel() // Finalizes models when AXIS = Y
  .with(AXIS, Axis.Z) // When BlockState AXIS = Z
    .modelForState() // Set models when AXIS = Z
    .modelFile(hModelFile) // Can show 'hModelFile'
    .addModel() // Finalizes models when AXIS = Z
  .with(AXIS, Axis.X)  // When BlockState AXIS = X
    .modelForState() // Set models when AXIS = X
    .modelFile(hModelFile) // Can show 'hModelFile'
    .rotationY(90) // Rotates 'hModelFile' 90 degrees on the Y axis
    .addModel(); // Finalizes models when AXIS = X

// EXAMPLE_BLOCK_2: Has Property BlockStateProperties#HORIZONTAL_FACING
this.getVariantBuilder(EXAMPLE_BLOCK_2) // Get variant builder
  .forAllStates(state -> // For all possible states
    ConfiguredModel.builder() // Creates configured model builder
      .modelFile(modelFile) // Can show 'modelFile'
      .rotationY((int) state.getValue(HORIZONTAL_FACING).toYRot()) // Rotates 'modelFile' on the Y axis depending on the property
      .build() // Creates the array of configured models
  );

// EXAMPLE_BLOCK_3: Has Properties BlockStateProperties#HORIZONTAL_FACING, BlockStateProperties#WATERLOGGED
this.getVariantBuilder(EXAMPLE_BLOCK_3) // Get variant builder
  .forAllStatesExcept(state -> // For all HORIZONTAL_FACING states
    ConfiguredModel.builder() // Creates configured model builder
      .modelFile(modelFile) // Can show 'modelFile'
      .rotationY((int) state.getValue(HORIZONTAL_FACING).toYRot()) // Rotates 'modelFile' on the Y axis depending on the property
      .build(), // Creates the array of configured models
  WATERLOGGED); // Ignores WATERLOGGED property
```

--------------------------------

### Implementing and Loading SavedData

Source: https://docs.minecraftforge.net/en/1.20.1/datastorage/saveddata

Example showing the creation, loading, and registration of a SavedData instance using DimensionDataStorage.

```java
// In some class
public ExampleSavedData create() {
  return new ExampleSavedData();
}

public ExampleSavedData load(CompoundTag tag) {
  ExampleSavedData data = this.create();
  // Load saved data
  return data;
}

// In some method within the class
netherDataStorage.computeIfAbsent(this::load, this::create, "example");
```

--------------------------------

### Initializing Screen Widgets

Source: https://docs.minecraftforge.net/en/1.20.1/gui/screens

Overrides the init method to add widgets and perform setup tasks. This method is called when the screen is opened or resized.

```java
// In some Screen subclass
@Override
protected void init() {
    super.init();

    // Add widgets and precomputed values
    this.addRenderableWidget(new EditBox(/* ... */));
}
```

--------------------------------

### Example JSON Dispatch Structures

Source: https://docs.minecraftforge.net/en/1.20.1/datastorage/codecs

Illustrates the expected JSON structure for simple and complex objects when using dispatch codecs.

```json
// Simple object
{
  "type": "string", // For StringObject
  "value": "value" // Codec type is not augmented from MapCodec, needs field
}

// Complex object
{
  "type": "complex", // For ComplexObject

  // Codec type is augmented from MapCodec, can be inlined
  "s": "value",
  "i": 0
}
```

--------------------------------

### Configure Game Test Structure Templates

Source: https://docs.minecraftforge.net/en/1.20.1/misc/gametest

Examples of how to use @GameTestHolder and @PrefixGameTestTemplate to control the location of structure templates.

```java
// Modid for all structures will be MODID
@GameTestHolder(MODID)
public class ExampleGameTests {

  // Class name is prepended, template name is not specified
  // Template Location at 'modid:examplegametests.exampletest'
  @GameTest
  public static void exampleTest(GameTestHelper helper) { /*...*/ }

  // Class name is not prepended, template name is not specified
  // Template Location at 'modid:exampletest2'
  @PrefixGameTestTemplate(false)
  @GameTest
  public static void exampleTest2(GameTestHelper helper) { /*...*/ }

  // Class name is prepended, template name is specified
  // Template Location at 'modid:examplegametests.test_template'
  @GameTest(template = "test_template")
  public static void exampleTest3(GameTestHelper helper) { /*...*/ }

  // Class name is not prepended, template name is specified
  // Template Location at 'modid:test_template2'
  @PrefixGameTestTemplate(false)
  @GameTest(template = "test_template2")
  public static void exampleTest4(GameTestHelper helper) { /*...*/ }
}
```

--------------------------------

### Define mod metadata in mods.toml

Source: https://docs.minecraftforge.net/en/1.20.1/gettingstarted/modfiles

Example structure for a mods.toml file including mod loader settings, metadata, and dependency declarations.

```toml
modLoader="javafml"
loaderVersion="[46,)"

license="All Rights Reserved"
issueTrackerURL="https://github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack=false

[[mods]]
  modId="examplemod"
  version="1.0.0.0"
  displayName="Example Mod"
  updateJSONURL="https://files.minecraftforge.net/net/minecraftforge/forge/promotions_slim.json"
  displayURL="https://minecraftforge.net"
  logoFile="logo.png"
  credits="I'd like to thank my mother and father."
  authors="Author"
  description='''
  Lets you craft dirt into diamonds. This is a traditional mod that has existed for eons. It is ancient. The holy Notch created it. Jeb rainbowfied it. Dinnerbone made it upside down. Etc.
  '''
  displayTest="MATCH_VERSION"

[[dependencies.examplemod]]
  modId="forge"
  mandatory=true
  versionRange="[46,)"
  ordering="NONE"
  side="BOTH"

[[dependencies.examplemod]]
  modId="minecraft"
  mandatory=true
  versionRange="[1.20]"
  ordering="NONE"
  side="BOTH"
```

--------------------------------

### Example of Module Package Collision

Source: https://docs.minecraftforge.net/en/1.20.1/gettingstarted/structuring

Illustrates how duplicate package names across different modules cause the mod loader to crash.

```text
module A
  - package X
    - class I
    - class J
module B
  - package X // This package will cause the mod loader to crash, as there already is a module with package X being exported
    - class R
    - class S
    - class T
```

--------------------------------

### Legacy Metadata Switch Statement

Source: https://docs.minecraftforge.net/en/1.20.1/blocks/states

Example of how metadata was historically used to determine block orientation and placement.

```java
switch (meta) {
  case 0: { ... } // south and on the lower half of the block
  case 1: { ... } // south on the upper side of the block
  case 2: { ... } // north and on the lower half of the block
  case 3: { ... } // north and on the upper half of the block
  // ... etc. ...
}
```

--------------------------------

### Configure WaveFront OBJ Model Loader

Source: https://docs.minecraftforge.net/en/1.20.1/rendering/modelloaders

Example JSON configuration for using the forge:obj loader, including the flip_v option to correct texture orientation.

```json
{
  // Add the following line on the same level as a 'model' declaration
  "loader": "forge:obj",
  "flip_v": true,
  "model": "examplemod:models/block/model.obj",
  "textures": {
    // Can refer to in .mtl using #texture0
    "texture0": "minecraft:block/dirt",
    "particle": "minecraft:block/dirt"
  }
}
```

--------------------------------

### Example encoded JSON for SomeObject

Source: https://docs.minecraftforge.net/en/1.20.1/datastorage/codecs

JSON representations of the SomeObject codec.

```json
// Encoded SomeObject
{
  "s": "value",
  "i": 5,
  "b": false
}

// Another encoded SomeObject
{
  "s": "value2",
  // i is omitted, defaults to 0
  "b": true
}
```

--------------------------------

### Recipe Advancement Criteria

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/recipes

Example JSON configuration for an advancement criteria that unlocks a recipe when a specific recipe is used.

```json
// Within some recipe advancement json
"has_the_recipe": { // Criteria label
  // Succeeds if examplemod:example_recipe is used
  "trigger": "minecraft:recipe_unlocked",
  "conditions": {
    "recipe": "examplemod:example_recipe"
  }
}
//...
"requirements": [
  [
    "has_the_recipe"
    // ... Other criteria labels to be ORed against to unlock recipe
  ]
]
```

--------------------------------

### Implement Block Update Synchronization

Source: https://docs.minecraftforge.net/en/1.20.1/blockentities

Example implementation for synchronizing data during block updates using update packets.

```java
@Override
public CompoundTag getUpdateTag() {
  CompoundTag tag = new CompoundTag();
  //Write your data into the tag
  return tag;
}

@Override
public Packet<ClientGamePacketListener> getUpdatePacket() {
  // Will get tag from #getUpdateTag
  return ClientboundBlockEntityDataPacket.create(this);
}

// Can override IForgeBlockEntity#onDataPacket. By default, this will defer to the #load.
```

--------------------------------

### Configure a Game Test

Source: https://docs.minecraftforge.net/en/1.20.1/misc/gametest

Customize test execution parameters like setup ticks and requirement status using annotation members.

```java
// In some class
@GameTest(
  setupTicks = 20L, // The test spends 20 ticks to set up for execution
  required = false // The failure is logged but does not affect the execution of the batch
)
public static void exampleConfiguredTest(GameTestHelper helper) {
  // Do stuff
}
```

--------------------------------

### Example GLM JSON Configuration

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/glm

A sample JSON structure for a global loot modifier, including the required type and conditions fields.

```json
// Within data/examplemod/loot_modifiers/example_glm.json
{
  "type": "examplemod:example_loot_modifier",
  "conditions": [
    // Normal loot table conditions
    // ...
  ],
  "prop1": "val1",
  "prop2": 10,
  "prop3": "minecraft:dirt"
}
```

--------------------------------

### Advancement Rewards Configuration

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/advancements

Example JSON structure for defining rewards in an advancement. This includes experience, loot tables, recipes, and a function to be executed.

```json
// In some advancement JSON
"rewards": {
  "experience": 10,
  "loot": [
    "minecraft:example_loot_table",
    "minecraft:example_loot_table2"
    // ...
  ],
  "recipes": [
    "minecraft:example_recipe",
    "minecraft:example_recipe2"
    // ...
  ],
  "function": "minecraft:example_function"
}
```

--------------------------------

### Define a translation key for an item

Source: https://docs.minecraftforge.net/en/1.20.1/concepts/internationalization

Items use translation keys derived from their registry name. This example shows the required JSON entry for an item with the ID examplemod:example_item.

```json
{
  "item.examplemod.example_item": "Example Item Name"
}
```

--------------------------------

### Creating a Basic KeyMapping

Source: https://docs.minecraftforge.net/en/1.20.1/misc/keymappings

Initialize a KeyMapping with a translation key, default input type, key code, and category.

```java
new KeyMapping(
  "key.examplemod.example1", // Will be localized using this translation key
  InputConstants.Type.KEYSYM, // Default mapping is on the keyboard
  GLFW.GLFW_KEY_P, // Default key is P
  "key.categories.misc" // Mapping will be in the misc category
)
```

--------------------------------

### Initialize SimpleChannel

Source: https://docs.minecraftforge.net/en/1.20.1/networking/simpleimpl

Create a static SimpleChannel instance with a protocol version and compatibility predicates to manage network communication.

```java
private static final String PROTOCOL_VERSION = "1";
public static final SimpleChannel INSTANCE = NetworkRegistry.newSimpleChannel(
  new ResourceLocation("mymodid", "main"),
  () -> PROTOCOL_VERSION,
  PROTOCOL_VERSION::equals,
  PROTOCOL_VERSION::equals
);
```

--------------------------------

### Synchronize Data with SlotItemHandler and DataSlot

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Demonstrates initializing a menu with an inventory handler and a single DataSlot for server-client synchronization.

```java
// Assume we have an inventory from a data object of size 5
// Assume we have a DataSlot constructed on each initialization of the server menu

// Client menu constructor
public MyMenuAccess(int containerId, Inventory playerInventory) {
  this(containerId, playerInventory, new ItemStackHandler(5), DataSlot.standalone());
}

// Server menu constructor
public MyMenuAccess(int containerId, Inventory playerInventory, IItemHandler dataInventory, DataSlot dataSingle) {
  // Check if the data inventory size is some fixed value
  // Then, add slots for data inventory
  this.addSlot(new SlotItemHandler(dataInventory, /*...*/));

  // Add slots for player inventory
  this.addSlot(new Slot(playerInventory, /*...*/));

  // Add data slots for handled integers
  this.addDataSlot(dataSingle);

  // ...
}
```

--------------------------------

### Creating and Checking Registry Tags

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/tags

Demonstrates creating different types of TagKeys and checking if objects belong to those tags using various registry access methods.

```java
public static final TagKey<Item> myItemTag = ItemTags.create(new ResourceLocation("mymod", "myitemgroup"));

public static final TagKey<Potion> myPotionTag = ForgeRegistries.POTIONS.tags().createTagKey(new ResourceLocation("mymod", "mypotiongroup"));

public static final TagKey<VillagerType> myVillagerTypeTag = TagKey.create(Registries.VILLAGER_TYPE, new ResourceLocation("mymod", "myvillagertypegroup"));

// In some method:

ItemStack stack = /*...*/;
boolean isInItemGroup = stack.is(myItemTag);

Potion potion = /*...*/;
boolean isInPotionGroup  = ForgeRegistries.POTIONS.tags().getTag(myPotionTag).contains(potion);

ResourceKey<VillagerType> villagerTypeKey = /*...*/;
boolean isInVillagerTypeGroup = BuiltInRegistries.VILLAGER_TYPE.getHolder(villagerTypeKey).map(holder -> holder.is(myVillagerTypeTag)).orElse(false);
```

--------------------------------

### Initialize Eclipse Workspace

Source: https://docs.minecraftforge.net/en/1.20.1/forgedev

Commands to prepare the Forge workspace for Eclipse using ForgeGradle.

```bash
./gradlew setup
```

```bash
./gradlew genEclipseRuns
```

--------------------------------

### Implementing quickMoveStack

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

This method handles the logic for moving items between inventory slots when shift-clicked. It requires careful management of slot indices to ensure items move to the correct inventory sections.

```java
// Assume we have a data inventory of size 5
// The inventory has 4 inputs (index 1 - 4) which outputs to a result slot (index 0)
// We also have the 27 player inventory slots and the 9 hotbar slots
// As such, the actual slots are indexed like so:
//   - Data Inventory: Result (0), Inputs (1 - 4)
//   - Player Inventory (5 - 31)
//   - Player Hotbar (32 - 40)
@Override
public ItemStack quickMoveStack(Player player, int quickMovedSlotIndex) {
  // The quick moved slot stack
  ItemStack quickMovedStack = ItemStack.EMPTY;
  // The quick moved slot
  Slot quickMovedSlot = this.slots.get(quickMovedSlotIndex) 

   // If the slot is in the valid range and the slot is not empty
  if (quickMovedSlot != null && quickMovedSlot.hasItem()) {
    // Get the raw stack to move
    ItemStack rawStack = quickMovedSlot.getItem(); 
    // Set the slot stack to a copy of the raw stack
    quickMovedStack = rawStack.copy();

    /*
    The following quick move logic can be simplified to if in data inventory,
    try to move to player inventory/hotbar and vice versa for containers
    that cannot transform data (e.g. chests).
    */

    // If the quick move was performed on the data inventory result slot
    if (quickMovedSlotIndex == 0) {
      // Try to move the result slot into the player inventory/hotbar
      if (!this.moveItemStackTo(rawStack, 5, 41, true)) {
        // If cannot move, no longer quick move
        return ItemStack.EMPTY;
      }

      // Perform logic on result slot quick move
      slot.onQuickCraft(rawStack, quickMovedStack);
    }
    // Else if the quick move was performed on the player inventory or hotbar slot
    else if (quickMovedSlotIndex >= 5 && quickMovedSlotIndex < 41) {
      // Try to move the inventory/hotbar slot into the data inventory input slots
      if (!this.moveItemStackTo(rawStack, 1, 5, false)) {
        // If cannot move and in player inventory slot, try to move to hotbar
        if (quickMovedSlotIndex < 32) {
          if (!this.moveItemStackTo(rawStack, 32, 41, false)) {
            // If cannot move, no longer quick move
            return ItemStack.EMPTY;
          }
        }
        // Else try to move hotbar into player inventory slot
        else if (!this.moveItemStackTo(rawStack, 5, 32, false)) {
          // If cannot move, no longer quick move
          return ItemStack.EMPTY;
        }
      }
    }
    // Else if the quick move was performed on the data inventory input slots, try to move to player inventory/hotbar
    else if (!this.moveItemStackTo(rawStack, 5, 41, false)) {
      // If cannot move, no longer quick move
      return ItemStack.EMPTY;
    }

    if (rawStack.isEmpty()) {
      // If the raw stack has completely moved out of the slot, set the slot to the empty stack
      quickMovedSlot.set(ItemStack.EMPTY);
    } else {
      // Otherwise, notify the slot that that the stack count has changed
      quickMovedSlot.setChanged();
    }

    /*
    The following if statement and Slot#onTake call can be removed if the
    menu does not represent a container that can transform stacks (e.g.
    chests).
    */
    if (rawStack.getCount() == quickMovedStack.getCount()) {
      // If the raw stack was not able to be moved to another slot, no longer quick move
      return ItemStack.EMPTY;
    }
    // Execute logic on what to do post move with the remaining stack
    quickMovedSlot.onTake(player, rawStack);
  }

  return quickMovedStack; // Return the slot stack
}
```

--------------------------------

### Open a Menu via NetworkHooks

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Use NetworkHooks.openScreen on the logical server to open a menu for a player.

```java
// In some implementation
NetworkHooks.openScreen(serverPlayer, new SimpleMenuProvider(
  (containerId, playerInventory, player) -> new MyMenu(containerId, playerInventory),
  Component.translatable("menu.title.examplemod.mymenu")
));
```

--------------------------------

### Implement Menu Access and Validation

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Use ContainerLevelAccess to manage block-attached menus and implement stillValid to verify player proximity.

```java
// Client menu constructor
public MyMenuAccess(int containerId, Inventory playerInventory) {
  this(containerId, playerInventory, ContainerLevelAccess.NULL);
}

// Server menu constructor
public MyMenuAccess(int containerId, Inventory playerInventory, ContainerLevelAccess access) {
  // ...
}

// Assume this menu is attached to RegistryObject<Block> MY_BLOCK
@Override
public boolean stillValid(Player player) {
  return AbstractContainerMenu.stillValid(this.access, player, MY_BLOCK.get());
}
```

--------------------------------

### Define Project Package Structure

Source: https://docs.minecraftforge.net/en/1.20.1/gettingstarted

Illustrates the required directory structure for Java source files based on the group ID and mod ID.

```text
com
- example (top-level package specified in group property)
  - mymod (the mod id)
    - MyMod.java (renamed ExampleMod.java)
```

--------------------------------

### Clone the MinecraftForge repository

Source: https://docs.minecraftforge.net/en/1.20.1/forgedev

Use this command to create a local copy of your forked repository. Replace <User> with your actual GitHub username.

```bash
git clone https://github.com/<User>/MinecraftForge
```

--------------------------------

### Implement LootTableSubProvider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/loottables

Create a class implementing LootTableSubProvider to define the generation logic via the BiConsumer writer.

```java
public class ExampleSubProvider implements LootTableSubProvider {

  // Used to create a factory method for the wrapping Supplier
  public ExampleSubProvider() {}

  // The method used to generate the loot tables
  @Override
  public void generate(BiConsumer<ResourceLocation, LootTable.Builder> writer) {
    // Generate loot tables here by calling writer#accept
  }
}
```

--------------------------------

### Registering and Defining Global Loot Modifiers

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/glm

Register the provider on the MOD event bus and define modifiers within the provider's start method.

```java
// On the MOD event bus
@SubscribeEvent
public void gatherData(GatherDataEvent event) {
    event.getGenerator().addProvider(
        // Tell generator to run only when server data are generating
        event.includeServer(),
        output -> new MyGlobalLootModifierProvider(output, MOD_ID)
    );
}

// In some GlobalLootModifierProvider#start
this.add("example_modifier", new ExampleModifier(
  new LootItemCondition[] {
    WeatherCheck.weather().setRaining(true).build() // Executes when raining
  },
  "val1",
  10,
  Items.DIRT
));
```

--------------------------------

### Define Item Overrides in JSON

Source: https://docs.minecraftforge.net/en/1.20.1/resources/client/models/itemproperties

Example of an item model definition using an override predicate that triggers when the property value is greater than or equal to the specified threshold.

```json
{
  "parent": "item/generated",
  "textures": {
    // Default
    "layer0": "examplemod:items/example_partial"
  },
  "overrides": [
    {
      // power >= .75
      "predicate": {
        "examplemod:power": 0.75
      },
      "model": "examplemod:item/example_powered"
    }
  ]
}
```

--------------------------------

### Vanilla JSON Item Model Overrides

Source: https://docs.minecraftforge.net/en/1.20.1/rendering/modelloaders/itemoverrides

Example structure of an overrides array within a vanilla JSON item model, defining predicates and target models.

```json
{
  // Inside a vanilla JSON item model
  "overrides": [
    {
      // This is an ItemOverride
      "predicate": {
        // This is the Map<ResourceLocation, Float>, containing the names of properties and their minimum values
        "example1:prop": 0.5
      },
      // This is the 'location', or target model, of the override, which is used if the predicate above matches
      "model": "example1:item/model"
    },
    {
      // This is another ItemOverride
      "predicate": {
        "example2:prop": 1
      },
      "model": "example2:item/model"
    }
  ]
}
```

--------------------------------

### Registering and Implementing Custom Ingredient Serializers

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/recipes/ingredients

Demonstrates declaring a serializer instance, registering it during the recipe serializer event, and returning it from an ingredient subclass.

```java
// In some serializer class
public static final ExampleIngredientSerializer INSTANCE = new ExampleIngredientSerializer();

// In some handler class
public void registerSerializers(RegisterEvent event) {
  event.register(ForgeRegistries.Keys.RECIPE_SERIALIZERS,
    helper -> CraftingHelper.register(registryName, INSTANCE)
  );
}

// In some ingredient subclass
@Override
public IIngredientSerializer<? extends Ingredient> getSerializer() {
  return INSTANCE;
}
```

--------------------------------

### Registering a MenuScreen

Source: https://docs.minecraftforge.net/en/1.20.1/gui/screens

Register a menu screen using MenuScreens#register inside the FMLClientSetupEvent. Must be called within #enqueueWork to ensure thread safety.

```java
// Event is listened to on the mod event bus
private void clientSetup(FMLClientSetupEvent event) {
    event.enqueueWork(
        // Assume RegistryObject<MenuType<MyMenu>> MY_MENU
        // Assume MyContainerScreen<MyMenu> which takes in three parameters
        () -> MenuScreens.register(MY_MENU.get(), MyContainerScreen::new)
    );
}
```

--------------------------------

### Matching Logic for Trigger Instance

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/advancements

Implements the logic to check if the current game state meets the conditions defined by the trigger instance. This example checks if an ItemStack matches a stored ItemPredicate.

```java
// This method is unique for each instance and is as such not overridden
public boolean matches(ItemStack stack) {
  // Since ItemPredicate matches a stack, a stack is the input
  return this.item.matches(stack);
}
```

--------------------------------

### Custom Trigger Instance Constructor

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/advancements

Example of a constructor for a custom advancement trigger instance. It calls the super constructor with the trigger's registry name and player conditions, then stores custom conditions like an ItemPredicate.

```java
// Where ID is the registry name of the trigger
public ExampleTriggerInstance(ContextAwarePredicate player, ItemPredicate item) {
  super(ID, player);
  // Store the item condition that must be met
}
```

--------------------------------

### Create ExampleTriggerInstance

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/advancements

Implement the `createInstance` method to read trigger conditions from JSON. This method is responsible for deserializing the criteria and creating a new trigger instance.

```java
@Override
public ExampleTriggerInstance createInstance(JsonObject json, ContextAwarePredicate player, DeserializationContext context) {
  // Read conditions from JSON: item
  return new ExampleTriggerInstance(player, item);
}
```

--------------------------------

### Implement a Custom Model Consumer Provider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/client/modelproviders

Create an IDataProvider that initializes and manages the custom ModelProvider.

```java
public class ExampleModelConsumerProvider implements IDataProvider {

  public ExampleModelConsumerProvider(PackOutput output, String modid, ExistingFileHelper existingFileHelper) {
    this.example = new ExampleModelProvider(output, modid, existingFileHelper);
  }
}
```

--------------------------------

### Constructing a Screen Subclass

Source: https://docs.minecraftforge.net/en/1.20.1/gui/screens

Initializes a screen with a title component.

```java
// In some Screen subclass
public MyScreen(Component title) {
    super(title);
}
```

--------------------------------

### Synchronize Multiple Integers with ContainerData

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Demonstrates using ContainerData to sync multiple integers via index lookup in a menu.

```java
// Assume we have a ContainerData of size 3

// Client menu constructor
public MyMenuAccess(int containerId, Inventory playerInventory) {
  this(containerId, playerInventory, new SimpleContainerData(3));
}

// Server menu constructor
public MyMenuAccess(int containerId, Inventory playerInventory, ContainerData dataMultiple) {
  // Check if the ContainerData size is some fixed value
  checkContainerDataCount(dataMultiple, 3);

  // Add data slots for handled integers
  this.addDataSlots(dataMultiple);

  // ...
}
```

--------------------------------

### Generate Smithing Trim Recipes

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/recipes

Initializes a smithing trim recipe builder via the smithingTrim method for armor trim recipes.

```java
// In RecipeProvider#buildRecipes(writer)
SmithingTrimRecipe builder = SmithingTrimRecipe.smithingTrim(template, base, addition, RecipeCategory.MISC)
  .unlocks("criteria", criteria) // How the recipe is unlocked
  .save(writer, name); // Add data to builder
```

--------------------------------

### Initialize BlockLootSubProvider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/loottables

Constructor for a BlockLootSubProvider subclass requiring explosion resistance set and FeatureFlagSet.

```java
// In some BlockLootSubProvider subclass
public MyBlockLootSubProvider() {
  super(Collections.emptySet(), FeatureFlags.REGISTRY.allFlags());
}
```

--------------------------------

### Implement a custom Recipe record

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/recipes/custom

A basic implementation of the Recipe interface using a Java record. Ensure all required interface methods are implemented.

```java
public record ExampleRecipe(Ingredient input, int data, ItemStack output) implements Recipe<Container> {
  // Implement methods here
}
```

--------------------------------

### Initialize AbstractContainerScreen subclass

Source: https://docs.minecraftforge.net/en/1.20.1/gui/screens

Constructor for an AbstractContainerScreen subclass, setting static label positions relative to the background.

```java
// In some AbstractContainerScreen subclass
public MyContainerScreen(MyMenu menu, Inventory playerInventory, Component title) {
    super(menu, playerInventory, title);

    this.titleLabelX = 10;
    this.inventoryLabelX = 10;

    /*
     * If the 'imageHeight' is changed, 'inventoryLabelY' must also be
     * changed as the value depends on the 'imageHeight' value.
     */
}
```

--------------------------------

### Registering a standard MenuType

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Use a MenuSupplier to create a basic MenuType. The constructor requires a reference to the menu class and a FeatureFlagSet.

```java
// For some DeferredRegister<MenuType<?>> REGISTER
public static final RegistryObject<MenuType<MyMenu>> MY_MENU = REGISTER.register("my_menu", () -> new MenuType(MyMenu::new, FeatureFlags.DEFAULT_FLAGS));

// In MyMenu, an AbstractContainerMenu subclass
public MyMenu(int containerId, Inventory playerInv) {
  super(MY_MENU.get(), containerId);
  // ...
}
```

--------------------------------

### Configure an OBJ model loader

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/client/modelproviders

Demonstrates using the ObjModelBuilder to configure a custom model loader for an OBJ file.

```java
// For some BlockModelBuilder builder
builder.customLoader(ObjModelBuilder::begin) // Custom loader 'forge:obj'
  .modelLocation(modLoc("models/block/model.obj")) // Set the OBJ model location
  .flipV(true) // Flips the V coordinate in the supplied .mtl texture
  .end() // Finish custom loader configuration
.texture("particle", mcLoc("block/dirt")) // Set particle texture to dirt
.texture("texture0", mcLoc("block/dirt")); // Set 'texture0' texture to dirt
```

--------------------------------

### Generating a Cooking Recipe

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/recipes

Use SimpleCookingRecipeBuilder for smelting, blasting, smoking, or campfire cooking recipes, specifying experience and cooking time.

```java
// In RecipeProvider#buildRecipes(writer)
SimpleCookingRecipeBuilder builder = SimpleCookingRecipeBuilder.smelting(input, RecipeCategory.MISC, result, experience, cookingTime)
  .unlockedBy("criteria", criteria) // How the recipe is unlocked 
  .save(writer); // Add data to builder
```

--------------------------------

### Configure ForgeConfigSpec with a static block

Source: https://docs.minecraftforge.net/en/1.20.1/misc/config

Use the configure method with a constructor reference to initialize configuration classes and their specifications.

```java
// In some config class
ExampleConfig(ForgeConfigSpec.Builder builder) {
  // Define values here in final fields
}

// Somewhere the constructor is accessible
static {
  Pair<ExampleConfig, ForgeConfigSpec> pair = new ForgeConfigSpec.Builder()
    .configure(ExampleConfig::new);
  // Store pair values in some constant field
}
```

--------------------------------

### Implement Menu in a Mob

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Implement MenuProvider on the Mob class and use mobInteract to trigger the menu opening.

```java
public class MyMob extends Mob implements MenuProvider {
  // ...

  @Override
  public InteractionResult mobInteract(Player player, InteractionHand hand) {
    if (!this.level.isClientSide && player instanceof ServerPlayer serverPlayer) {
      NetworkHooks.openScreen(serverPlayer, this);
    }
    return InteractionResult.sidedSuccess(this.level.isClientSide);
  }
}
```

--------------------------------

### Non-Item Recipe Logic Implementation

Source: https://docs.minecraftforge.net/en/1.20.1/resources/server/recipes/custom

Demonstrates defining custom recipe methods and retrieving them via RecipeManager for non-item based logic.

```java
// In some Recipe subimplementation ExampleRecipe

// Checks the block at the position to see if it matches the stored data
boolean matches(Level level, BlockPos pos);

// Creates the block state to set the block at the specified position to
BlockState assemble(RegistryAccess access);

// In some manager class
public Optional<ExampleRecipe> getRecipeFor(Level level, BlockPos pos) {
  return level.getRecipeManager()
    .getAllRecipesFor(exampleRecipeType) // Gets all recipes
    .stream() // Looks through all recipes for types
    .filter(recipe -> recipe.matches(level, pos)) // Checks if the recipe inputs are valid
    .findFirst(); // Finds the first recipe whose inputs match
}
```

--------------------------------

### Registering SoundDefinitionsProvider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/client/sounds

Add the provider to the DataGenerator on the MOD event bus to ensure it runs during client asset generation.

```java
// On the MOD event bus
@SubscribeEvent
public void gatherData(GatherDataEvent event) {
    event.getGenerator().addProvider(
        // Tell generator to run only when client assets are generating
        event.includeClient(),
        output -> new MySoundDefinitionsProvider(output, MOD_ID, event.getExistingFileHelper())
    );
}
```

--------------------------------

### Implement a Custom TagsProvider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/tags

Create a subclass of TagsProvider by passing the registry key and required data generation parameters to the super constructor.

```java
public RecipeTypeTagsProvider(PackOutput output, CompletableFuture<HolderLookup.Provider> registries, ExistingFileHelper fileHelper) {
  super(output, Registries.RECIPE_TYPE, registries, MOD_ID, fileHelper);
}
```

--------------------------------

### Registering a custom BEWLR in an Item class

Source: https://docs.minecraftforge.net/en/1.20.1/items/bewlr

Override initializeClient to provide an IClientItemExtensions instance that returns your custom BEWLR instance. Each mod should maintain only one instance of the BEWLR.

```java
// In your item class
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
  consumer.accept(new IClientItemExtensions() {

    @Override
    public BlockEntityWithoutLevelRenderer getCustomRenderer() {
      return myBEWLRInstance;
    }
  });
}
```

--------------------------------

### Generate Smithing Transform Recipes

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/recipes

Initializes a smithing transform recipe builder via the smithing method and defines unlock criteria before saving.

```java
// In RecipeProvider#buildRecipes(writer)
SmithingTransformRecipeBuilder builder = SmithingTransformRecipeBuilder.smithing(template, base, addition, RecipeCategory.MISC, result)
  .unlocks("criteria", criteria) // How the recipe is unlocked
  .save(writer, name); // Add data to builder
```

--------------------------------

### Define a basic ConfigValue

Source: https://docs.minecraftforge.net/en/1.20.1/misc/config

Create a configuration entry with an optional comment using the builder's define method.

```java
// For some ForgeConfigSpec$Builder builder
ConfigValue<T> value = builder.comment("Comment")
  .define("config_value_name", defaultValue);
```

--------------------------------

### Using Capability#orEmpty for Single Capability Exposure

Source: https://docs.minecraftforge.net/en/1.20.1/datastorage/capabilities

Simplified implementation of getCapability when only one capability is exposed on an object.

```java
@Override
public <T> LazyOptional<T> getCapability(Capability<T> cap, Direction side) {
  return ForgeCapabilities.ITEM_HANDLER.orEmpty(cap, inventoryHandlerLazyOptional);
}
```

--------------------------------

### Define Menu Constructors

Source: https://docs.minecraftforge.net/en/1.20.1/gui/menus

Implement separate constructors for client and server initialization, ensuring client-side fields have appropriate defaults.

```java
// Client menu constructor
public MyMenu(int containerId, Inventory playerInventory) {
  this(containerId, playerInventory);
}

// Server menu constructor
public MyMenu(int containerId, Inventory playerInventory) {
  // ...
}
```

--------------------------------

### Registering a RecipeProvider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/recipes

Add the provider to the DataGenerator on the MOD event bus to ensure it runs during server data generation.

```java
// On the MOD event bus
@SubscribeEvent
public void gatherData(GatherDataEvent event) {
    event.getGenerator().addProvider(
        // Tell generator to run only when server data are generating
        event.includeServer(),
        MyRecipeProvider::new
    );
}
```

--------------------------------

### Registering DatapackBuiltinEntriesProvider

Source: https://docs.minecraftforge.net/en/1.20.1/datagen/server/datapackregistries

Add the provider to the DataGenerator on the MOD event bus to handle server data generation.

```java
// On the MOD event bus
@SubscribeEvent
public void gatherData(GatherDataEvent event) {
    event.getGenerator().addProvider(
        // Tell generator to run only when server data are generating
        event.includeServer(),
        output -> new DatapackBuiltinEntriesProvider(
          output,
          event.getLookupProvider(),
          // The builder containing the datapack registry objects to generate
          new RegistrySetBuilder().add(/* ... */),
          // Set of mod ids to generate the datapack registry objects of
          Set.of(MOD_ID)
        )
    );
}
```

--------------------------------

### Configure displayTest in mods.toml

Source: https://docs.minecraftforge.net/en/1.20.1/concepts/sides

Set the displayTest property to control how the mod handles version mismatches between client and server.

```toml
[[mods]]
  # ...

  # 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="IGNORE_ALL_VERSION" # MATCH_VERSION is the default if nothing is specified (#optional)
```
Tokens:
Raw