This is an early work-in-progress wiki dedicated to documenting the methods, tools and APIs of the Fabric project.

Fabric is a modular modding toolchain targetting Minecraft 1.14 and above, including snapshots.

Make sure to check out our community spaces, and read our Community Rules!

• Frequently Asked Questions (from users)
• Frequently Asked Questions (expert mode) - a supplement to the above with more detailed answers

This wiki is also available in the following languages:

Français

简体中文(Simplified Chinese)

If you're willing to use Fabric as a player, server administrator or modpack developers, these articles are for you:

• Installing Fabric
• Installing Fabric using the Minecraft Launcher
• Installing Fabric using MultiMC
• Installing a Minecraft/Fabric Server
• Adding mods
• Updating an existing MultiMC Instance
• Install/Verify Java

Please keep in mind that we recommend using MultiMC and MCUpdater for modpack play and distribution. However, that doesn't stop us from trying to support other solutions!

• Using MCUpdater for Fabric modpacks (covers usage and creation)
• Publishing Fabric modpacks on Technic
• Publishing Fabric modpacks on ATLauncher

• Modpack-related endpoints

If you'd like to start developing with Fabric, here are some articles which might interest you.

• Setting up a development environment
• Enabling Log4j debug messages
• Publishing mods with CurseGradle

• Introduction to Modding with Fabric
• Conventions and Terminology
  • Basic conventions and terminology
  • Server and client side terminology
• Registries
  • Intro to Registries
  • Standard Registries
• Development Tools
  • Third-party library mods
  • Applying changes without restarting Minecraft
• Creating a lang file
• Using mappings
• Adding a crafting recipe

• Adding an item
• Adding an item group
• Adding a tooltip

• Adding a block
• Giving a block state
• Making a directional block
• Adding a BlockEntity
• Storing items in a block as an inventory
• Dynamically change the color of a block or item
• Manipulating a Block's appearance
• Rendering blocks and items dynamically using block entity renderers

• Creating a fluid

• Adding an Entity

• Generating custom ores in the world
• Generating Features
• Generating StructureFeatures
• Using Jigsaws in StructureFeatures
• Adding your structure to /locate
• Adding a Biome
• Dimension Concepts
• Creating a basic dimension

• Adding Armor
• Adding custom enchantments
• Custom Keybindings
• Creating custom events
• Adding items to existing loot tables
• Creating Commands
• Playing Sounds
• Networking
• List of useful tutorials

• Modding Tips
• Updating from Loader 0.3.x to 0.4.x
• Updating Yarn mappings in a Java codebase
• Hotswapping Mixins
• DataFixers [WIP]

• Rendering blocks and items dynamically using block entity renderers
• Manipulating a Block's appearance

• fabric.mod.json
• Mixin library wiki
• Rendering in Fabric (DRAFT)
• Fabric build pipelines (DRAFT)
• Fabric Loader
• Fabric Loom

• Mod environment template
• Fabric API test mods - not a direct tutorial, but may come in handy

If you'd like to contribute to Fabric, you might be interested in these links:

• The Fabric Feature Procedure - or how to get your feature accepted (or not!)
• Fabric on GitHub
• Game mappings repository + contribution documentation

• Updating Yarn to a new Minecraft version - for prospective Yarn developers, not regular users or modders!

• Wiki Meta - Starting point for contributing to the wiki
• Wiki Agenda - See what is on the current agenda, and what other contributors are currently working on.