Welcome to the RestApi documentation!





Versions


✅ = Available.
⌛ = Planned.
🚧 = Waiting update.
⚠ = Not recommended.
❌ = Broken/Not working.
🔳 = It wont be available.

= Forge       = Fabric       = Quilt       = NeoForge       = Architectury       = Vanilla

NeoForge is available for 1.20.2 and upper!

Api version 1.19~.2 1.19.3 1.19.4 1.20 1.20.1 1.20.2 1.20.4 1.20.5 1.21
1.0 Release
🔳 ⌛ ⌛ ⌛ ⌛ ⌛ ⌛ ⌛🚧 ⌛🚧
... ... ... ... ... ... ... ... ... ...
0.11 Beta
🔳 ⌛ ⌛ ⌛ ⌛ ⌛🚧 ⌛🚧 ⌛🚧 🔳
0.10.1 Beta
🔳 ✅ ✅ ✅ ✅ ✅🔳 ✅🔳 🔳 🔳
0.10 Beta
🔳 ❌ ❌ ❌ ❌ ❌🔳 ❌🔳 🔳 🔳
0.9 Beta
🔳 ✅ ✅ ✅ ✅ ✅🔳 🔳 🔳 🔳
0.8 Beta
🔳 ✅ ✅ ✅ ✅ ✅ 🔳 🔳 🔳
0.7 Beta
✅ ✅ ⚠ ✅ ✅ ✅ 🔳 🔳 🔳
0.6 Alpha
🔳 🔳 🔳 ✅ 🔳 🔳 🔳 🔳 🔳
0.5 Alpha
🔳 🔳 🔳 ⚠ 🔳 🔳 🔳 🔳 🔳
0.4.1 Beta
🔳 ⚠ ⚠ ⚠ ⚠ ⚠ 🔳 🔳 🔳
0.4 Beta
🔳 🔳 🔳 ❌ ❌ ❌ 🔳 🔳 🔳
0.3 Beta
🔳 🔳 🔳 ⚠ ⚠ ⚠ 🔳 🔳 🔳
0.2 Alpha
🔳 🔳 🔳 ⚠ 🔳 🔳 🔳 🔳 🔳
0.1 Alpha
🔳 🔳 🔳 ⚠ 🔳 🔳 🔳 🔳 🔳

What is this?

Our API for programming mods in Minecraft Java, for Forge, Fabric, Quilt and NeoForge using Architectury, in a much simpler way, without you having to worry about version changes.


Best version

Won't update/port to:


1.19.2 and older 1.20.3
There are too many incompatibilities, and it's tedious to maintain the code for those versions. This version is broken; I don't recommend using it. We can't update because none of the libraries we depend on are available in this version.

Docs

Registries

To be able to register something, you first have to create a registry. For example, if you want to register an item, you'll need to create an item registry.

Register items. Register creative tabs. Register sounds. Register blocks. Register criterion triggers/advancement triggers.
Other

Other types of things you can do with the API.

Util. Ore generation.
Repos using the api.

Here are open repositories that use the API. This way, you can see the examples and learn something about them.

0.7 -> The version of the api used.




Tutorials / Guides

Here are several posts that you can read to learn how to use our API and integrate it correctly:

Get started

Goals

Work in progress
  • 1.20.2 and 1.20.4 support on Quilt.
  • 1.20.5 support on Forge, Fabric, Quilt and NeoForge.
Completed
  • 1.20.4 support.
  • NeoForge support.
  • Quilt support.