api readme and dep info

This commit is contained in:
dags- 2020-02-26 11:46:04 +00:00
parent dae4689c34
commit 930266af56
1 changed files with 23 additions and 0 deletions

23
TerraForgedAPI/README.md Normal file
View File

@ -0,0 +1,23 @@
# TerraForgedAPI
### Dependency
```groovy
repositories {
maven {
url "https://io.terraforged.com/repository/maven/"
}
}
dependencies {
implementation "com.terraforged:TerraForgedAPI:0.0.1-mc1.15.2:deobf@jar"
}
```
### Usage
TerraForged fires a number of setup events each time its chunk generator is created. These events expose certain
components of the generator allowing for world-gen content to be configured, modified, or added to.
See the `com.terraforged.api.TerraEvent` class for the available events.
All events are fired on the `FORGE` event bus.