Skip to content

Latest commit

 

History

History
110 lines (91 loc) · 6.59 KB

README.md

File metadata and controls

110 lines (91 loc) · 6.59 KB
Raw

SilkSpawners - A lightweight plugin to make spawners mineable
Latest Release Release Status Build Status Tested Versions CodeFactor Crowdin Localization
This plugin makes spawners minable using SilkTouch tools.

Visit on Spigot Visit on Hangar

Contributing

Contributions and translations are welcome. See Contributing for more.

Building

Requirements: JDK 17 (any distribution)

Simply download the source and build it using Gradle.

./gradlew :Plugin:assemble --no-daemon

Your build of SilkSpawners will be available at build/libs/SilkSpawners_v2.jar.

Commands

  • /silkspawners help [command]
  • /silkspawners give <Player> <Type> [Amount]
  • /silkspawners set <Type>
  • /silkspawners explosion <enable/disable/setting> <Player>
  • /silkspawners locale <setting/reload/update>
  • /silkspawners entities
  • /silkspawners version

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 update locale files.
  • 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.

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
  item:
    name: $dSpawner # The name of the spawner item dropped
    prefix: $e # The text before the spawner name in the lore
    prefixOld: '' # If you change your prefix, set this value to your old prefix to keep existing spawners functional
    lore: [] # Set an array for this value to set a custom lore
  explosion:
    normal: 0 # The explosion intensity when spawners are mined without SilkTouch
    silktouch: 0 # The explosion intensity when spawners are mined with SilkTouch
  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: 2 # 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

If you want to use a dollar sign in a value, you can escape it by putting a backslash in front of it.

Custom messages

To protect your locale files from unwanted overwriting, you must manually update the locale files with the /silkspawners locale command after an update.

If you want to create your own locale file, you should create a new file to prevent your changes from being overwritten when you update 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.

Statistics

Statistics Statistics from bStats