From 46b62f29a8ae885b191ed0458ace2efacca80467 Mon Sep 17 00:00:00 2001 From: Carson McManus Date: Tue, 27 Sep 2022 19:22:28 -0400 Subject: [PATCH] add readme for extractor (#90) --- extractor/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 extractor/README.md diff --git a/extractor/README.md b/extractor/README.md new file mode 100644 index 0000000..dae5973 --- /dev/null +++ b/extractor/README.md @@ -0,0 +1,15 @@ +# Valence Extractor + +This is a Fabric mod for Minecraft that extracts data about different things in Minecraft, like blocks, packets, etc. All the extracted data is stored in the sibling `extracted` folder. + +### How to use + +Here's how to regenerate the contents of `extracted`. + +From this directory, run the following + +```sh +./gradlew runServer +``` + +This will run the extractor and immediately exit, outputting the files that are listed in the logs. These need to be manually moved to `extracted` to be committed.