New changes (#12)

* Shutdown fast * Change to order of releases * Revert "Shutdown fast" This reverts commit be2ea227718b19b00a0be0e59ec54bb87ffd5ea2. * Remove all shutdown hook, we do not care about generator worlds * Update README.md * Fix typo * Add OS-specific commands * More code improvements * Fix compilation * Add job timeout * Revert "Remove all shutdown hook, we do not care about generator worlds" This reverts commit 44117795360c9d67fab15566e2fc6436bfe9ac6f. * More aggressive server stopping
2023-12-31 23:07:36 +01:00
parent 09fe9f6a2b
commit 0f1c6bdd04
117 changed files with 420 additions and 456 deletions
@@ -1,4 +1,34 @@
-1. Update gradle.properties with the latest values from https://fabricmc.net/develop/
-2. Run `./gradlew build` and fix any errors caused by API changes if any (see https://fabricmc.net/blog/)
-3. Run `./gradlew runServer`
-4. Check the results in `run/minecraft-data`
+# minecraft-data-generator-server
+
+This tool generates minecraft-data files based on a running server using a fabric mod.
+The supported versions can be read in the directory structure.
+Every version has its own directory.
+
+## Usage
+
+You can put any version that has a directory into the command below.
+Just replace `<version>` with the version you want to generate.
+
+For Linux/Mac OS:
+```bash
+./gradlew :<version>:runServer
+```
+
+For Windows:
+```bash
+gradlew.bat :<version>:runServer
+```
+
+You can then find the minecraft-data in the `<version>/run/minecraft-data` directory.
+
+## Adding a new version
+
+To add a new version, you need to create a new directory in the root directory with the version name.
+Then you need to add the version to the list in the `settings.gradle.kts` file.
+Then also add it to the `.github/workflows/build.yml` file.
+Then copy the code of the most recently released version into the new directory.
+Then you need to change the values in the `gradle.properties` file.
+At last, you need to fix all code issues that are caused by the new version.
+For that, use an IDE like IntelliJ IDEA to fix the issues.
+Once everything compiles, you can commit the changes, push them to your fork and create a pull request.
+Once your PR was accepted and merged, the new version will be available in the next release.