Upstream/FastAsyncWorldedit
1
0
Fork 0
mirror of https://github.com/boy0001/FastAsyncWorldedit.git synced 2024-09-27 14:42:37 +02:00
Code Issues Projects Releases Wiki Activity

Update Dependency section

Valentin Chassignol 2018-06-23 12:31:38 +02:00
parent 1f8482b3f4
commit ef9db2bfeb
1 changed files with 39 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
API.md

@ -5,11 +5,46 @@ If you need help coding anything, feel free to hop on [IRC](http://webchat.esper
Firstly, FAWE isn't meant to modify the behavior of the WorldEdit API. Existing code should run faster simply by having FAWE installed. Porting code (which is using the WorldEdit API) to work async is as easy as putting it in an async thread (e.g. With the bukkit scheduler).
That said, the FAWE API offers additional functionality not already available in WorldEdit. Below are some examples for WorldEdit and FAWE:
# Dependency
# Maven
Repository: `http://ci.athion.net/job/FastAsyncWorldEdit/ws/mvn/`
Dependency: `com.boydti:fawe-api:<version>` or `com.boydti:fawe-api:latest`
> Note: Add FAWE as a dependency before WorldEdit (e.g. in `pom.xml` or `build.gradle`)
**Repository**: ``http://ci.athion.net/job/FastAsyncWorldEdit/ws/mvn/``
**Dependency**: ``com.boydti:fawe-api:<version>`` or ``com.boydti:fawe-api:latest``
> Note: Add FAWE as a dependency **before** WorldEdit (e.g. in `pom.xml` or `build.gradle`)
## Gradle
```gradle
// Add our custom repository URL
repositories {
// ...
maven {
url 'http://ci.athion.net/job/FastAsyncWorldEdit/ws/mvn/'
}
}
// Add us to your dependencies
dependencies {
// ...
compile 'com.boydti:fawe-api:latest'
}
```
## Maven
```xml
<!-- FAWE repository -->
<repository>
<id>FAWE-repo</id>
<url>http://ci.athion.net/job/FastAsyncWorldEdit/ws/mvn/</url>
</repository>
<!-- FAWE API -->
<dependency>
<groupId>com.boydti</groupId>
<artifactId>fawe-api</artifactId>
<version>latest</version>
</dependency>
```
# Compiling
You can compile FAWE with gradle, which is included with this repository: