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!
-
View User Profile
-
Send Message
Posted Aug 30, 2012@bukOhTwo
Just so I understand: you're saying your previous post permissions weren't working and you were getting a syntax error message, or you were getting a no permission allowed message?
And in any case, adding Vault fixed the problem? That is odd. What permission system?
Regarding sethome and bed, there's currently no way to do that although I suppose all the code exists so I could add it, sethome would just have to respect the "modeRequiresBed" flag. It was primarily designed for SP no-command use case where players right click on a bed to set home (thus impossible if no bed), and the "modeRequiresBed" strategy will not spawn a player at a home unless there is a bed within 5 blocks.
Which works the same with /sethome. While it would allow them to SET a home even if no bed in 5 blocks, but if you put modeRequiresBed in your strategies that use homes (such as onDeath or onHomeCommand), they won't be able to use that home if there is no bed or the bed is destroyed, etc.
-
View User Profile
-
Send Message
Posted Aug 30, 2012@ThisUsernameIsMine
They might be missing from the page, I'll have to check and make sure all the commands/permissions are up-to-date. However, the pattern is the same for all commands: /home is "/hsp.command.home", /sethome is "/hsp.command.sethome". So, groupspawn should be "hsp.command.groupspawn".
Thanks for pointing out it's missing on the documentation, though, I'll try to get that up to date soon.
-
View User Profile
-
Send Message
Posted Aug 30, 2012I ended up switching to Vault, and it ended up allowing permissions to pass. Can you guide me as to how to force sethome NAME to require a bed within 5 blocks? I had trouble following the examples... I tried onSetHomeCommand...
-
View User Profile
-
Send Message
Posted Aug 29, 2012@andune
Good lord.. How many keystrokes/mouse clicks do you do on an average daily base? (know WhatPulse? :-))
Thanks for clearing that up! Because of that worldspawn 'issue', i've decided to use VAULT perms again. But because of this change, i now can't find what permission nodes belong to the commands /groupspawn , /setgroupspawn (and probably some others i can't recall atm).
I've been visiting each page and found most perm nodes under 'User Command Reference', but it doesn't cover them all.
-
View User Profile
-
Send Message
Posted Aug 29, 2012@bukOhTwo
Thanks for the report. As per the comment just below yours, please try the latest dev version. It only has one change from the current release and I believe it will fix the issue. It would be great if a few folks having problems would try this dev build and report back whether the issue is fixed or not. Thanks!
-
View User Profile
-
Send Message
Posted Aug 29, 2012I'm having issues as well. HSP is claiming that we don't have permission to set a home (using /sethome NAME). I'm using bPermissions and the latest recommended build of HSP.
EDIT: I am using CommandBook, but the homes feature is disabled.
-
View User Profile
-
Send Message
Posted Aug 28, 2012@andune
Would those who have reported issues with HSP commands please try the dev 1.7.2 release which can be found on the Changelog page. I suspect it will resolve the issue.
However, I would also very much appreciate those who have had the issue reporting in on OS and JVM combinations. I've been unable to reproduce the issue in any of my local test environments and I've tried very hard to do so - but I don't run Windows on any of my machines (I don't even have one to test on - Linux & Mac only). It would be helpful to know if all the folks who have issues on 1.7.1 are Windows users.
-
View User Profile
-
Send Message
Posted Aug 28, 2012@gabe323
Thanks for the report. It's clear from people reporting in that there is a problem, but I'm unable to reproduce it locally so that I can resolve it. More information would help so that I can reproduce and resolve the issue.
If you are having an issue with HSP 1.7, first, please know that you can just install 1.6.3 and use HSP fine as before, the only thing you miss out on is new HSP 1.7 features. But if you are having an issue, I would appreciate you going to Ticket #135 and adding details about your installation so I can track it down.
As best I can tell, there is no conflict between Essentials and HSP. My working assumption at this point is that there is another plugin (or plugins) common to installations that are not working. If I can find a common plugin, I can install and reproduce the issue and resolve it.
-
View User Profile
-
Send Message
Posted Aug 28, 2012I've had the same issue of HSP commands not working after the 1.7 update. I've been using HSP + Essentials for the last 8 months with no conflicts.
-
View User Profile
-
Send Message
Posted Aug 28, 2012@Techwiz100
Invert your VIP permissions, list the most important first. HSP processes the list in order, and it's likely that your "vip10" users also inhereit your "vip5" permissions, so HSP checks "vip5" and stops there. Reverse it so "vip10" is listed first and it should work as you expect. Further reading on this behavior is in the online docs here.
To confirm my hypothesis (short of just making the change), you can run "/pc homes.vip5 playername" where playername is one of your vip10 users. My money is on it returning TRUE that they have the "homes.vip5" permission.
-
View User Profile
-
Send Message
Posted Aug 28, 2012@khobbits
Actually, the whole purpose of HSP dynamic command registration is EXACTLY to play nice with other plugins. And it appears to play fine with Essentials, and I see you're jumping through hoops to try to accomplish similar "play nice" in Essentials as well.
The two big advantages to HSP's new dynamic command system are:
Unfortunately Bukkit does not provide a robust dynamic Command facility, so plugins that want to provide their admins with more control have to work harder to do it (I see Essentials is no exception). I think CommandBook does it well and only wish sk89q had actually released his plugin framework for everyone to use. In the meantime, HSP's system serves the purpose well until Bukkit (or Mojang official API) publishes a better way for all developers to do it in the API.
-
View User Profile
-
Send Message
Posted Aug 28, 2012@Mayhem777
I never said other people weren't, only that with the information available to me (you're using Essentials and HSP), I'm not able to reproduce the issue. If I can't reproduce it, it's very difficult to fix it.
OriginalMadman reports he is using CommandBook. @Mayhem777, the error message you said was printed out seemed more like a CommandBook error, do you use CommandBook as well?
I'm a CommandBook user myself so for those of you having issues, as per my previous post, please share as much detail as you can (use pastebin): such as a full plugin list with versions (use the excellent PlugMan plugin and type "/plugman vlist"). Please share your HSP config and if you're running CommandBook, your CommandBook config as well.
Also, please share the exact behavior happening. OriginalMadMan says "the commands don't work at all" - do you get a permission error? Any error message? Or just silence?
There seem to be many people using HSP 1.7+ successfully (my own server included), so there is something unique in your environments causing the issue. I will be happy to fix it if I can reproduce the issue and track it down. Need more info, please!
-
View User Profile
-
Send Message
Posted Aug 28, 2012@andune
Ignoring bukkit practices and hacking dynamic command registration, is not a good way to cooperate with other plugins, but then again sk89q and team, never liked to play nice with others ;)
Normally plugins that do this, don't however conflict with Essentials, because they force themselves to highest priority (regardless of what the server owner wants). So I don't see why there would be any conflicts.
-
View User Profile
-
Send Message
Posted Aug 28, 2012See? more people having problems with homt,spawn etc... im using pex but IM op so i supposed to have all permissions and i still can't use commands like /sethtome /home /spawm etc, there's no error message on the console, there's just nothing, i've deleted ALL old data of plugin and installed new ver from 0, but doesn't work, im using R2 1.3.2
-
View User Profile
-
Send Message
Posted Aug 28, 2012I am having trouble setting up multiple permission based home location for VIP users on my server.
These are my settings for the VIP levels. Am I missing something?
-
View User Profile
-
Send Message
Posted Aug 28, 2012I have the same issue, /home and /spawn don't work now even in the latest "fix". I only have commandbook otherwise (no essentials etc) - where the modules are turned off.
No errors, and /listhomes work.
-
View User Profile
-
Send Message
Posted Aug 27, 2012@diannetea
To try to reproduce the issue, I installed Essentials on a test server tonight. I confirmed Essentials standalone behavior: /home and /sethome worked. I then installed HSP 1.7.1 (fresh install, no config changes, no usurping) and HSP /home and /sethome worked fine. Here is what I tested with:
So according to my testing, Essentials and HSP play nice together and there are no issues. @diannetea if you want further help with this please open a ticket and include relevant info such as: 1) full plugin list with versions 2) HSP config.yml 3) screenshot of the misbehavior (so I can see exactly what is happening). 4) bukkit.yml
Here is an example ticket that included all relevant information and I was able to reproduce and resolve the issue as a result. Ticket #131
Beyond you providing more info, I can do nothing further as I cannot reproduce your issue in local testing.
-
View User Profile
-
Send Message
Posted Aug 27, 2012@khobbits
Ah that was directed at me. So it seems Essentials does some interrogation of other plugins "plugin.yml" files and acts differently based on what it finds. It seems I will have to do some work to Command Usurping then specific to Essentials in light of this.
As to why HSP 1.7 plugin.yml doesn't contain commands, it's because they are dynamically registered now, much like CommandBook (notice their plugin.yml is devoid of commands these days, too). This lets admins turn on/off HSP commands through their config.yml so they don't have to remember to open and edit plugin.yml every time they update HSP. (A personal annoyance of mine from back in the days when I used to run Essentials, sounds like you have a better system now)
-
View User Profile
-
Send Message
Posted Aug 27, 2012@diannetea
The way HSP 1.7+ handles command registration has changed, specifically to allow for custom commands and also to now allow you to completely turn off HSP commands if you want (some people do). So, there's a LOT more flexibility in the 1.7 command system.
However, I did notice in my testing that the way commands are registered now seems to have some impact on the Command Usurping system I built, which in truth is somewhat of a hack that I built in order to make HSP users' lives easier since there are so many "uber command" packs that often have /home, /spawn, etc commands (such as Essentials and CommandBook).
Always the "best" way to alleviate command conflicts is to either edit the plugin.yml or config files of conflicting plugins, or to monkey with Bukkit aliases (for example, you could alias "/home" to "/hsphome" and it will always work, regardless of how you switch around your plugins).
But in the interest of making it easy for HSP users, I have Command Usurping, and it sounds like you were depending on that feature and it's no longer working the same. I specifically fixed it (and confirmed with testing) for CommandBook in HSP 1.7.1, but I've not run Essentials for a long time and have done no testing with it.
Interesting that it works in 1.6.3 and not in 1.7, since the Usurp mechanism for HSP didn't change at all, the only thing that changed is the way that HSP registers it's own commands.
In any case, plenty of options for you to fix the conflict between Essentials and HSP, feel free to choose any of them. When I get a chance, I will do some specific testing with Essentials and HSP Command Usurping and see if I can figure out what's going on and fix any issues.
-
View User Profile
-
Send Message
Posted Aug 27, 2012@andune
If you don't want to conflict with Essentials, list your commands in your plugin.yml ;)