From d52cf95aa89ee077014b8d1c962adf67a1e5cd86 Mon Sep 17 00:00:00 2001 From: dags Date: Fri, 26 Jun 2020 19:53:54 +0100 Subject: [PATCH 1/2] update the right readme -_- --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 8f0db38..09ad54e 100644 --- a/README.md +++ b/README.md @@ -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. From f459521667258c98f127c397029a92a01bc82154 Mon Sep 17 00:00:00 2001 From: dags Date: Fri, 26 Jun 2020 19:55:05 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 09ad54e..1b2d19e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The primary outlet of which is a Forge mod for the popular game Minecraft (Java Firstly you must recursively git-clone this repository and its submodules (Engine & FeatureManager). To build the mod jar just use the gradle build task. The jar will output to the `build/libs` directory. -Commands: +#### Commands ```shell script git clone --recursive https://github.com/TerraForged/TerraForged.git @@ -17,7 +17,7 @@ git clone --recursive https://github.com/TerraForged/TerraForged.git ### Developing With TerraForged's API -##### Dependency +#### Dependency ```groovy repositories { maven { @@ -30,7 +30,7 @@ dependencies { } ``` -##### Usage +#### 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.