diff --git a/README.md b/README.md index 0ca55da41..342364d42 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # Terra Terra is a data-driven world generator based on [Gaea](https://github.com/PolyhedralDev/Gaea). + +## 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. + +**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)** + +## 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! \ No newline at end of file diff --git a/test.sh b/test.sh index 343b0b01f..05a6a213b 100755 --- a/test.sh +++ b/test.sh @@ -1,6 +1,6 @@ DIRECTORY=./target PROJECT=Terra -NAME=Terra +NAME="Terra:DEFAULT" WORLD=world REPO=https://github.com/PolyhedralDev/WorldGenTestServer @@ -44,5 +44,4 @@ java -Xms5G -Xmx5G -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis -XX:+AlwaysPreTouch -XX:G1NewSizePercent=30 -XX:G1MaxNewSizePercent=40 -XX:G1HeapRegionSize=8M -XX:G1ReservePercent=20 -XX:G1HeapWastePercent=5 \ -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=15 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 \ -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 -Dusing.aikars.flags=https://mcflags.emc.gs -Daikars.new.flags=true \ --agentpath:/home/dfsek/YourKit-JavaProfiler-2020.9/bin/linux-x86-64/libyjpagent.so=delay=10000 \ -jar paperclip.jar nogui \ No newline at end of file