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!
Comments
-
andune Owner
-
View User Profile
-
Send Message
Posted Sep 30, 2012@andune
Logged info about my plugins via BukkitInsider. HSP is one of the most heaviest plugins wich I have. Average plugin is about 1000 calls and 30us. And yours is about 10x higher. Btw, kinda weird to see a Bleach fan as java coder. http://lurkmore.so/images/8/8f/Typical_bleach_manga.jpg
ver HomeSpawnPlus
12:25:54 [INFO] HomeSpawnPlus version 1.7.1
12:25:54 [INFO] Author: morganm
ver
12:25:57 [INFO] This server is running CraftBukkit version git-Bukkit-1.3.2-b281jnks (MC: 1.3.2) (Implementing API version Unknown-Version) (It's CB)
-
View User Profile
-
Send Message
Posted Sep 29, 2012@Apple_columb
Want to provide a little more detail? Looks like a performance printout showing that HSP was called 12468 times and took an average of 1.5 milliseconds per call. Do you have a question in there somewhere? Perhaps some additional information to add if you think something is wrong? Or perhaps using your terminology: dafuq?
-
View User Profile
-
Send Message
Posted Sep 29, 2012org.morganm.homespawnplus.listener.HSPPlayerListener [HomeSpawnPlus, priority MONITOR] (12468 calls, 1524us avg) Dafuq?
-
View User Profile
-
Send Message
Posted Sep 29, 2012Severe error when some issues a command with a trailing backslash:
http://dev.bukkit.org/paste/6317/
Also: not typing named homes/spawns the exact same way result in a 'no spawn/home named ... found' (case sensitive?)
-
View User Profile
-
Send Message
Posted Sep 23, 2012@cbprog
R: v1.7.1 for CB 1.3.2-R0.1 .. hello? (lol)
btw (slightly off-topic): how do you earn Reputation points, and can you lose points? ;)
-
View User Profile
-
Send Message
Posted Sep 23, 2012@cbprog
It runs fine on 1.3.2. Did you even try it?
-
View User Profile
-
Send Message
Posted Sep 23, 2012Hello. When will support 1.3.2? Almost all of the plugins support is 1.3.2, but not you.
-
View User Profile
-
Send Message
Posted Sep 21, 2012@andune
Ok!, ticket open :D
-
View User Profile
-
Send Message
Posted Sep 20, 2012@Q2Lummox
This is not currently possible. A mode could be added to do something like:
Which would have the effect of spawning the player at their nearest home (bed only), if it was between 0-100 blocks away. Failing that, it would just spawn them at the nearest spawn.
If this is along the lines of what you are thinking, please open an enhancement ticket for this request. Similar distance checking code for the "nearest" spawns already exist, so this wouldn't be too hard to add.
-
View User Profile
-
Send Message
Posted Sep 20, 2012@gabizou
Interesting. /permcheck would be explainable by virtue of the fact that I haven't kept the plugin.yml permissions list for "hsp.*" up to date as new commands have been added. I'll update it manually for the next release and find a way to automate it so I don't have to remember to update it every time I add a command or permission node.
However /hsp is controlled by "hsp.admin" which is listed in "hsp.*", so that should be working. Assuming I understand your problem statement correctly, I don't know why that is.
-
View User Profile
-
Send Message
Posted Sep 20, 2012It would be possible to, that the beds are the point of "spawn", whenever you are at "X" blocks of distance?, If you are not within this radius, you appear in the "graveyard" closer.
For example, set your bed as spawnpoint. You are away from your home and die 100 blocks of distance, then reappear in your home (for, be in the range),
The same situation as you set your spawnpoint bed, leave your house, you move away 1,000 blocks, and kill you. This time, to be out of range of your "bed spawn" reappear in the nearest cemetery.
Is there any way to specify a radius from the bed spawn?, If you are within that radius, you appear in your bed, if you're out of range, reappear in the nearest cemetery.
If possible, as I can do this?.
Awesome plugin ... Thanks and regards.
-
View User Profile
-
Send Message
Posted Sep 19, 2012@diannetea
Yes, if you look at the homeLimits: section of the full config.yml, you'll see an example commented out.
The How HSP works documentation also has a description of the per-permission options (which work the same for events, costs, limits, cooldowns, etc). In particular, pay attention to the part about "Beware permission system inheritance". Most people setup the permission groups to inherit from previous groups and if you do this, you have to order your HSP permissions from highest precedence to lowest precedence in the config file. Read the doc, it has an example.
Last, there is a working example documented in Example 4.
-
View User Profile
-
Send Message
Posted Sep 19, 2012Is there a permission or something in the config to allow different ranks more homes?
-
View User Profile
-
Send Message
Posted Sep 19, 2012@andune
Changed it to just superperms for permissions and I can now use /home and /homelistother etc but nothing with /hsp or /permcheck.
-
View User Profile
-
Send Message
Posted Sep 19, 2012@gabizou
Thanks for the details. Try changing the last part of your config to just this:
This will tell HSP to bypass Vault for permissions and just use superperms (note Vault will still be found and used for economy, this just controls permissions). Please let me know if that fixes the issue, if I recall correctly you are the 2nd or 3rd person to report problems with the ".*" nodes when using Vault/bPerms. So if this change fixes it, let me know so I can document this issue in the FAQ.
-
View User Profile
-
Send Message
Posted Sep 19, 2012@andune
I get this when loading HomeSpawnPlus: http://pastebin.com/EkuVwyJx
Here is my config: http://pastebin.com/Ak9d83fx
And the permission nodes that I'm granting the admin group that doesn't inherit from anyone (we're op'ed anyways) are:
- hsp.CooldownExempt.* - hsp.CostExempt.* - hsp.WarmupExempt.* - hsp.admin - hsp.basic - hsp.command.home.otherworld - hsp.full - hsp.home.bedsethome - hsp.singleGlobalHomeExempt
With that, founders still can't do /home or /hsp, getting a green You don't have permission to do this.
-
View User Profile
-
Send Message
Posted Sep 18, 2012@Ekevoo
Sure. HSP not only has a YAML back-end, but it can use the same code to create a YAML backup and restore. The admin commands page covers the backup and restore commands.
You should backup while using whatever DB has your current data and then verify your data is in the "backup.yml" file. Then change to your new DB target and restart. HSP will come up with an empty database (and build tables automatically) and then you can just restore into that empty database and you should be good to go.
-
View User Profile
-
Send Message
Posted Sep 18, 2012Say, if I wanted to migrate from SQLite to MySQL, is there a command for that or am I on my own?
-
View User Profile
-
Send Message
Posted Sep 17, 2012@gabizou
As HomeSpawnPlus starts up, it should print out a message like so:
2012-09-13 04:00:38 [INFO] [HomeSpawnPlus] using VAULT:PermissionsEx for permissions
What does yours say? I have heard some users report strange issues with Vault and some other perm combos (bPerms perhaps?) about the children nodes not rolling up properly. I don't use them myself and haven't tested, but if I know your exact configuration I can try it out locally and see where the problem lies. If it's an HSP issue, I can fix it. I fit's a Vault/bPerms issue, at least I can put some info about it in the FAQ.
Something you can try, on the permissions page is documented the permissions config option, which can direct HSP to use specific permission systems. Try setting it to just "superperms" to see if that helps.
-
View User Profile
-
Send Message
Posted Sep 17, 2012So I'm using bPermissions and I'm getting something rather odd. HSP doesn't grant any permissions to OPs or the perm group that has hsp.admin, hsp.basic etc.
Members have hsp.basic and HSP is acknowledging that fact. It's not too much of an issue for the OP's since they get to teleport everywhere but it's a bit worrying. Any ideas?