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

Updated API (markdown)

NotMyFault 2019-07-01 19:08:56 +02:00
parent c682d96c26
commit 38486dd06f
1 changed files with 34 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
API.md

@ -7,31 +7,18 @@ Firstly, FAWE isn't meant to modify the behavior of the WorldEdit API. Existing
That said, the FAWE API offers additional functionality not already available in WorldEdit. Below are some examples for WorldEdit and FAWE:
# Dependency
## Maven:
[1.8 - 1.12.2]
[1.13+]
## 1.12.2 and below (legacy)
## Gradle:
[1.8 - 1.12.2]
[1.13+]
**Repository**: ``http://ci.athion.net/job/FastAsyncWorldEdit/ws/mvn/``
**Dependency**: ``com.boydti:fawe-api:<version>`` or ``com.boydti:fawe-api:latest``
## 1.8 - 1.12.2 (legacy)
> 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
## Maven 1.8 - 1.12.2
```xml
<!-- FAWE legacy repository -->
<repository>
@ -45,31 +32,26 @@ dependencies {
<artifactId>fawe-api</artifactId>
<version>latest</version>
</dependency>
```
## 1.13 and higher
**Repository**: ``https://ci.athion.net/job/FastAsyncWorldEdit-1.13/ws/mvn``
**Dependency**: ``com.boydti:fawe-api:<version>`` or ``com.boydti:fawe-api:latest``
## Gradle
## Gradle 1.8 - 1.12.2
```gradle
// Add our custom repository URL
// FAWE legacy repository
repositories {
// ...
maven {
url 'https://ci.athion.net/job/FastAsyncWorldEdit-1.13/ws/mvn'
}
maven { url 'http://ci.athion.net/job/FastAsyncWorldEdit/ws/mvn/' }
}
// Add us to your dependencies
// FAWE legacy API
dependencies {
// ...
compile 'com.boydti:fawe-api:latest'
}
### Compiling
You can compile FAWE with gradle, which is included with this repository:
```
## Maven
$ gradlew setupDecompWorkspace
$ gradlew build
```
```
## Maven 1.13+
```xml
<!-- FAWE repository -->
<repository>
@ -86,10 +68,22 @@ dependencies {
```
# Compiling
You can compile FAWE with gradle, which is included with this repository:
## Gradle 1.13+
```gradle
// FAWE repository
repositories {
maven { url 'https://ci.athion.net/job/FastAsyncWorldEdit-1.13/ws/mvn'
}
}
// FAWE API
dependencies {
compile 'com.boydti:fawe-api:latest'
}
```
### Compiling
You can compile FAWE with Gradle, which is included with this repository:
```
$ gradlew setupDecompWorkspace
$ gradlew build
```
### Threading