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!
Neato nice update keep up the good work!
hey, can you make a command for invite other People? and thx for the nice Plugin ;)
@IIGoldII
The command you're looking for is documented on the admin commands page and is "/hspconvert spawncontrol". You will need the permission "hsp.admin" to run this command.
Hi, Is there any way for me to import my spawns from SpawnControl, original by TimberJaw, into HSP?How would I go about doing so?
Thanks.
@andune
Thank you so much!
@Drumpie
This is covered in the permissions page: you just need to give them the permission hsp.CooldownExempt.*
Is it possible to make a special Moderator group so that they can use Home and Spawn without a cooldown?
@Annlaw_Clayshaper
Sure, easily doable! I've documented your use case as example3 on the examples page.
Hi I have something specific I want to do on my server and I was wondering if it is possible with this plugin
I would like to create two spawnpoints for two different groups of users on my server but otherwise I don't want to interfere with their ability to set personal spawn beds.
I just want the people to spawn in their specific spawnpoint if their beds are missing or if its their first visit
Is this possible?
Annlaw
@Hangar
Thanks, fixed.
The link for User Commands on this page is bad:
http://dev.bukkit.org/server-mods/homespawnplus/pages/permissions/
@andune
I checked and rechecked the permissions for the player, and also made sure they didn't have OP status. I think I found the problem. Apparently wasn't on your end at all and I apologize :). There was a syntax error in the permissions file that apparently wasn't generating an error but mucked up some permissions. Corrected that and it's good to go. One thing I might suggest though is to move/add a message to display the cost of the warp while it's warming up so that players know they are about to get hit with a fee :)
@kuroneko42
It is likely whoever you are testing with has the 'hsp.CostExempt.*' permissions set. Please review the Permissions page for more info.
@TerraNetworkOrg
Before you go hunting, do note that HSP has a built-in debugging facility for strategies, so you can verify exactly what HSP is doing and what location it is returning:
When true, as HSP processes strategies, it will verbosely describe exactly what it's doing in your server.log file. Turn it on, type "/hsp rc" to reload live and then have one of your mods test. You will be able to see the exact location HSP wanted to send them to and why. If that's exactly as you expect (ie. the nearest graveyard), then some other plugin is monkeying with your ON_SPAWN event. If you don't get what you expect, you can debug it further from there based on the info in the messages.
I'm having problems with getting the commands to cost money. I think the settings are right and Vault appears to be loaded. But it never pops up a message or deducts funds. Any ideas? Thanks!
Then i have to search for the disturbing plugin .. strange. Thx! Great Plugin :-)
Found it! MyHome was interfering with the respawn, deactivated it and now it works for admins, too :D
@TerraNetworkOrg
Have you defined some permission-based override? such as:
If so, the permission is overriding your graveyard setting. You will have to turn that permission off for that world. If that''s not the cause, you may have some other plugin mucking with your respawn event, as short of defining a permission chain like above, HSP makes no distinction between player/op/mod when doing respawn strategy checks.
Hm still some problems with the graveyard concept
It works for normal players, but not for me as admin, what permission do i need to remove for admins?
1) Okay, i will post it as a feature request.
2) Will have a look into it!
3) Thx, will try it :-)
@TerraNetworkOrg
Currently per-group cost is not possible. It was on my todo list but I deferred it in order to get 1.0 out the door. It would be great if you'd post a ticket requesting this feature so I don't lose track and other people can vote it up if they like the idea.
Regarding a graveyard, I've been meaning to document some examples that show different scenarios for HSP so people can find one that matches their use case to get going quickly. I've started that page here, covering your request: http://dev.bukkit.org/server-mods/homespawnplus/pages/examples/
Last, setting up PEX (which I also use) would be just assigning a permission like 'group.Member' to your 'Member' group, then you can reference 'group.Member' as the permission in HSP. I did it this way instead of Perm2-style groups so that folks using Superperms (which lack the concept of groups) can also use the features of HSP.