Cardinal Components API

Version 7.2.0:

Updated to 1.25.10 (thanks TheDeathlyCow!)

see full changelog here

Version 7.1.0-beta.1:

Updated to 1.21.9 snapshot (25w36b)

Thanks to MoriyaShiine for the update !

see full changelog here

Version 7.0.0-beta.1:

Updated to 1.25.6

Changes

• NBT serialization now all goes through the new ReadView and WriteView interfaces

see full changelog here

Version 6.3.1:

Fixes

• Fixed crash in scoreboard module when no mod saved any data using it

see full changelog here

Version 6.3.0:

Updated to 1.25

see full changelog here

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

Version 5.3.0:

Fixes

• Fixed specific block entities not ticking despite a parent class having a ticking component attached

see full changelog here

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

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

Version 6.2.0:

Updated to 1.21.3

see full changelog here

Version 6.1.2:

Fixes

• Fixed clientside chunk Load/Unload triggering respectively onServerLoad and onServerUnload instead of onClientLoad/onClientUnload

see full changelog here

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

Version 6.1.0:

Updated to 1.21

see full changelog here

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.

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
• 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

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.

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
• 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

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.

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
• 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

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.

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
• 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

Version 6.0.0:

Updated to 1.20.5

This update introduces multiple breaking changes - a migration guide is available on the Ladysnake website.

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
• 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

Version 6.0.0:

Updated to 1.20.5

This update introduces multiple breaking changes - a migration guide is available on the Ladysnake website.

Beta 2

Changes

• All the serialization methods now take an additional registry lookup argument
  • Relevant migration guide
• 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

Version 6.0.0:

Updated to 1.20.5

This update introduces multiple breaking changes - a migration guide is available on the Ladysnake website.

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