PortableHole's configuration is stored in
bukkit/plugins/PortableHole/config.yml. It can be edited directly. Once editing is complete, the updated configuration can be reloaded by typing
/ph reload (or by restarting/reloading the server).
|author_validation.players||List of String||List of player names whose books may be used to create holes - see Author Validation below||empty|
|author_validation.groups||List of String||List of permission group names whose players' books may be used to create holes - see Author Validation below||empty|
|book_title||String||Books must have this title to be used as tunnelling books. Note: if you change this after players have received or created tunneling books, those books will no longer function! It is recommended to set this once, before players start using the plugin.||Portable Hole|
|default_book_text||List of String||The text that appears inside the book, if read. Unlike book_title, this can be changed at any time without breaking existing books.||[ "Left-click to use!" ]|
|costs||List of (cost,blocks)||Defines the cost players pay to create holes||See Costs|
|crafting.enabled||Boolean||Whether or not to add a recipe for the tunnelling book. See Crafting a Book|
|crafting.recipe||List of String||The recipe for crafting a tunnelling book. See Crafting a Book|
|crafting.ingredients||Map of character to material name||The materials to use for shaped recipes. See Crafting a Book|
|crafting.author||String||The player name to use as the author for all crafted tunnelling books. See Crafting a Book|
|crafting.shaped||Boolean||Is the tunnelling book recipe shaped or shapeless? See Crafting a Book|
|effects.hole_open||Effect||Effect to play when a hole opens - see Effects below||sound,name=enderman_teleport|
|effects.hole_close||Effect||Effect to play when a hole closes - see Effects below||sound,name=enderman_teleport|
|effects.hole_failed||Effect||Effect to play when hole creation fails for any reason - see Effects below||sound,name=note_bass|
|lifetime.initial||integer||Initial lifetime in ticks for created holes||15|
|lifetime.per_length||integer||Lifetime in ticks per block-length of created holes. A hole of length n has a lifetime of lifetime.initial + lifetime.per_length * n ticks - e.g. a one-block hole will last for 35 ticks, or 1.75 seconds.||20|
|log_level||String||Plugin's logging level - one of FINEST, FINER, FINE, INFO, WARNING, SEVERE. Leave at INFO normally||INFO|
|max_tunnel_length.horizontal||integer||The maximum length that a horizontal tunnel can be||31|
|max_tunnel_length.vertical||integer||The maximum length that a vertical tunnel can be||31|
|particle_effect||String||Particle effect to play inside an open hole. May be any visual effect from http://jd.bukkit.org/apidocs/org/bukkit/Effect.html - ender_signal, potion_break, smoke, mobspawner_flames (or leave blank to disable particle effects)||ender_signal|
|tunnellable.blacklist||List of integer||A list of block id's that will cause tunnel creation to fail, if encountered - by default, any block with an associated tile entity - chests, furnaces, dispensers....||23,54,58,61,62,95,116,117,118|
|tunnellable.whitelist||List of integer||A list of block id's which may be tunnelled through. By default any "passable" block - i.e. a block that can be walked through - will be considered as the end of a tunnel, but you can override this by adding block id's to the whitelist.||empty|
|verbose_charges||boolean||When true, players are messaged about all charges made for creating holes||true|
|void_tunnelling||boolean||When true, it's possible to open tunnels into the void (Y<=0). Be careful with this setting - falling into the void isn't fun.||false|
All messages displayed to players can be modified, e.g. if your players' primary language is not English. The defaults are:
|messages.cant_create||Can't create a hole here.|
|messages.too_deep||Can't create a hole that deep.|
|messages.stopped||Something prevents you from tunnelling here...|
|messages.cant_afford||Can't afford to dig!|
|messages.credits||You have %d tunnelling credits.|
|messages.gave_book||"Gave a %s book to &e%s."|
|messages.got_book||"You have been given a %s book."|
|messages.not_valid_author||The author of this book isn't allowed to create holes.|
|messages.charge_made||"Tunnelling charge taken: &e%s"|
The author_validation.players and author_validation.groups settings are used as follows:
- If author_validation.players and author_validation.groups are both blank, then anybody's books can be used to create a hole.
- Otherwise, if the book's author is in the players list, the book can be used.
- Otherwise, if the book's author is in a permission group in the groups list, the book can be used. (For this to work, you must have Vault installed, along with a configured permissions plugin).
- Otherwise, the book cannot be used to create a hole.
This allows you to restrict whose books may be used. E.g. you might only want players in the admins permission group to be allowed to create usable tunnelling books. Note that these books can be given/traded/sold to other players - it is the book's author that is checked, not the player who is using the book.
Several settings allow you to define special effects, either sounds or visual, which are played when a particular event occurs. See the entries in Settings under effects for a list of those settings and their defaults. The format for specifying an effect is:
All effects start with effect type, followed by one or more key/value pairs. The valid effect types are:
- sound: Play a sound that the client knows about.
- effect: Play an effect which may be visual, audible, or both. E.g. puff of smoke, portal particles...
- explosion: Play an explosion effect (or even a real explosion!)
- lightning: Play a lightning effect (or even a real lightning strike!)
The valid parameters are:
|Parameter name||Type||Use with||Description|
|volume||float||sound||Specifies the volume of the sound, default 1.0|
|pitch||float||sound||Specifies the pitch of the sound, default 1.0 (valid range appears to be 0..3)|
|name||string||sound, effect||Specifies the Bukkit sound or effect name to play. See http://jd.bukkit.org/apidocs/org/bukkit/Sound.html for a list of valid sounds, and http://jd.bukkit.org/apidocs/org/bukkit/Effect.html for a list of valid effects (you may use upper or lower case).|
|data||int||effect||Effect-specific data. Not all effects need this. For SMOKE, it gives the smoke direction (4 is straight up)|
|radius||int||effect||The radius of the effect. Players must be within this radius to see/hear the effect. Default: 64|
|power||float||explosion, lightning||The power of an explosion or lightning strike. Any value above 0 means a real explosion or strike (for lightning, all non-zero values are equivalent). Default: 0|
|fire||boolean||explosion||If true, explosions will also cause fires. Default: false|
Leaving a setting as blank disables playing an effect for that event.
If you wanted to use piston effects instead of ender-style effects for holes, you could do:
effects: hole_open: sound,name=piston_extend hole_close: sound,name=piston_retract
Or if you want no sounds played at all:
effects: hole_open: hole_close: