Skip to content

Commit e436e30

Browse files
authored
Merge pull request #13 from SploonMC/dev
Added information about generated output
2 parents b0e06eb + 297c1ff commit e436e30

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,20 @@ just runs the docker container and pushes the patches to Git.
5757
> java_21_home = ""
5858
> ```
5959
60+
## Output
61+
For each version the program builds, three files are generated:
62+
63+
- **`1.10.2.patch`**: The `bsdiff` binary patch file generated by the tool. This patch can transform a vanilla Minecraft server jar into a Spigot server jar for version `1.10.2`.
64+
- **`1.10.2.json`**: Metadata for the patch file, including information about the patch and the software it applies to. For reference, see the [`1.10.2.json`](https://github.com/SploonMC/patches/blob/master/1.10.2.json) file.
65+
- **`1.10.2.libs`**: A file containing Maven coordinates of libraries required on the classpath for the patched program to run. This may include libraries present in the patch itself. For reference, see the [`1.10.2.libs`](https://github.com/SploonMC/patches/blob/master/1.10.2.libs) file.
66+
67+
For example, if you build version `1.10.2`, the output directory will contain:
68+
```
69+
1.10.2.patch
70+
1.10.2.json
71+
1.10.2.libs
72+
```
73+
6074
## Building
6175
To build this project, you need Cargo and a recent version of Rust from the nightly channel. Building is straightforward, like any other Rust program:
6276
```bash

0 commit comments

Comments
 (0)