Create README.md

VimeWorld · Dec 7, 2022 · 21ac54a · 21ac54a
1 parent 9940842
commit 21ac54a
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# mc-world-trimmer
+Optimizer for Minecraft 1.8.8 worlds - trim chunks, remove player data, etc.
+
+```
+Usage:
+  mc-world-trimmer [options] path
+Examples:
+  mc-world-trimmer -r -dry .minecraft/saves
+  mc-world-trimmer -r -o .
+  mc-world-trimmer -o world.zip
+Options:
+  -dry
+        Dry run (no changes on disk)
+  -hm
+        Recalculate height maps
+  -lm
+        Compute low maps
+  -o    Overwrite original world
+  -r    Recursive search for worlds
+  -s string
+        Suffix for optimized worlds (default "_opt")
+  -v    Verbose logging
+```