README.md

Minecraft World Packager

This tool is used to automatically prepare a Minecraft World for release. This project was inspired by:

• https://github.com/shurik204/map-prepare

Also exists as a github action

Features

• Filter files that you want to keep using glob patterns
• Delete chunks that are considered empty (filled only with air / with no entities / with no poi)
• Zip all datapacks and update the level.dat accordingly
• Zip and add a resourcepack to the world if provided
• Zip additional files (Readme, ...)
• Filter scores and objectives
• Set the level.dat world name

How to use

Download

You can either run the program and follow the instructions or use it as a command:

Usage: mcwpack [WORLD_PATH] [OPTIONS]

Arguments:
  [WORLD_PATH]

Options:
  -z <ZIP_PATH>         Set the output zip
  -d <DIR_PATH>         Set the output directory
  -c <CONFIG_FILE>      Use the given config file
  -v                    Show debug trace
  -q                    Silence warning
  -h, --help            Print help
  -V, --version         Print version

Configuration

More information on the default config.yaml file.

Compiling from source

You need to have cargo installed on your system.

Download the archive or clone the repository:

git clone https://github.com/aksiome/mcwpack.git

Run the following command inside the repository:

cargo build --release

The mcwpack binary should be created inside the target/release directory.

Contributions

Anyone can contribute to this repository. Please do so by posting issues when you've found something that is unexpected or sending a pull request for improvements.