Home

CB: Compressed Blocks Wiki

This directory contains player, server, and modpack-author documentation for CB.

Loader-specific configuration

Configuration behavior differs by loader:

• Forge (3.1.0 and newer): Compression settings are controlled through the JSONC catalogs in config/compressedblocks/. The default blocks.jsonc and crates.jsonc files are copied from the mod's bundled resources when they do not already exist. Optional custom entries are loaded from custom_blocks.jsonc and custom_crates.jsonc in the same directory. Forge does not use a separate loader TOML configuration for these settings.
• NeoForge and Fabric: The JSONC catalogs provide the initial defaults for per-entry settings. Saved values in the loader configuration TOML take precedence over those defaults. Changing a JSONC default does not automatically overwrite an existing TOML value.

The JSONC files define entry data on all supported loaders; the loader-specific configuration behavior determines where effective configurable values come from.

Guides

• Adding custom entries - configure custom block and crate definitions.
• Custom resource-pack assets - provide models, blockstates, textures, and recipe data.

Example packs

Warning

Custom entries require both a resource pack and a datapack. The resource pack can be distributed and enabled with the modpack, but the datapack must be loaded by every world using the custom entries.

For modpacks, the datapack should be supplied automatically to newly created worlds using a third-party mod that provides datapacks globally or automatically. Otherwise, users must manually install the datapack into every world they create.

The examples below demonstrate the expected layout:

• Example resource pack - blockstates, models, and language names.
• Example datapack - recipes, loot tables, and tags (advancements are optional).

Custom entry definitions are read at game startup from:

• config/compressedblocks/custom_blocks.jsonc
• config/compressedblocks/custom_crates.jsonc

The built-in defaults are copied from the mod's bundled resources to config/compressedblocks/blocks.jsonc and config/compressedblocks/crates.jsonc when those files do not already exist. These default catalogs are the runtime source of entry definitions on Forge (3.1.0 and newer). On NeoForge and Fabric, they also provide the initial defaults for loader-configurable values.

Custom entries can add new IDs or override built-in entries by using the same ID in the corresponding custom file. Both custom files support single-line comments beginning with //, which can help label or organize entries. For example:

[
  // Blocks from Biomes O' Plenty
  { "id": "bop_white_sand", "kind": "BLOCK" ... }
]

Changes to JSONC files require a restart. On multiplayer servers, install matching definitions and compatible configuration on the server and every client.