From dc52dd635b3e8fe96a4c2eeafcc2b6d491d13c41 Mon Sep 17 00:00:00 2001 From: dfsek Date: Wed, 3 Mar 2021 15:59:26 -0700 Subject: [PATCH] update README.md --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 42b12fcbc..759f27aaf 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ # Terra -Terra is a data-driven world generator based on [Gaea](https://github.com/PolyhedralDev/Gaea). Find out more on our -[Spigot page](https://www.spigotmc.org/resources/85151/)! + +Terra is an incredibly powerful free & open-source data-driven, platform-agnostic world generator. It allows you to create a world exactly +to your specifications, with no knowledge of Java required. + +## Downloads: + +* Paper+ servers (Paper, Tuinity, Purpur, etc): [SpigotMC](https://www.spigotmc.org/resources/85151/) +* Fabric: [Modrinth](https://modrinth.com/mod/terra) / [CurseForge](https://www.curseforge.com/minecraft/mc-mods/terra-world-generator) ## Building and running Terra -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. + +To build, simply run `./gradlew build` (`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 setupServer` or -`./gradlew.bat setupServer` to set up the server, then `./gradlew testWithPaper` or `gradlew.bat testWithPaper` to run -the server. If you want a clean installation of the server, re-run the `setupServer` task. -This will download a default server config from [here](https://github.com/PolyhedralDev/WorldGenTestServer) +`./gradlew.bat setupServer` to set up the server, then `./gradlew testWithPaper` or `gradlew.bat testWithPaper` to run the server. If you +want a clean installation of the server, re-run the `setupServer` task. 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 `bukkit.yml` of the test server if you are not using the default