update the right readme -_-

This commit is contained in:
dags 2020-06-26 19:53:54 +01:00 committed by GitHub
parent 01798b7cf4
commit d52cf95aa8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions

View File

@ -14,3 +14,27 @@ git clone --recursive https://github.com/TerraForged/TerraForged.git
./gradlew build
```
### Developing With TerraForged's API
##### Dependency
```groovy
repositories {
maven {
url "https://io.terraforged.com/repository/maven/"
}
}
dependencies {
implementation fg.deobf("com.terraforged:TerraForged:1.15.2-0.1.0:api")
}
```
##### 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 dynamically.
See the `com.terraforged.api.TerraEvent` class for the available events.
All events are fired on the `FORGE` event bus.