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)

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.

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

• 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

• Using CrowdinTranslate to provide live community translations
• Using GitHub Actions to find errors in your commits
• Modding Tips
• Updating Yarn mappings in a Java codebase
• DataFixers [WIP]
• Access Wideners
• Reflection
• Adding to Enums
• Interface Injection

• 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

• 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

• Creating a Fluid

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

• Dimension Concepts
• Generating Custom Ores
• Adding Features
• Adding Trees (Advanced)
• Adding Structure Features
• Adding Biomes
• Adding Generator Types
• Adding Dimensions
  • Creating a Custom Portal

• Introduction to RecipeTypes
  • Adding a recipe type (DRAFT)
  • Adding a cooking recipe type
  • Adding a cutting recipe type

• Mining Levels
• Raycasting
• Custom Keybindings
• Creating Commands
• Networking
• Status Effects
• Adding a Particle
• Playing Sounds
• Custom Gamerule
• Custom Data/Resource Pack Resources
• Tag Conventions
• List of Useful Tutorials
• Adding Player Statistics

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

• Introduction
• Mixin registration
• Injects
• Accessors and Invokers
• Redirectors
  • Method redirectors
• Examples
• Hotswapping Mixins
• Exporting Mixin Classes

• Dynamic Recipe Generation
• Dynamic Model Generation

• Using Jigsaws in StructureFeatures

• Rendering blocks and items dynamically using block entity renderers
• Manipulating a Block's appearance
• Adding a Cookie Creeper Entity
• Updating from Loader 0.3.x to 0.4.x

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!)
• FabLabs - a testing ground for drafting new Fabric features before submitting PRs
• Fabric on GitHub
• Game mappings repository + contribution documentation

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

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