undo
This commit is contained in:
parent
4241e9a015
commit
a613e407a3
35
README.md
35
README.md
@ -5,36 +5,13 @@ The primary outlet of which is a Forge mod for the popular game Minecraft (Java
|
||||
|
||||
### Building From Source
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Commands:
|
||||
Command:
|
||||
```shell script
|
||||
git clone --recursive https://github.com/TerraForged/TerraForged.git
|
||||
|
||||
./gradlew build
|
||||
./gradlew publish
|
||||
```
|
||||
|
||||
### 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.
|
||||
// TODO - more
|
||||
|
Loading…
Reference in New Issue
Block a user