HomeSpawnPlus

Table of Contents

HomeSpawnPlus (HSP) / SpawnControl: the most advanced Home/Spawn plugin for Bukkit. HSP has flexible events and strategies that you can customize for your unique needs. If you just want dead-simple home/spawn management, HSP can do that too, but you might find some other plugin easier to setup or understand. If you want full control and maximum flexibility to do whatever YOU want and not be limited by just basic /home and /spawn functionality, then HSP might be for you.

HSP's events and strategies, custom commands and integrations with plugins like WorldGuard and Multiverse allow you to completely control every aspect of spawns and homes, so that unique edge or setup you want, chances are good that HSP can do it for you.

Please read the FAQ before posting questions or tickets (especially Essentials users). Also there are Examples.

Versions

Official releases are on the Files tab of this page
Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk. Jenkins

HomeSpawnPlus has these Features:

Multi-world homes (one-home per world, multiple homes per world or even just one global home, your choice)
Specific control as to what happens on events such as player login, player death, typing /spawn or /home commands using strategies. Should the user always stay on the same world? Spawn at the nearest of multiple spawns (ie. graveyard concept)? Maybe they always go to a specific group spawn on that world (for PvP factions, perhaps)? Your choice.
Ability to set a one-time new player spawn point
Cooldowns and warmups Can be set to cancel on movement or damage. Advanced details here.
Economy support (via Vault) to optionally charge players for commands
Home limits, definable per-group or per-permission. More documentation.
Configurable per-world or per-permission for just about every option (events, cooldowns, warmups, costs, homeLimits)
Define your own custom commands Documentation here
WorldGuard region-spawn support (allow people to spawn at WG region spawn when inside that WG region)
Ability to visit homes other people have set, on any world (controlled by Permissions)
Language localization Also you can customize any message in HSP. Details here.
Home invites - documentation here
Set homes by clicking on a bed: read bed-related options documentation.
Dynmap integration built in, very configurable to meet your own needs
Persistence choice: Sqlite (default), MySQL or YAML
Standard YML config.yml: with live reloading in-game (/hsp rc)
Import home data from other plugins (Essentials 2.9, CommandBook 2.1 and SpawnControl v0.8)

Installation:

Download HomeSpawnPlus.jar and put it in your Bukkit plugins folder
Startup Bukkit, HomeSpawnPlus will automatically put the default config.yml into plugins/HomeSpawnPlus/config.yml
Configure config.yml to your liking, then either '/hsp rc' to live reload the config, or restart your server.

Additional info

This plugin was designed to work with Vault, WEPIF, PEX, Permissions 2.x/3.x, or any Superperms-compatible plugin. Please read more about permissions here.

Under the hood: How HSP works

Examples

Spawn strategy documentation

Advanced Cooldown and Warmup information

User Command Reference

Admin Command Reference

Permissions

Changelog

Source Code

Metrics plugin

This plugin utilises Hidendra's plugin metrics system, which means that the following information is collected and sent to mcstats.org:

A unique identifier The server's version of Java Whether the server is in offline or online mode The plugin's version The server's version The OS version/name and architecture The core count for the CPU The number of players online The Metrics version

Opting out of this service can be done by editing plugins/Plugin Metrics/config.yml and changing opt-out to true.

Have an issue? Got a new idea?

If you find a bug or have an enhancement request, please create a ticket so I don't lose track of the request or issue in a comment stream. If you have a basic question, feel free to post in the comments here or visit the forums on forums.bukkit.org.

Thanks to @Timberjaw for the awesome work on SpawnControl that gave me a great base to start from!

Comments

_ForgeUser6876887
- Join Date: 5/23/2011
- Posts: 106
- Member Details
#1211 _ForgeUser6876887

View User Profile

Send Message

Posted Jul 28, 2013
@andune @Gunnerrrrr

Thank you both for the responses. :D

hsp.command.home.otherworld is the key.... and making sure I'm not OP when I test the home commands! Dhoo!

Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1210 andune

View User Profile

Send Message

Posted Jul 28, 2013
@Junrall

Yes, the permission hsp.command.home.otherworld controls this. If the players do not have this permission, they will not be able to used named homes to go to other worlds.

Rollback Post to Revision RollBack
_ForgeUser8667406
- Join Date: 3/31/2012
- Posts: 441
- Member Details
#1209 _ForgeUser8667406

View User Profile

Send Message

Posted Jul 28, 2013
@Junrall

Firstly in your config, go to the "events" section, and add this:

events: # strategies to use when player types "/home" onHomeCommand: - homeLocalWorld

If you don't already have this setup, you can set it so players get one home per-world instead of a global home:

homeLimits: # If true, players can only have a single global home (set # either by /sethome or a bed) # singleGlobalHome: false default: perWorld: 1 global: -1

Let me know if that helps.
Rollback Post to Revision RollBack
_ForgeUser6876887
- Join Date: 5/23/2011
- Posts: 106
- Member Details
#1208 _ForgeUser6876887

View User Profile

Send Message

Posted Jul 28, 2013
Hello,

If a person has a named home in World-A and that same person is in World-B... How would I prevent them from teleporting to the named home in World-A? Is it possible to make named homes world dependent?

Thanks!

Last edited by _ForgeUser6876887: Jul 28, 2013

Rollback Post to Revision RollBack
_ForgeUser8667406
- Join Date: 3/31/2012
- Posts: 441
- Member Details
#1207 _ForgeUser8667406

View User Profile

Send Message

Posted Jul 27, 2013
@TheFitSoldier

Find the warmup section in your config and paste everything below over it. If there isn't a warmup section in your config, add the one below.

Yes, HSP should work with all permission systems.

Rollback Post to Revision RollBack
_ForgeUser9726356
- Join Date: 10/2/2012
- Posts: 115
- Member Details
#1206 _ForgeUser9726356

View User Profile

Send Message

Posted Jul 26, 2013
@Gunnerrrrr

Paste that exactly?

Also does this plugin work with GroupManager? I have Vault installed as well.

Rollback Post to Revision RollBack

_ForgeUser8667406

Join Date: 3/31/2012
Posts: 441
Member Details

#1205 Posted Jul 26, 2013

@TheFitSoldier

To set a warmup per world, paste this in your config:

warmup:
  # globally enable or disable warmups.
  enabled: true
 
  # set to true if movement should cancel a warmup
  onMoveCancel: true

  # set to true if receiving damage should cancel a warmup
  onDamageCancel: true

  # individual command warmup timers
  home: 0
  spawn: 0
  groupspawn: 0

#  example of world-specific warmups
  world:
    YourWorldHere:
      # whether this world should have its own warmups
      warmupPerWorld: true
      home: 5
      spawn: 5
    AnotherWorldhere:
      warmupPerWorld: true
      home: 1
      spawn: 1
      groupspawn: 2

_ForgeUser9726356
- Join Date: 10/2/2012
- Posts: 115
- Member Details
#1204 _ForgeUser9726356

View User Profile

Send Message

Posted Jul 26, 2013
I found this, where do I type it? Also, will this work with GroupManager? I have Vault installed but I don't use Pex or superperms.

example of world-specific cooldowns
world:
myworld:
# whether this world should have its own cooldowns
cooldownPerWorld: false
home: 120
spawn: 120
# resetOnDeath can be per-world or even per-permission
resetOnDeath: true
Rollback Post to Revision RollBack
_ForgeUser9726356
- Join Date: 10/2/2012
- Posts: 115
- Member Details
#1203 _ForgeUser9726356

View User Profile

Send Message

Posted Jul 26, 2013
I have a Survival world on my server. I have set a world spawn to all my worlds but for factions I want it so that the player spawns in the world spawn and has a 5 sec waiting time to get back to the Survival World spawn.

Is it possible with HSP?

Rollback Post to Revision RollBack
_ForgeUser2470202
- Join Date: 4/29/2009
- Posts: 121
- Member Details
#1202 _ForgeUser2470202

View User Profile

Send Message

Posted Jul 25, 2013
Thanks, you are the best :)

Very Good Support :)

Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1201 andune

View User Profile

Send Message

Posted Jul 24, 2013
@DarkRyuZ7

Sure, something like so:

events: permission: group1: permissions: [group1] onSpawnCommand: - spawnSpecificWorld:A group2: permissions: [group2] onSpawnCommand: - modeSourceWorld:A - spawnSpecificWorld:B - modeSourceWorld:B - spawnSpecificWorld:B - modeSourceWorld:C - spawnSpecificWorld:C - modeSourceWorld:D - spawnSpecificWorld:D

You have to assign the permissions to your groups, ie. 'group1' to your Group1. You can call it whatever you want, this is just an example.

In the Group2 example, the 'modeSourceWorld' restricts the following strategies to only take effect if the mode is true (in this case, if the source world is as described), so what you see is just HSP's implementation of the rules you described.

Of course you'll have to use HSP's "/setspawn" command on each of the worlds to set the spawn, HSP does not use the default Bukkit map spawn.
Rollback Post to Revision RollBack
_ForgeUser2470202
- Join Date: 4/29/2009
- Posts: 121
- Member Details
#1200 _ForgeUser2470202

View User Profile

Send Message

Posted Jul 24, 2013
Uff... Sorry for that now... I have some Questions and... Yeah, i dont know if you can help.

I want to create 4 Worlds, we call them now A, B, C and D again.

Now, i have 2 Groups. Group1 and Group2

I want, if Group1 type "/spawn" they come out at World A, wherever they are ! !

And if Group2 type "/spawn" they should come out at World B if they are on World A or on World B. And if they are on World C they come to spawn of C, and on D, they come to D.

Is THAT Possible ? Sorry for this disguisting Questioning :)

Rollback Post to Revision RollBack
_ForgeUser11680263
- Join Date: 6/16/2013
- Posts: 196
- Member Details
#1199 _ForgeUser11680263

View User Profile

Send Message

Posted Jul 23, 2013
@andune

The players can't use /sethome but they can use /homeset, so I don't think it's the same as the second issue.

I just posted the ticket regarding the second issue. =)

Last edited by _ForgeUser11680263: Jul 23, 2013

Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1198 andune

View User Profile

Send Message

Posted Jul 23, 2013
@TheBlackBeltPanda

Are you sure the first issue (problems with /sethome) isn't the same as the 2nd issue? That is, users are complaining about not being able to /sethome, but perhaps it's because of homeLimits and they don't notice/report the message?

I ask because it certainly simplifies troubleshooting if we're dealing with just one problem instead of two.

As to the 2nd problem of homeLimits, can you open a ticket and attach your config file to the ticket as well as describe a specific failed scenario: ie. user XYZ standing on world ABC who is confirmed to have permission 123 with /permcheck (output attached), typed "/sethome foo" and got the error "max number of homes 2" when I expected his max to be 5 instead.

Rollback Post to Revision RollBack
_ForgeUser11680263
- Join Date: 6/16/2013
- Posts: 196
- Member Details
#1197 _ForgeUser11680263

View User Profile

Send Message

Posted Jul 23, 2013
After I updated to 1.6.2, my players are having problems with using /sethome. I have all the aliases setup and they were working with 1.5.2. Another problem I'm seeing is the home limits not functioning properly. In 1.5.2 I had set up permissions to allow different amounts of homes. Now a lot of my players keep getting the message "You are at your max number of homes of 2" when they should have more (according to the permissions).

Any ideas why this is happening after the update?

Last edited by _ForgeUser11680263: Jul 23, 2013

Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1196 andune

View User Profile

Send Message

Posted Jul 22, 2013
@limer5

Yes, sure is. You can read more about it in the bed documentation here. Glad you're enjoying the plugin.

Rollback Post to Revision RollBack
_ForgeUser11811428
- Join Date: 7/6/2013
- Posts: 3
- Member Details
#1195 _ForgeUser11811428

View User Profile

Send Message

Posted Jul 22, 2013
The plugin has been working great so far. I have another question though. Is there a way to make it so that when someone tries /hsphome from a home that was set by a bed but the bed was destoyed afterwords the command wont work and instead it will leave a message such as your bed was destroyed?

Sorry to keep bothering you.

Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1194 andune

View User Profile

Send Message

Posted Jul 22, 2013
@ttftw42

Hmm. In HSP 2.0 (still in beta), there is a Message strategy that you could use like so:

events: world: allowedWorld: customCommandEvent: - spawnNamedSpawn:somespawn notAllowedWorld: customCommandEvent: - message:This is not permitted here. commands: custom: class: CustomEventCommand event: customCommandEvent

Of course for managing lots of worlds, you can just make the default customCommandEvent be one or the other and then have the world override for the less used case.

As mentioned, however, the message strategy is new, only in HSP 2.0.

An alternative for 1.7 is to just setup your permissions so that on not-allowed worlds they get the standard "no permission" message. This is as simple as denying the permission on worlds you don't want it used. In my example, the command is /custom so the default permission HSP uses is hsp.command.custom. You obviously need to use whatever values make sense for the configuration you're using.
Rollback Post to Revision RollBack
_ForgeUser11886100
- Join Date: 7/19/2013
- Posts: 2
- Member Details
#1193 _ForgeUser11886100

View User Profile

Send Message

Posted Jul 22, 2013
Do I have the ability to send error text in a custom command? Let's say a command isn't permitted on a world...the way it works now I get "Location not found." which can be a little cryptic. I would rather say something like "This is not permitted here."

Rollback Post to Revision RollBack
_ForgeUser8059396
- Join Date: 12/11/2011
- Posts: 4
- Member Details
#1192 _ForgeUser8059396

View User Profile

Send Message

Posted Jul 22, 2013
@andune

Alright, get it now. Thanks!

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

32449
Created

Sep 25, 2011
Last Released File

Feb 8, 2015
Total Downloads

391,735
License

GNU Lesser General Public Lice...

v2.0
Feb 8, 2015
v1.7
Aug 25, 2012

Bukkit

HomeSpawnPlus

Bukkit Plugins

HomeSpawnPlus

Table of Contents

Please read the FAQ before posting questions or tickets (especially Essentials users). Also there are Examples.

Versions

HomeSpawnPlus has these Features:

Installation:

Additional info

Under the hood: How HSP works

Examples

Spawn strategy documentation

Advanced Cooldown and Warmup information

User Command Reference

Admin Command Reference

Permissions

Changelog

Source Code

Metrics plugin

Have an issue? Got a new idea?

Comments

About This Project

Categories

Members

Recent Files

Bukkit