mirror of
https://github.com/PaperMC/Waterfall.git
synced 2025-01-13 19:21:50 +01:00
[CI-SKIP] Add plugin developers section in README.md (#556)
Co-authored-by: Mariell <proximyst@proximyst.com>
This commit is contained in:
parent
dd1fbb948b
commit
899d6870d1
38
README.md
38
README.md
@ -24,6 +24,44 @@ Download a copy of Waterfall.jar from our buildserver here: [Waterfall](https://
|
||||
|
||||
Waterfall requires **Java 8** or above.
|
||||
|
||||
## How To (Plugin Developers)
|
||||
------
|
||||
* See our API patches [here](BungeeCord-Patches)
|
||||
* Waterfall API JavaDocs here: [papermc.io/javadocs/waterfall](https://papermc.io/javadocs/waterfall)
|
||||
* Maven repository (for `waterfall-api`):
|
||||
```xml
|
||||
<repository>
|
||||
<id>papermc</id>
|
||||
<url>https://papermc.io/repo/repository/maven-public/</url>
|
||||
</repository>
|
||||
```
|
||||
* Artifact information:
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>io.github.waterfallmc</groupId>
|
||||
<artifactId>waterfall-api</artifactId>
|
||||
<version>1.16-R0.4-SNAPSHOT</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
**Or alternatively, with Gradle:**
|
||||
|
||||
* Repository:
|
||||
```groovy
|
||||
repositories {
|
||||
maven {
|
||||
url 'https://papermc.io/repo/repository/maven-public/'
|
||||
}
|
||||
}
|
||||
```
|
||||
* Artifact:
|
||||
```groovy
|
||||
dependencies {
|
||||
compileOnly 'io.github.waterfallmc:waterfall-api:1.16-R0.4-SNAPSHOT'
|
||||
}
|
||||
```
|
||||
|
||||
## How To (Compiling From Source)
|
||||
|
||||
To compile Waterfall, you need JDK8, git, bash, maven, and an internet connection.
|
||||
|
Loading…
Reference in New Issue
Block a user