Canary

The Canary mod serves as an early warning system for potentially dangerous behavior of other modifications in the game. Modpack developers can use it to identify issues and determine the culprits of emerging errors.

Main Detection Functions

Canary can detect the following types of problems:

• Creation of new entity data serializers
• Unsafe registration of tracked entity data
• Addition of new block state properties to standard game blocks

When any of these problems are detected, the mod intentionally causes the game to crash and precisely indicates which specific mod caused the issue.

Diagnostic Capabilities

The mod also provides additional diagnostic tools:

• When the corresponding setting is activated in the configuration ("print_blockstate_report": true), a detailed report on block states is output to the log
• The /canaryclient diagnoseDesync command generates a comparative report on block states on the client and server

Interesting Fact

The mod's name refers to the real practice of using canaries in coal mines to detect poisonous gases. Similar to its real prototype, if the "canary dies" (the game crashes), a serious problem has been detected.