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

_ForgeUser6831786
- Join Date: 5/19/2011
- Posts: 19
- Member Details
#131 _ForgeUser6831786

View User Profile

Send Message

Posted Feb 17, 2012
On the latest version of HSP and using PEX 1.18, players get the following message when trying to /sethome:

"You are at your limit of 0 homes for world "world" "

Here is my config file: http://pastie.org/3399964

My PEX permissions.yml file: http://pastie.org/3399975

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

View User Profile

Send Message

Posted Feb 16, 2012
For those with problems with CommandBook & usurpCommands:

The latest versions of CommandBook no longer follow the Bukkit standard for registering the commands. This is a case of "the way Bukkit handles this is lame" and so plugin authors have to work around the issue. CommandBook, behind the scenes, has some nice functionality inherited from work that @sk89q has done, but unfortunately it veers off the "stock Bukkit" path. As a result, HSP is no longer able to usurp it's commands (the usurping itself was just a hack to work around the poor way Bukkit handles this anyway).

CommandBook, to it's credit, does have a great component model to help with this. In your CommandBook config.yml, add "homes" to your disabled components, like so:

# CommandBook config.yml components: disabled: - homes

With this in place, all "home"-related functionality from CommandBook will be disabled (including the commands) and HSP will be able to function without interference from CommandBook.
Rollback Post to Revision RollBack
_ForgeUser1138703
- Join Date: 9/20/2008
- Posts: 17
- Member Details
#129 _ForgeUser1138703

View User Profile

Send Message

Posted Feb 16, 2012
@andune

1.4.1 Fixed the first join spawn. brilliant, thanks.

Last edited by _ForgeUser1138703: Feb 16, 2012

Rollback Post to Revision RollBack
_ForgeUser1138703
- Join Date: 9/20/2008
- Posts: 17
- Member Details
#128 _ForgeUser1138703

View User Profile

Send Message

Posted Feb 16, 2012
@ArrowsToDaKnee

I had the same conflict, and just removed commandbook from the server when I wasn't doing admin duties to make /home work again.

Rollback Post to Revision RollBack
_ForgeUser8137814
- Join Date: 12/24/2011
- Posts: 33
- Member Details
#127 _ForgeUser8137814

View User Profile

Send Message

Posted Feb 16, 2012
Okay, usurpCommands do not work anymore, even if I paste it in config, and remove comment tag in config_default Also, any changes in config_default are removed...

Rollback Post to Revision RollBack
_ForgeUser8137814
- Join Date: 12/24/2011
- Posts: 33
- Member Details
#126 _ForgeUser8137814

View User Profile

Send Message

Posted Feb 16, 2012
Hey, when I right click bed, it says click within 5 seconds to make home, I do, and it says it did. WHen I do /home, it doesn't work. I thought this was a conflict with commandbook, so I used usurpCommands: - home - sethome - spawn - setspawn

But it still didn't work...

Rollback Post to Revision RollBack
_ForgeUser8075891
- Join Date: 12/14/2011
- Posts: 2,145
- Member Details
#125 _ForgeUser8075891

View User Profile

Send Message

Posted Feb 15, 2012
1.4.1 fixed it for me as well!! :-) :-) :-)

Using it right now. Thanks! :D

Last edited by _ForgeUser8075891: Feb 15, 2012

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

View User Profile

Send Message

Posted Feb 14, 2012
@ChrisJamesRobb

Can you please try the version I linked in this ticket regarding the issue:

http://dev.bukkit.org/server-mods/homespawnplus/tickets/70-always-spawn-at-first-spawn/

If I get some positive reports that the linked version resolves the issue I will officially release it as version 1.4.1.

Rollback Post to Revision RollBack
_ForgeUser1138703
- Join Date: 9/20/2008
- Posts: 17
- Member Details
#123 _ForgeUser1138703

View User Profile

Send Message

Posted Feb 14, 2012
@Tomskied

Same problem here. -spawnNewPlayer is causing every player who joins the server to go to the new player spawn point. I have reverted back to version 1.3.1 from 1.4 and now it seems to work.

Last edited by _ForgeUser1138703: Feb 14, 2012

Rollback Post to Revision RollBack
_ForgeUser8075891
- Join Date: 12/14/2011
- Posts: 2,145
- Member Details
#122 _ForgeUser8075891

View User Profile

Send Message

Posted Feb 14, 2012
@andune

Thanks for the instructions. I'll dive into this deep dark matter and keep you updated ;-) (bear with me)

Best regards :)

Last edited by _ForgeUser8075891: Feb 14, 2012

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

View User Profile

Send Message

Posted Feb 13, 2012
@ThisUsernameIsMine

You can help diagnose your own issue by setting "core.verboseStrategyLogging" in your config.yml to true. When people login, HSP will print the strategy being executed and you'll be able to see what/where/why HSP is sending them. If you can't figure it out from that, you can further set "core.debug" to true and HSP will spit out verbose debug info into "HomeSpawnPlus/debug.log", which might help you figure out the issue.

If you can't figure it out from all that extra info, you can use pastebin to paste your verboseStrategy logs and debug logs to me and I'll see if I can help from there.

Rollback Post to Revision RollBack
_ForgeUser6843428
- Join Date: 5/19/2011
- Posts: 560
- Member Details
#120 _ForgeUser6843428

View User Profile

Send Message

Posted Feb 13, 2012
@andune

Ah ok perfect, then it works as it says it should :) Thanks alot

One bug I have though now, on your newest build, is that on join, I believe its not recording people as being a player that has already visited. I tried it outyesterday and it massively bugged out, so had to rollback to an older version.

Every player on join will always go to newplayerspawn no matter if they have visited the server before, I have the strategy as :

# strategies to use when player is joining the game onJoin: - spawnNewPlayer - default

but it treats everyone as NewPlayer. Don't know if this is just me, my files are from the old hsp builds as I wanted to keep config and the group spawns i had already set, but the newplayer is not working for me.
Last edited by _ForgeUser6843428: Feb 13, 2012

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

View User Profile

Send Message

Posted Feb 13, 2012
@Tomskied

Hi Tom, the exact lines of code that do this check are:

if( plugin.getHSPConfig().getBoolean(ConfigOptions.SINGLE_GLOBAL_HOME, false) && !plugin.hasPermission(l.getWorld().getName(), playerName, HomeSpawnPlus.BASE_PERMISSION_NODE+".singleGlobalHomeExempt") ) {

which says: if the SINGLE_GLOBAL_HOME is set and the current player doesn't have "hsp.singleGlobalHomeExempt" permission; then it enforces single global home, otherwise it doesn't. All I can say is that I recall testing it and having it work and from what I can see in the code, it is coded correctly. You might use your permission system to confirm in-game the existence of the permission; or if I can get a second person to test and confirm there is an issue, I will re-test and try to reproduce the problem myself.

Also, to add to this, re-reading your request: all singleGlobalHomeExempt does is exempt the given player from the "SINGLE_GLOBAL_HOME" setting (which enforces only 1 single world home). Players with "hsp.singleGlobalHomeExempt" are still subject to the normal limits defined in the config (perWorld and global). There are no permissions that allow the overriding of home limits; the way to do this would be to define a per-permission limit for your mods and set the global/per-home limits there to -1.
Last edited by andune: Feb 13, 2012

Rollback Post to Revision RollBack
_ForgeUser8075891
- Join Date: 12/14/2011
- Posts: 2,145
- Member Details
#118 _ForgeUser8075891

View User Profile

Send Message

Posted Feb 13, 2012
This is a great plugin i've been using for quite some time, but there's an issue i have with it.

I have a small home network and my own server. Whenever we're playing on the server we all connect from a local ip. The problem is that even when using /setspawn and /setfirstspawn, everyone except me is spawning on a random location in the radius of the main spawn that was set-up using /setspawn or /setfirstspawn.

This was tested after disabling/uninstalling all other plugins that were on the server @ RB 1.1-R3 and latest R4

Basically all i want is that new players (that haven't ever connected before) spawn on the given location. but somehow that doesn't seem to work :(

Last edited by _ForgeUser8075891: Feb 13, 2012

Rollback Post to Revision RollBack
_ForgeUser6843428
- Join Date: 5/19/2011
- Posts: 560
- Member Details
#117 _ForgeUser6843428

View User Profile

Send Message

Posted Feb 12, 2012
Hey andune, been using your plugin for a while now, its great, but the singlehomespawnexempt node doesn't seem to be doing much for my players, for op it works, but when given to players without .* perms it doesn't work and still limits the player to what it is set as in the config. Is this something I am doing wrong?

The perm I give the players is - hsp.singleGlobalHomeExempt

I have tried many different perms to check if the case sensitive was breaking it, but with no luck. Any suggestions?

Rollback Post to Revision RollBack
_ForgeUser8137814
- Join Date: 12/24/2011
- Posts: 33
- Member Details
#116 _ForgeUser8137814

View User Profile

Send Message

Posted Feb 11, 2012
@andune

Where do you change that?

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

View User Profile

Send Message

Posted Feb 10, 2012
@stargateanubis14

I didn't read your comment until just now, but coincidentally, the last part you asked about is exactly what I just added in v1.4.

You can now choose how HSP determines whether a player is new, with the 3 modes breaking down like so:

PLAYER_DAT: This is the default, since most people seem to expect this to be the behavior. If the player doesn't have a "player.dat" file, they are considered new.
BUKKIT: This uses the Bukkit ".isNewPlayer()" API. I've found this to be wonky and buggy, but if you're in the "why don't you just use the Bukkit API?" camp, then this setting is for you
ORIGINAL: This uses HSP's original algorithm which checks HSP's database to see if it's ever seen the player before and falls back to the "player.dat" check if there's no database entry.
Last edited by andune: Feb 10, 2012

Rollback Post to Revision RollBack
_ForgeUser6942935
- Join Date: 6/1/2011
- Posts: 37
- Member Details
#114 _ForgeUser6942935

View User Profile

Send Message

Posted Feb 6, 2012
@PaTr0N

I have that working just like you do (my players spawn in an underground stasis chamber, but once they leave spawn area they cannot get back in: 1-time only visit. When they do /spawn, they are sent to the 'public' spawn.)

I had issues because the spawnNewPlayer is taking the 'new player' from the server's player files. So you basically have to wipe the server's player data, AND the plugins spawn info, as well as configure the plugin properly, just to have the player spawn undergrund first.

So what it boils down to, is check for other plugins that check of 'first time join', or modify that info, and clean it out.

Personally, i think it would be best for the plugin to have an option to track 'first time join since plugin installed', or 'first time join based on server files'.... but *meh* >.>

Last edited by _ForgeUser6942935: Feb 6, 2012

Rollback Post to Revision RollBack
_ForgeUser416547
- Join Date: 12/29/2007
- Posts: 32
- Member Details
#113 _ForgeUser416547

View User Profile

Send Message

Posted Jan 31, 2012
Hello,

First of all, thanks for this powerful plugin!

I was really excited about the spawnNewPlayer strategy because i tought that performing a /setfirstspawn at an arbitrary location would skip the "above sea level" spawning rule, as for one of my ideas to work i really need brand new players to spawn underground, in a special room. Is there any way you guys know of, that would allow me to accomplish this?

Rollback Post to Revision RollBack
_ForgeUser8137814
- Join Date: 12/24/2011
- Posts: 33
- Member Details
#112 _ForgeUser8137814

View User Profile

Send Message

Posted Jan 27, 2012
@scungilli

PEX has issues using parent nodes sometimes (not sure why). I've already told the creator this, but it hasn't been fixed. Post your permissions.yml

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

392,389
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