SilkSpawners (Versions 1.8.8 - 1.26.2)

SilkSpawners

If you use a pickaxe with the silk touch enchantment while breaking a spawner, you will receive the spawner you broke. When placing the spawner again, the spawner will spawn the mob it spawned when breaking it.
Compatible with Paper, Spigot, Purpur, Bukkit and Folia servers.

QuickStart

Want to use SilkSpawners without configuring permissions or anything else? Install the plugin and run this command as an admin or from the console, then confirm as prompted:

/silkspawners setup

Commands

• /silkspawners help [command]
• /silkspawners give <player> <entity> [amount]
• /silkspawners set <entity>
• /silkspawners explosion <enable/disable/setting> <player>
• /silkspawners locale <setting/reload/restore>
• /silkspawners config <reload/get/set> [setting] [value]
• /silkspawners config explosion <list/add/remove> [all/normal/silktouch] [values]
• /silkspawners setup [confirm/revert]
• /silkspawners entities
• /silkspawners version
• /silkspawners dump

Permissions

Commands

silkspawners.command.give - Use this command to give spawners to players.

In addition, set silkspawners.command.give.* to allow all entities or replace the star with an entity name.

silkspawners.command.set - Use this command to change already placed spawners.

In addition, set silkspawners.command.set.* to allow all entities or replace the star with an entity name.

silkspawners.command.explosion - Use this command to temporarily enable or disable spawner explosions for a specific player.
silkspawners.command.locale - Use this command to reload and restore locale files.
silkspawners.command.config - Use this command to view and reload the configuration, including the explosion tiers. In addition, set silkspawners.command.config.set to allow changing settings and explosion tiers.
silkspawners.command.setup - Use this command to disable or restore the permissions needed to use spawners.
silkspawners.command.entities - Use this command to see the entities you can use in permissions and commands.
silkspawners.command.version - Use this command to see if updates are available.
silkspawners.command.dump - Use this command to create a diagnostic report for support requests.

Spawners

silkspawners.break.* - Permission to set if players will receive destroyed spawners.
silkspawners.place.* - Permission to set if players can place silk spawners.
silkspawners.change.* - Permission to set if players can change spawners with eggs.
silkspawners.explosion - If set, spawner explosion is enabled.

If you want to allow only specific types of spawners you can replace the * with an entity name. Use the entities command to see spawnable entities.

Configuration

Default configuration:

messages:
  prefix: $8[$bSilkSpawners$8] # The plugin prefix used in all messages
  locale: en # The locale file to be used
spawner:
  dropChance: 100 # Probability that the spawner will drop when mined (0-100)
  destroyable: true  # If set to false, it won't be possible to destroy spawners without SilkTouch or without the permission
  pickaxeRequired: true # If set to false, spawners will always drop regardless of what the player is holding in his hand
  silktouchRequired: true # If set to false, spawners will drop even if the used pickaxe does not have SilkTouch
  silktouchLevel: 1 # The minimum SilkTouch level the pickaxe needs to mine spawners, at least 1 (useful for custom pickaxes with higher enchantment levels)
  item:
    name: $d{entity} Spawner # The name of the spawner item dropped, {entity} is replaced with the mob name
    color: $e # The color of the mob name in chat messages
    prefixOld: [] # Lore prefixes used by spawner items from older plugin versions, kept so those items stay recognized
    lore: ['$7Spawns $e{entity}'] # The lore of the spawner item, {entity} is replaced with the mob name
  explosion:
    all: [] # Explosion tiers rolled whenever spawners are mined, with or without SilkTouch (see below)
    normal: [] # Explosion tiers rolled when spawners are mined without SilkTouch (see below)
    silktouch: [] # Explosion tiers rolled when spawners are mined with SilkTouch (see below)
  message:
    denyDestroy: true # If set to true, a message will be sent to the player if the spawner cannot be destroyed
    denyPlace: true # If set to true, a message will be sent to the player if the spawner cannot be placed
    denyChange: true # If set to true, a message will be sent to the player if the spawner cannot be changed
  permission:
    disableDestroy: false # If set to true, no permission is required to receive destroyed spawners
    disablePlace: false # If set to true, no permission is required to place spawners
    disableChange: false # If set to true, no permission is required to change spawners with eggs
update:
  configVersion: 4 # Do not change this value manually! It is automatically managed by the plugin
  check:
    enabled: true # If set to true, the plugin will check for updates
    interval: 24 # The interval in hours at which to check for updates, at least 1
hooks:
  shopguiplus: true # If set to true, SilkSpawners will hook into ShopGUI+ if it is installed

If you want to use a dollar sign in a value, you can escape it by putting a backslash in front of it.
All messages (in the configuration and in locale files) can be formatted with either legacy color codes or MiniMessage tags. Mixing both formats within the same message is not supported.

Changing settings in game

• 
  
  
  • /silkspawners config get <setting> shows the current value and what the setting does
  • /silkspawners config set <setting> <value> changes it in the config.yml file

Settings and values are tab completed. Changing settings requires the silkspawners.command.config.set permission. Changes take effect immediately, except for hooks.shopguiplus, which needs a server restart. Lists can only be changed in the file, and explosion tiers are managed with /silkspawners config explosion (see below).

Explosion tiers

Mined spawners can explode for players with the silkspawners.explosion permission: explosion.normal tiers apply when mining without SilkTouch, explosion.silktouch with it, and explosion.all to both. Each tier needs a chance in percent and an explosion power (TNT is 4.0). The example below gives a 50% chance of a small explosion, 30% of a large one and 10% of a massive one that also ignites fires:

spawner:
  explosion:
    normal:
    - chance: 50
      power: 2.0
    - chance: 30
      power: 4.0
    - chance: 10
      power: 8.0
      setFire: true # Optional: the explosion ignites fires (default false)
      breakBlocks: true # Optional: the explosion damages surrounding blocks (default true)

Changing tiers in game:

• 
  
  
  • /silkspawners config explosion list [all/normal/silktouch] shows the configured tiers
  • /silkspawners config explosion add <all/normal/silktouch> <power> [chance] [setFire] [breakBlocks] adds a tier
  • /silkspawners config explosion remove <all/normal/silktouch> <tier> removes a tier by its number in the list

Adding and removing tiers requires the silkspawners.command.config.set permission. Changes made with the command take effect immediately. Changes made in the file take effect after /silkspawners config reload or a server restart.

Custom messages

New and reworded messages are applied to your locale files automatically on startup. Messages you edited yourself are never touched, so a customized message keeps its wording across updates.

Use /silkspawners locale restore confirm only to discard your own edits and return every message to the bundled default.
If you want to create your own locale file, you should create a new file to prevent your changes from being overwritten when you restore the locale files.
Locale files must be named accordingly to the messages_myfile.properties naming schema and can be used by setting myfile as locale.

If you have created your own translation, it would be awesome if you could submit it at our translation program, so other people can use it too.