-
Notifications
You must be signed in to change notification settings - Fork 0
Setup Guide
To install Alcatraz, simply drop the JAR into your /plugins folder and restart/reload your server.
No configuration is required for Alcatraz out of the box. If you'd like to modify the default selection item or other values, the configuration file is located in /plugins/Alcatraz/config.yml
If you update the configuration file, be sure to execute the command /alca reload to load the new settings into memory
Once Alcatraz has been installed and is running, you can begin to setup your prison(s). To begin, execute the following setup command: /alca setup [prisonName] where [prisonName] is entirely replaced with your desired prison name.
Assuming all goes well, Alcatraz will then display on screen setup messages instructing you on how to continue setting up the prison.Below is a brief description of the different points Alcatraz will ask you to select:
- First Point - One corner of the perimeter of the prison area.
- Second Point - The opposite point of the perimeter of the prison area
- Start Point - The prison spawn point where new inmates will be sent upon join and where existing inmates can teleport back to
- Return Point - Where players will be sent once they quit playing within a prison
To set each point, move to the desired location and execute the command /alca here
Note: The first and second points should be an area selection, meaning selecting the highest corner point and lowest corner point to define a cube of area. This area is used to check if prisoner's have escaped prison and will render your prison unplayable if you just selected two points on a flat plane.
Once all of the necessary selection points have been made, you should receive a message from Alcatraz notifying you of the successful prison setup. You're now ready to begin setting up cells!
Alcatraz prisons have cells that are assigned an inmate when they join. The number of players a prison can handle is the number of available cells. If there are no more available cells in your prison, no more players will be able to join the prison. There's no limit to the number of cells that a prison can handle. Cells aren't bound by coordinates or anything special, they're simply a component that allows order within the prison. Additionally, cells have signs which automatically update with the inmate assigned to them and will otherwise display "vacant". Cells can also have an unlimited number of signs assigned to them.
After you've setup your prison, you can then begin to add cells. You'll need to add cells before you can begin adding cell signs.
To add a cell to your prison, execute the following command - /alca add [prisonName] cell [cellNumber], replacing [prisonName] with the name of your prison and [cellNumber] with the unique number of the cell
If the cell has been setup successfully, you'll receive a confirmation message.
Cell signs allow you to add an unlimited number of automatically updating signs to a cell. These signs will display the prison name and the current inmate assigned to that cell, if any. It's recommended that you add a cell sign on the inside and outside of every cell, as well as having a big wall in a main area of the prison for players to see who is assigned to what cell.
To add a cell sign, execute the command /alca add [prisonName] sign [cellNumber]. You'll receive a message from Alcatraz prompting you to select the desired sign with the selection tool. Left click on the desired sign and you should receive a confirmation message from Alcatraz that the sign was setup successfully. The sign should automatically update with rich color.
Alcatraz has the ability to integrate with [InSignsPlus] (http://dev.bukkit.org/bukkit-plugins/vault/), a plugin which allows signs to appear differently depending on which player is looking at them. Alcatraz will use special placeholders on signs to show each inmate which cell is theirs a well as other inmate information.
To add an inmate sign, simply add one of the following placeholders (including the {}'s) on any line of a sign in game:
- {player} - Inmate name
- {alcCell} - Inmate cell number
- {alcMoney} - Inmate's current balance
- {alcKills} - Inmate kills
- {alcStrikes} - Inmate strikes
- {alcMinIn} - How long inmate has been in prison
- {alcMinLeft} - How long inmate has until execution
- {alcCostMin} - Cost for additional minutes to prolong execution
- {alcCostStrike} - Cost for 1 strike removal
- {alcOnline} - Number of inmates online in the inmate's prison
Action signs are specialized signs placed throughout prisons which enable inmates to perform specialized actions. These signs are typically well hidden or hard to reach due to their powerful nature.
Loot Signs, when clicked, which attempt to randomly select another inmate to loot. If successful, the inventory of the looted inmate will appear on screen for the looter to access. If the loot fails, the looter can receive strikes automatically from the AI warden.
Raid Signs, when clicked, will teleport all inmates back to the prison spawn and search through all inventories for contraband. If items such as shanks or lock picks are found, they will be removed and strikes will be given to the owner.
To add an inmate sign, setup a blank sign as follows:
- [Alcatraz] - leave as is
- prisonName - replace with the name of your prison
- [action] - replace entire line with either
raidorloot
Join signs display the number of prisoners online / offline and allow players to join the prison upon clicking the sign.
To add a join sign, setup a blank sign as follows:
- [Alcatraz] - leave as is
- prisonName - replace with the name of your prison
- join
There are three types of chests within Alcatraz that enhance the game play experience:
- Food Chest - Automatically regenerated chests with food for inmates to ensure they don't starve
- Random Chest - Automatically regenerated chests that are filled with random items which can be used for combat or crafting
- Reward Chest - Automatically regenerated chests that are filled with highly sought after items, such as shanks, lock picks and poisons.
To add one of these chests to your prison, execute the command /alca add [prisonName] chest [food/random/reward], replacing [prisonName] with the name of your prison and [food/random/reward] with one of the available options. Once you've executed the command, Alcatraz will prompt you to select the chest with the selection tool. Once you've left clicked on the chest, you'll receive a confirmation message from Alcatraz confirming your selection.
Once you've setup your prison, cells, signs and chests - it's now time to begin playing in your prison! Players can execute the command /alc play to receive a list of available prisons to play and /alc play [prisonName], replacing [prisonName] with the desired prison to play.
To leave Alcatraz, execute the command /alc quit