Bukkit

Overview

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).

Configuration Reference

Message Text

All messages displayed to players can be modified, e.g. if your players' primary language is not English. The defaults are:

Author Validation

The author_validation.players and author_validation.groups settings are used as follows:

1. If author_validation.players and author_validation.groups are both blank, then anybody's books can be used to create a hole.
2. Otherwise, if the book's author is in the players list, the book can be used.
3. 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).
4. 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.

Effects

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:

<effect-type>,<key>=<value>[,<key>=<value>...]

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:

Leaving a setting as blank disables playing an effect for that event.

Example

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: