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!
i dont see this worth a ticket cause im not sure if its homespawnplus or another plugin overriding.
homespawnplus works perfect for me, but when i install spout it starts to always spawn my users at the global spawnpoint if they reconnect. this is verry annoying, and i dont know why this just happens when spout is active.
i tought already about the possible issues, i think it must be something that uses the spout api and overrides the spawn then. i can say its not multiverse worldguard commandbook or other plugin so far. at least not what i would see in my current configs. its realy confusing me and the strategy is set to default after newplayerspawn ... realy weird. maybe theres someone also having this issue.
@Zenonic
Please use the dev.bukkit tickets to check for existing enhancement requests and feel free to make your own there. I will lose track of them if they are just in the comment stream here.
Regarding a home invite, Ticket #28 has been opened requesting that feature, please feel free to go comment on that ticket if you have further ideas/requirements for that enhancement.
Regarding PEX multigroups, this probably wouldn't be that hard to implement, it would be similar to how the current home/spawn have a ".named" setting. In any case, please open an enhancement ticket for it and I may get around to adding it in a future version as I have time.
@mumblerit
The "my.custom.perm" is whatever you want and it is defined using your permission system (PEX, bPerm, Superperms, etc). Maybe you have a "group.Member" permission that is associated with your "Member" group already, you could just use that (I imagine this is the most common usage). Or, for example, you could define a 60-second cooldown and call it "hsp.custom.cooldown.60sec" and then associate that (using your permission system) to whatever groups you want to have that setting.
It's totally up to you and your permission setup what permission you want to use, HSP doesn't care: as long your permission system returns "true" when HSP checks for the permission you list, then that cooldown/warmup/cost entry will be active for that player.
Another suggestion would be to further develop the ability of visiting other people's homes(something similar to /home invite from MyHomes so you would need the home-owners permission to teleport to the home)
Is there any chance HSP will support PEX multi-groups for groupspawn? (if a player is in groupA or groupB they could write /groupspawn groupA or choose to /groupspawn groupB).
You added cooldown per permission and some settings here, http://dev.bukkit.org/server-mods/homespawnplus/pages/cooldowns-and-warmups/
however my questionis where do you define the my.customer.perm, perhaps a quick example?
@dademon216
HSP's "disableCommands" config option was an attempt at allowing exactly what you are describing. HSP will stop listening to /home and /sethome if you turn on the disableCommands for them, but sadly, Bukkit provides no way to actually release those commands so another plugin can use them.
So for now, your only option is to open up HSP's "plugin.yml" and edit out the /home and /spawn commands. Or another thing you can do, is rename either HSP or MyHome to the alphabetic order you want (so rename aMyHome.jar or perhaps zHomeSpawnPlus.jar). Right now that's the only way Bukkit provides an admin for controlling which plugin gets which commands (sad, I know).
HSP can use some trickery to actually usurp commands from another plugin that has already registered them, so for example, if you install CommandBook and find it is snarfing your /spawn and /setspawn for example, rather than editing CommandBook's plugin.yml, you can just tell HSP to usurp those commands.
@stargateanubis14
I guess I'm not sure what you mean by exact spawning. This plugin uses the exact same mechanics as the original SpawnControl in that it records the *exact* location that you set a spawn, using the Bukkit floating point locations as well as the pitch and yaw. When respawning, it then sends the player to those *EXACT* coordinates, so the player respawns *EXACTLY* where you were standing/facing when you typed /setspawn.
I would not expect any behavior difference between HSP and the original SpawnControl in this regard. If you can describe a reproducible test scenario that shows HSP not working, please open a defect ticket with your description and I will do my best to recreate the scenario and fix whatever the problem may be.
@RedPoptarts
Hmm, thanks for the report. It does appear the "basic" file is getting copied into place of "config_defaults.yml" instead of the advanced one. I could have swore I tested this and saw it work, but I'll dig into it and figure out what's going on.
I know its a weird request, but I used SpawnControl for exact spawning. I use MyHome for homes.. Is there a way to completely disable /home and /sethome *just for this plugin*?
I want this one to be for /spawn and MyHome for /home.
Permissions arent doing it and I can't disable home in this config without disabling it completely.
for some reason, this doesn't have exact spawning... (eg, if there is a block on top of the spawn location, they spawn on top)
This is the only reason i was using spawn control >.>
Love the new additions, very well organized and easier to use and configure than before.
You are missing a few options from the config-default.yml though.
usurp commands is explained in some advanced documentation, but is not included in the new config-default. I think there's some more that's excluded, but I didn't know if you intended the default config to contain all available options or not.
Keep up the good work!
@ksevelyar
Hmm, sorry I wrote up a response and it got lost somehow. HSP does support Superperms and I've updated the description here to reflect that as well as added some more detailed info about it's permission support on the permissions page.
With the upcoming holidays, I will have some time to work on HSP and complete a few feature requests. Existing users please look over the tickets and vote for the ones you want. In the absence of any votes I'll just pick one or two I like to implement. If I get enough votes for features to establish an order of priority, I will most likely implement the most voted feature requests.
This plugin was designed to work with Permissions 2.7, 3.0 or a similar compatible plugin (GroupManager, PEX, etc).
Does the plugin support Bukkit Permissions?
@andune
I found a really bad bug! When you set a limit of homes a user can have and you enable iconomy, the user tries to set a second home, the money is taken from him, but he can't set the home. Pls fix it :-)
@andune
Ok thx. I've done it local with a SQLite-Tool.
@sykefuu
Yes it does.
will this support multiple homes per player ?
@TerraNetworkOrg
Right now, there is not, short of deleting it from the underlying database. Would be a pretty easy feature to add.
Is there a way to delete a specific spawn?