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

Hint:

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

Learn how to contribute to the wiki!

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:

• 简体中文 (Simplified Chinese)
• Français (French)
• Deutsch (German)
• 한국어 (Korean)
• Русский (Russian)
• 日本語 (Japanese)

If you wish to use Fabric as a player, server administrator or modpack developer, these articles are for you:

• Installing Fabric
• Installing Fabric using the Minecraft Launcher (Windows)
• Installing Fabric using MultiMC (Windows)
• Installing Fabric using MultiMC (macOS)
• Installing Fabric using GDLauncher (Windows)
• Installing Fabric using GDLauncher (Linux)
• Installing a Minecraft/Fabric Server
• Installing a Fabric server without a GUI (e.g. Linux)
• Adding mods

• Update in MC Launcher
• Updating an existing MultiMC Instance

• Install/Verify Java (Windows)
• Install/Verify Java (macOS)
• Install/Verify Java (Linux)

• How to post your logs to get help (Win)
• How to post your logs to get help (macOS)

• Multiple Java versions in MultiMC

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
• Dependency Overrides (Loader 0.11.1 or later!)

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

These pages will help you setup a productive development environment and semi-automated releases.

• Setting up a Development Environment
• Enabling Log4j Debug Messages
• Publishing Mods on Modrinth with Minotaur
• Publishing Mods on Curseforge with CurseGradle

These pages are essential must-reads when modding with Fabric, and modding Minecraft in general, if you are new to modding, it is recommended you read the following.

• Introduction to Modding Minecraft in General
• Introduction to Modding with Fabric
• Reading the Minecraft source
• 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

These pages will guide you on the creation of items, such as tools, armor and food. Alongside crafting recipes and enchantments.

• Item Documentation
• Practical Example: Adding an Item
  • Creating an ItemGroup for your items
  • Adding a custom tooltip to your item
• Adding a Crafting Recipe
• Adding Armor
• Adding Tools
• Adding a Shield
• Adding Custom Enchantments
• Adding Model Predicate Providers

These pages will guide you through the creation of blocks, storage of items and data in blocks via block entities, and the creation of models and blockstates.

• Adding a Block
• Giving a Block State
  • Making a Directional Block
  • Make the Block Waterloggable
• 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
  • Rendering Blocks and Items Dynamically using a custom Model
  • Rendering Blocks and Items Dynamically using Block Entity Renderers
• Creating a Container Block
  • Syncing Custom Data with Extended ScreenHandlers
  • Syncing Integers with PropertyDelegates
• Adding a Custom Crop

These pages will guide you through the Fabric Data Generation API, which generates JSON files through data generators.

• Getting started using Data Generation
• Advancements Generation
• Loot Table Generation
• Model Generation
• Tag Generation
• Recipe Generation
• Language File Generation

These pages will guide you through world generation concepts.

• Dimension Concepts
• Generating Custom Ores
• Adding Features
• Adding Trees (Advanced)
• Adding Structure Features
• Adding Biomes
• Custom Chunk Generators (DRAFT)
• Adding World Presets
• Adding Dimensions
  • Creating a Custom Portal

These pages will guide you through Mojang's Brigadier library which allows you to create commands with complex arguments and actions.

• Creating Commands
• Command Exceptions
• Command Suggestions
• Command Redirects
• Command Argument Types
• Command Examples

These pages will guide you through using the many events included in Fabric API, and how to create your own events for you or other mods to use.

• Listening to Events (DRAFT)
• Creating Custom Events
• Adding Items to Existing Loot Tables
• Event Index (DRAFT)

• Adding an Entity
• Adding a Custom Spawn Egg
• Creating a Custom Projectile

• Creating a Fluid

These pages will guide you through the usage of SpongePowered's Mixin library, which is a highly complex topic. We recommend you read these pages thoroughly.

• Introduction
• Mixin registration
• Injects
• Accessors and Invokers
• Redirectors
  • Method redirectors
• Tips
• Examples
• Hotswapping Mixins
• Exporting Mixin Classes
• Access Wideners
• Reflection
• Interface Injection

Some of these pages are currently being written, some may not be available.

• Introduction to RecipeTypes
  • Adding a recipe type (DRAFT)
  • Adding a cooking recipe type
  • Adding a cutting recipe type
• Mining Levels
• Global World Data
  • Persistent States
  • Cardinal Components
• Raycasting
• Custom Keybindings
• Networking
• Status Effects
• Adding a Particle
• Playing Sounds
• Custom Gamerule
• Custom Data/Resource Pack Resources
• Tag Conventions
• List of Useful Tutorials
• Adding Player Statistics
• Modding Tips
• DataFixers [WIP]
• Fluid, Item and Energy Transfer

• Updating Yarn mappings in a Java codebase
• Updating Yarn to a new Minecraft version

• The Fabric Feature Procedure
• FabLabs
• Fabric on GitHub
• Yarn Mappings on GitHub

Looking for old tutorials? They've probably been archived. You can view archived pages here.

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

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

• 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.