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!
@HotelErotica
Ah, apologies, a typo on my part: the new strategy is "modeHomeNoBed" - i've updated the ChangeLog to reflect that and will update the web documentation soon.
@andune
Mind giving a little insight on the new strategy? Wasn't "modeHomeBedOnly" already a mode?
@bigscary
At the moment, the plugin keeps track of player data in the DB and uses that to detect "first login", however you bring up a good point about an estalished player base. I may add to the new player algorithm to include looking for the player .dat file in the default world, and if present, will assume the player is not new.
Regarding your request for inviting to /homes, I figured someone would ask for that eventually.. :P Please submit a ticket with your enhancement request so I can keep track of it. To be clear, is the desired functionality a 1-time invite or more of a permanent "invite until revoked" invite? Just include that info in your ticket, I'll think on it some more.
Hey andune, I'm confused a little about what exactly you mean by "new player first login". Do you mean that after installing the plugin, everyone who logs in will be spawned there, OR do you somehow detect whether or not a player has been on the server before your plugin was installed to decide where to spawn them?
I ask because players on my server have been there a while, and I wouldn't consider them "new", but your plugin might see them as "new to it". I'm worried that after I install this plugin, they'll be confused because the next time they log in, they'll be in a different place from where they logged out.
Also, will you please consider adding an option for players to invite other players to teleport to their home? It will help lots for players who want to adventure together or share their builds, and especially for the case where a friend of yours has just joined the server and you'd like to start playing together.
@HotelErotica
Done, this is added in v1.0.2, which the Bukkit dev admins should approve shortly. I didn't get a chance to test it, but it was a simple enough change so hopefully it works well for you. Let me know if you find otherwise.
You think you can add one more thing for me? :D If you could add one more strategy, like "modeHomeNoBeds" basically make it so when someone types /home, it'll only take them to a home that has been set with the /sethome command and not the one set by clicking the bed.
@craftopia
Economy support has already been added, through the optional Vault dependency, which has the advantage that it supports whatever economy plugin you all want to run on your servers (including BOSEcon). So you can already charge for /sethome, /home, /spawn, etc with the plugin today.
Currently multiple homes in a single world is under active development (60% done), so that will be in the next release.
Economy support so I can charge my players for multiple homes would make this the ultimate plugin! I use BOSEcon so keep that in mind please :)
I would like to see iConomy support, having players pay for their home tp and home creation.