Bukkit

Core options

These are general plugin options that don't fit into the other categories.

Events options

Event strategies are the heart and soul of what makes HomeSpawnPlus so flexible and puts the power in your hands to setup your home/spawn scenarios to happen exactly how you want. Events types are broken into three categories and evaluated in this order:

• Events by permission (events.permission.somename.event)
• Events by world (events.world.myworld.event)
• Default Events (events..event)

The events shown here just use the default "events." prefix, but they apply equally to the other two types that are available. Please see this example for the correct format for per-world or per-permission strategies

Please reference the strategies doc for detailed descriptions of strategies.

NOTE: Event types are always evaluated in the order: permission, world, default. The order they appear in the config file does not matter unless a player has two permission chains that apply, in which case the first permission listed in the config file will be the one to "win" (it will NOT evaluate both).

Cooldown options

Cooldowns are the amount of time (in seconds) required before a given command can be used again. Cooldowns timers are unique to the command, meaning the cooldown for "/home" is different than "/spawn". Cooldowns are currently global for all worlds, a future addition will allow changing them per-world or tying them to a specific permission/group.

Warmup options

Warmups define the amount of time (in seconds) it takes before a given command fires. For example, by setting "/home" to a 10 second warmup, the player must wait 10 seconds after typing "/home" before they are actually teleported home. Like cooldowns, warmup settings are currently global; a future enhancement will allow you to set them up differently per-world or per-permission/group.

Home limits options

These options allow you to limit the number of homes a player can have per-world and globally. Home limits are defined for permissions and worlds much the same way events are, please see the default config.yml for examples.

Cost options

These options allow you to use your economy plugin of choice to charge players for various commands. You MUST have the optional Vault dependency installed in order for these options to work.

Disabled commands

This section allows you to entirely disable commands from being available. You might use this, for example, if you just want a really simple single-home-per-world setup and want to disable commands like "/listhomes" or "/deletehome".

[Author's note: These options were originally intended to make admins lives easier by allowing you to make HSP "play nice" with other plugins, disabling commands you want another plugin to use instead (such as /home for MyHomes). Sadly, Bukkit doesn't allow HSP to unregister it's command fully, so the most HSP can do is stop responding to the command, but it can't hand over control to another plugin. So you're still stuck editing plugin.yml files for now - Sorry]

Command Usurp options

A complaint I heard a few times as people first got started with HSP was that some of their commands weren't working as expected. This was usually caused because some other plugin (such as CommandBook, Essentials, etc) were registering the "/home", "/sethome", etc commands first and so HSP was never getting the commands. The usual fix involves hand-editing plugin.yml files for other plugins, or renaming your JARs such that HSP loads first. Both of these require remembering what you did anytime you update and is a general PITA.

So HSP offers an easier alternative: if you want HSP to "usurp" commands from other plugins, just list those commands here and it will be done, in a way that is upgrade-proof and so won't come back to bite you in the ass on your next upgrade because you forgot to edit a plugin.yml again.

The format is like so:

usurpCommands:
  - home
  - sethome
  - spawn

You can list any commands here that HSP uses and HSP will take them over from any other plugins that have that command registered when it starts up. This option is not enabled by default.

Permission system

HomeSpawnPlus tries to do "the right thing" and just leverage whatever permission system you have in place. While superperms was supposed to solve all the multiple permission system nonsense, it fell short in implementation and left plugin authors having to write even more code than before to support things that Perm2-compatible plugins had out of the box (such as groups, offline permissions and other-world permissions). Plugins like Vault and WEPIF (WorldEdit) help with this, but not everyone is using these.

So HSP has a single Permission class controlled by a config option that lets you easily choose which Permission system you want to use. In general, you should ever have to do anything with this, since HSP will just look through the default list in order and use the first one it finds. But if, for some reason, you wanted to use WEPIF instead of Vault, or let's say there was a bug in Vault and you wanted to use PEX implementation directly, you can do so with the "permissions" config option. The author recommends Vault, it is by far the most robust and best performing option available. Here is the section right from the default config.yml:

# This defines which permission system HSP uses. Vault and WEPIF
# (WEPIF is built into WorldEdit) are preferred, they both provide
# a nice interface to all other permission systems. If you don't have
# or don't want to use either of those, there is some native support
# for a few other permission systems that you can use. These are
# checked in the order they are listed for existence, and the
# first one to match is used.
permissions:
  - vault
  - wepif
  - pex
  - perm2-compat
  - superperms
  - ops