BetterJails

Resource in spigotmc.org & dev.bukkit.org

A simple jails system Bukkit plugin aimed for most Minecraft versions.

It lets you manage jails, jail offline players, and sentence time will be over when prisoners have been online for the required time.

Sections

• Commands and permissions
• Configuration
• Sub-commands execution
• Developer API
• Compiling

Commands and permissions

Commands

• /setjail <jail name> / Adds a new jail location where the command is executed.
• /deljail <jail name> / Removes a jail location from the jails list.
• /jails / Prints a list of available jails.
• /jail <player> <jail> <time> / Sends a player to the provided jail, and won't be teleported back until the time provided has passed. Time format must match against this rule: ^(\d{1,10}(\.\d{1,2})?)[yMwdhms]$. If all that sounds like gibberish, you can check here for some random examples of valid times.
• /jail info <player> / Will print out in the chat some information about the jailed player stored in the player data file.
• /unjail <player> / Teleports a jailed player back to where they were when jailed.
• /betterjails / Prints the version of the plugin.
• /betterjails reload / Reloads files into memory.
• /betterjails save / Saves files from memory.

Permissions

All permissions default to operators only unless otherwise noted.

• betterjails.jail / Lets the user execute the /jail command.
• betterjails.jail.exempt / The user with this permission cannot be jailed by others (unless offline, but it runs check when joining).
• betterjails.jails / Lets the user execute the /jails command.
• betterjails.unjail / Lets the user execute the /unjail command.
• betterjails.setjail / Lets the user execute the /setjail command.
• betterjails.deljail / Lets the user execute the /deljail command.
• betterjails.receivebroadcast / Prints in the user's chat when a player has been jailed/unjailed.
• betterjails.betterjails / Lets the user execute the /betterjails command. Permission defaults to true for all users.
• betterjails.betterjails.reload / Lets the user execute the /betterjails reload command.
• betterjails.betterjails.save / Lets the user execute the /betterjails save command.

Configuration

backupLocation: Coordinates of an unjail backup location, just in case the prisoner's last location is found corrupt.

---

offlineTime: Whether the prisoner has to be online for sentence time to count.

Value: Boolean (true or false)

---

changeGroup: Whether the player's group should be changed when jailed.

Requires Vault!

Value: Boolean (true or false)

---

prisonerGroup: If changeGroup is set to true, the group name to which the player should be moved when jailed.

Value: String (group name)

---

autoSaveTimeInMinutes: The time interval in minutes between each time when data files get saved. Set to 0 to disable the autosaving feature.

Value: Integer (a whole number, c'mon...)

---

messages: Various messages that pop up when doing commands.

---

Sub-commands execution

This is pretty straight-forward. All of this is inside subcommands.yml.

The commands under as-prisoner will be executed as if the prisoner performed them, and the ones under as-console will be executed as if they were sent from the console.

All the commands under on-jail will be executed when the player is sent to jail; and the ones under on-release will be executed when the player gets released from jail.

All the commands will only be performed when the player is online. If they are jailed/released while offline, they will be executed when they get online.

Developer API

BetterJails now ships with a developer API! Plugin developers can now interact with B.J., listen to specific events, create jails, release prisoners and much more.

The BetterJails interface is the heart of the API, in there you can access all the other interfaces you need to work with B.J.:

• A PrisonerManager in which you can retrieve prisoners, jail players and release prisoners
• A JailManager in which you can create and delete jails
• An EventBus where you can subscribe (or "listen") to certain events dispatched throughout the functioning of the plugin.

You can get an instance of the BetterJails interface like so:

public class MyPlugin extends JavaPlugin {

  private BetterJails betterJails;

  public BetterJails getBetterJails() {
    return this.betterJails;
  }

  @Override
  public void onEnable() {
    this.betterJails = Bukkit.getServicesManager().load(BetterJails.class);
  }
}

Don't forget to add "BetterJails" as depend/softdepend to your plugin.yml :)

The API is published in OSS Sonatype as it is currently in a snapshot state (and will be for the rest of v1 lifecycle). Importing the BetterJails API to your project depends on how you build your plugin.

Maven

If you are using Maven, you need to add the (new) Sonatype repository to your pom.xml

<repository>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
</repository>

You also need to add the dependency itself that will be pulled from Sonatype

<dependency>
    <groupId>io.github.emilyy-dev</groupId>
    <artifactId>betterjails-api</artifactId>
    <version>1.5-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

Same principle applies if you are using Gradle to build your plugin:

Groovy DSL

repositories {
    maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
}

dependencies {
    compileOnly 'io.github.emilyy-dev:betterjails-api:1.5-SNAPSHOT'
}

Kotlin DSL

repositories {
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}

dependencies {
    compileOnly("io.github.emilyy-dev:betterjails-api:1.5-SNAPSHOT")
}

Manually

If you want to manually add the API dependency to your classpath, you can obtain the jar by downloading it from here.

Compiling

You can compile this plugin by cloning the repository and running ./gradlew build in the root directory of the project, you can find the final jar in ./betterjails/build/libs/betterjails-1.5-SNAPSHOT.jar.