/patchwork-api

An attempt to reimplement the Minecraft Forge API on Fabric

Primary LanguageJavaGNU Lesser General Public License v2.1LGPL-2.1

Patchwork

A best-effort reimplementation of the Minecraft Forge API.

How do I use this?

Patchwork is not yet ready for general use. However, if you're ambitious and want to test, we provide prebuilt releases on GitHub. Note that you will need to pass any Forge mods through Patchwork Patcher as well.

While we do not expect most mods to work, bug reports would be appreciated. We also have a list of mods that are known to work in the #modlist channel of our Discord server.

If you know Java and would like to contribute, check out our contribution guide!

Technical details

Patchwork API aims to re-implement the entirety of Minecraft Forge as a set of small and modular Fabric mods. This is in order to run Minecraft Forge mods patched using Patchwork Patcher on Fabric.

However, Patchwork aims not only to simply run Forge mods on Fabric but additionally aims to maintain a superior level of code quality to Forge. We feel the Fabric toolchain is superior to Forge on a technical level, but lacks both the sheer quantity of hooks and features as well as existing mod support. Thus, Patchwork seeks to provide both the benefits of Fabric and the benefits of Forge.

This modular organization is modeled after the organization of Fabric API. This may seem like a confusing decision because Minecraft Forge itself is monolithic, but there are a few good reasons:

  1. Porting. Since each module is a separate compilation unit, it is possible to port individual modules at a time to newer Minecraft versions. Less critical modules can also be disabled until more critical modules have been ported first.
  2. Organization. Modules keep related code together and unrelated code separate. This means that Mixins are located in the same place with code using them. Keeping related code close together makes it easier to reason about the code, and analyze each module in isolation.
  3. It works. The modular organization has already been used by Fabric API to great success.