Skip to content

Usage

Jump to bottom
DaPorkchop_ edited this page Mar 19, 2022 · 4 revisions

Usage

Before I begin, I just want to point out that SaveSearcher is distributed without warranty. If something breaks and your save is corrupted or your computer explodes, don't come yelling at me.

Requirements

SaveSearcher requires that Java 8 is installed on your system (and on your PATH). If you don't have Java, download it here.

Compatibility

SaveSearcher is tested to work with any valid Minecraft (java edition) save from version 1.12.2. It should work with older saves from 1.8 upwards, but is NOT compatible with older formats or worlds last used in 1.13 upwards.

SaveSearcher will also work with modded saves (with Minecraft Forge)! It's been tested on a few worlds running the PepsiPack (a 1.12.2 modpack with around 130 mods) without issue.

Basic Usage

Base command:

java -jar savesearcher.jar

where savesearcher.jar can be replaced by the path to the compiled jar.

Large operations can require significant amounts of RAM, which can be added like this:

java -Xmx2G -XX:+UseG1GC -jar savesearcher.jar

This will run SaveSearcher with 2 gigabytes of RAM, and enables the G1 garbage collector (which can be faster).

Examples

java -jar savesearcher.jar --input=./world/ --output=./result/ --dim=-1 --block,id=minecraft:wool,meta=4

This will search for yellow wool in the nether (dimension -1) of the world at ./world/, and save the coordinates of each block it finds to a CSV file in the result/ directory.

java -jar savesearcher.jar --input=./world/ --output=result/ --format=csv_gz --sign --doublechest --block,id=minecraft:bedrock,min=6 --block,id=minecraft:white_shulker_box --block,id=minecraft:sponge,meta=1 --block,id=buildcraftfactory:pump

This will obtain the following information from the overworld of the world at ./world/ and save all of it to separate, GZIP-compressed CSV files in the result/ directory:

  • The location and contents of every sign (minecraft:sign) in the world
  • The location of every double chest (two neighboring minecraft:chest blocks) in the world
  • The location of every minecraft:bedrock block between (inclusive) y=6 and y=255 in the world
  • The location of every minecraft:white_shulker_box block in the world
  • The location of every minecraft:sponge block with metadata 1 (i.e. a wet sponge) in the world
  • The location of every buildcraftfactory:pump block in the world. Yes, SaveSearcher supports modded worlds!

For more information on the individual modules, simply run SaveSearcher with no arguments or with the --help argument.

Clone this wiki locally