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

_ForgeUser8370244
- Join Date: 2/4/2012
- Posts: 115
- Member Details
#1253 _ForgeUser8370244

View User Profile

Send Message

Posted Sep 13, 2013
@barbaroes

Its easy to do barbaroes

Just look in your bukkit.yml file  ( in the root of your server )

near the bottom you will see alias:

add these to the file

  home:
  - hsphome
  spawn:
  - hspspawn
  sethome:
  - hspsethome

HSP will respond to both  /spawn  and /hspspawn...  and /home and /hsphome  ( the ones with hsp  are strictly HSP commands though.

Since essentials also uses /spawn and /home your server can get confused as to which addon should process it.

When you make an alias in the bukkit.yml file  it will only use the one that you have told it to so when someone types /home bukkit will see it as /hsphome  and force HSP to handle the command.

When you create an alias  it tells bukkit to

Rollback Post to Revision RollBack
_ForgeUser9096157
- Join Date: 6/26/2012
- Posts: 40
- Member Details
#1252 _ForgeUser9096157

View User Profile

Send Message

Posted Sep 13, 2013
Hey I know this is in the FAQ but no matter what I do I can't get HSP and essentials to play nice. All I want is for HSP to get control of /spawn and /home, is there a way to disable parts of essentials? I've tried commandbook, renaming the files, nothing seems to work.

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

View User Profile

Send Message

Posted Sep 12, 2013
@NoHoPeLess

It means your HSP config looks something like so:

events: onJoin: - ModeRememberSpawn - ModeRememberLocation - spawnNewPlayer

and that the player who joined in this case was not a new player, so it fell of the end of the chain without doing anything. Those Mode statements only affect upcoming strategies and the only "action" strategy you have is spawnNewPlayer. The player isn't new, so HSP finished without doing anything (null result).
Rollback Post to Revision RollBack

_ForgeUser10184112

Join Date: 12/8/2012
Posts: 706
Member Details

#1250 Posted Sep 12, 2013

2013-09-12 09:22:47 [INFO] NoHoPeLess[/XX.XXX.XXX.X:XXXXX] logged in with entity id 3796 at ([spawn2] -19.770695109255527, 32.0, -22.389810228118172)
2013-09-12 09:22:47 [INFO] Loaded player file for NoHoPeLess
2013-09-12 09:22:47 [INFO] [Ultrabans] Logged NoHoPeLess connecting from ip:XX.XXX.XXX.X
2013-09-12 09:22:47 [INFO] [HomeSpawnPlus]  Strategy evaluation started, type=onjoin player=CraftPlayer{name=NoHoPeLess}
2013-09-12 09:22:47 [INFO] [HomeSpawnPlus]  (strategy ModeRememberSpawn) Evaluated mode change strategy, new mode = [org.morganm.homespawnplus.strategies.ModeDefault@405b19ff, org.morganm.homespawnplus.strategies.ModeRememberSpawn@1c94b505]
2013-09-12 09:22:47 [INFO] [HomeSpawnPlus]  (strategy ModeRememberLocation) Evaluated mode change strategy, new mode = [org.morganm.homespawnplus.strategies.ModeDefault@405b19ff, org.morganm.homespawnplus.strategies.ModeRememberSpawn@1c94b505, org.morganm.homespawnplus.strategies.ModeRememberLocation@66f869eb]
2013-09-12 09:22:47 [INFO] [HomeSpawnPlus]  (strategy spawnNewPlayer) player is detemined to NOT be a new player
2013-09-12 09:22:47 [INFO] [HomeSpawnPlus]  (strategy spawnNewPlayer) result is [loc={null}, home=null, spawn={null}]
2013-09-12 09:22:47 [INFO] [HomeSpawnPlus]  Evaluation chain complete, result = [loc={null}, home=null, spawn={null}]

what does that mean?

Last edited by _ForgeUser10184112: Sep 12, 2013

andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1249 andune

View User Profile

Send Message

Posted Sep 8, 2013
@barbaroes

An event chain for this would be:

events: # or whatever you want these to be onSpawnCommand: - spawnLocalWorld - spawnDefaultWorld world: Skyblock: onSpawnCommand: - spawnLocalWorld

Of course, there's nothing different about Skyblock except I've left off the spawnDefaultWorld, but if you've defined a /setspawn in Skyblock, that never would have been hit anyway. My assumption is that you only want the /spawn command to work on the Skyblock world and nowhere else? If so, just give the hsp.command.spawn permission only on that world. Alternately, in the above config, set the default onSpawnCommand to just use default strategy, which will do nothing.

Here is the documentation link for custom commands.
Rollback Post to Revision RollBack
_ForgeUser9096157
- Join Date: 6/26/2012
- Posts: 40
- Member Details
#1248 _ForgeUser9096157

View User Profile

Send Message

Posted Sep 8, 2013
@andune

Well I also have other worlds aswell. I can't set a strategy for that because then all the worlds spawns will bring them to Skyblock. And I was strolling through the config and couldn't find custom commands. Can you direct me to it?

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

View User Profile

Send Message

Posted Sep 8, 2013
@barbaroes

You need to decide under what conditions you want /spawn to take them to the skyblock spawn. If it's when ever anyone types /spawn, then you just override the default onSpawnCommand event with the strategy spawnSpecificWorld:skyblock.

If your intent is to only have it work while on the skyblock world, then use a world-specific configuration for onSpawnCommand.

Also note you could use HSP custom commands to make it so the actual command /sb took them straight to the skyblock spawn.

Rollback Post to Revision RollBack
_ForgeUser9096157
- Join Date: 6/26/2012
- Posts: 40
- Member Details
#1246 _ForgeUser9096157

View User Profile

Send Message

Posted Sep 7, 2013
I use multiverse and was wondering, can I set a spawnpoint for 1 world, in a different world? Like I have a skyblock plugin where players do /sb and go to a new world. I want their /spawn to bring them to the skyblock spawn. How do I do this?

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

View User Profile

Send Message

Posted Sep 7, 2013
@Jodide

Spawn points are stored in the database. Which is either Sqlite, MySQL or YAML depending on how you've configured HSP. You can view your spawn points in-game by running /spawnlist.

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

View User Profile

Send Message

Posted Sep 7, 2013
@NoHoPeLess

First of all, you'll have to disable any spawning login behavior in AuthMe, so you eliminate it from doing anything when the user logs in. Second, please state your desired behavior clearly. I can't tell if your goal is to:

Have the player join at the exact spot they logged out at
Have the player sent to spawn on the world they last logged out on

Both are easily possible.
Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1243 andune

View User Profile

Send Message

Posted Sep 7, 2013
@Xibalba7

If you're using YAML and it's writing in your bukkit server root, yes that is a bug. I think I've seen this behavior in some 2.0 testing I was doing, it's possible it's a bug in 1.7 as well. Please open a ticket and I'll take a look at it.

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

View User Profile

Send Message

Posted Sep 7, 2013
@fov360

Sure. I just commented on your Ticket #218 with the answer.

Rollback Post to Revision RollBack
_ForgeUser10335331
- Join Date: 1/5/2013
- Posts: 49
- Member Details
#1241 _ForgeUser10335331

View User Profile

Send Message

Posted Sep 7, 2013
Is there a way to convert old HSP Data to mySQL?

Rollback Post to Revision RollBack
_ForgeUser11574371
- Join Date: 5/30/2013
- Posts: 77
- Member Details
#1240 _ForgeUser11574371

View User Profile

Send Message

Posted Sep 1, 2013
Hi,

Is it a bug that hsp uses .../bukkitserver to stores its files instead of /bukkitserver/plugins/hsp ?

Rollback Post to Revision RollBack
_ForgeUser10184112
- Join Date: 12/8/2012
- Posts: 706
- Member Details
#1239 _ForgeUser10184112

View User Profile

Send Message

Posted Aug 29, 2013
Hello :D i have some trouble... I set the spawnpoint for a world... soo when a user joins, he joins on the last point then he teleported to the spawnpoint of the world, then when he logs in (authme) he comes to the last location... this is very confused...

currently setting:

events:

strategies to use when player is joining the game onJoin: - spawnLastLocation - modeRememberLocation - spawnNewPlayer
Rollback Post to Revision RollBack
_ForgeUser7272822
- Join Date: 7/26/2011
- Posts: 5
- Member Details
#1238 _ForgeUser7272822

View User Profile

Send Message

Posted Aug 29, 2013
Where are the spawnpoints stored? I can't find it.

Rollback Post to Revision RollBack
i9hdkill
- Join Date: 5/25/2010
- Posts: 134
- Member Details
#1237 i9hdkill

View User Profile

Send Message

Posted Aug 26, 2013
@Gunnerrrrr

awesome thx^^

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

View User Profile

Send Message

Posted Aug 25, 2013
@I9hdkill

Add this to your config.

commands: # you can disable individual built-in commands here # disabledCommands: - home # - sethome # - spawn
Last edited by _ForgeUser8667406: Aug 25, 2013

Rollback Post to Revision RollBack
i9hdkill
- Join Date: 5/25/2010
- Posts: 134
- Member Details
#1235 i9hdkill

View User Profile

Send Message

Posted Aug 25, 2013
I am searching for a way to disable the home command because i use my own home plugin. Theres a way to do that?

Last edited by i9hdkill: Aug 25, 2013

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

View User Profile

Send Message

Posted Aug 22, 2013
@Xibalba7

I can't imagine any problems if you use singleGlobalHome and use the homeAnyWorld strategy, but feel free to post your results if you're getting something other than what you expect (use core.verboseStrategyLogging).

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