Upstream/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-24 12:16:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated API Documentation (markdown)

Alexander Söderberg 2020-04-11 03:18:30 +02:00
parent aa5643490f
commit ed6e16ce14
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
API-Documentation.md

@ -1,6 +1,9 @@
## API Documentation for PlotSquared
Download the PlotSquared v5 jar from Spigot and put it into your `${basedir}` folder when using maven or `libs` folder when using gradle.
If you need to access the bukkit module of PlotSquared, you need to add `PlotSquared-BukkitAPI` as `<artifactId>` and declare it as non-transitive.
**This is v5 only!**
If you need to access the Bukkit module of PlotSquared, you need to add `PlotSquared-Bukkit` as `<artifactId>` and declare it as non-transitive.
You need to add the WorldEdit repository as well.
```xml
<!-- WorldEdit -->
@ -8,29 +11,30 @@ You need to add the WorldEdit repository as well.
<id>enginehub</id>
<url>https://maven.enginehub.org/repo/</url>
</repository>
<repository>
<id>plotsquared</id>
<url>https://plotsquared.com/mvn/</url>
</repository>
<!-- PlotSquared API -->
<dependency>
<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>
<groupId>com.plotsquared</groupId>
<artifactId>PlotSquared</artifactId>
<version>5.1</version> <!-- Or 'latest' -->
</dependency>
```
## 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
repositories {
maven { url = "https://maven.enginehub.org/repo/" } // WorldEdit
flatDir {
dirs("libs")
}
maven { url = "https://plotsquared.com/mvn/" } // PlotSquared
}
// PlotSquared API
dependencies {
"implementation"("name:PlotSquared-Bukkit-5.1")
implementation("com.plotsquared:PlotSquared:5.1")
}
```
You can compile PlotSquared with Gradle, which is included with this repository: