diff --git a/README.md b/README.md index 7a344bd..f748457 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Stuff not many other plugins do. Dependencies: - **1.21.1 and newer** - [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) -- To use modules marked N, you must use a JAR made precisely for your server version. +- To use modules marked N, you must use a JAR [made for the exact server version.](/Minecon724/tweaks724/src/branch/master/docs/BUILDING.md) # Features diff --git a/docs/BUILDING.md b/docs/BUILDING.md index 91fecbf..7af000f 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -1,10 +1,17 @@ -1. Download BuildTools, move it into an empty directory and open terminal -2. Download Minecraft sources: - ``` - java -jar BuildTools.jar --rev 1.21.4 --remapped - ``` +First, download NMS. There are two ways: -3. Clone this repository: +- Use `tools/download_nms.sh` +- Download BuildTools, move it into an empty directory and run: + ``` + java -jar BuildTools.jar --rev 1.21.4 --remapped + ``` + You must run this for every version you want to build for. + + + +Then build the plugin: + +1. Clone this repository: ``` git clone https://git.m724.eu/Minecon724/tweaks724 cd tweaks724 @@ -13,13 +20,13 @@ ``` git checkout tags/tweaks-0.1.12 ``` -4. To compile for native version: +2. For the "native" version: ``` ./mvnw package ``` - To compile for another version: + For another compatible version: ``` ./mvnw package -Dproject.craftbukkit.version=v1_21_R3 -Dproject.minecraft.version=1.21.4 ``` -5. Look for `tweaks-0.1.12+1.21.4.jar` in `target/` \ No newline at end of file +Look for `tweaks-0.1.12+1.21.4.jar` in `target/` \ No newline at end of file