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

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

View User Profile

Send Message

Posted May 16, 2013
@hutt132

There are a few things going on here. First you cannot have the same section multiple times in YAML. Cut & paste your YAML config into this online yaml parser: http:yaml-online-parser.appspot.com/. Then notice on the right (parsed) side under "homeLimits", you can only see "limit5" and "limit15". This is because YAML only sees the latest entry, your second "permission" entry.

That aside, lets try to solve your original problem statement:
Quote:
I'm trying to make it so rank1 can only set 1 home in world1 and rank2 can only set 2 homes in world1. But also rank1 can only set 2 homes in world2 and rank2 can only set 3 homes in world2.

So the first thing to realize is that HSP doesn't combine per-permission and per-world combinations: you get one or the other. The reason is if you want to do things that are per-world AND per-permission, you can use your permission system to do this. Let's use examples to illustrate. Here's a sample HSP limits section:

homeLimits: permission: 3home: permissions: [hsp.3home] perWorld: 3 2home: permissions: [hsp.2home] perWorld: 2 1home: permissions: [hsp.1home] perWorld: 1

Here we have defined 3 different limits entries that respond to 3 separate (made-up) permissions. Now, using your permission system, assign these permissions per-world to meet your original problem statement, here is a contrived YAML example:

# made up permissions.yml file specific to world1 group: member: permissions: - hsp.1home vip: permissions: - hsp.2home # made up permissions.yml file specific to world2 group: member: permissions: - hsp.2home vip: permissions: - hsp.3home

I don't know what permission system you use (and I don't help with permission problems), but whatever it is, follow the above pattern to assign per-world permissions in whatever way you see fit to match what you want to do.

Hope that helps.
Rollback Post to Revision RollBack
_ForgeUser8667406
- Join Date: 3/31/2012
- Posts: 441
- Member Details
#1088 _ForgeUser8667406

View User Profile

Send Message

Posted May 16, 2013
@shadvalentine

I have talked to andune about that before. He has no interest in doing that since there are many others that work perfectly for those features.

@Lars_1993

I'm not sure how that would work. Make a ticket and wait for andune on that one, sorry.

Rollback Post to Revision RollBack
shadvalentine
- Location: Norwich
- Join Date: 4/15/2012
- Posts: 491
- Member Details
#1087 shadvalentine

View User Profile

Send Message

Posted May 16, 2013
is there any chance that you will add other commands like /tp /tploc /tap /back?

Rollback Post to Revision RollBack
_ForgeUser7569089
- Join Date: 9/18/2011
- Posts: 94
- Member Details
#1086 _ForgeUser7569089

View User Profile

Send Message

Posted May 16, 2013
This plugin is delightful, and served me well in the past. Now that I need to access more features like the ones this has, I'm leaving SimpleSpawn and coming back to HSP.

That being said, I am going to miss the special teleport visual effects used in SimpleSpawn. Is there any way to have these in HSP?

Rollback Post to Revision RollBack
_ForgeUser5898762
- Join Date: 10/22/2010
- Posts: 13
- Member Details
#1085 _ForgeUser5898762

View User Profile

Send Message

Posted May 15, 2013
@Gunnerrrrr

Ok, but that is if I want all the worlds on the server sharing homes. But if I have a set of surival worlds, a set of creative worlds and a set of anarchy worlds, would it be possible then?

Rollback Post to Revision RollBack

_ForgeUser8667406

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

#1084 Posted May 14, 2013

@Lars_1993

You can use global homes.

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

  default:
    perWorld: 1
    global: 3

_ForgeUser7550340
- Join Date: 9/15/2011
- Posts: 139
- Member Details
#1083 _ForgeUser7550340

View User Profile

Send Message

Posted May 11, 2013
I was talking with Gunner and we tried this config: http://pastebin.com/YcMLcMLa

It only allows me to set 1 home in the world "world" while I'm member. But if we remove the lines from "creative:" and down, it works properly. So the only issue is setting up limits for multiple worlds. Any idea on how to do this?

Rollback Post to Revision RollBack
_ForgeUser5898762
- Join Date: 10/22/2010
- Posts: 13
- Member Details
#1082 _ForgeUser5898762

View User Profile

Send Message

Posted May 11, 2013
Ok, another question. Is there a way to have worlds inherit the same homelimits as another world? To explain, I want to have the Survival_nether and Survival_the_end to have the same homes as 'Survival'. So if you have a limit of 3 homes in 'Survival', and you make 1 home in the overworld and 1 home in the nether, you have only 1 home left to set somewhere in either the Survival overworld, the survival nether, or the survival end world.

Thanks in advance, Lars

Last edited by _ForgeUser5898762: May 11, 2013

Rollback Post to Revision RollBack
_ForgeUser7550340
- Join Date: 9/15/2011
- Posts: 139
- Member Details
#1081 _ForgeUser7550340

View User Profile

Send Message

Posted May 11, 2013
@Gunnerrrrr

Doesn't work for me. I put the custom permission in pex and I'm only allowed to set 1 home in world1 with the permission for 2 homes.

I sent you a message asking for you Skype if you have one because it would be easier to text chat.

Rollback Post to Revision RollBack

_ForgeUser8667406

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

#1080 Posted May 11, 2013

@hutt132 You can do that by giving each group a permission.

  world:
    world1:
      perWorld: 1
  permission:
    limit1:
      permissions:
      - your.custom.permission.1
      perWorld: 1
      global: -1
    limit2:
      permissions:
      - your.custom.permission.2
      perWorld: 2
      global: -1
    world2:
      perWorld: 1
  permission:
    limit2:
      permissions:
      - your.custom.permission.3
      perWorld: 2
      global: -1
    limit3:
      permissions:
      - your.custom.permission.4
      perWorld: 3
      global: -1

Last edited by _ForgeUser8667406: May 11, 2013

_ForgeUser7550340
- Join Date: 9/15/2011
- Posts: 139
- Member Details
#1079 _ForgeUser7550340

View User Profile

Send Message

Posted May 11, 2013
I'm trying to make it so rank1 can only set 1 home in world1 and rank2 can only set 2 homes in world1. But also rank1 can only set 2 homes in world2 and rank2 can only set 3 homes in world2. Is this even possible? I've been trying to figure out how to do this for hours and it's very frustrating. Is there an easier way for me to contact you such as Skype?

Rollback Post to Revision RollBack
_ForgeUser41579
- Join Date: 9/30/2005
- Posts: 538
- Member Details
#1078 _ForgeUser41579

View User Profile

Send Message

Posted May 10, 2013
I love this plugin. It's worked great for a long time now. Thanks to andune for picking up the previous code and maintaining it for us whiners :)

Last edited by _ForgeUser41579: May 10, 2013

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

View User Profile

Send Message

Posted May 9, 2013
@DarkRyuZ7

Does he have permission to teleport to homes in other worlds?

Which would be hsp.command.home.otherworld

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

View User Profile

Send Message

Posted May 9, 2013
Now, next Problem...

Player got his home.

With the donator Permission, he got a second home.

He placed his First home on world A His Named Home on World C

If he uses "/home name" on World A, he doesnt came out on his named Home on C, it ports him to his unnamed Home on World A ?

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

View User Profile

Send Message

Posted May 6, 2013
@maximus107

Manage your teams through groups. Lets say you have team blue and team green, just use HSP's groupspawn capabilities to have people spawn at their group spawns whenever you want, such as onDeath. Something like: /setgroupspawn blue to setup a group spawn and then:

events: onDeath: - spawnGroup onSpawnCommand: - spawnGroup

to have them spawn there when they die or type /spawn.
Rollback Post to Revision RollBack
andune
- Join Date: 12/9/2006
- Posts: 728
- Member Details
#1074 andune

View User Profile

Send Message

Posted May 6, 2013
@Lars_1993

Check out the config_defaults.yml in your HomeSpawnPlus directory. It has a homeLimits section with a commented out example.

The simplest thing, based on your description, is to set the default properly and manage exceptions. For example, you have 3 worlds and 2 of them (anarchy and creative) you want at 1 home per world. So perhaps Survival you want to allow 2 homes? Here is an example config to do that:

homeLimits: default: perWorld: 1 global: -1 world: Survival: perWorld: 2

In this example, a player can have 2 homes in Survival but only 1 home per world on Anarchy and Creative. Perhaps you don't like that players can set homes in nether and end worlds? If so you could set the default.perWorld to 0 and then create a per-world setting for each world where you want them to be allowed to have homes.
Last edited by andune: May 6, 2013

Rollback Post to Revision RollBack
_ForgeUser8915684
- Join Date: 5/19/2012
- Posts: 1
- Member Details
#1073 _ForgeUser8915684

View User Profile

Send Message

Posted May 6, 2013
Hi. I have a new server and I'm trying to set up a way of having two pvp "teams" where you can only goto that team's spawn if you are on that team... Is there a way to do this? Thank you in advance =D.

Rollback Post to Revision RollBack
_ForgeUser5898762
- Join Date: 10/22/2010
- Posts: 13
- Member Details
#1072 _ForgeUser5898762

View User Profile

Send Message

Posted May 6, 2013
I am trying to do something, don't know if this is the right place to ask how, but bear with me.

I basically have a multiworld server (using multiverse), with 3 main worlds: Survival, Anarchy and Creative. Now I set up all the settings in the config file to the way I want and it works perfectly. The only thing I still want is setting different home limits for different worlds.

For example, I want all players, no matter what rank (except admins and higher, they have unlimited everywhere) to only have one home in the anarchy world. The same goes for the creative world, but here they have no homes at all.

For the Survivalworld, I want players to have different home limits depending on their rank. Newbies should have 1 home, Members 3, Veteran 5 and so on...

I read all the documents, but cannot figure out a way to do this (or atleast not understand a way :P)

Hope anyone has a solution. Thanks in advance.

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

View User Profile

Send Message

Posted May 5, 2013
@andune

Already saw it on both Jenkins and bukkit (still unapproved, but downloadable).

Thanks a lot for keeping this one alive. I really appreciate it andune :) +1

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

View User Profile

Send Message

Posted May 5, 2013
@ritzecraft

That is correct, this is an intentional break by the Bukkit team, you can read more about it in the Why so many versions link above.

Knowing they were intentionally breaking it on every major MC release, I made it very easy to update HSP to new CraftBukkit versions, it's a 1-line change. So I am able to update quickly and a build goes up on Jenkins as soon as I notice (which sometimes takes a few days as I'm not really active in the Minecraft community anymore).

Nevertheless, every time a new CB version change goes up, people come here and open tickets on the break and/or post comments because they don't go check Jenkins. All plugins devs warned the Bukkit team this would happen when they switched to the breaking changes, so there's nothing I can do about it except to ignore any whining I see (thankfully not too much) and just get new HSP builds up as quickly as I can when the breaking changes happen.

Speaking of which, new build is already posted as there's now a CB 1.5.2 beta, it'll appear in the Files list whenever Bukkit admins approve it.

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