Upstream/FastAsyncWorldedit
1
0
Fork 0
mirror of https://github.com/boy0001/FastAsyncWorldedit.git synced 2024-06-25 22:24:54 +02:00
Code Issues Projects Releases Wiki Activity

Updated API (markdown)

NotMyFault 2019-10-30 17:01:21 +01:00
parent 2ee4fe237d
commit bab063a6a3
1 changed files with 2 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
API.md

@ -6,14 +6,12 @@ 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
# Bukkit Dependency
## Maven:
[1.8 - 1.12.2](https://github.com/boy0001/FastAsyncWorldedit/wiki/API#maven-18---1122)<br>
[1.13+](https://github.com/boy0001/FastAsyncWorldedit/wiki/API#maven-113)
## Gradle:
[1.8 - 1.12.2](https://github.com/boy0001/FastAsyncWorldedit/wiki/API#gradle-18---1122)<br>
[1.13+](https://github.com/boy0001/FastAsyncWorldedit/wiki/API#gradle-113)
## 1.8 - 1.12.2 (legacy)
> Note: Add FAWE as a dependency **before** WorldEdit (e.g. in `pom.xml` or `build.gradle`)
@ -51,41 +49,8 @@ You can compile FAWE with gradle, which is included with this repository:
$ gradlew setupDecompWorkspace
$ gradlew build
```
## Maven 1.13+
```xml
<!-- FAWE repository -->
<repository>
<id>fawe-repo</id>
<url>https://ci.athion.net/job/FastAsyncWorldEdit-Breaking/ws/mvn</url>
</repository>
If you want to access the nukkit api, you need to replace `fawe-api` with `fawe-nukkit` and add it too.
<!-- FAWE API -->
<dependency>
<groupId>com.boydti</groupId>
<artifactId>fawe-api</artifactId>
<version>latest</version>
</dependency>
```
## Gradle 1.13+
```gradle
// FAWE repository
repositories {
maven { url 'https://ci.athion.net/job/FastAsyncWorldEdit-Breaking/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 build
```
## Useful methods for Fawe legacy:
### Threading
- [Performance tips with FAWE](https://github.com/boy0001/FastAsyncWorldedit/wiki/Some-tips-when-using-the-FAWE-API)