mirror of
https://github.com/italicsjenga/valence.git
synced 2024-12-23 22:41:30 +11:00
add readme for extractor (#90)
This commit is contained in:
parent
dfce70ef5c
commit
46b62f29a8
15
extractor/README.md
Normal file
15
extractor/README.md
Normal 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.
|
Loading…
Reference in a new issue