HomeSpawnPlus

HSP

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!

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of andune andune Jan 23, 2015 at 04:27 UTC - 0 likes

    @keytastic: Go

    Beta3 is the most stable release right now. Beta2 and Beta1 have known bugs (such as the one you mention), so I'd generally recommend everyone should be running beta3 and if you have a problem running it, please open an issue so I can fix it.

    I can't speak to Spigot 1.7, I don't happen to have a JAR laying around and there isn't any documentation on how to use the new "BuildTools" method to produce one and I'm not motivated enough to try to hand roll one myself from source. But I do test HSP builds against both CraftBukkit 1.7 and Spigot 1.8 and in my tests, beta3 is working well on both.

    EDIT I should add that although I test HSP 2.0 on both CB 1.7 and Spigot 1.8: 1.8 is actually the "target" platform and therefore the most tested and supported. This is particularly important when it comes to HSP's integrations - many plugins are either 1.7 or 1.8-compatible, but not both (such as latest WorldGuard, Vault, etc). Where this happens I'm integrating against the 1.8 versions of these plugins, and for 1.7 these integrations would no longer work.

    Another way of saying it: HSP 2.0 will run on CB 1.7 and the core plugin will work, but features that require integrations with other plugins may or may not work depending on how those plugins have changed between 1.7 and 1.8.

    Last edited Jan 23, 2015 by andune
  • Avatar of andune andune Jan 23, 2015 at 04:22 UTC - 0 likes

    @Z3dd7: Go

    Yes I'm managing tickets in github and much prefer issues to be reported there. If I find a bug as a result of a reported issue, it's very easy for me to associate the fix with the issue when I check in the code, and you'll also get faster feedback on bug fixes as the code is checked in. I still check comments here on DBO but not as often. (I'll look at your ticket and try to reproduce the problem and respond to you on github)

    Last edited Jan 23, 2015 by andune
  • Avatar of keytastic keytastic Jan 23, 2015 at 03:18 UTC - 0 likes

    Can anyone confirm whether Beta 3 runs on Spigot 1.7.10?

    Beta 1 doesn't support UUIDs, so I updated to Beta 2 (still with Spigot 1.7.10) and it mostly works, but sometimes players do /spawn or /home and nothing happens.

  • Avatar of Z3dd7 Z3dd7 Jan 22, 2015 at 18:54 UTC - 0 likes

    Hi, I'm using HSP since a while now and I particulary like the random spawning feature.

    But since I updated HSP to 2.0 beta 1,2 and 3, this stopped working. Now the portals linked with HSP behave like standart portals.

    Here are the console logs : http://pastebin.com/XmSWqxtx

    We can see that both WorldBorder and MultiversePortals are loading fine, but HSP didn't linked with WorldBorder.

    Here are the concerned parts of my config (core and events are separated in two config files) : http://pastebin.com/m400t0mi

    So, is it a fail in my config or a bug in HSP ?

    Thanks for fixing/helping, Z3dd7.

    (I also created a ticket but I don't know if you are managing them)

    ZBDH5f1966a5e1000dbe7bcdc11c9b8fed5d

  • Avatar of keytastic keytastic Jan 18, 2015 at 01:42 UTC - 0 likes

    @andune: Go

    EDIT: Updating to beta2 fixed it.

    Last edited Jan 18, 2015 by keytastic
  • Avatar of andune andune Jan 17, 2015 at 19:27 UTC - 0 likes

    @keytastic: Go

    Turn on core.verboseStrategyLogging. What happens when HSP processes events will be verbosely printed out to the server log and you can figure out what's happening.

    Some possibilities:

    • If you've upgraded from 1.7 to 2.0, you might still have your old config.yml in place, yet you're modifying the 2.0 config files. HSP will prefer the 1.7 config if it finds it, so make sure you move it out of the way.
    • It's not uncommon for other plugins to also try to control login events. HSP will print warnings to your server logs if you tell HSP to do one thing and it notices another plugin did something else, so look at your log files.

    I'm sure there are lots of other possibilities, but best thing is to look at verboseStrategyLogging output and if you can't figure it out from there, zip up your HomeSpawnPlus plugin directory and pastebin your server log entries into a ticket and I'll try to help.

  • Avatar of keytastic keytastic Jan 17, 2015 at 06:37 UTC - 0 likes

    Hey, love the plugin! I've been using it for awhile, and I'm very glad to see you're still updating it!

    I'm having a strange issue that I can't fix, however. Here's what I want:

    • New player spawn (special area inside spawn world)
    • Default spawn (where everyone spawns every time they join the server)

    But no matter what I try, new players always start in the default survival world and other players retain their positions when they relog.

  • Avatar of andune andune Jan 11, 2015 at 16:02 UTC - 0 likes

    @RedJon28: Go

    Latest dev builds are at Jenkins. Old Bukkit rules prohibited a direct link without some special wording, I'm not sure if that applies anymore, so just look up on this main project page under 'Versions' for the Jenkins link.

    For your second request:

    commands:
      hub:
        class: CustomEventCommand
        event: hubevent
    
    events:
      hubevent:
        - spawnDefaultWorld
    

    Or if you had a specific spawn in mind instead of the default one, just use spawnNamedSpawn:spawnName. Don't forget each of those config sections go in their respective config files in HSP 2.0 config/ directory

    Last edited Jan 11, 2015 by andune
  • Avatar of RedJon28 RedJon28 Jan 11, 2015 at 01:38 UTC - 0 likes

    @andune

    1. 1 would you give me the link for that build because i cant find it lol. thx
    1. 2 I am trying to make a custom command /hub to take you to the default world and it doesnt work? can you show me how i would set it up to do that? plz thx

    ps works PERFECT!

  • Avatar of andune andune Jan 08, 2015 at 02:07 UTC - 0 likes

    @RedJon28: Go

    The "missing write method" should be fixed in the latest build (#586). The rest of that message is normal and completely benign. I have no control over it, the ebeans server built into Bukkit spits out those messages when it starts up. Despite the spam and the ominous sounding "ERROR ebean.properties not found", everything is fine and will work normally.

Facts

Date created
Sep 26, 2011
Categories
Last update
Jan 08, 2015
Development stage
Mature
License
GNU Lesser General Public License version 3 (LGPLv3)
Curse link
HomeSpawnPlus
Downloads
133,049
Recent files

Authors