Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/querz/worldpruner
A simple GUI and command line app to prune chunks from a Minecraft Java Edition world.
https://github.com/querz/worldpruner
Last synced: about 1 month ago
JSON representation
A simple GUI and command line app to prune chunks from a Minecraft Java Edition world.
- Host: GitHub
- URL: https://github.com/querz/worldpruner
- Owner: Querz
- License: mit
- Created: 2022-05-07T18:19:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-12T08:06:14.000Z (over 2 years ago)
- Last Synced: 2023-08-19T04:10:38.996Z (over 1 year ago)
- Language: Java
- Size: 205 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WorldPruner 
A simple GUI and command line app to prune chunks from a Minecraft Java Edition world.
> Make sure you have a backup of your world!
>
> We are not liable for data loss!
## Prerequisites
- Java 17
## Usage
There are two ways to use this application: *GUI* mode and *CLI* mode.
### GUI Mode
The GUI mode offers an easy way to tweak the different parameters of the application.
To use the GUI, open the `WorldPruner.jar` file with Java.
You simply need to open your world folder with the file chooser, provide a minimum time, a radius and an
optional [whitelist](#whitelisting-chunks) containing all chunks that should be kept in any case.
### CLI Mode
The CLI mode is meant for server owners, to prune their world without needing to download the world first. This mode
allows to operate the application from the command line.
**Command line arguments:**
| Argument(s) | Default Value | Description |
|----------------------------|---------------|--------------------------------------------------------------------------|
| `--world` `-w` | *Required* | The path to the world folder |
| `--time` `-t` | `0 seconds` | The minimum time a chunk should have to be kept |
| `--radius` `-r` | `0` | The radius of additional chunks preserved around matching chunks |
| `--white-list` `-W` | | The path to whitelist CSV file |
| `--continue-on-error` `-c` | | If execution should continue if an error occurs |
| `--white-list-only` `-l` | | Prune everything except the whitelist, requires `--white-list` to be set |
| `--debug` `-d` | | Enables debug logging to the log file, also works for GUI mode |
| `--help` `-h` | | Prints all available commandline options |
**Examples:**
*Prune all chunks that are not older than 1 minute*
```sh
java -jar WorldPruner.jar --world "/path/to/my/world/" --time "1 minute"
```
*Prune all chunks that are not older than 5 minutes, keep a radius of two chunks and continue if an error occurs*
```sh
java -jar WorldPruner.jar --world "/path/to/my/world/" --time "5 minutes" --radius 2 --continue-on-error
```
*Prune all chunks that are not older than 1 day, keep a radius of ten chunks and keep all chunks in the `whitelist.csv`*
```sh
java -jar WorldPruner.jar --world "/path/to/my/world/" --time "1 day" --radius 10 --white-list "/path/to/whitelist.csv"
```
*Print all available commandline options*
```sh
java -jar WorldPruner.jar --help
```
## Whitelisting Chunks
You can create and export a whiltelist from [MCA Selector](https://github.com/Querz/mcaselector).
More information on how to create a whitelist can be found [here](https://github.com/Querz/mcaselector/wiki/Selections#save-and-load-selections).
If you want to create your own whitelist read [this](https://github.com/Querz/mcaselector/wiki/Selections#selection-file-format).