From 6efac08d265345389bce865ffcaf462abf72f9b3 Mon Sep 17 00:00:00 2001 From: solonovamax Date: Mon, 2 Nov 2020 12:20:52 -0500 Subject: [PATCH] Update README to reflect new changes with build system. Signed-off-by: solonovamax --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45f42c6ea..ef1598182 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,13 @@ Terra is a data-driven world generator based on [Gaea](https://github.com/Polyhe [Spigot page](https://www.spigotmc.org/resources/85151/)! ## Building and running Terra -To run Terra on a test server, clone this repo, package with Maven, then run `test.sh`. The script will clone a test -server skeleton (found [here](https://github.com/PolyhedralDev/WorldGenTestServer)) and set everything up to run. +To build, simply run `./gradlew build` on Linux/MacOS, or `gradlew.bat build` on Windows. +This will produce a jar in `build/libs` called `Terra-[CURRENT VERSION].jar`. +You can put this right into your plugins dir, along with the correct Gaea version. + +If you would like to test it with a default server config, just run `./gradlew testWithPaper` or `gradlew.bat testWithPaper`. +This will download a default server config from [here](https://github.com/PolyhedralDev/WorldGenTestServer) +and install the server in the `target/server` directory, along with all the needed plugins. **Note: You will need to adjust the `NAME` variable in test.sh if you are not using the default Terra config (you may also change the value after server installation, in `bukkit.yml` of the test server)** @@ -12,6 +17,7 @@ also change the value after server installation, in `bukkit.yml` of the test ser ## Contributing Contributions are welcome! If you want to see a feature in Terra, please, open an issue, or implement it yourself and submit a PR! +Join the discord [here](https://discord.gg/PXUEbbF) if you would like to talk more about the project! ## Beta Terra is still in beta! While it is stable, it is not feature-complete. There is a lot to be added! \ No newline at end of file