Upstream
/
PlotSquared
mirror of https://github.com/IntellectualSites/PlotSquared.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated API Documentation (markdown)

NotMyFault 2020-02-20 18:45:45 +01:00
parent 5f6d022df6
commit beac915ebf
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
API-Documentation.md

@ -1,12 +1,6 @@
## API Documentation for PlotSquared
## Bukkit: Maven 1.13+
If you need to access the bukkit module of PlotSquared, you need to add `PlotSquared-BukkitAPI` as `<artifactId>` and declare it as non-transitive.
```xml
<!-- PlotSquared repository -->
<repository>
<id>plotsquared-repo</id>
<url>https://ci.athion.net/job/PlotSquared-v5-Releases/ws/mvn/</url>
</repository>
<!-- WorldEdit -->
<repository>
<id>enginehub</id>
@ -18,20 +12,24 @@ If you need to access the bukkit module of PlotSquared, you need to add `PlotSqu
<groupId>com.github.intellectualsites.plotsquared</groupId>
<artifactId>PlotSquared-CoreAPI</artifactId>
<version>5.1</version>
<scope>system</scope>
<systemPath>${basedir}/lib/PlotSquared-Bukkit-5.1.jar</systemPath>
</dependency>
```
## Bukkit: Gradle 1.13+
## Bukkit: Gradle
If you need to access the bukkit module of PlotSquared, you need to add `PlotSquared-BukkitAPI` into the `dependencies` block and declare it as non-transitive.
```gradle
// PlotSquared repository
repositories {
maven { url = "https://ci.athion.net/job/PlotSquared-v5-Releases/ws/mvn/" }
maven { url = "https://maven.enginehub.org/repo/" } // WorldEdit
flatDir {
dirs("libs")
}
}
// PlotSquared API
dependencies {
"implementation"("com.github.intellectualsites.plotsquared:PlotSquared-CoreAPI:5.1")
"implementation"("name:PlotSquared-Bukkit-5.1")
}
```
You can compile PlotSquared with Gradle, which is included with this repository: