Fabric

https://docs.fabricmc.net/develop/
Admin
Fabric is a lightweight modding toolchain for Minecraft: Java Edition that allows developers to...
Tokens:220,092
Snippets:1,719
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Main entrypoint implementing ModInitializer

Source: https://docs.fabricmc.net/develop/getting-started/project-structure

Example of a simple main entrypoint that logs a message to the console when the game starts. The class implements ModInitializer and uses a logger named after the mod ID. It also includes a static helper method to create Identifiers.

```java
public class ExampleMod implements ModInitializer {
	// This logger is used to write text to the console and the log file.
	// It is considered best practice to use your mod id as the logger's name.
	// That way, it's clear which mod wrote info, warnings, and errors.
	public static final String MOD_ID = "example-mod";
	public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);

	@Override
	public void onInitialize() {
		// This code runs as soon as Minecraft is in a mod-load-ready state.
		// However, some things (like resources) may still be uninitialized.
		// Proceed with mild caution.

		LOGGER.info("Hello Fabric world!");
	}

	public static Identifier id(String path) {
		return Identifier.fromNamespaceAndPath(MOD_ID, path);
	}
}
```

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

### Iterate Over All Registry Entries

Source: https://docs.fabricmc.net/develop/registries/dynamic-registry

Iterate over all entries in a dynamic registry to populate a UI, such as a custom screen with widgets. The example uses `ifPresent` on the `Optional<Registry<T>>` and iterates with a for-each loop, creating a `MagicSkillWidget` for each entry and adding it to the screen. This is useful for UI population; see the linked guides on custom screens and widgets.

```java
registry.ifPresent(reg -> {
	int y = 50;

	for (MagicSkillsRegistryEntry skill : reg) {
		MagicSkillWidget widget = new MagicSkillWidget(skill, font, 40, y, 80, 20);
		this.addRenderableWidget(widget);
		y += 30;
	}
});
```

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

### Clone the Fabric example mod repository

Source: https://docs.fabricmc.net/develop/getting-started/creating-a-project

Clones the Fabric example mod repository into a folder named example-mod. Requires Git to be installed. After cloning, delete the .git folder from the cloned repository.

```shell
git clone https://github.com/FabricMC/fabric-example-mod.git example-mod
```

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

### Minecraft JAR path example

Source: https://docs.fabricmc.net/develop/getting-started/vscode/tips-and-tricks

Example of a path to the Minecraft JAR in the loom cache, used for javap.

```text
C:/project/.gradle/loom-cache/minecraftMaven/net/minecraft/minecraft-merged-503b555a3d/1.21.8-net.fabricmc.yarn.1_21_8.1.21.8+build.1-v2/minecraft-merged-503b555a3d-1.21.8-net.fabricmc.yarn.1_21_8.1.21.8+build.1-v2.jar
```

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

### Create remap configurations for a source set

Source: https://docs.fabricmc.net/develop/loom/options

Creates modExampleImplementation and related configurations that remap mods for the example source set.

```groovy
createRemapConfigurations(sourceSets.example)
```

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

### Example Mod fabric.mod.json

Source: https://docs.fabricmc.net/develop/loader/fabric-mod-json

Complete fabric.mod.json metadata file for the Example Mod, placed in the JAR's root directory. It declares schemaVersion 1, entrypoints for main/client/fabric-datagen, mixins, dependencies, and an access widener. This is the file used by the website's Example Mod.

```json
{
  "schemaVersion": 1,
  "id": "example-mod",
  "version": "1.0.0",
  "name": "Example Mod",
  "icon": "assets/example-mod/icon.png",
  "environment": "*",
  "entrypoints": {
    "main": [
      "com.example.docs.ExampleMod",
      "com.example.docs.event.ExampleModEvents",
      "com.example.docs.command.ExampleModCommands",
      "com.example.docs.effect.ExampleModEffects",
      "com.example.docs.potion.ExampleModPotions",
      "com.example.docs.sound.ExampleModSounds",
      "com.example.docs.damage.ExampleModDamageTypes",
      "com.example.docs.item.ExampleModItems",
      "com.example.docs.enchantment.ExampleModEnchantments",
      "com.example.docs.block.ExampleModBlocks",
      "com.example.docs.block.entity.ExampleModBlockEntities",
      "com.example.docs.menu.ExampleModMenuType",
      "com.example.docs.component.ExampleModComponents",
      "com.example.docs.advancement.ExampleModDatagenAdvancement",
      "com.example.docs.networking.ExampleModNetworking",
      "com.example.docs.networking.basic.ExampleModNetworkingBasic",
      "com.example.docs.debug.ExampleModDebug",
      "com.example.docs.saveddata.ExampleModSavedData",
      "com.example.docs.entity.attribute.ExampleModAttributes",
      "com.example.docs.recipe.ExampleModRecipes",
      "com.example.docs.entity.ExampleModEntity",
      "com.example.docs.gamerule.ExampleModGameRules",
      "com.example.docs.dynamic_registries.ExampleModDynamicRegistries",
      "com.example.docs.conditions.ExampleModResourceConditions",
      "com.example.docs.stats.ExampleModStats"
    ],
    "client": [
      "com.example.docs.client.command.ExampleModClientCommands",
      "com.example.docs.ExampleModBlockEntityRenderer",
      "com.example.docs.ExampleModDynamicSound",
      "com.example.docs.ExampleModClient",
      "com.example.docs.ExampleModScreens",
      "com.example.docs.rendering.CustomRenderPipeline",
      "com.example.docs.rendering.HudRenderingEntrypoint",
      "com.example.docs.rendering.RenderingConceptsEntrypoint",
      "com.example.docs.network.basic.ExampleModNetworkingBasicClient",
      "com.example.docs.appearance.ExampleModAppearanceClient",
      "com.example.docs.keymapping.ExampleModKeyMappingsClient",
      "com.example.docs.ExampleModRecipesClient",
      "com.example.docs.entity.ExampleModCustomEntityClient",
      "com.example.docs.projectile.ExampleModProjectileClient"
    ],
    "fabric-datagen": ["com.example.docs.datagen.ExampleModDataGenerator"]
  },
  "mixins": [
    "example-mod.mixins.json",
    {
      "config": "example-mod.client.mixins.json",
      "environment": "client"
    }
  ],
  "depends": {
    "fabricloader": ">=0.19.0",
    "minecraft": "~26.2",
    "java": ">=25",
    "fabric-api": "*"
  },
  "accessWidener": "example-mod.classtweaker"
}
```

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

### canStartSilent() override

Source: https://docs.fabricmc.net/develop/sounds/dynamic-sounds

Override of canStartSilent() to allow the SoundInstance to start playing. You can add your own condition instead of returning true.

```java
@Override
public boolean canStartSilent() {
	// override to true, so that the SoundInstance can start
	// or add your own condition to the SoundInstance, if necessary
	return true;
}
```

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

### EngineSoundInstance example implementation

Source: https://docs.fabricmc.net/develop/sounds/dynamic-sounds

Example custom SoundInstance that extends AbstractDynamicSoundInstance. In tick(), it checks conditions to end the sound, applies default tick behavior, and modulates volume and pitch.

```java
public class EngineSoundInstance extends AbstractDynamicSoundInstance {
	// Here we just use the default constructor parameters.
	// If you want to specifically set values here already,
	// you can clean up the constructor parameters a bit
	public EngineSoundInstance(DynamicSoundSource soundSource, SoundEvent soundEvent, SoundSource soundCategory,
							int startTransitionTicks, int endTransitionTicks, float maxVolume, float minPitch, float maxPitch,
							SoundInstanceCallback callback) {
		super(soundSource, soundEvent, soundCategory, startTransitionTicks, endTransitionTicks, maxVolume, minPitch, maxPitch, callback);
	}

	@Override
	public void tick() {
		// check conditions which set this sound automatically into the ending phase
		if (soundSource instanceof EngineBlockEntity blockEntity && blockEntity.isRemoved()) {
			this.end();
		}

		// apply the default tick behaviour from the parent class
		super.tick();

		// modulate volume and pitch of the SoundInstance
		this.modulateSoundForTransition();
		this.modulateSoundForStress();
	}

	// you can also add sound modulation methods here,
	// which should be only accessible to this
	// specific SoundInstance
}
```

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

### environment field

Source: https://docs.fabricmc.net/develop/loader/fabric-mod-json

Example JSON showing the 'environment' field with value '*', which runs in all environments. Other values are 'client' and 'server'.

```json
"environment": "*"
```

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

### Method descriptor example

Source: https://docs.fabricmc.net/develop/mixins/bytecode

Shows a Java method and its corresponding bytecode descriptor, which concatenates parameter types and the return type.

```java
void drawText(int x, int y, String text, int color) {
    // ...
}
```

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

### Dye Recipe Example

Source: https://docs.fabricmc.net/develop/data-generation/recipes

Generates a recipe that dyes the specified item (leather gloves) using the given name. This is used for dyeable items.

```java
dyedItem(ModItems.LEATHER_GLOVES, "leather_gloves");
```

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

### license field

Source: https://docs.fabricmc.net/develop/loader/fabric-mod-json

Example JSON showing the 'license' field with an SPDX license identifier. Recommended for open-source licenses.

```json
"license": "CC0-1.0"
```

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

### Display tag example

Source: https://docs.fabricmc.net/develop/blocks/block-models

Sets model translation, rotation, and scale for a specific position. Position can be one of the listed values like 'firstperson_righthand' or 'gui'.

```json
{
  "display": {
    "<position>": {
      "rotation": [0.0, 0.0, 0.0],
      "translation": [0.0, 0.0, 0.0],
      "scale": [0.0, 0.0, 0.0]
    }
  }
}
```

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

### Create ExampleModRegistries class with registry key

Source: https://docs.fabricmc.net/develop/registries/dynamic-registry

Declares a ResourceKey for the magic skills registry and an initialize() method placeholder. Recommended to centralize registry keys.

```java
public class ExampleModRegistries {
	public static final ResourceKey<Registry<MagicSkillsRegistryEntry>> MAGIC_SKILLS_REGISTRY_KEY =
					ResourceKey.createRegistryKey(ExampleMod.id("magic_skills_registry"));

	public static void initialize() {
		// Register Code Here
	}
}
```

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

### Field Accessor Usage Example

Source: https://docs.fabricmc.net/develop/mixins/accessors

Usage of the HudAccessor to get and set the overlay message time on a Hud instance.

```java
void exampleInstanceFieldAccessorUsage(Hud hud, int newMessageTime) {
	int oldMessageTime = ((HudAccessor) hud).example_mod$getOverlayMessageTime();

	((HudAccessor) hud).example_mod$setOverlayMessageTime(newMessageTime);
}
```

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

### Get a Specific Entry with RegistryAccess.get

Source: https://docs.fabricmc.net/develop/registries/dynamic-registry

Use the `get` method of `RegistryAccess` to retrieve a specific entry as an `Optional<Holder.Reference<T>>`. The example creates a `ResourceKey` for the entry, then uses `ifPresent` to access the value and perform logic such as sending an overlay message. The `HEALING_SKILL_ENTRY_ID` can be obtained as described in the 'Read Entry ID' section.

```java
ResourceKey<MagicSkillsRegistryEntry> HEALING_SKILL_ENTRY_ID = ResourceKey.create(ExampleModRegistries.MAGIC_SKILLS_SYNCED_REGISTRY_KEY, ExampleMod.id("healing_skill"));
Optional<Holder.Reference<MagicSkillsRegistryEntry>> entry = registryAccess.get(HEALING_SKILL_ENTRY_ID);
entry.ifPresent(magicSkillRef -> {
	MagicSkillsRegistryEntry magicSkill = magicSkillRef.value();
	// Other logic to reduce player's mana and running the function
	serverPlayer.sendOverlayMessage(Component.literal("Used %s Magical Skill, Mana Reduced By %d".formatted(magicSkill.name(), magicSkill.manaCost())));
});
```

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

### Register an Item with ResourceKey and Item.Properties

Source: https://docs.fabricmc.net/develop/items/first-item

These two fields are part of the item registration example. The first creates a ResourceKey for the item, and the second registers the item using the register method with an Item.Properties instance.

```java
public static final ResourceKey<Item> SUSPICIOUS_SUBSTANCE = create("suspicious_substance");
```

```java
public static final Item SUSPICIOUS_SUBSTANCE = register(ModItemIds.SUSPICIOUS_SUBSTANCE, Item::new, new Item.Properties());
```

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

### Create ExampleModAdvancementProvider

Source: https://docs.fabricmc.net/develop/data-generation/advancements

Create a class extending FabricAdvancementProvider and implement the generateAdvancement method. This is the first step in setting up advancement generation with datagen.

```java
public class ExampleModAdvancementProvider extends FabricAdvancementProvider {
	protected ExampleModAdvancementProvider(FabricPackOutput output, CompletableFuture<HolderLookup.Provider> registryLookup) {
		super(output, registryLookup);
	}

	@Override
	public void generateAdvancement(HolderLookup.Provider wrapperLookup, Consumer<AdvancementHolder> consumer) {
	}
}
```

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

### Smelting Recipe Example

Source: https://docs.fabricmc.net/develop/data-generation/recipes

Generates a smelting recipe that converts glass bottles into glass, awarding 0.1 experience and taking 300 ticks. The recipe is placed in the MISC category and group "glass_bottle_to_glass".

```java
oreSmelting(
		List.of(Items.GLASS_BOTTLE), // Inputs
		RecipeCategory.MISC, // Category
		CookingBookCategory.MISC, // Category
		Items.GLASS, // Output
		0.1f, // Experience
		300, // Cooking time
		"glass_bottle_to_glass" // group
);
```

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

### Example inject-interface entry

Source: https://docs.fabricmc.net/develop/class-tweakers/interface-injection

Example entry for injecting BucketEmptySoundGetter into FlowingFluid using internal names.

```classtweaker
inject-interface  net/minecraft/world/level/material/FlowingFluid  com/example/docs/interface_injection/BucketEmptySoundGetter
```

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

### Set up recipe generation with FabricRecipeProvider

Source: https://docs.fabricmc.net/develop/data-generation/recipes

Create a recipe provider by extending FabricRecipeProvider and override createRecipeProvider to return a RecipeProvider whose buildRecipes method contains the recipe logic. Then register the provider in the DataGeneratorEntrypoint's onInitializeDataGenerator method using pack.addProvider(ExampleModRecipeProvider::new).

```java
import java.util.List;
import java.util.concurrent.CompletableFuture;

import net.minecraft.core.HolderLookup;
import net.minecraft.core.registries.Registries;
import net.minecraft.data.recipes.RecipeCategory;
import net.minecraft.data.recipes.RecipeOutput;
import net.minecraft.data.recipes.RecipeProvider;
import net.minecraft.data.recipes.SimpleCookingRecipeBuilder;
import net.minecraft.data.recipes.SpecialRecipeBuilder;
import net.minecraft.tags.ItemTags;
import net.minecraft.world.item.Item;
import net.minecraft.world.item.ItemStackTemplate;
import net.minecraft.world.item.Items;
import net.minecraft.world.item.crafting.CookingBookCategory;
import net.minecraft.world.item.crafting.Ingredient;
import net.minecraft.world.item.crafting.ShieldDecorationRecipe;

import net.fabricmc.fabric.api.datagen.v1.FabricPackOutput;
import net.fabricmc.fabric.api.datagen.v1.provider.FabricRecipeProvider;
import net.fabricmc.fabric.api.resource.conditions.v1.ResourceConditions;

import com.example.docs.ExampleMod;
import com.example.docs.item.ModItems;

public class ExampleModRecipeProvider extends FabricRecipeProvider {
	public ExampleModRecipeProvider(FabricPackOutput output, CompletableFuture<HolderLookup.Provider> registriesFuture) {
		super(output, registriesFuture);
	}

	@Override
	protected RecipeProvider createRecipeProvider(HolderLookup.Provider registryLookup, RecipeOutput exporter) {
		return new RecipeProvider(registryLookup, exporter) {
			@Override
			public void buildRecipes() {
				HolderLookup.RegistryLookup<Item> itemLookup = registries.lookupOrThrow(Registries.ITEM);
			}
		};
	}

	@Override
	public String getName() {
		return "ExampleModRecipeProvider";
	}
}
```

```java
pack.addProvider(ExampleModRecipeProvider::new);
```

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

### Method Invoker Example: InventoryAccessor

Source: https://docs.fabricmc.net/develop/mixins/accessors

Example invoker interface for the Inventory class, exposing the hasRemainingSpaceForItem method.

```java
@Mixin(Inventory.class)
public interface InventoryAccessor {
	@Invoker("hasRemainingSpaceForItem")
	boolean example_mod$hasRemainingSpaceForItem(ItemStack slotItemStack, ItemStack newItemStack);
}
```

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

### Create ExampleModWorldConfiguredFeatures class

Source: https://docs.fabricmc.net/develop/data-generation/features

Creates the configured features class with a `configure` method that takes a `BootstrapContext<ConfiguredFeature<?, ?>>`. This class is the starting point for defining configured features.

```java
public class ExampleModWorldConfiguredFeatures {
	public static void configure(BootstrapContext<ConfiguredFeature<?, ?>> context) {
	}
}
```

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

### Local variable indexing for doubles in a static method

Source: https://docs.fabricmc.net/develop/mixins/bytecode

Demonstrates that longs and doubles occupy two indexes in the LVT. In this static method, `x` gets index 0, `y` gets index 2, and `z` gets index 4.

```java
public static double add(double x, double y, double z) {
    return x + y + z;
}
```

```bytecode
static add (DDD)D
  dload 0  // x
  dload 2  // y
  dadd
  dload 4  // z
  dadd
  dreturn
```

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

### Create sample linked list instance

Source: https://docs.fabricmc.net/develop/serialization/codecs

Creates a sample singly-linked list with values 2, 3, and 5 to be serialized using the recursive codec.

```java
ListNode linkedList = new ListNode(
		2,
		Optional.of(
				new ListNode(
						3,
						Optional.of(
								new ListNode(
												5,
												Optional.empty()
								)
						)
				)
		)
);
```

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

### Local variable indexing in a non-static method

Source: https://docs.fabricmc.net/develop/mixins/bytecode

Shows how local variables and parameters are indexed in the Local Variable Table (LVT) for a non-static method. In the bytecode, `this` gets index 0, `offset` gets index 1, and `result` gets index 2.

```java
public int getX(int offset) {
    int result = this.x + offset;
    return result;
}
```

```bytecode
public getX (I)I
  aload 0  // this
  getfield x
  iload 1  // offset
  iadd
  istore 2  // result

  iload 2  // result
  ireturn
```

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

### Set up a FabricLanguageProvider and register it with datagen

Source: https://docs.fabricmc.net/develop/data-generation/translations

Create a language provider by extending FabricLanguageProvider and register it in the DataGeneratorEntrypoint. The constructor takes a FabricPackOutput and a CompletableFuture<HolderLookup.Provider>; specifying "en_us" is optional as it is the default. You need a separate provider for each language you want to generate.

```java
public class ExampleModEnglishLangProvider extends FabricLanguageProvider {
	protected ExampleModEnglishLangProvider(FabricPackOutput dataOutput, CompletableFuture<HolderLookup.Provider> registryLookup) {
		// Specifying en_us is optional, as it's the default language code
		super(dataOutput, "en_us", registryLookup);
	}

	@Override
	public void generateTranslations(HolderLookup.Provider holderLookup, TranslationBuilder translationBuilder) {
	}
}
```

```java
pack.addProvider(ExampleModEnglishLangProvider::new);
```

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

### Field Accessor Example: HudAccessor

Source: https://docs.fabricmc.net/develop/mixins/accessors

Example accessor interface for the Hud class, providing getter and setter for the overlayMessageTime field.

```java
@Mixin(Hud.class)
public interface HudAccessor {
	@Accessor("overlayMessageTime")
	int example_mod$getOverlayMessageTime();

	@Accessor("overlayMessageTime")
	void example_mod$setOverlayMessageTime(int messageTime);
}
```

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

### Shapeless Recipe Example

Source: https://docs.fabricmc.net/develop/data-generation/recipes

Creates a shapeless recipe that produces one dirt from one coarse dirt. The recipe is unlocked by having coarse dirt in the inventory. Use this for recipes without a specific shape.

```java
shapeless(RecipeCategory.BUILDING_BLOCKS, Items.DIRT) // You can also specify an int to produce more than one
		.requires(Items.COARSE_DIRT) // You can also specify an int to require more than one, or a tag to accept multiple things
		// Create an advancement that gives you the recipe
		.unlockedBy(getHasName(Items.COARSE_DIRT), has(Items.COARSE_DIRT))
		.save(output);
```

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

### Call initialize from mod initializer

Source: https://docs.fabricmc.net/develop/registries/dynamic-registry

Shows the mod initializer calling ExampleModRegistries.initialize() during onInitialize.

```java
public class ExampleModDynamicRegistries implements ModInitializer {
	@Override
	public void onInitialize() {
		ExampleModRegistries.initialize();
	}
}
```

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

### Language file en_us.json for translatable text

Source: https://docs.fabricmc.net/develop/text-and-translations

The language file maps translation keys to their localized strings. This example shows the entries for the keys used in the translatable text example.

```json
{
  "example-mod.text.hello": "Hello!",
  "example-mod.text.bye": "Goodbye :("
}
```

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

### Access Widener Example for MenuSupplier

Source: https://docs.fabricmc.net/develop/class-tweakers/access-widening

Example access widener entry that makes the inner class MenuSupplier in MenuType public. Uses the accessible directive and the internal class name.

```classtweaker
# Makes the inner class MenuSupplier in MenuType public
accessible	class	net/minecraft/world/inventory/MenuType$MenuSupplier
```

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

### Initialize Registries with Bootstrap

Source: https://docs.fabricmc.net/develop/automatic-testing

Initializes Minecraft's registries by detecting the version and bootstrapping. Add this to the beginning of the beforeAll method to fix the 'Not bootstrapped' error.

```java
SharedConstants.tryDetectVersion();
Bootstrap.bootStrap();
```

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

### Create ExampleModWorldgenProvider class

Source: https://docs.fabricmc.net/develop/data-generation/features

Extends FabricDynamicRegistryProvider and overrides configure to add all configured and placed features. The getName method returns "World Generation".

```java
public class ExampleModWorldgenProvider extends FabricDynamicRegistryProvider {
	public ExampleModWorldgenProvider(FabricPackOutput output, CompletableFuture<HolderLookup.Provider> registriesFuture) {
		super(output, registriesFuture);
	}

	@Override
	protected void configure(HolderLookup.Provider registries, Entries entries) {
		entries.addAll(registries.lookupOrThrow(Registries.CONFIGURED_FEATURE));
		entries.addAll(registries.lookupOrThrow(Registries.PLACED_FEATURE));
	}

	@Override
	public String getName() {
		return "World Generation";
	}
}
```

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

### Line comment shortcut example

Source: https://docs.fabricmc.net/develop/getting-started/intellij-idea/tips-and-tricks

Use the line comment shortcut (⌘/CTRL + /) to toggle comments on selected lines. This example shows commented-out field declarations alongside active ones.

```java
// private static final int PROTECTION_BOOTS = 2;
private static final int PROTECTION_LEGGINGS = 5;
// private static final int PROTECTION_CHESTPLATE = 6;
private static final int PROTECTION_HELMET = 1;
```

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

### Block comment shortcut example

Source: https://docs.fabricmc.net/develop/getting-started/intellij-idea/tips-and-tricks

Use the block comment shortcut (⌘/CTRL + ⌥/Shift + /) to comment out multiple lines. This example shows a block comment around initialization calls and an inline comment inside a method.

```java
/*
ModItems.initialize();
ModSounds.initializeSounds();
ModParticles.initialize();
*/

private static int secondsToTicks(float seconds) {
    return (int) (seconds * 20 /*+ 69*/);
}
```

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

### Smoking Recipe Example

Source: https://docs.fabricmc.net/develop/data-generation/recipes

Creates a smoking recipe that turns a water bucket into a bucket, awarding 0.35 experience and taking 100 ticks. It is unlocked by having a water bucket and saved with the mod ID and recipe name.

```java
SimpleCookingRecipeBuilder.smoking(
		Ingredient.of(Items.WATER_BUCKET), // Input
		RecipeCategory.MISC, // Category (MISC for smoking recipes)
		Items.BUCKET, // Output
		0.35f, // Experience
		100 // Cooking Time
)
		.unlockedBy(getHasName(Items.WATER_BUCKET), has(Items.WATER_BUCKET)) // You can specify how this recipe is unlocked here.
		.save(output, ExampleMod.id("water_bucket_to_bucket").toString()); // Then save the recipe with your modid and the recipe name.
```

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

### List of BlockPos data

Source: https://docs.fabricmc.net/develop/serialization/codecs

Example data list of BlockPos objects to be serialized.

```java
List<BlockPos> data = List.of(new BlockPos(10, 5, 7));
```

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

### name and description fields

Source: https://docs.fabricmc.net/develop/loader/fabric-mod-json

Example JSON showing the 'name' and 'description' fields. 'name' defaults to the mod id if not present, and 'description' defaults to an empty string.

```json
"name": "Example Mod",
"description": "This is an example description! Tell everyone what your mod is about!",
```

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

### Method Invoker Usage Example

Source: https://docs.fabricmc.net/develop/mixins/accessors

Usage of the InventoryAccessor to call the hasRemainingSpaceForItem method.

```java
void exampleInstanceMethodInvokerUsage(Inventory inventory, ItemStack slotItemStack, ItemStack newItemStack) {
	if (((InventoryAccessor) inventory).example_mod$hasRemainingSpaceForItem(slotItemStack, newItemStack)) {
		/* ... */
	}
}
```

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

### Handle clientbound engine sound packet with DynamicSoundManager

Source: https://docs.fabricmc.net/develop/sounds/dynamic-sounds

Handles a clientbound packet that starts or stops a dynamic engine sound. Uses DynamicSoundManager to play an EngineSoundInstance when the packet requests start, and ends the playing instance when the packet requests stop. Requires an EngineBlockEntity at the packet's position and a registered CustomSounds.ENGINE_LOOP sound.

```java
private static void handleClientboundEngineSoundPacket(EngineSoundInstancePacket packet, ClientPlayNetworking.Context context) {
	ClientLevel level = context.client().level;
	if (level == null) return;

	DynamicSoundManager soundManager = DynamicSoundManager.getInstance();

	if (level.getBlockEntity(packet.blockEntityPos()) instanceof EngineBlockEntity engineBlockEntity) {
		if (packet.shouldStart()) {
			soundManager.play(new EngineSoundInstance(engineBlockEntity,
					CustomSounds.ENGINE_LOOP, SoundSource.BLOCKS,
					60, 30, 1.2f, 0.8f, 1.4f,
					soundManager)
			);

			return;
		}
	}

	if (!packet.shouldStart()) {
		soundManager.getPlayingSoundInstance(CustomSounds.ENGINE_LOOP).ifPresent(AbstractDynamicSoundInstance::end);
	}
}
```

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

### Define multiple mods with separate classpath groups

Source: https://docs.fabricmc.net/develop/loom/classpath-groups

Use this snippet to define multiple mods, each with its own classpath group. The `example-mod` groups `main` and `client` source sets, while `example-mod-test` groups the `testmod` source set separately.

```gradle
loom {
    mods {
        "example-mod" {
            sourceSet sourceSets.main
            sourceSet sourceSets.client
        }
        "example-mod-test" {
            sourceSet sourceSets.testmod
        }
    }
}
```

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

### Not condition

Source: https://docs.fabricmc.net/develop/resource-conditions

Inverts the load condition specified in 'value'. The example will fail because it inverts 'fabric:true'.

```json
{
  "fabric:load_conditions": [
    {
      "condition": "fabric:not",
      "value": {
        "condition": "fabric:true"
      }
    }
  ]
}
```

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

### Implement quickMoveStack for custom menu

Source: https://docs.fabricmc.net/develop/blocks/workstations

Implements quickMoveStack for a custom menu with two input slots and one result slot. Defines slot index constants and handles shift-clicking from the result slot, inventory, hotbar, and input slots, moving stacks between them. Returns ItemStack.EMPTY when no movement is possible.

```java
private static final int INPUT_SLOTS_COUNT = 2;
private static final int RESULT_SLOT = 0;
private static final int INPUT_SLOTS_START = RESULT_SLOT + 1; // 1
private static final int INPUT_SLOTS_END = INPUT_SLOTS_START + INPUT_SLOTS_COUNT; // 3
private static final int INVENTORY_START = INPUT_SLOTS_END; // 3
private static final int INVENTORY_END = INVENTORY_START + 27; // 30
private static final int HOTBAR_START = INVENTORY_END; // 30
private static final int HOTBAR_END = HOTBAR_START + 9; // 39

@Override
public ItemStack quickMoveStack(Player player, int slotIndex) {
	Slot slot = this.slots.get(slotIndex);

	//noinspection ConstantValue
	if (slot == null || !slot.hasItem()) {
		return ItemStack.EMPTY;
	}

	ItemStack stack = slot.getItem();
	ItemStack clicked = stack.copy();

	if (slotIndex == RESULT_SLOT) {
		stack.getItem().onCraftedBy(stack, player);

		if (!this.moveItemStackTo(stack, INVENTORY_START, HOTBAR_END, true)) {
			return ItemStack.EMPTY;
		}

		slot.onQuickCraft(stack, clicked);
	} else if (slotIndex >= INVENTORY_START && slotIndex < HOTBAR_END) {
		if (!this.moveItemStackTo(stack, INPUT_SLOTS_START, INPUT_SLOTS_END, false)) {
			if (slotIndex < HOTBAR_START) {
				if (!this.moveItemStackTo(stack, HOTBAR_START, HOTBAR_END, false)) {
					return ItemStack.EMPTY;
				}
			} else if (!this.moveItemStackTo(stack, INVENTORY_START, INVENTORY_END, false)) {
				return ItemStack.EMPTY;
			}
		}
	} else if (!this.moveItemStackTo(stack, INVENTORY_START, HOTBAR_END, false)) {
		return ItemStack.EMPTY;
	}

	if (stack.isEmpty()) {
		slot.setByPlayer(ItemStack.EMPTY);
	} else {
		slot.setChanged();
	}

	if (stack.getCount() == clicked.getCount()) {
		return ItemStack.EMPTY;
	}

	slot.onTake(player, stack);

	if (slotIndex == RESULT_SLOT) {
		player.drop(stack, false);
	}

	return clicked;
}
```

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

### Ambient occlusion tag example

Source: https://docs.fabricmc.net/develop/blocks/block-models

Specifies whether to use ambient occlusion. Defaults to true.

```json
{
  "ambientocclusion": "true/false"
}
```

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

### Serialized CountingBean JSON

Source: https://docs.fabricmc.net/develop/serialization/codecs

Example JSON output for a CountingBean, showing the type field and its specific field.

```json
{
  "type": "example-mod:counting_bean",
  "counting_number": 42
}
```

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

### Initialize sounds in mod initializer

Source: https://docs.fabricmc.net/develop/sounds/custom

Shows both the basic inline registration and the cleaner approach using the CustomSounds helper class. The initialize() call registers all custom SoundEvents.

```java
public class ExampleModSounds implements ModInitializer {
	@Override
	public void onInitialize() {
		// This is the basic registering. Use a new class for registering sounds
		// instead, to keep the ModInitializer implementing class clean!
		Registry.register(BuiltInRegistries.SOUND_EVENT, ExampleMod.id("metal_whistle_simple"),
				SoundEvent.createVariableRangeEvent(ExampleMod.id("metal_whistle_simple")));

		// ... the cleaner approach.
		CustomSounds.initialize(); 
	}
}
```

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

### Implement recipe book methods

Source: https://docs.fabricmc.net/develop/recipes/custom-recipe-types

Implements recipeBookCategory, placementInfo, isSpecial, showNotification, and group methods. Returns null for recipeBookCategory and PlacementInfo.NOT_PLACEABLE for placementInfo, and overrides isSpecial to true to prevent recipe-book-related errors.

```java
@Override
public @Nullable RecipeBookCategory recipeBookCategory() {
	return null;
}

@Override
public PlacementInfo placementInfo() {
	return PlacementInfo.NOT_PLACEABLE;
}

@Override
public boolean isSpecial() {
	return true;
}

@Override
public boolean showNotification() {
	return true;
}

@Override
public String group() {
	return "upgrading";
}
```

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

### Serialized StringyBean JSON

Source: https://docs.fabricmc.net/develop/serialization/codecs

Example JSON output for a StringyBean, showing the type field and its specific field.

```json
{
  "type": "example-mod:stringy_bean",
  "stringy_string": "This bean is stringy!"
}
```

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

### JSON representation of CoolBeansClass

Source: https://docs.fabricmc.net/develop/serialization/codecs

Example JSON file that matches the CoolBeansClass fields, using snake_case keys.

```json
{
  "bean_positions": [
    [
      1,
      2,
      3
    ],
    [
      4,
      5,
      6
    ]
  ],
  "bean_type": "example-mod:lightning_tater",
  "beans_amount": 5
}
```

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

### Register brewing recipe with FabricPotionBrewingBuilder.BUILD

Source: https://docs.fabricmc.net/develop/items/potions

Registers a brewing recipe using the FabricPotionBrewingBuilder.BUILD event. addMix takes a starting potion (Potions.WATER), an ingredient item (Items.POTATO), and the output potion (TATER_POTION).

```java
FabricPotionBrewingBuilder.BUILD.register(builder -> {
	builder.addMix(
			// Input potion.
			Potions.WATER,
			// Ingredient
			Items.POTATO,
			// Output potion.
			TATER_POTION
	);
});
```

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

### Create custom SuggestionProvider and use it in a command

Source: https://docs.fabricmc.net/develop/commands/suggestions

Creates a custom SuggestionProvider that suggests online player names, then registers a command using it and handles the execution. The provider reads the CommandSourceStack and uses builder.suggest for each name.

```java
public class PlayerSuggestionProvider implements SuggestionProvider<CommandSourceStack> {
	@Override
	public CompletableFuture<Suggestions> getSuggestions(CommandContext<CommandSourceStack> context, SuggestionsBuilder builder) throws CommandSyntaxException {
		CommandSourceStack source = context.getSource();

		// Thankfully, the ServerCommandSource has a method to get a list of player names.
		Collection<String> playerNames = source.getOnlinePlayerNames();

		// Add all player names to the builder.
		for (String playerName : playerNames) {
			builder.suggest(playerName);
		}

		// Lock the suggestions after we've modified them.
		return builder.buildFuture();
	}
}
```

```java
CommandRegistrationCallback.EVENT.register((dispatcher, registryAccess, environment) -> {
	dispatcher.register(Commands.literal("command_with_custom_suggestions").then(
			Commands.argument("player_name", StringArgumentType.string())
					.suggests(new PlayerSuggestionProvider())
					.executes(ExampleModCommands::executeCommandWithCustomSuggestions)
	));
});
```

```java
private static int executeCommandWithCustomSuggestions(CommandContext<CommandSourceStack> context) {
	String name = StringArgumentType.getString(context, "player_name");
	context.getSource().sendSuccess(() -> Component.literal("Called /command_with_custom_suggestions with value = %s".formatted(name)), false);
	return 1;
}
```
Tokens:
Raw