Mappings/README.md

18 lines
723 B
Markdown
Raw Normal View History

2023-03-04 19:01:02 +01:00
# Mappings
2023-03-04 17:41:58 +01:00
2023-03-04 19:01:02 +01:00
Generates and compiles mapping files for Via*. Current mapping files can be found in the `mappings/` directory.
2023-03-04 17:41:58 +01:00
2023-03-04 19:01:02 +01:00
## Generating json mapping files for a Minecraft version
2023-03-04 17:41:58 +01:00
2023-03-04 19:01:02 +01:00
Compile the project using `mvn clean build` and put the jar in some directory, ideally the project root.
Then run the jar with: `java -jar MappingsGenerator.jar <path to server jar> <version>`,
e.g. `java -jar MappingsGenerator.jar server.jar 20w22a`. The mapping file will then be generated in the `mappings/`
directory.
## Compiling json mapping files into compact nbt files
2023-03-04 17:41:58 +01:00
## License
2023-03-04 19:01:02 +01:00
The Java code is licensed under the GNU GPL v3 license. The files under `mappings/` are free to copy, use, and expand
upon in whatever way you like.