Sueta

MineMe

1.6.1

I was bored, created a mine plugin with GUIs, holograms, etc, still bored

·Plugin

If you have any problem, check the FAQ and Troubleshooting section, if your problem is not solved, post it or send me a PM
Do you want more frequent updates? Well, I have to eat at least once a day, so why don't you help me by donating? :D

MineMe 1.x is discontinued, MineMe 2.0 is on the works!
No, there will not be MineMe 1.7, MineMe 1.7 is MineMe 2.0, that is on the works and is a rewrite from scrath using Kotlin and the Shiroi Framework, which will provide cool support with other 2 new plugins to come

A long time ago, in a galaxy far far away...
There was a guy who always dreamed of the perfect AutomaticMineReset plugin, in which he was not limited by the 90° curse of Minecraft...
Then he suddenly stopped procrastinating and thus, MineMe was born!
Now he's on this journey to make the best AutomaticMineReset plugin, will you assist him in his adventure?
ONLY TIME WILL TELL ~Dramatic Voice~

Features:
Features that are already implemented and ready to use!

  • All the basic mine features: Modifying ore percentage easily, AutoTP out of mines, Mine reset broadcast message, etc
  • Customizable holograms implementation (For now, only HolographicDisplays is supported, but more to come!).
  • Completely customizable messages.
  • Developer Friendly API.
  • Custom World Edit Mine Create. Select a Cuboid Region, create a cuboid mine, select a Cylinder Region, create a circular mine
  • New mine shapes!I'm actually surprised no one did this yet but ooh well, this uses World Edit's API to create different shapes for mines :D Currently available shapes: [Cuboid, Circular, Polygonal]
  • Mine Potion Effects! Add effects to your player when they enter the mine :D
  • MineResetLite conversion!
  • Tag replacement, display stats like broken/remaining blocks, time until next reset, mine volume, etc!
  • MVdWPlaceholderAPI compatible! Placeholders below!.
  • Color Pallete! Change your hole chat color design by changing one letter in predefined colors! (Primary, Secondary, Neutral, Error)
  • 1.9 and 1.8 compatible (1.7 and below not tested, but should be fine).
  • MineEditorGUI (MEGUI): Edit mines via a menu!

Screenshots:

In game





MEGUI (Mine Editor Graphical User Interface)




Installation

Steps
  1. Download WorldEdit (If you haven't already)
  2. Download MineMe
  3. If you wish to use any other extra feature (Holograms/MVdW), download their respective .jar file
  4. Make sure you have Java 1.8 installed, if you don't, install it. No, you can't use java 1.7 or 1.6.
  5. Place the WorldEdit.jar and MineMe.jar (and any other dependency jar) you've downloaded into your plugins folder.
  6. Start your server, the plugin will generate the config files.
  7. ???
  8. Profit.

Permissions:
mineme.admin
... Well...
Yeah
Dependencies:

FAQ and Troubleshooting:
Q: Hey! How do I-
A: Tutorials section, probably what you want to know is there, if it isn't, send me a PM or post in the forum thread and I'll make a tutorial for it

Q: The icon placeholder is giving me a
java.lang.IllegalArgumentException: No enum constant
org.bukkit.Material.(material name here), but the material name is right! I've even checked F3!1!!1eleven!
A: Well, bukkit and minecraft material name's are different, what is called ENDER_EYE in minecraft is called EYE_OF_ENDER in bukkit, why you ask? I don't know, it's just how it is, Here is a list of the Bukkit Materials names, use them :p

Q: Found a bug! What do I do?
A: Post about it here and I'll fix it as soon as I can :)

Q: I get a java.lang.UnsupportedClassVersionError on server startup.
A:

Installation
4. Make sure you have Java 1.8 installed, if you don't, install it. No, you can't use java 1.7 or 1.6.

Completed Features:
These features were in Planned Features and are already completed, so you can use them :D

  • Lifetime Statistics: 100% (Total blocks broken since mine creation) [Done]
  • Circular Mines:100% [Done]
  • MineEditorGUI (MEGUI): 100% Edit mines via a menu! [Done]
  • Polygon Mines: 100% [Done]

Planned Features:
These are features that are being worked on (maybe) and will be added on future updates! :p

  • Multi Cuboid Mines: 50% [WIP]
  • Mine achievements: 50% [WIP] (Completely break mine in less than x minutes, x lifetime broken blocks, etc)
  • Natural-Minor Caves: 0% (Generate Minecraft-like caves inside your mine)
  • Sign support. 0%
  • Optinal random skip-reset chance, as suggested by MildlySerious @ Reddit (Thanks!). 0%
  • PerPlayer Statistics: 0% (Total blocks broken per player since mine creation AND since last reset)

Tags:

Tags for you to use in your configs :D

----- Global tags (Always replaced) -----

  • %prefix% - Replaced by messagePrefix (The one right below)
  • %separator% - Replaced by messageSeparator
  • %header% - Replaced by pluginHeader

----- Mines tags (Will only be replaced on Mine messages) -----

  • %mine% - Replaced by the mine -> NAME <-
  • %alias% - Replaced by the mine -> ALIAS <-
  • %totalresets% = Replaced by the total number of times the mine was reseted
  • %totalminedblocks% = Replaced by the total number of mined blocks since its creation
  • %totalminedblocks% = Replaced by the total number of mined blocks since its creation
  • %volume% - Replaced by the mine's volume
  • %resettime% - The time remaining till next reset
  • %minedblocks% - Replaced by the number of mined blocks
  • %minedblockspercent% - Replaced by the percentage of mined blocks
  • %avgspeed% - The broken blocks of each second
  • %totalpercentage% - The total percentage of all the material
  • %totalmaterials% - The total number of material
  • %remainingblocks% - Replaced by the number of remaining blocks
  • %remainingblockspercent% - Replaced by the percentage of remaining blocks

----- Hologram tags (Will only be replaced on Hologram messages) -----

  • %icon% - Replaced by the icon of the mine (which is given in the config)

Tutorials:

Enabling your first mine!

Ok, so now that you've installed the plugin, now you need to start your server for it to generate the necessary files!
The plugin config has:

  • config.yml
  • messages.yml
  • mines folder

First we need to enable our mine! So open the mines folder and open the examplemine.yml.

enabled: false #<<< Change this
   enabled: true #<<< To this
   #This basically tells the plugin "Hey, load this!"
   #This is initially set to false because the examplemine is set from
   #0,64,0 to 20,84,10 and there could be something built, so I've set it
   #false by default to prevent MineMe from destroy your builds (Based on a true story, you will be missed Cydonia </3)

Now, the first thing we need to do is enabled the mine, so simply search for "enabled" in the config, set it to true, go into minecraft and type: /mineme reload
This basically says to the plugin: "Hey! I've changed a few things back here! Load the configs again!", and the changes you've made will be updated :)
I recommend you to always change settings directly into the config and type /mineme (or mm or mrl or mine (< Any of these will work)) reload, because it's faster and more productive, but if you want to use /mineme edit (mine) (params) hey, be my guest :D

Using holograms

To use holograms, you need to have a hologram plugin installed in your server. For now, the only compatible hologram plugin is HolographicDisplays, but if you use any other plugin and would like me to add it too, just leave a suggestion below :D
To enable HolographicDisplays in MineMe you need to change 2 lines in config.yml.

holograms:
   enableHolograms: false #<<< Change this
   enableHolograms: true #<<< To this

   useHolographicDisplaysAPI: false #<<< And this
   useHolographicDisplaysAPI: true #<<< To this
   #useHolographicDisplaysAPI might already be set to true, in this case, you don't need to do anything :)

Type /mineme reload in the game and if:

  1. An compatible hologram plugin is installed
  2. You have enabled useHolograms in config.yml
  3. You have enabled the compatible hologram plugin API in config.yml

Holograms should appear, :D easy peasy
Each mine has it own way of showing holograms:

  • Cuboid and Circular mines will have one hologram on each side and one on top
  • Polygonal holograms will have one hologram on each point

There are 2 ways the hologram can find the text to display, and those are:

  1. Default hologram text
  2. Custom hologram text

Default hologram text is a list of Strings(Text) found in config.yml

defaultHologramText:
    - '%header%'
    - '%alias%'
    - '$2Mined: $1%minedblocks%$4/$1%volume% $2blocks'
    - '$1%remainingblockspercent%$2% remaining'
    - '&7Stone $2percentage:$1 %composition:STONE%'
    - '&2Emerald $2percentage$1 %composition:EMERALD_ORE%'
    - '&6Gold $2percentage$1 %composition:GOLD_ORE%'
    - '$2Time until next reset: $1%resettime%'
    - '&e&lBanana for scale!'
    - '%header%'

This will be used when either: forceDefaultHologramOnAllMines is set to true in config.yml (Will force all the mines to use the default hologram text), ooooor, useCustomHologramText is set to false in the mine config file (Will only affect the mine itself).
If you want to set a custom hologram text for a particular mine, you need to do this:

  • Set useCustomHologramText to true in the mine's config file
  • Set hologramsText to how you'd like the hologram to look like

So your mine config file should look like this:

#If this mine will use the hologramsText below
#False will use the default text in config.yml
useCustomHologramText: true
#This will only be used in case HolographicDisplays is available and enabled
#in config.yml and useCustomHologramText is enabled AAAAND forceDefaultHologramOnAllMines isn't enabled in config.yml :D
hologramsText:
   - '%alias%'
   - '$1Mined: $2%minedblocks% $1blocks'
   - '$2%remainingblockspercent%$1% remaining'
   - '$3This is a custom hologram text! :D'

Aaaand congratulations! You've successfully installed holograms into your mines! Now go make that P4 :)

Similar projects

Plugin →