Coral contains a flawless setup wizard to help you create all your public mines with ease. To get started creating your mine you must give yourself a mine wand using /mine givewand <player> and select a cuboid region. You should then run the command /mine create <name> where <name> represents a custom mine id. You will then be provided with a series of prompts in chat to setup your mine, you may cancel this setup process by typing cancel at any point.
The first prompts will ask you for the materials which the mine should contain, please ensure to type these materials in upper case. After specifying a material, you will be prompted to specify the chance in which the material should spawn in the mine. This is chance is percentage based, meaning that if "DIAMOND_BLOCK" is entered followed by "50", then 50% of the mine blocks will be diamond blocks. These two prompts will repeat until you type done. It is important that you ONLY type "done" after specifying the chance of the material added previously, or this material will not load into the mine.
After specifying materials you will then be prompted with a true/false option to add a central hologram into the mine. It is important to note that this is completely separate from the player settings. If you select false for this section the player will NOT be able to see a hologram regardless of the Hologram Visibility setting they have selected in /settings. This hologram is able to be changed in CoralPrisons/modules/mines/mines/<mine>.yml under the hologram: section.
Following on from this, you will be prompted with a true/false option for what method should use to reset. This can be done in two different ways, either by interval or percentage. You will first be prompted with the interval method, where the mine resets every x seconds. If true is selected, you will then be asked to input an interval the mine should reset. Please note that this MUST be in seconds. You will then be prompted with the percentage method, where the mine resets when the mine reaches a specified % of blocks. If true is selected you will be asked to input a percentage for the mine to reset.
Next you will be asked to set a teleport location for this mine, simply make your way over to a block youd like and type confirm. Players will spawn at this location every time they tp to the mine, or the mine resets. Next, you will be asked to enter the priority of the mine, the lower the number the higher the priority. Last but not least, you will be prompted with a true/false option to add a bedrock border, which adds an outer coating of bedrock around the mine. Your mine setup is now complete.
HINT: You may need to run /mine reset <mine> after creation is complete, to resend the chunks!
Mine List
Coral displays all your public mines which you have created in /mines list. This can be used by players to teleport to specific mines. This menu can be edited in CoralPrisons/modules/mines/configs/main.yml. Each mine item shown in this menu can be edited in their respective configs found in CoralPrisons/modules/mines/mines/<mine>.yml under the menu-item section.
Resetting mines
In order to reset a mine run the /mine reset <mine> command, where <mine> represents the mine id.
Configuration Files
lang.yml
messages:"admin-help":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eMines Module" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&7<> = Required" - "&7[] = Optional" - " " - "&e&lCOMMANDS:" - "&e&lā &7/mines create <name>" - "&e&lā &7/mines reset <name>" - "&e&lā &7/mines reload <name>" - "&e&lā &7/mines givewand <player>" - "&e&lā &7/mines list" - " " - "&6&m------------------------------------------""no-permission":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You do not have &cpermission&7 to perform this action.""mine-already-exists":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7This &cmine&7 already exists.""invalid-mine":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7This &cmine&7 does not exist.""no-selection-made":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You must have a &cmine selection&7 to do this.""invalid-chance":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You must specify a &cnumber&7 for a block chance.""invalid-material":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You must specify a valid &cmaterial&7 for a block.""invalid-interval":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You must specify a valid &cnumber&7 for the reset interval.""invalid-priority":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You must specify a valid &cnumber&7 for the mine priority.""invalid-player":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You have specified an &cinvalid&7 player.""wand-given":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7You have given &e%player%&7 a mine wand.""wand-received":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7You have received a &emine wand&7.""first-selection":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7You have selected &eposition #1&7.""second-selection":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7You have selected &eposition #2&7.""add-block-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eAdd Block" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify a &ematerial&7 in chat to add to your new mine's" - "&7list of blocks." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""add-block-chance-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eAdd Chance" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify a &echance&7 in chat for the mine block." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""bedrock-border-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eBedrock Border" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify &etrue&7/&efalse&7 to determine if the mine will" - "&7generate a bedrock border automatically." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""hologram-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eHologram" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify &etrue&7/&efalse&7 to determine if the mine will" - "&7contain a hologram at the center." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""interval-enabled-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eToggle Interval" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify &etrue&7/&efalse&7 to determine if the mine will" - "&7reset based on a timed interval." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""interval-period-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eReset Interval" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify an &einteger&7 to determine how often the mine" - "&7will automatically reset." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""percentage-enabled-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eToggle Percentage" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify &etrue&7/&efalse&7 to determine if the mine will" - "&7reset based on the percentage of blocks left." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""percentage-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eReset Percentage" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify a &enumber&7 to determine what percentage of blocks" - "&7left in the mine will qualify for an automatic reset." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""teleport-location-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eTeleport Location" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Stand where you would like the mine teleport location to" - "&7be set and then type &e'confirm'&7." - " " - "&7&oTip: Type &f&o'confirm'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""priority-prompt":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&6&m------------------------------------------" - " " - "&e&lCoral&6&lPrisons &8&lā &eMine Priority" - "&7&oMade by &f&oRelocation#0001&7&o." - " " - "&e&lDESCRIPTION:" - "&7Specify an &einteger&7 to determine the priority of the mine." - "&7The higher the number the farther it will be in the list." - " " - "&7&oTip: Type &f&o'done'&7&o if you are finished with this part of" - "&7&othe process or type &f&o'cancel'&7&o to cancel the" - "&7&ocreation of your new mine." - " " - "&6&m------------------------------------------""no-blocks-set":sound:enabled:truevalue:"FIZZ"volume:1pitch:1message:enabled:truevalue: - "&c&lCoral&4&lPrisons &8&lā &7You need to set at least &c1 block&7 to complete the mine creation process."
"created-mine":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7You have created the &e%name%&7 mine.""reset-mine":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7You have reset the &e%name%&7 mine. &7(Took %time%ms)"
configs/main.yml
wand-item:enchanted:truematerial:"BLAZE_ROD"name:"&6&l[&e&l!&6&l] &eMine Wand &7(Read)"lore: - " " - "&eInformation" - "&eā &7Left-Click: &fPosition #1" - "&eā &7Right-Click: &fPosition #2" - " " - "&eDescription" - "&7After setting both mine region positions and you are" - "&7satisfied with your selection run the following" - "&7command: &f/mine create <name>&7." - " " - "&7&o(( This is a &f&omine&7&o region selection tool! ))"menus:"mine-list-menu":title:"&8&lMINES"rows:5mine-slots: [10,11,12,13,14,15,16,19,20,21,22,23,24,25,28,29,30,31,32,33,34]borders:"gray":material:"GRAY_STAINED_GLASS_PANE"name:" "lore: []slots: - "0-44""light-gray":material:"LIGHT_GRAY_STAINED_GLASS_PANE"name:" "lore: []slots: - "10-16" - "19-25" - "28-34"next-page-item:slot:41material:"LIME_DYE"name:"&2&l[&a&l!&2&l] &aNext Page &7(Click)"lore: []previous-page-item:slot:39material:"RED_DYE"name:"&4&l[&c&l!&4&l] &cPrevious Page &7(Click)"lore: []current-page-item:slot:40material:"CLOCK"name:"&6&l[&e&l!&6&l] &eCurrent Page: &f&l#%page%"lore: []
configs/settings.yml
command:name:"coralmines"aliases: - "coralmine" - "mine" - "mines" - "abyssmines" - "amine" - "abyssmine" - "amines" - "cmine" - "cmines"mine-selection-preview:enabled:trueparticle:"ORANGE"#Colors such as RED, ORANGE, YELLOW etc are 1.9+ Particles only
mines/ExampleMine.yml
experimental: packet-based-blocks: true # This is an experimental setting - it is only for performance testing, and the roadmap atm.
menu-item:"unlocked":material:"LIME_STAINED_GLASS"name:"&2&l[&a&l!&2&l] &a%mine% Mine &7(Teleport)"lore: - " " - "&aInformation" - "&aā &7Status: &fUnlocked" - " " - "&7&o(( Click to teleport to the &f&o%mine%&7&o mine! ))""locked":material:"RED_STAINED_GLASS"name:"&4&l[&c&l!&4&l] &c%mine% Mine &7(Locked)"lore: - " " - "&cInformation" - "&cā &7Status: &fLocked" - " " - "&7&o(( You must rankup more to &f&ounlock&7&o this mine! ))"teleport-location:"world;0;100;0;0;0"#World, X, Y, Z, Yaw, Pitchbedrock-border: false #Only used if defined when creating the mine, will always make sure there is a bedrock border around the mine.
notification-times: [3,2,1]priority: -1 #Automatically defined, but can be manually defined to re-adjust mine priorities. Higher priorities mean better mines.
interval-reset:enabled:trueperiod:60percentage-reset:enabled:trueperiod:50hologram:enabled:truey-increase:4lines: - "&6&m-------------------------------------" - "" - "&e&l%name% Mine &8&lā &eCoralPrisons" - "&7&oMade by &f&oRelocation#0001&7&o." - "" - "&e&lINFORMATION:" - "&e&lā &7Blocks left: &f%blocks-left%" - "&e&lā &7Time left: &f%time-left%" - "&e&lā &7Percent left: &f%percent-left%%" - "&e&lā &7Progress: &f%bar%" - "" - "&6&m-------------------------------------"region:world:"world"min-x:-50min-y:50min-z:-50max-x:50max-y:150max-z:50packet-region:world:"world"min-x:-100min-y:0min-z:-100max-x:100max-y:255max-z:100blocks: - "DIAMOND_BLOCK;100;0"messages:"reset-notification":sound:enabled:truevalue:"BLOCK_NOTE_PLING"volume:1pitch:1title:enabled:truetitle:"&e&l%time%"sub-title:"""reset":sound:enabled:truevalue:"LEVEL_UP"volume:1pitch:1title:enabled:truetitle:"&a&lRESET COMPLETE"sub-title:""message:enabled:truevalue: - "&e&lCoral&6&lPrisons &8&lā &7The &e%name%&7 Mine has reset."
