Skip to main content

​
Installation

Chunker is available in two formats: a desktop application with a graphical interface and a command-line interface (CLI) for advanced users and automation.

​
System Requirements

  • Operating System: Windows, macOS, or Linux
  • Memory: Minimum 4GB RAM (8GB recommended for large worlds)
  • Java: Bundled with the application (no separate installation required)
  • Disk Space: Sufficient space for input and output worlds (worlds can be several GB)
Chunker defaults to using 75% of available memory. For large worlds, ensure you have adequate RAM available.

​
Installing the Desktop App

The desktop application provides an Electron-based frontend for easy world conversion.
1

Download Chunker

Visit the GitHub releases page and download the appropriate version for your operating system:
  • Windows: Chunker-{version}.exe
  • macOS: Chunker-{version}.dmg
  • Linux: Chunker-{version}.AppImage or .deb package
2

Install the Application

Run the .exe installer and follow the installation wizard.
3

Launch Chunker

Open Chunker from your applications menu or desktop shortcut.

​
Customizing Memory Allocation (Desktop App)

By default, Chunker uses 75% of available system memory. You can customize this when launching: 
# Allocate 8GB maximum memory
Chunker.exe -Xmx8G

# Set both minimum and maximum memory
Chunker.exe -Xms4G -Xmx8G
Chunker forwards -Xmx (maximum memory) and -Xms (minimum memory) flags to the Java Virtual Machine. For other JVM options, use --java-options="...".

​
Installing the CLI

The command-line interface is perfect for automation, scripting, and server administrators.
1

Install Java 17 or Higher

Verify your Java installation:
java -version
The output should show Java 17 or higher. If not installed, download from:
2

Download Chunker CLI

Download chunker-cli-{version}.jar from the GitHub releases page.
3

Verify Installation

Test the CLI by running:
java -jar chunker-cli-{version}.jar --version
This should display the Chunker version information.

​
CLI Memory Configuration

For large world conversions, increase the JVM heap size: 
# Allocate 8GB of memory
java -Xmx8G -jar chunker-cli-{version}.jar -i input_world -f BEDROCK_1_20_80 -o output

# Set both minimum and maximum
java -Xms4G -Xmx8G -jar chunker-cli-{version}.jar -i input_world -f BEDROCK_1_20_80 -o output
If you encounter OutOfMemoryError during conversion, increase the heap size with -Xmx flag. Large worlds may require 8GB or more.

​
Building from Source

For developers who want to build Chunker from source:
1

Clone the Repository

git clone https://github.com/HiveGamesOSS/Chunker.git
cd Chunker
2

Build with Gradle

Build the CLI:
./gradlew build
Build the desktop app:
./gradlew :app:build
3

Find the Binaries

  • CLI JAR: build/libs/chunker-cli-{version}.jar
  • Native executables: build/libs/windows/, build/libs/linux/, or build/libs/mac/
  • Desktop app: build/libs/{platform}/
You can skip tests during build by adding -x test to the gradle command.

​
Verifying Your Installation

To verify Chunker is working correctly:
Launch the application. You should see the Chunker interface with options to select input and output directories.

​
Next Steps

Quick Start Guide

Ready to convert your first world? Follow our step-by-step quick start guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us