Architectury API

Architectury API: A Bridge for Building Multi-Platform Mods

This is an intermediary API designed to simplify the multi-platform mod development process.

What exactly is the Architectury API?

The core purpose of the Architectury API is to function as an interface library designed to abstract calls for both the Fabric API and Forge API. As is well known, although these two major loaders often arrive at the same destination when implementing similar functionality, their underlying code implementations vary significantly. This API was created to bridge these differences and unify the calling interface.

Architectury API maintains a high-frequency update cadence, continuously introducing new hooks and features to adapt to version changes. To date, the library encompasses over 90 event hooks and provides abstraction layers for network packet transmission, loader calls, and game registries. Furthermore, it offers an easy-to-use and powerful @ExpectPlatform annotation (please note that this feature is currently only applicable to static methods), which further simplifies the process of writing cross-platform logic.

Do I absolutely have to use this API?

That depends on your specific needs. It is important to clarify that the Architectury API is just one piece of the vast Architectury ecosystem; the Architectury Plugin (Gradle plugin) is what truly provides multi-platform build capabilities and pulls the strings behind the scenes.

For projects built on the Architectury architecture, this API is actually optional. This means you have the freedom to choose; you can create an Architectury project using only the Architectury Plugin without being forced to depend on this API library.

Advantages of choosing Architectury

• Fully Open Source: A transparent codebase that allows developers to delve deep into research and contributions.
• Streamlined Code: It significantly reduces the lengthy and repetitive "boilerplate code" found in multi-platform mod development, making your code structure cleaner and more efficient.

Starting your multi-platform mod development journey

If you are ready to embark on the journey of multi-platform mod development, the following core components and resources will be your capable assistants:

Architectury Loom This is a fork of Fabric Loom, specially modified and enhanced, dedicated to adding powerful multi-platform development capabilities.

Gradle Plugin This component contains Architectury Injectables, which is the key to achieving the functionality of the @ExpectPlatform annotation and is also the core plugin for the entire build process.

Example Mod This is a repository for an example mod previously built using Architectury. Please be sure to note that this example is currently unmaintained; for the best development experience, it is recommended to prioritize using the mod templates provided below.

Mod Templates This is a collection of ready-made, fully-structured templates designed to help developers start their projects as quickly as possible and become proficient in using the Architectury toolchain.