add readme for extractor (#90)

This commit is contained in:
Carson McManus 2022-09-27 19:22:28 -04:00 committed by GitHub
parent dfce70ef5c
commit 46b62f29a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

15
extractor/README.md Normal file
View file

@ -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.