Skip to content

Repository files navigation

CB: Compressed Blocks

CurseForge Modrinth Discord Paypal WakaTime

Supported Minecraft Versions

Minecraft Version Status
Latest release Supported
1.21.11 Archived since 3.1.0
1.21.2 - 1.21.10 Archived since 2.0.0
1.21.1 Supported
1.20.3 - 1.20.6 EOL · Archived
1.20.1 / .2 Supported
1.14.1 - 1.19.4 EOL · Archived

Important

Backports and Version Requests

Backports and updates for specific Minecraft versions are request-based and are not automatically provided for every release.

If you need CB for a specific Minecraft version, open an issue and specify the required Minecraft version.

Versions without active maintenance may be marked as archived.

Overview

CB: Compressed Blocks adds multi-level compression for blocks and items, reducing the space they occupy in the world and inventory.

  • Compressed blocks: Place compressed variants directly in the world.
  • Item crates: Store compressed items more compactly.
  • Multiple compression levels: Compress variants repeatedly to reach higher levels.
  • Two recipe types: Use 3×3 compression recipes or 2×2 recipes for entries that already have a 3×3 crafting recipe.
  • Decompression: Recover the original blocks and items by reversing the compression process.
  • Extensible compression: Add custom entries for blocks and items, including content from other mods.

A single maximum-level variant can represent up to 3,486,784,401 original blocks or items.

Features

  • Multi-level block and item compression.
  • Placeable compressed blocks and compact item crates.
  • 3×3 and 2×2 compression recipes.
  • Decompression through successive levels.
  • Custom compression entries and resource-pack support.

Image Showcase

View screenshots Compressed Blocks screenshot 1 Compressed Blocks screenshot 2
Compressed Blocks screenshot 3 Compressed Blocks screenshot 4
Compressed Blocks screenshot 5 Compressed Blocks screenshot 6
Compressed Blocks screenshot 7 Compressed Blocks screenshot 8

Installation

  1. Download CB from CurseForge or Modrinth.
  2. Install the appropriate Fabric, Forge, or NeoForge loader for your Minecraft version and install the required dependencies:
  3. Place the downloaded .jar file and required dependencies into your mods folder.
  4. Launch Minecraft.

Make sure the CB version matches both your Minecraft version and mod loader.

Usage

Compressing Blocks and Items

CB provides two compression recipes depending on the item or block being compressed.

Normal Compression

Normal compression uses a 3×3 crafting recipe, combining nine identical blocks or items into one compressed variant.

  1. Place 9 of the same block or item into the crafting grid.
  2. Craft the resulting compressed variant.

The resulting variant can be compressed again to reach the next compression level.

Small Compression

For blocks and items that already have a 3×3 vanilla crafting recipe, CB provides a smaller 2×2 compression recipe.

  1. Place 4 of the same block or item into the crafting grid.
  2. Craft the resulting compressed variant.

This provides a more compact compression recipe while keeping the existing vanilla crafting recipe available.

Decompressing

Compressed variants can be decompressed one level at a time.

  1. Place the compressed block or item crate into the player's crafting inventory or a crafting table.
  2. Retrieve the decompressed variant.
  3. Repeat until the original blocks or items are recovered.

Extensible Compression

CB's compression system is not limited to the built-in catalog. Users and modpack developers can add custom blocks and items by providing the required entry definitions and resources.

Custom entries can introduce new IDs or override existing entries:

  • New ID: Adds a new compression entry.
  • Existing ID: Replaces the corresponding built-in entry.

Custom entries can use resources supplied through a resource pack, allowing CB to support blocks and items from other mods without requiring explicit integration into CB.

See the Wiki for configuration details, required resources, examples, and setup instructions.

Loader-Specific Configuration

Configuration behavior differs between mod loaders.

Forge (3.1.0 or later)

Forge does not use a separate loader configuration file for compression settings. Instead, the JSONC catalogs define the available compression entries and their default settings.

  • config/compressedblocks/blocks.jsonc - Block compression entries.
  • config/compressedblocks/crates.jsonc - Item crate entries.
  • config/compressedblocks/custom_blocks.jsonc - Optional custom block entries.
  • config/compressedblocks/custom_crates.jsonc - Optional custom crate entries.

The default catalogs are copied from the mod's bundled resources when the corresponding configuration files do not exist. Changes to these files control the entries and their settings on Forge.

NeoForge and Fabric (3.1.0 or later)

NeoForge and Fabric use loader configuration files to control configurable compression settings.

The JSONC catalogs provide the initial default values. Once the loader configuration has saved values, those values take precedence over the JSONC defaults.

Changing a JSONC default does not automatically overwrite an existing value in the loader configuration.

Custom entries are defined separately through the JSONC custom-entry files. See the Custom Entries guide for details.

Built-in Blocks and Crates

Browse the built-in compression entries in the Blocks and Crates catalogs.

For custom entries and configuration instructions, see the Wiki.

Contributing

Contributions are welcome. Fork the repository, make your changes, and submit a pull request.

For larger changes, new features, or additional Minecraft version support, consider opening an issue first to discuss the proposed changes.

Support

For bug reports, feature requests, and version requests, open an issue on GitHub.

For questions, general discussion, or community support, join our Discord server.

When requesting a backport or update, specify the exact Minecraft version.

License

This mod is licensed under the MIT License. See the LICENSE file for the full license text.

Releases

Sponsor this project

Used by

Contributors

Languages