Cardinal Components API (Cardinal Components API)

Version 6.3.0:

Updated to 1.25



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.3.0/changelog.md "Changelog")

Version 6.3.0-alpha.1+25w09b:

Updated to 1.25 snapshot (25w09b)

*Note: while this port does not incur breaking changes to the API, it does revamp internals, especially in the scoreboard module.
Please report any issue you may find at https://github.com/Ladysnake/Cardinal-Components-API/issues.*



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.3.0-alpha.1+25w09b/changelog.md "Changelog")

Version 5.3.0:

**Fixes**
- Fixed specific block entities not ticking despite a parent class having a ticking component attached


see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.2.3/changelog.md "Changelog")

Version 6.2.2:

**Fixes**
- Fixed an incompatibility between `cardinal-components-block` and Immersive Portals, which would cause desynchronization issues
for block entities seen through a portal *(thanks daimond113 !)*



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.2.2/changelog.md "Changelog")

Version 6.2.1:

**Fixes**
- Fixed issue in the `cardinal-components-chunk` module causing save failures when no mod actually used said module
- Unfortunately, any chunk in which the damage happened will be reset.
If you have a backup of your world, you should try loading that. Otherwise, I guess this is a reminder that regular backups
are critical, especially when adding new mods or updating across Minecraft versions.
In any case, my apologies for the damage and the delay in fixing the bug.
        ~ Pyrofab

PS: if you never got spammed by red popups saying "failed to save chunk", you are most likely unaffected by the issue.



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.2.1/changelog.md "Changelog")

Version 6.2.0:

Updated to 1.21.3



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.2.0/changelog.md "Changelog")

Version 6.1.2:

**Fixes**
- Fixed clientside chunk Load/Unload triggering respectively `onServerLoad` and `onServerUnload` instead of `onClientLoad`/`onClientUnload`



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.1.2/changelog.md "Changelog")

Version 6.1.1:

**Fixes**
- Fixed `C2SSelfMessagingComponent#sendC2SMessage` mistakenly adding the component ID to the custom data buffer
- Check out the new documentation for this API here: https://ladysnake.org/wiki/cardinal-components-api/modules/entity#client-to-server-networking
- Removed dependency on `com.demonwav.mcdev:annotations` - this should remove some errors in dev environments



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.1.1/changelog.md "Changelog")

Version 6.1.0:

Updated to 1.21



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.1.0/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5/1.20.6

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` module is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules
- Component registration now happens during mod init. This should fix some classloading-related issues, and make loading errors easier to diagnose.
- The internal ASM generation systems have been partially rewritten (thanks lukebemish !)
- All the serialization methods now take an additional registry lookup argument
- [Relevant migration guide](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes#serialization)
- Warning: due to the above change, level components may not be deserialized correctly if a mod calls `LevelProperties.readProperties` instead of `LevelStorage.parseSaveProperties`

**Fixes**
- Missing components (usually caused by removed mods) will no longer trigger a wall of warnings
- The number of warnings logged for each missing component type is configurable

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API
- The deprecated `util` package in `cardinal-components-block` has been removed



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5/1.20.6

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

### Release Candidate 1
**Fixes**
- Fixed respawn copy strategies not being correctly registered for player entities

### Pre-Release 3
**Fixes**
- Missing components (usually caused by removed mods) will no longer trigger a wall of warnings
- The number of warnings logged for each missing component type is configurable

### Pre-Release 2
**Fixes**
- The library no longer requires Loom 1.7-alpha to be used in dev workspaces

### Pre-Release 1
**Changes**
- Component registration now happens during mod init. This should fix some classloading-related issues, and make loading errors easier to diagnose.
- The internal ASM generation systems have been partially rewritten (thanks lukebemish !)

### Beta 3
**Fixes**
- Fixed the most basic binary incompatibilities with mods compiled for beta 1

### Beta 2

**Changes**
- All the serialization methods now take an additional registry lookup argument
- [Relevant migration guide](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes#serialization)
- Warning: due to the above change, level components may not be deserialized correctly if a mod calls `LevelProperties.readProperties` instead of `LevelStorage.parseSaveProperties`

**Removals**
- The deprecated `util` package in `cardinal-components-block` has been removed

### Beta 1

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0-rc1/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5/1.20.6

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

### Pre-Release 2
**Fixes**
- The library no longer requires Loom 1.7-alpha to be used in dev workspaces

### Pre-Release 1
**Changes**
- Component registration now happens during mod init. This should fix some classloading-related issues, and make loading errors easier to diagnose.
- The internal ASM generation systems have been partially rewritten (thanks lukebemish !)

### Beta 3
**Fixes**
- Fixed the most basic binary incompatibilities with mods compiled for beta 1

### Beta 2

**Changes**
- All the serialization methods now take an additional registry lookup argument
- [Relevant migration guide](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes#serialization)
- Warning: due to the above change, level components may not be deserialized correctly if a mod calls `LevelProperties.readProperties` instead of `LevelStorage.parseSaveProperties`

**Removals**
- The deprecated `util` package in `cardinal-components-block` has been removed

### Beta 1

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0-pre2/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5/1.20.6

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

### Pre-Release 1
**Changes**
- Component registration now happens during mod init. This should fix some classloading-related issues, and make loading errors easier to diagnose.
- The internal ASM generation systems have been partially rewritten (thanks lukebemish !)

### Beta 3
**Fixes**
- Fixed the most basic binary incompatibilities with mods compiled for beta 1

### Beta 2

**Changes**
- All the serialization methods now take an additional registry lookup argument
- [Relevant migration guide](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes#serialization)
- Warning: due to the above change, level components may not be deserialized correctly if a mod calls `LevelProperties.readProperties` instead of `LevelStorage.parseSaveProperties`

**Removals**
- The deprecated `util` package in `cardinal-components-block` has been removed

### Beta 1

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0-pre1/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

### Beta 3
**Fixes**
- Fixed the most basic binary incompatibilities with mods compiled for beta 1

### Beta 2

**Changes**
- All the serialization methods now take an additional registry lookup argument
- [Relevant migration guide](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes#serialization)
- Warning: due to the above change, level components may not be deserialized correctly if a mod calls `LevelProperties.readProperties` instead of `LevelStorage.parseSaveProperties`

**Removals**
- The deprecated `util` package in `cardinal-components-block` has been removed

### Beta 1

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0-beta.3/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

### Beta 2

**Changes**
- All the serialization methods now take an additional registry lookup argument
- [Relevant migration guide](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes#serialization)
- Warning: due to the above change, level components may not be deserialized correctly if a mod calls `LevelProperties.readProperties` instead of `LevelStorage.parseSaveProperties`

**Removals**
- The deprecated `util` package in `cardinal-components-block` has been removed

### Beta 1

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0-beta.2/changelog.md "Changelog")

Version 6.0.0:

Updated to 1.20.5

This update introduces multiple breaking changes - a migration guide is available on [the Ladysnake website](https://ladysnake.org/wiki/cardinal-components-api/upgrade-instructions/CCA-6-changes).

**Additions**
- Added `C2SSelfMessagingComponent`, a new experimental utility interface to simplify client-to-server messaging on player components
- Added `WorldComponentRegistry#registerFor` methods, allowing for dimension-specific world components
- Scoreboard and team components now support client ticking

**Changes**
- Migrated all packages from `dev.onyxstudios` to `org.ladysnake`
- Updated documentation and licenses to reflect package change
- `RespawnCopyStrategy` now also applies on mob conversion
- The `cardinal-components-level` is now deprecated, as it is redundant with the `cardinal-components-scoreboard` module
- Mods are encouraged to move to scoreboard components, which serve the same purpose of global data storage and have an API more consistent with other modules

**Removals**
- *Removed item components.* The `cardinal-components-item` module now contains an `ItemComponentMigrationRegistry`, which is used to help you migrate to vanilla components.
- Removed `PlayerCopyCallback` - if you were using it, you can switch to `ServerPlayerEvents.COPY_FROM` from Fabric API



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/6.0.0-beta.1/changelog.md "Changelog")

Version 5.4.0:

Updated to 1.20.3



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/5.4.0/changelog.md "Changelog")

Version 5.3.0:

Updated to 1.20.2

**Additions**
- Added load- and unload-aware components as an experimental feature
- This can be used to implement advanced initialization and cleanup 🧽

**Changes**
- Deprecated the `utils` package in `cardinal-components-block` as it is now virtually unusable



see full changelog [here](https://github.com/Ladysnake/Cardinal-Components-API/blob/5.3.0/changelog.md "Changelog")

Version 5.2.2:

Fixed chunk components being lost during deserialization (thanks to Stuff-Stuffs !)



see full changelog [here](https://github.com//Cardinal Components Api/blob/5.2.2/changelog.md "Changelog")

Version 5.2.1:

Fixed compatibility with full 1.20 release



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.2.1/changelog.md "Changelog")

Version 5.2.0:

Updated to MC 1.20 (Thanks to IMS !)



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.2.0/changelog.md "Changelog")

Version 5.1.0:

Updated to MC 1.19.3



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.1.0/changelog.md "Changelog")

Version 5.0.2:

- Fix world components not synchronizing on load



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.0.2/changelog.md "Changelog")

Version 5.0.1:

**Fixes**
- Fixed components ticking only on subclasses of the block entities they were declared for
(e.g. if a ticking component got attached to ChestBlockEntity, it would only tick on TrappedChestBlockEntity)



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.0.1/changelog.md "Changelog")

Version 5.0.0:

Updated to MC 1.19

**Additions**
- Component providers now expose the `ComponentAccess` interface through Loom's interface injection
- `ComponentAccess` adds `getComponent` as an alternative to `ComponentKey#get`, and `syncComponent` as an alternative to `ComponentKey#sync`
- It is now recommended to use e.g. `entity.getComponent(KEY)` instead of `KEY.get(entity)`, as this enforces type checking



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.0.0/changelog.md "Changelog")

Version 4.2.0:

**Additions**
- Players can now set the `log-deserialization-warnings` option to toggle warnings when a component fails to be resolved
(typically due to mods being removed)

**Mod Compatibility**
- Fixed incompatibility with Immersive Portals



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/4.2.0/changelog.md "Changelog")

Version 5.0.0:

Updated to MC 1.19

**Additions**
- Component providers now expose the `ComponentAccess` interface through Loom's interface injection
- `ComponentAccess` adds `getComponent` as an alternative to `ComponentKey#get`, and `syncComponent` as an alternative to `ComponentKey#sync`
- It is now recommended to use e.g. `entity.getComponent(KEY)` instead of `KEY.get(entity)`, as this enforces type checking



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/5.0.0-beta.1/changelog.md "Changelog")

Version 4.1.4:

Updated to 1.18.2



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/4.1.4/changelog.md "Changelog")

Version 4.1.3:

**Additions**
- Added mod icons

**Fixes**
- Fixed chunk components serialization



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/4.1.3/changelog.md "Changelog")

Version 4.1.1:

**Fixes**
Fixed modded ComponentProvider subclasses (as in, custom entities) on newer loom versions



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/4.1.2/changelog.md "Changelog")

Version 4.1.1:

**Fixes**
Fixed modded ComponentProvider subclasses (as in, custom entities) on newer loom versions



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/4.1.1/changelog.md "Changelog")

Version 4.1.0:

Now available on modrinth!

**Changes**
- **Changed the maven group from `io.github.onyxstudios.Cardinal-Components-API` to `dev.onyxstudios.cardinal-components-api`**

**Fixes**
- Fixed curseforge upload



see full changelog [here](https://github.com/OnyxStudios/Cardinal-Components-API/blob/4.1.0/changelog.md "Changelog")