2020-01-16 23:14:14 +01:00
|
|
|
# TerraForged
|
2020-01-19 22:11:57 +01:00
|
|
|
|
2020-03-10 14:29:34 +01:00
|
|
|
TerraForged is a small collection of projects centered around procedurally generated worlds.
|
|
|
|
|
The primary outlet of which is a Forge mod for the popular game Minecraft (Java Edition).
|
2020-02-22 21:55:47 +01:00
|
|
|
|
2020-03-10 14:29:34 +01:00
|
|
|
### Building From Source
|
2020-02-22 21:55:47 +01:00
|
|
|
|
2020-03-10 14:29:34 +01:00
|
|
|
The project relies on Gradle for build and dependency management. In order to compile you need
|
|
|
|
|
to use the maven-publish task, with the mod binary being located under the 'TerraForgedMod'
|
|
|
|
|
sub-project.
|
2020-02-22 21:55:47 +01:00
|
|
|
|
2020-06-26 20:50:49 +02:00
|
|
|
#### Command
|
2020-03-10 14:29:34 +01:00
|
|
|
```shell script
|
|
|
|
|
./gradlew publish
|
|
|
|
|
```
|
2020-03-02 11:02:08 +01:00
|
|
|
|
2020-03-10 14:29:34 +01:00
|
|
|
// TODO - more
|
2020-06-26 20:50:26 +02:00
|
|
|
|
|
|
|
|
### Developing With TerraForged's API
|
|
|
|
|
|
|
|
|
|
##### Dependency
|
|
|
|
|
```groovy
|
|
|
|
|
repositories {
|
|
|
|
|
maven {
|
|
|
|
|
url "https://io.terraforged.com/repository/maven/"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
dependencies {
|
2020-06-26 20:51:52 +02:00
|
|
|
implementation fg.deobf("com.terraforged:TerraForged:1.15.2-0.1.0:api")
|
2020-06-26 20:50:26 +02:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
##### 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.
|
