HomeSpawnPlus
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 Owner
-
View User Profile
-
Send Message
Posted Apr 24, 2012Andune!
I love your plugin BUT i'm missing a feature i think is important to many of us.
(per) group-based spawn-stragegies.
What i want to do with it: I have a group called 'FailNoob'. The people that belong to it have
to (re)spawn in their groupspawn. With the current version of HSP it is possible to change
the order of the spawn-stragegies, but the order in which it looks applies to ALL groups.
I don't want other groups to spawn in their groupspawn, but in their homes (if they have one). i.e. i'm looking for spawn-stragegies that can be set-up per-group, not one stragegy voor all groups.
Hopefully you understand what i'm trying to point out ;-)
Best regards,
- ThisUsernameIsMine
-
View User Profile
-
Send Message
Posted Apr 24, 2012@fragger505
I already have that conversion built in as part of the HomeInvite updates I did in 1.5. I didn't think to apply it to cooldown/warmups primarily because I never expected someone would have some that long. :) In any case, it would be a trivial matter to add it into a future version now that the code is already written. Please submit an enhancement ticket so I don't lose track of the request.
-
View User Profile
-
Send Message
Posted Apr 24, 2012Can you implement a smart time unit conversion so that way player won't get cooldown/warmup notifications of meaningless values like 2133seconds to 35m33s
-
View User Profile
-
Send Message
Posted Apr 24, 2012@WayGroovy
I'm not entirely sure I understand your goal. It sounds like you want a plugin to "remember" where the user last was when they leave a given world, but then you sound like you want said plugin to ignore that value and just do whatever you've programmed it to do (spawn, homes, etc). I don't see in your explanation where you're ever actually using the recorded value?
I'm not entirely sure the feature makes sense for HSP, but maybe if I understand the intended use case a little better I can decide if it makes sense and is worth implementing.
-
View User Profile
-
Send Message
Posted Apr 24, 2012@Meryrn
I'm not sure that's possible right now and to be honest, it wasn't really intentional before, it was just a side-effect of how it was done. I've had complaints about the 2-bed clicks, complaints about the message being printed, complaints about it not being printed and requests to have vanilla SP behavior. You're a difficult group to please. ;)
In an effort to allow people to do all these different things, I added a few options in the last version so people could choose the behavior they wanted. However, I never expected someone to use it in the way you describe (even though that was default behavior before) so I will have to add another option for that. Next version. :)
-
View User Profile
-
Send Message
Posted Apr 24, 2012No need answer me. I already figured out with that problem. Maybe author needed add in description that this plugin conflict with xAuth and perfect working with AuthMe.
-
View User Profile
-
Send Message
Posted Apr 23, 2012I'm searching around for a plugin to manage multi-world location, and I think that this has Most but not All of the features I'm looking for.
I'm trying to find a plugin that will monitor a players location on each world, such that on warp or logout out of a world marks their location, and on warp back to the world or login it follows the normal rules for that world's spawn, even if affected by other plugins, like random-spawn.
Basically, I'd like each world to be treated as if it were it's own server, for warping and login logout purposes...
Any help would be appreciated. Thank you for your time.
-
View User Profile
-
Send Message
Posted Apr 23, 2012Hi. I have on my server your plugin and xAuth, i use your plugin for multispawn for 4 groups, and when player join server and need reg (xAuth) they spawn on standard first spawnpoint (before HSP, created with essentials /setspawn), but not groupspawn. How can i fix this? Maybe need some permissions for groups? and how to do specific group death point (group graveyard).
My config for now:
I disable essentials spawn and homes, and add in config:
Will be appreciate if you help me. THX
-
View User Profile
-
Send Message
Posted Apr 22, 2012So.. with releases after 1.5, how do you go about sleeping in a bed without setting that one to your home?
It was possible to sleep at night, and two-click at daytime to set it as your home back in 1.5, not anymore..
Atleast I can't figure out how to do it.
-
View User Profile
-
Send Message
Posted Apr 21, 2012Oh, excuse me. When i am updating server, i makes folder and test new plugins.I forget smthing and this folder was with russian symbols) Now all OK
-
View User Profile
-
Send Message
Posted Apr 21, 2012Sry, i thought you are updating it to 1.2.5 :D http://pastebin.com/rxAa3bAB its error =)
CraftBukkit version git-Bukkit-1.2.5-R1.0-b2149jnks (MC: 1.2.5) (Implementing API version 1.2.5-R1.0)
HSP 1.5.1, 1.5.2, 1.5.3 doesnt work, ololo
-
View User Profile
-
Send Message
Posted Apr 21, 2012@Armani76
First thing to do is make sure the players have the permissions you intend using whatever permission system you have, most of them have a built-in way to validate.
When HSP starts up, you should see something like:
This will tell you what permission system HSP thinks it is working with. If that's not what you expect, then check out the permissions page for help or ask back here.
Last, note you can use hsp aliases to be sure it's not some other plugin eating your commands, so try: /hsphome and /hspsethome to see if they work.
-
View User Profile
-
Send Message
Posted Apr 21, 2012@Zeluboba
What doesn't work? Do you have any errors to report? Here are my versions:
and it works fine. Perhaps you could post something more useful than "it doesn't work" if you want help?
-
View User Profile
-
Send Message
Posted Apr 21, 2012Hi, nice plugin ) but have problems with permission. Admin can use this plugin, players haven't access to these commands with "You don't have permission to do that"
My "permissions.yml" in bukkit base folder have next script: groups: default: default: true permissions: - modifyworld.* - hsp.command.home - hsp.command.sethome - hsp.command.spawn ...
In command book, I made your recommendation changes disabled with "homes" and "spawn-locations" "low-priority-command-registration" to true.
help me please, thanks a lot !
-
View User Profile
-
Send Message
Posted Apr 20, 2012doesnt works with 1.2.5 at all.
-
View User Profile
-
Send Message
Posted Apr 19, 2012@OriginalMadman
Thanks for the report, another user opened Ticket #93 for this issue and I've confirmed it's specific to 1.5.2 and downgrading to 1.5.1 does fix it. I'll add it to the 'known issues' for 1.5.2.
The issue is already fixed in dev (for 1.5.3), I just haven't released it yet as I'm adding a few other small features and waiting for any more bug reports so I can get a 1.5.3 out that will last us a little while. :)
-
View User Profile
-
Send Message
Posted Apr 19, 2012Hi, after upgrading from 1.5.1 to 1.5.2 all my players named homes stopped working - but regular /home still worked. This in console:
2012-04-20 08:02:11 [WARNING] [HomeSpawnPlus] Strategy homeNamedHome was not given a homeName argument, nothing to do
I downgraded to 1.5.1 and they work again.
-
View User Profile
-
Send Message
Posted Apr 19, 2012@frebib
The second config file (config_defaults.yml) is simply provided for your reference, which shows the full config options and their defaults. It is not referenced by HSP in any way and is overwritten everytime HSP starts up.
The only config file that matters is "config.yml". With a fresh install, this is a simplified config which covers the basics a person might want to tweak just to get going. If you want all the options, you could copy config_defaults.yml over config.yml and start tweaking. Or if you see some options in config_defaults.yml you want to play with, you can just copy those sections over, whatever you want.
-
View User Profile
-
Send Message
Posted Apr 19, 2012I understand that there are 2 config files, I am not sure whether all config params need to be in the config.yml or I can use both respective files concurrently?
-
View User Profile
-
Send Message
Posted Apr 19, 2012@krisdestruction
OK I can see a brief pause as well, I added some timing debugs, here's what I'm seeing:
http://pastebin.com/ZJc8LKBb
The total startup time here is 675ms (.6 second) and 96% of that time is spent starting up the database (using SQLite). I see the same when using MySQL, the database is 95%+ of the startup time. Interestingly using the new YAML backend (as of 1.5) cuts startup time down to 112ms. But this is on my test server, the YAML files are tiny, not sure how quick it would load if you had 10000 homes.
In any case, I suspect the long DB startups are due to the "Persistence reimplemented" feature, since it has to load it's own EBEAN instance instead of just using the one Bukkit already has loaded. This comes packed with live-reload benefits, but for those more concerned about shaving .5sec off their startup time, I might offer an option to just use the native Bukkit ebean implementation.
Here is a dev version, which is just v1.5.2 with some startup debug timings:
http://dl.dropbox.com/u/1743272/Minecraft/HomeSpawnPlus/HomeSpawnPlus-1.5.3-dev.jar
Feel free to use this one, set "core.debug=true" in your config.yml and you'll end up with the same timing info in my pastebin. Please report back if you're seeing anything different.