From 4eac0978ed2437e6c0ae5070ce2d23273b785ce0 Mon Sep 17 00:00:00 2001 From: cyberpwn Date: Mon, 10 Jan 2022 01:20:10 -0500 Subject: [PATCH] Readme stuff --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0800e0fb..84584c781 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,39 @@ For 1.16 and below, see the 1.14-1.16 branch. The master branch is for the lates # [Support](https://discord.gg/3xxPTpT) **|** [Documentation](https://docs.volmit.com/iris/) **|** [Git](https://github.com/IrisDimensions) -## Iris Toolbelt +# Building + +Building Iris is fairly simple, though you will need to setup a few things if your system has never been used for java development. + +Consider supporting our development by buying Iris on spigot! We work hard to make Iris the best it can be for everyone. + + +### Command Line Builds +1. Install [Java JDK 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) +2. Set the JDK installation path to `JAVA_HOME` as an environment variable. + * Windows + 1. Start > Type `env` and press Enter + 2. Advanced > Environment Variables + 3. Under System Variables, click `New...` + 4. Variable Name: `JAVA_HOME` + 5. Variable Value: `C:\Program Files\Java\jdk-17.0.1` (verify this eixsts after installing java dont just copy the example text) + * MacOS + 1. Run `/usr/libexec/java_home -V` and look for Java 17 + 2. Run `sudo nano ~/.zshenv` + 3. Add `export JAVA_HOME=$(/usr/libexec/java_home)` as a new line + 4. Use `CTRL + X`, then Press `Y`, Then `ENTER` + 5. Quit & Reopen Terminal and verify with `echo $JAVA_HOME`. It should print a directory +3. If this is your first time building Iris for MC 1.18+ run `gradlew setup` inside the root Iris project folder. Otherwise skip this step. Grab a coffee, this may take up to 5 minutes depending on your cpu & internet connection. +4. Once the project is setup, run `gradlew iris` +5. The Iris jar will be placed in `Iris/build/Iris-XXX-XXX.jar` Enjoy! Consider supporting us by buying it on spigot! + +### IDE Builds (for development) +* Run `gradlew setup` any time you get dependency issues with craftbukkit +* Configure ITJ Gradle to use JDK 17 (in settings, search for gradle) +* Add a build line in the build.gradle for your own build task to directly compile Iris into your plugins folder if you prefer. +* Resync the project & run your newly created task (under the development folder in gradle tasks!) + +# Iris Toolbelt Everyone needs a toolbelt.