PlotSquared
  • README
  • Getting Started
    • Why should you switch to PlotSquared?
    • Installation
  • Features
    • Block Buckets
    • ChestShop Compatibility
    • Commands
    • Plot backups
    • Plot flags
    • Plot membership tiers
    • UUID conversion
    • Vanilla tags
    • WorldEdit & FastAsyncWorldEdit features
  • API
    • API documentation
    • Event API
    • Flag API
  • Configuration
    • General Settings
    • Storage Configuration
    • World Configuration
  • Customization
    • Placeholders
    • Plot component presets
    • Plot components
    • Single plot area
  • Optimization
    • Chunk Processor
    • Plot Analysis
    • World Reduction
  • Permissions
    • Bypass Permissions
    • Permission Packs
  • Schematics
    • Plotworld Road Schematics
    • Schematic export
    • Plot Schematic on Generation
    • Plot Schematic on Claim
Powered by GitBook
On this page
  • Maven & Gradle Examples
  • Gradle - PlotSquared Core
  • Gradle - PlotSquared Core and Bukkit
  • Maven - PlotSquared Core
  • Maven - PlotSquared Core and Bukkit
  • Useful classes for PlotSquared
  • Tutorials
  • Terminology
  • Plot area
  • Clusters
  • Road
  • Plot
Edit on GitHub
  1. API

API documentation

PreviousWorldEdit & FastAsyncWorldEdit featuresNextEvent API

Last updated 23 days ago

Maven & Gradle Examples

  • Javadocs:

  • Major upgrade diff:

Gradle is the recommended when working with the PlotSquared API. Ensure the points to Java 17 or higher.

If you are looking for snapshots, add the repository of S01 OSS Sonatype (https://s01.oss.sonatype.org/) to the repositories' block.

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

If you have made a tutorial, or an addon for PlotSquared, and want us to link it here, please create an issue. We'd really appreciate it!

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.

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.

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.

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: #getPlotAreaByString(...)

See: See:

See: #isPlotRoad(...)

See: #getPlots(...)

intellectualsites.github.io/plotsquared-javadocs
intellectualsites.github.io/plotsquared-api-diff
toolchain
PlotAPI
PlotPlayer
FlagContainer
SchematicHandler
ChunkManager
UUIDPipeline
Flag API
Event API
PlotAreaManager.java
PlotCluster.java
PlotSquared.java
Location.java
PlotArea.java
Getting an instance of PlotSquared