SpawnerRankup

Summary

A utility to view, break and upgrade your existing spawners. Right-clicking on your spawner will bring up a GUI for you to interact with. In this GUI you can: upgrade your spawner's statistics, view your statistics, and break the spawner, leaving a little spawner item on the ground for you to pick up and move, whilst maintaining the spawner's functionality and mob when placed back down.

Commands

Just /spawnerrankup reload to pick back up the config file from where it was last saved, and load the new one into the plugin. Takes effect immediately, but be careful when using this besides for testing, as it can produce some odd results on already upgraded spawners.

To be able to execute this command, you will need to have the spawnerrankup.reload permission.

Permissions

You will need to have spawnerrankup.gui to be able to use the GUI. (default:true)

The plugin also raises/fires the BlockBreakEvent when the spawner is broken, and if the user does not have access to break blocks in the area containing the spawner (for instance, a Factions claimed area, or a PlotMe plot), the block will not be broken.

Specific GUI interaction

There are two clickable items, the Redstone Block to upgrade the spawner in the chunk levels, and the Barrier to break the item.

Hovering over the Redstone Block it will show the current number of upgrades the spawner can have, and the total number of upgrades it currently has. Clicking on it will attempt to upgrade the spawner. It will first check if the spawner is already at maximum level, then (if it isn't), it'll check the XP Levels of the user, and if they don't have (at least) the adamant level of XP, it'll stop there. The XP costs and upgrade tiers and upgrade additions can be defined in the config.

Clicking on the Barrier will break the spawner (if you have the ability to), and spawn an item that holds all of the data of the spawner on it, ready to be placed back down.

Each of the Iron Blocks display information on specific attributes of the spawner, and are not clickable.

Config

This is the (for the meantime) default config (I'm adding more - I promise):

levelups:
  #Number of mobs to ATTEMPT to spawn per activation
  SpawnCount: 2
  #The range in which the spawner will ATTEMPT to spawn
  SpawnRange: 1
  #The minimum delay between spawner activation in ticks
  MinSpawnDelay: -1
  #The maximum delay between spawner activation in ticks
  MaxSpawnDelay: -1
  #The maximum number of nearby entities the spawner can still work with.
  #More than this value of mobs nearby will cause the spawner to skip activations (useful against lag)
  MaxNearbyEntities: 2
  #The range required for a player to activate the spawner in blocks
  RequiredPlayerRange: -1
  #List of level costs. Can only upgrade whilst there is another level in the list
  Costs:
    - 0
    - 50
    - 100
    - 200
    - 300

Footnote

This is explicitly incompatible with SilkSpawners, as SilkSpawners does not preserve the NBT of the spawner, and thus any spawners broken this way will not keep the upgrade level, but will keep the mobtype. You can use SilkSpawners to change the type of the spawner with no issues.

IT'S IN ALPHA This uses NBT-NMS, so I can't account for everything. Please comment on any errors or things that don't work as you expect.