/ShatteredRifts

An immersive location-based teleportation plugin.

Primary LanguageKotlinMIT LicenseMIT


License GitHub Issues GitHub Version Discord Ko-Fi

About

ShatteredRifts is a plugin that can be used to create timed portals around the world, each going to specific locations. These teleport all entities inside of them, making them useful for getting pets around or for creating interesting RPG locations to explore.

For Server Owners

Looking for a development release? You can get it here. Looking for the latest full version? You can get it here. Either way, the file ending in -dist.jar is what you want.

For Developers

Building

Mac/Linux:

git clone https://github.com/ShatteredSuite/ShatteredRifts.git
cd ShatteredRifts
./gradlew publishToMavenLocal

Windows:

git clone https://github.com/ShatteredSuite/ShatteredRifts.git
cd ShatteredRifts
gradlew.bat publishToMavenLocal

In either case, the jars will be produced in build/libs.

Installing

Maven

Add the following to your pom.xml:

<repositories> 
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.ShatteredSuite</groupId>
        <artifactId>ShatteredRifts</artifactId>
        <version>Tag</version>
    </dependency>
</dependencies>

Next, add a dependency in your plugin.yml:

depend:
- ShatteredRifts

Finally, use any of the features you like!

Gradle

Add the following to your build.gradle:

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.ShatteredSuite:ShatteredRifts:Tag'
}

Next, add a dependency in your plugin.yml:

depend:
- ShatteredRifts

Finally, use any of the features you like!

API

Events

RiftTeleportPlayerEvent is called when a player is telepored from a rift. RiftTeleportEntityEvent is called when a non-player entity is teleported from a rift.