first commit

README.md

@@ -0,0 +1,28 @@
+# quirky matcher for qm
+
+## setup
+
+In this tutorial our old version will be `1.18` and our new version will be `1.19`.
+
+0. Before you start, make sure you've merged all pull requests marked with `final-comment-period` in the QM repo!
+1. Clone this repo. We'll be calling the folder you cloned it into our `root` folder.
+2. Enter your root folder.
+3. Clone QM with `git clone https://github.com/quiltmc/quilt-mappings` and rename the folder to your old version. For us, this means we'll have a QM clone in a directory named `1.18`.
+4. Repeat, this time naming the folder after your new version.
+5. Open up `save_methods.mjs` and replace the version constants with yours. For our example, this means we'll be replacing `from_version` with `1.18` and `to_version` with `1.19`.
+6. Download the hashed tiny file for your new version from [here](https://maven.quiltmc.org/repository/release/org/quiltmc/hashed/). The file you're looking for should be named something like `hashed-1.19.tiny`. Place the file in your root folder.
+7. Go into your new version clone and update the `MINECRAFT_VERSION` constant in `buildSrc/src/main/java/quilt/internal/Constants.java` to match your current version.
+8. Run `git checkout -b [your new version name]` to create a new branch for the new version. (`git checkout -b 1.19` for us)
+9. Return to your root folder. You're ready to start matching!
+
+## matching
+
+1. In both the old and new clones, run `./gradlew mapPerVersionMappingsJar`.
+2. In the new clone, run `./gradlew dropInvalidMappings`.
+3. Run `git add .` and `git commit -m "[your new version name]"` to commit.
+4. Return to your root folder and run `node save_methods.mjs`.
+5. In the new clone, run `./gradlew dropInvalidMappings` again.
+6. Run `./gradlew generatePackageInfoMappings` to generate new package info files.
+7. Run `./gradlew build javadocJar` to test your build.
+8. Run `git add .` and `git commit -m "match [your new version name] to [your old version name]"` to commit.
+9. Run `git push`, and you're done!