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 have installed this plugin to my server and now i want to give my player permission how do i do that i am useing group manager can you give me an example how i give permission
@Jameshobbs
This should be fixed in the latest Jenkins build. For future bug reports, please use github issues so that I can link code fixes with the issue that reported them.
Alright, installed the latest version from jenkins and the import/conversion from essentials works exactly right and all is great!
Sadly however, I have a strange issue.
My default world is "world". I can use the /sethome command no problem.
If I switch to the world "factions", then sethome throws the following exception: http://pastebin.com/VYbxHYS3
Is this 1.8 compatible? Also, does this plugin allow players to set more than one home, and can the amount be changed for different ranks? Such as Member can set 1 home, Donor can set 2, VIP can set 3.
Yes it is 1.8 compatible. Yes players can set more than one home. Yes the amount can be changed for different ranks. The plugin allows a lot of customization, so there's no "1-2-3" prescriptive solution to your problem, but documentation for all the things you asked for exists on the dev.bukkit.org site for HomeSpawnPlus, so please look there.
@andune
Good to hear that name changes are supported!
I will take a look at the home spawn plus dev build tonight. Thanks for the information!! And I am also glad that the issue is resolved haha. I'll get back to you when I get things installed and tested.
@Jameshobbs
Thanks for the files. I was positive I fixed this issue, so after looking at the data and then the code, I see that I'm not going crazy, it is fixed:
https://github.com/andune/HomeSpawnPlus/issues/39
And this shows up in the Jenkins change log in build #615, built on Feb 14:
http://andune.com/jenkins/job/HomeSpawnPlus/changes
Sadly, the release version here on DBO was built on Feb 9. Just further confirmation that I'm long overdue for an update here to DBO.
TL;DR: download the latest build off of Jenkins. The dev builds on Jenkins are extremely stable and have all the fixes from any bugs reported since the last release here on DBO on Feb 9.
@Jameshobbs
"Also will you be supporting UUIDs for homes in the future rather than the player name?"
HSP tables related to players use player name and HSP tracks UUIDs for changes. If a player changes their name, HSP will notice and update the database entries to the new player name.
@andune
Thanks for the reply andune.
Here is the userdata for my player from essentials: http://pastebin.com/MjSzxqaS The name of the file is: 46045e50-33bd-45db-8600-ab4dbc7549d1.yml
And here is the conversion into the single yml called "data.yml" in the HomeSpawnPlus directory. http://pastebin.com/HhEiy5P5
Hope this helps. Also will you be supporting UUIDs for homes in the future rather than the player name?
@Jameshobbs
I'm not sure what you mean by player name listed as UUID? HSP uses player name as the primary key and I recall having to update the Essentials converter to account for UUIDs in the Essentials files. Last I knew it was working, but I don't play or keep up with other server plugins anymore so if something is broken I won't know it until someone reports it here.
If you'd like, feel free to zip up your Essentials and HomeSpawnPlus plugin directories - as long as you aren't using MySQL, I can then interrogate the database to see if there are any clues and I can also test the import myself locally and do some debugging to see if anything turns up.
Love the plugin! Really awesome features and is exactly what I was looking for.
I attempted the import essentials command and it worked perfectly except I am not seeing any of the homes listed when using the list homes command.
One thing I noticed was the player name is listed as a UUID. Would this cause issues when trying to list the homes?
@andune
Hi, yea we run it very successfully on spigot,and love it, I was just wondering if there were any plans to copy it across to the spigot resource forums? I stumbled across it quite by accident, which is a shame for such a great plugin. :)
@frizzbee30
Yes. When I wrote HSP v2, I wrote it with a server abstraction layer, primarily because I was writing v2 when MC-API was getting a lot of buzz and I didn't expect to have a lot of time to come back and write and maintain HSP for different servers later, so I put in the work up front while I still had time. I've already started the Spigot implementation, back when API v0.1 was first released. I understand there is now a working server implementation to test against, so sometime soon I can pick work back up again and start testing.
I also expect HSP will work with whatever Spigot/Bukkit shim is eventually made, but regardless, HSP will run and support Spigot APIs directly. Thanks to the server abstraction, 90% of the code base will remain the same so it will run the same on both Bukkit and Spigot, and eventually MC-API if that's ever released.
Hi, any plans to copy this across to spigot? It's an amazing plugin that should get more exposure :D
@FiftyWalrus
Sure. Something like:
or replace spawnDefaultWorld with whatever makes sense for you. Perhaps spawnNamedWorld:theSpawn or spawnSpecificWorld:theWorld.
By not specifying anything other than the one world event, all other events will be set to just default, meaning they will do nothing.
if i start/restart my server, everything is good with the plugin.
but after a few minutes, the plugin doesn´t respond
Can I use this plugin to only run an event for a specific world? I'm using FarmWorld, and want players to be sent back to Spawn when the login, to avoid them logging in a suffocating when the world is changed.
@robvan
That is bizarre, I have never heard of that issue before.
It is certainly possible, HSP does listen to the "right-click" event in order to provide it's various bed-related functions. But that behavior has been in for many years and I've never seen this issue reported, so I have a hard time imagining the unique set of circumstances that would cause this problem.
HSP is open source, so if you want to eliminate this possibility, feel free to clone the source off of git and build your own copy. Here is the code that hooks the right click event:
https://github.com/andune/HomeSpawnPlus/blob/master/bukkit/src/main/java/com/andune/minecraft/hsp/server/bukkit/BukkitEventDispatcher.java#L168
Just comment out the @EventHandler annotation on line 168 and rebuild the JAR (Instructions for building can be found in the README on the main project page: https://github.com/andune/HomeSpawnPlus/). You'll then have a copy of HSP that doesn't hook this event, so don't expect some of the bed-related features to work, but you may find that it solves your particular issue. If so, I would be interested to hear back and any additional information that could help troubleshoot the problem, though at the very least if you confirm this fixes the issue I could provide a config option to do the same in the release version of HSP.
Nice plugin. I ran into a problem and am wondering if I have something configured wrong, or if it's an incompatibility issue.
With this plugin installed, my users lose access to open chests and build/break blocks. Once I remove this plugin, everything works fine again.
I'm using griefprevention and pex plugins on CB 1.8.4-R0.1-SNAPSHOT.
Thank You.
@andune
Excellent! Thank you for the fast reply and great work on this plugin.