mirror of
https://github.com/PolyhedralDev/Terra.git
synced 2026-02-16 02:20:57 +00:00
Update README.md
This commit is contained in:
11
README.md
11
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!
|
||||
Reference in New Issue
Block a user