Metadata-Version: 2.1
Name: mc_trimmer
Version: 0.1.2
Author: Dw4lt
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# MC-Trimmer
Allows for fast, UI-less trimming of minecraft worlds.

## Usage
```sh
mctrimmer [-h] [-b [BACKUP_DIR]] -i INPUT_DIR [-o [OUTPUT_DIR]] [-p [THREADS]] -c {inhabited_time<15s, ...}

Trim a minecraft dimension based on per-chunk criteria. v0.1.0

options:
  -h, --help            Show this help message and exit.
  -b/--backup [BACKUP_DIR]
                        Backup regions affected by trimming to this directory. Defaults to './backup'
  -i/--input-region INPUT_DIR
                        Directory to source the dimension files from. If no output directory is specified, in-place editing will be performed.
  -o/--output-region [OUTPUT_DIR]
                        Directory to store the dimension files to. If unspecified, in-place editing will be performed by taking the input directory instead.
  -p/--parallel [THREADS]
                        Parallelize the task. If no thread count is specified, the number of cpu cores -1 is taken instead.
  -c/--criteria {inhabited_time<15s,inhabited_time<30s,inhabited_time<1m,inhabited_time<2m,inhabited_time<3m,inhabited_time<5m,inhabited_time<10m}
                        Pre-defined criteria by which to determmine if a chunk should be trimmed or not.
```


## Benchmark
Conditions:
```md
OS:                         Windows10 64bit
CPU:                        AMD 3700x
SSD:                        Corsair MP510 2TB
Total file size processed:  1.05 GB
Total output size:          436 MB
Total files:                120 region files, 120 entities files
```

Command being run:
```bat
Measure-Command {mctrimmer -i "./test_in" -o "%appdata%/.minecraft/saves/test" -b "./tests/test_backup" -c "inhabited_time<30s" -p}
```

Results:
```bat
TotalSeconds      : 3.3509565
TotalSeconds      : 4.4760565
TotalSeconds      : 3.3780054
TotalSeconds      : 3.4098966
TotalSeconds      : 4.0146584
TotalSeconds      : 3.7998296
TotalSeconds      : 3.8248743
TotalSeconds      : 3.9705653
```
