This document provides information on how to get started quickly using Prison’s
Documented updated: 2021-12-11
This document covers how to run
/ranks autoConfigure, it’s options, and what to do after the command runs.
Prison’s Auto Configure will perform most of the basic configurations to get you up and running quickly. This feature will perform the following tasks for you:
Create a series of Ranks and Mines that will be named A through Z, for both the mines and the linked ranks. The mines are generated as Virtual Mines.
Link each Mine to it’s associated Rank.
Assign blocks to each mine, starting with the least valuable blocks for Mine A, and then including more valuable blocks until it gets to Mine Z.
Auto Configure now uses a new feature called Access by Rank. This is automatically enabled for Mine Access and Access to TP for the players. Access by Rank eliminates the need to use perms for these access. As a player ranks up, they will gain access to ranks and mines, but all prior ranks and mines will automatically be included.
Auto assign random Mine Liners to each mine.
Auto generate 10 Prestige Ranks and have them enabled by default.
Enable Ladder Base Rank Cost Multiplier for the Prestiges ladder. Once a player prestiges, this will enable a rank cost multiplier that will increase all rank cost. As the player ranks upon the prestiges ladder, the rank costs will increase.
Enable Prison’s Sellall feature and preload the default shop prices with about 98 items and blocks. These defaults settings will allow your players to sell what they mine.
Enable Prison’s Auto Features. This includes, by default, auto pickup, auto smelt, and auto block. It also enables other features such as providing XP for certain blocks, fortune, etc.
Some of the steps involved and which are covered by this document:
Server Requirements and expectations - Quick overview on what you need before you get started.
Starting Up Prison the First Time - Perform a quick sanity check that everything is working.
What the Auto Configure Command Does - A short list of what the command will do. See the Overview above.
Running the command
/ranks autoConfigure - Running the command and what to expect.
Alternative setting to use with the Auto Configure command
Turning Virtual Mines in to Actual Mines - How to set the mine’s locations so they become real.
Other topics that may be helpful but not fully covered in this document:
Setting a Mine’s Spawn Location
Resizing A Mine
Moving A Mine
Changing A Mine’s Liner
Submitting a New Liner Request
Working with Mines within a Void World - Special considerations for resizing, moving, and liners when in a Void World.
Working with Mine’s Permissions
Using Mine Reset Commands
Working with Rank Commands
These listings are to help guide you in planning on what you need. A minecraft server is a deep expression of the owner’s vision and the possibilities are unlimited. Prison provides many more options. As such, what works for one server, may not work for yours. These items provides a starting point of the endless of possibilities. Try them and see what happens.
Prison prints out a lot of detailed information when it starts up. Please review the console to confirm there are no obvious error messages. If there was an issue with prison, and prison is able to detect any issues upon startup, then they will be listed there.
If at any time it appears like there may be something wrong with prison, then please check these startup messages for it may give you a clue as to what is going on.
If at any time you need help with prison, then the first few lines and the list of plugins, with their versions, usually are able to provide a lot of details as to what may be going on.
Please see the short section at the top of this document titled: Overview.
It is strongly suggested to run this command from the console so it will be easier to see the messages and any notifications it may provide.
The current version of Prison’s
/ranks autoConfigure uses Access by Ranks to allow players to use various parts of prison automatically. Two of the major components that are using Access by Rank are
/mines tp and player access to the mines. These accesses are based upon the default rank. A player, through Access by Ranks, has access to all prior ranks too. This new feature of using Rank Associations will only work for mines that are linked to ranks.
The use of Access by Ranks prevents the need for
/ranks autoConfigure to generate any rank commands dealing with permissions. You may need to add them for your own needs.
Critical: It should be noted that the ideal conditions to running this command is without having any mines or ranks previously defined. If any are detected, this command will terminate and will not attempt to perform any actions. You can use the Option force to force the auto configure to run if there are ranks and mines already defined. If you do force it, keep in mind that it will skip over any rank or mine that it would otherwise try to generate. It will not add blocks to existing mines. It will not hook up ranks to mines. Nor will it configure such features as Mine Access Permissions. If you decide to use force you do so at your own risks. That said, it’s easy to delete the
plugins/Prison/ directory and start over (or just rename it).
Almost every command within prison has detailed help, and it can be activated by adding the
help keyword to the end of the command. For example:
/ranks autoConfigure help
Under most circumstances you will not have to choose any options.
Then run the command. It should only take about 5 seconds run and will generate a lot of output.
The server that was created to run this example was using 9 core plugins:
The generated log files can now be found in this document:
Listing the generated ranks on all ladders using the
/ranks list all
Listing the information on Rank A, including the ladder and rank commands.:
/ranks info a all
Using the keyword
all is the same as also running the command:
/ranks command list a
Listing the generated mines:
/mines list all
Review the details of Mine A, including the block listing:
/mines info A all
Generally you would never need to use any of the options. But they do provide for some control during auto configure process.
Default values - [
full price=50000 mult=1.5]
Full - The default for options. This will perform a full auto configure. See the section at the top of the document titled Overview for a list of features and actions performed. Future releases of prison will probably expand upon these.
price=x - The default value for price is 50,000. This set’s the price for the first rank.
mult=x - The default value for the multiplier is 1.5. This is the multiplier that is used calculate the next rank. So if the first rank has an initial cost of 50,000 then the second rank cost is 1.5 times that value. Therefore the second rank will have a cost of 75,000 (50,000 * 1.5).
Force - If any mines or ranks exist, normally it will prevent auto configure from running. Force forces it to run, but with consequences. It will skip over any rank or mine that it would otherwise try to generate. It will not add rank commands to existing ranks. It will not add blocks to existing mines. It will not hook up ranks to mines. Nor will it configure such features as Mine Access Permissions. If you decide to use force you do so at your own risks.
ranks - If specified, it will only generate ranks and not the mines.
mines - If specified, it will only generate mines and not the ranks.
One of the first things that you probably should do first, is to protect your new world. The following are a few commands that will prevent players from breaking blocks outside of the mines, and then the next two will prevent mobs from spawning (optional).
/rg flag -w <world> __global__ passthrough deny /region flag -w <world> __global__ mob-spawning deny /gamerule doMobSpawning false
To convert the virtual mines you need to define mine’s area. There are two primary ways of doing this:
Use your feet - seriously ;)
/mines set area <mineName> feet 20 7
feetidentifies that the coordinates for the location of the mine is based upon your feet location.
This one command actually runs the next two commands automatically:
/mines set size <mineName> wall 20
/mines set size <mineName> bottom 7
/mines set size helpincreases or decreases a mine’s size in the specified direction, for the specified side.
If a void world, you may need to
force the liner. Now would also be a good time to change it if you wish.
/mines set liner ?
/mines set liner <mineName> walls bright force
/mines set liner <mineName> bottom seaEchos force
Note: You can also set the ladder widths. Please use the ‘help’ keyword for more information.
The other method is a little more controlled, and that’s using prison wand to select the two opposite corners, which means you need to have a block to click on. If they don’t exist, then you will need to add them.
/mines set area <mineName>
Prison has an advanced command handler that is able to do a lot of things. One of it’s features is to provide more information on each command that it has registered. To activate this feature, just add the keyword
help to the end of any command. Here are a few examples.
/mines info <mine> help /ranks promote help /ranks command add help /prison support submit /prison utils potionEffect help
help keyword can be used on sub-command listings, which will display the list of commands at that level. The
help keyword is applied automatically for sub-commands and is what actually triggers the command listings.
Stand where you want the mine’s spawn to be, looking in the direction you want them to be facing. Then issue this command:
/mines set spawn <mineName>
If you do not set a spawn location, then players will be teleported to the top-center of the mine. If there is air under their feet, then it will spawn a glass block for them to stand upon to prevent fall damage. If the mine has been significantly mined and there are no blocks around that area, then may fall to their death if they leave that glass block.
Special considerations for resizing, moving, and liners when in a Void World.