API documentation
Maven & Gradle Examples
Major upgrade diff: intellectualsites.github.io/plotsquared-api-diff
Gradle - PlotSquared Core
If you need to access the Bukkit module of PlotSquared, copy the example below.
repositories {
mavenCentral()
maven("https://repo.papermc.io/repository/maven-public/")
}
dependencies {
implementation(platform("com.intellectualsites.bom:bom-newest:1.52"))
compileOnly("com.intellectualsites.plotsquared:plotsquared-core")
}
Gradle - PlotSquared Core and Bukkit
repositories {
mavenCentral()
maven("https://repo.papermc.io/repository/maven-public/")
}
dependencies {
implementation(platform("com.intellectualsites.bom:bom-newest:1.52"))
compileOnly("com.intellectualsites.plotsquared:plotsquared-core")
compileOnly("com.intellectualsites.plotsquared:plotsquared-bukkit") { isTransitive = false }
}
Maven - PlotSquared Core
<repositories>
<repository>
<id>papermc</id>
<url>https://repo.papermc.io/repository/maven-public/</url>
</repository>
</repositories>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.intellectualsites.bom</groupId>
<artifactId>bom-newest</artifactId>
<version>1.52</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.intellectualsites.plotsquared</groupId>
<artifactId>plotsquared-core</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
Maven - PlotSquared Core and Bukkit
<repositories>
<repository>
<id>papermc</id>
<url>https://repo.papermc.io/repository/maven-public/</url>
</repository>
</repositories>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.intellectualsites.bom</groupId>
<artifactId>bom-newest</artifactId>
<version>1.52</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.intellectualsites.plotsquared</groupId>
<artifactId>plotsquared-core</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.intellectualsites.plotsquared</groupId>
<artifactId>plotsquared-bukkit</artifactId>
<scope>provided</scope>
<exclusions>
<exclusion>
<artifactId>plotsquared-core</artifactId>
<groupId>*</groupId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
Useful classes for PlotSquared
Tutorials
Terminology
Plot area
A plot area is any area that PlotSquared will manage/handle. If this is an infinite plot world, the entire world is considered to be a plot area. If you use plot clusters, then only part of the world will be a plot area, and anything outside this area will not be handled by PlotSquared.
See: PlotAreaManager.java#getPlotAreaByString(...)
Clusters
Clusters can be created within existing plot areas, or they can be created in a previously non-plot world, which will in turn create it's own plot area.
See: PlotCluster.java See: PlotSquared.java
Road
A road is what separates each plot, and includes the wall around each plot. Attempting to get a plot at this location will return null.
See: Location.java#isPlotRoad(...)
Plot
A plot can be claimed or unclaimed. Getting a plot at a location where one isn't claimed will return a new unowned plot object.
See: PlotArea.java#getPlots(...)
Last updated