AlexandGitHub
b8e0215b2a
* Actually fail unit tests if generation fails * Do not fail fast * Fix 1.8.9 spam * Fix 1.8.9 generation * Fix 1.8.9 generation * Fix entity generation on 4 versions * Fix projectile thrown package * Disable 1.17 recipe generator
47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
# minecraft-data-generator
|
|
|
|
This tool generates minecraft-data files based on a running a server on client classpath 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` 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 module directory.
|
|
Then you need to change the values in the `build.gradle` file.
|
|
At last, you need to fix all code issues that are caused by the new version.
|
|
if there are any new curse, treasure, or non-tradeable, or non-discoverable enchantments in the new version, you need to add them manually to the `EnchantmentsDataGenerator` class.
|
|
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.
|
|
|
|
## Technical info
|
|
|
|
By configuring Unimined (the mod build tool used by this project) to run the server, the server will be started with the client classpath.
|
|
The Minecraft client always contains a copy of the whole server code.
|
|
This is so because the integrated server is always bundled with clients and Mojang has always additionally bundled the dedicated server code within the client code.
|
|
This way we can access client information and classes while running a modded server environment.
|
|
|
|
The `common` module shares common mod logic to allow us to deduplicate similar code across versions.
|