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

Updated API Documentation (markdown)

NotMyFault 2020-05-10 15:18:51 +02:00
parent ddd649034b
commit 2e355c61fd
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
API-Documentation.md

@ -4,6 +4,22 @@
JavaDocs are available via: https://plotsquared.com/docs/
## Gradle
If you need to access the Bukkit module of PlotSquared, you need to add `PlotSquared-Bukkit` into the `dependencies` block and declare it as non-transitive.
```gradle
repositories {
maven { url = "https://maven.enginehub.org/repo/" } // WorldEdit
maven { url = "https://mvn.intellectualsites.com/content/groups/public/" } // PlotSquared
}
// PlotSquared API
dependencies {
implementation("com.plotsquared:PlotSquared:5.1")
}
```
You can compile PlotSquared with Gradle, which is included with this repository:
$ `gradlew build`
## Maven
If you need to access the Bukkit module of PlotSquared, you need to add `PlotSquared-Bukkit` as `<artifactId>` and declare it as non-transitive.
@ -29,22 +45,6 @@ You need to add the WorldEdit repository as well.
</dependency>
```
## Gradle
If you need to access the Bukkit module of PlotSquared, you need to add `PlotSquared-Bukkit` into the `dependencies` block and declare it as non-transitive.
```gradle
repositories {
maven { url = "https://maven.enginehub.org/repo/" } // WorldEdit
maven { url = "https://mvn.intellectualsites.com/content/groups/public/" } // PlotSquared
}
// PlotSquared API
dependencies {
implementation("com.plotsquared:PlotSquared:5.1")
}
```
You can compile PlotSquared with Gradle, which is included with this repository:
$ `gradlew build`
## Useful classes for PlotSquared
[[PlotAPI|https://github.com/IntellectualSites/PlotSquared/blob/v5/Core/src/main/java/com/plotsquared/core/api/PlotAPI.java]]
[[PlotPlayer|https://github.com/IntellectualSites/PlotSquared/blob/v5/Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java]]