Guides
Build a Fabric mod
Use a Fabric mod project for features that need mod APIs, client visuals, or custom controls.
Match the Minecraft version, Fabric loader, and dependencies required by the mod. Players may need to install it in their client as well as on the server.
Decide where the mod runs
Section titled “Decide where the mod runs”| Environment | Describe |
|---|---|
| Client only | Visuals, controls, and whether an unmodified server should work. |
| Server only | Server behavior and what players experience. |
| Client and server | What runs on each side and what players must install. |
A deployment tests server behavior. Test client visuals and controls in a local Fabric game client.
Prepare the specification
Section titled “Prepare the specification”- Select Mod and an available Minecraft version on the home screen.
- Switch to Plan and describe the feature:
Plan a Fabric mod for Minecraft <version> called <name>.It runs on <client / server / both>.The player should be able to <behavior>.It activates when <key press, interaction, command, or event>.Required dependencies: <names and versions, or none>.Explain configuration, installation, and how to test it.Review the plan, including which side needs each dependency.
Build and review
Section titled “Build and review”Choose Implement plan, or switch to Build and request implementation. Wait for completion, inspect the source and mod metadata, then choose Keep all or Undo all.
Save edits and choose Build now to produce a JAR. Read build errors and the available security report.
Test the mod
Section titled “Test the mod”For server behavior, launch a deployment and join with the required Minecraft/Fabric setup. Install the mod in the client too if the feature requires it.
For a client-only mod, download the JAR and test it in a matching Fabric client. Check activation, settings, and interaction with other required mods.
After a fix, rebuild and replace the earlier artifact before retesting. A server deployment cannot verify client-only rendering or input.
Download and install
Section titled “Download and install”Download the successful JAR you tested. Keep its Minecraft, Fabric loader, and dependency requirements with it. Follow installation instructions for the client, server, or both.