Skip to content

Developer Documentation

DMP9 edited this page Jan 17, 2017 · 11 revisions

Prison

[User Documentation](User Documentation) [Developer Documentation](Developer Documentation)

Developer documentation

Welcome to the Prison Developer Documentation page. Here you will find useful information on how to develop your own modules for Prison 3.

Pages

  1. Introduction
  2. Create a module
  3. The module manager

Download prison

While it is recommended that you use a release, developers may want to build our Work-In-Progress GitHub repository. To do this, we've made a tool called PrisonBuild (it can be downloaded here).

Usually, the latest Prison commit is automatically built with Jenkins. If the Jenkins build is failing, PrisonBuild will not work!

This tool assumes you have your JAVA_HOME variable set to your JDK location, you have your GRADLE_HOME variable set to your Gradle installation location and that you have git installed and in your path.

Once you've downloaded PrisonBuild, run this command in a new, empty directory that has prisonbuild.jar in it.

java -jar PrisonBuild.jar

This will build the latest commit of Prison, and output it to Spigot.zip and Sponge.zip. Extract the correct archive for the correct platform! Enjoy!

Development build status

API: Build Status Mines: Build Status Ranks: Build Status Cells: Build Status