Screenshot 1 of 1. MinecraftHub-generated cover art for Framework: a floating grassy block island with a workshop of crafting tables and furnaces and a chest, under a day sky
What Framework works with.
| Platform | Java Edition |
|---|---|
| Loaders | Fabric, NeoForge, Forge |
| Minecraft versions | 1.18, 1.18.2, 1.19.4, 1.20.6, 1.21.11, 26.1.2, 26.2, 26.3 |
| Environment | Client, Server |
Framework is a Minecraft library mod by MrCrayfish for Fabric, NeoForge and Forge, installed on both client and server. It supplies shared systems for registration and network messages that his other mods rely on. Install it alongside the MrCrayfish mods that use it.
Loaders and versions
- Fabric: Minecraft 1.19.2 to 26.3. The newest build needs no dependencies, optionally Configured and Catalogue.
- NeoForge: Minecraft 1.20.4 to 26.3. The newest build needs no dependencies, optionally Configured and Catalogue.
- Forge: Minecraft 1.18 to 1.21.3. The newest build needs no dependencies, optionally Configured and Catalogue.
What Framework provides
The library exists to ease multi-platform mod development. Beyond registration and networking, it ships three features that mod authors can build on.
- Open Model Format extends vanilla JSON block models. Elements can be rotated to any angle instead of 22.5 degree steps, and they can sit outside the usual bounds of -16 to 32. The page's example is a helicopter model from a vehicle mod.
- Synced Data Keys attach extra data to any entity without a complex capability. The data syncs to clients on its own, can be saved across world reloads and restarts, and can optionally persist through death.
- Easy login packets condense the code Forge needs for login packets into one registration method. Framework then sends the data to clients.
Installing Framework
- 1.Set up the loader your other mods use, following the guide for Fabric or Forge and NeoForge.
- 2.Download the Framework file that matches both your loader and your Minecraft release from CurseForge.
- 3.Place it in the mods folder of your game directory, next to the mod that needs it.
- 4.Put the same file on the dedicated server if you run one, then launch with the loader's profile.
Configured is an optional dependency, and Framework runs without it. Java Edition only, Bedrock cannot load it.
For developers
Framework is hosted on GitHub Packages. To depend on it, add a GitHub username and a personal token with only the read:packages scope to gradle.properties in your Gradle user home, not in the project. Then add the repository and dependencies as the README describes.
Questions about Framework.
4 questions
What is the Framework mod for?
Framework is a library that MrCrayfish's mods share. It handles registration, network messages and extra systems such as Open Model Format, which extends vanilla JSON block models, and Synced Data Keys, which attach data to entities and can sync it to clients automatically. CurseForge describes it as a common library powering all of MrCrayfish's mods.
How do I install Framework?
Install Fabric, NeoForge or Forge for your Minecraft release, then place the matching Framework file in the mods folder of your game directory. Launch with the loader's profile. Choose a file built for the same loader and the same Minecraft release as your other mods.
Does Framework need to be on a multiplayer server?
Yes. Its files are tagged for both client and server, so install it on both sides. Choose the file that matches your loader and Minecraft release, and use the same loader on both sides. The file list on CurseForge shows which loaders and releases each build covers.
Does Framework work on Bedrock Edition?
No. Framework is a Java Edition mod that needs Fabric, NeoForge or Forge, and Bedrock Edition cannot load mods built for those loaders. Bedrock uses a different add-on format, so look for a Bedrock-specific resource instead.
