mirrors/Terra
1
0
Fork 0
mirror of https://github.com/PolyhedralDev/Terra.git synced 2026-02-16 02:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README to reflect new changes with build system.

Browse Source 
Signed-off-by: solonovamax <solonovamax@12oclockpoint.com>
This commit is contained in:
solonovamax
2020-11-02 12:20:52 -05:00
parent dc6b619899
commit 6efac08d26
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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!