Cardinal Components API is an API which is used to attach data to objects to help interact with various parts of the game. This can help make mod creation easier and the mods more compatible. Not only can this be used for new things but you are also able to attach it to vanilla classes to make more changes. Your data will automatically save once implements and there is a helper interface to help with the data. The API by itself is very customisable and lightweight and uses ASM-generated extensions for some of the tweaks. There is a wiki, a GitHub, and lots of Javadoc to help developers use the mod.
For players, the mod does not do anything on the surface, but is required for some mods to run, and pre-bundled in many other mods. Some mods which use Cardinal Components are:
Age of Exile
Anti Mob Farm
Bag of holding
Bosses of Mass Destruction
Dungeons of Exile
Easy Shulker Boxes
Eman’s Dynamic Difficulty
Library of Exile
Public GUI Announcement
Tropicraft: An Unofficial Update
And Many more
Many mods on Fabric or Quilt require Cardinal, but some mods bundle it Jar in Jar or other formats so you do not always need to install it manually.
For developers, the wiki comes with lots of useful information about developing with it, but so far the mod is only for Fabric and its derivatives so you will need to change your code if you also want to work on MC Forge. The mod is commonly used for configs.
Follow the procedures described below to install this mod into your game
- Download and install the Fabric
- Install Fabric API
- Download the mod
- Put the mod into .minecraft/mods folder
- Launch Minecraft