CompassHome
CompassHome
We've all seen the fancy teleportation systems that involve right-clicking the compass and then selecting the location you want to go to. But have you ever wished your players could teleport to their homes this way? Or just have the compass point to their home? Well, this plugin is perfect for you!
Features
- Players can set homes at a location
- The administrators can set a limit on the number of homes a player can set
- The administrators can choose whether players should be teleported when they select a location or have their compass updated to point there
- The administrators can define any number of public warps that players can use
- The administrators can select the item used in the teleportation menu
- The administrators can decide which item to display for a warp
- And more...
Think we're missing a feature? Post it in the comments or submit a feature request!
Configuration
The configuration file is fairly simple and straightforward.
Configuration option | Value (default value) | Explanation |
---|---|---|
teleport-on-select | Boolean (true) | Whether players should be teleported when they select a home/warp (true) or their compasses updated to point to that location without teleporting the player (false). |
allow-cross-world-teleportation.homes | Boolean (true) | Whether players can teleport to their home that's in a different world. |
allow-cross-world-teleportation.warps | Boolean (true) | Whether players can teleport to a public warp that's in another world. |
materials.home | Material (ENDER_PEARL) | The item that should be used for the player's homes in the teleportation menu. Must be a valid Material |
materials.warp | Material (EYE_OF_ENDER) | The item that should be used for the public warps in the teleportation menu. Must be a valid Material |
maximum-homes | Integer (10) | The number of homes a player is allowed to set. |
auto-updater.enabled | Boolean (true) | Set this to false to prevent the plugin from communication with Bukkit Dev to check for updates. |
auto-updater.download-new-updates | Boolean (true) | If this is set to true, the plugin will automatically be updated once a new version is approved on Bukkit Dev. Setting this to false will only display a notice in the console. If auto-updater.enabled is set to false, this does nothing at all. |
Commands
- /sethome <home name> Set a home at the current location. The name must be alphanumeric and cannot contain spaces.
- /delhome <home name> Delete a set home.
- /setwarp <warp name> Set a public warp at the current location. The warp can be accessed by anybody. The name must be alphanumeric and cannot contain spaces.
- /delwarp <warp name> Delete a public warp.
- /compass Open the Teleportation Menu.
- /warpitem Set the item shown for a certain warp in the Teleportation menu.
Permissions
Permission name | Default | Description |
---|---|---|
compasshome.use | Everybody | Allow right-clicking the compass to bring up the teleportation menu |
compasshome.compass | OP | Allow opening the teleportation menu via command (/compass) |
compasshome.sethome | Everybody | Allow access to /sethome and /delhome |
compasshome.sethome.unlimited | OP | Bypass the maximum-homes check |
compasshome.setwarp | OP | Allow creating a public warp |
compasshome.delwarp | OP | Allow deleting a public warp |
Screenshots
Click for larger images
Support
If you found a bug or have a feature request, please open a ticket on GitHub: Issue tracker If you don't know how to do something or aren't sure if you've found a bug or not, post a comment over here on Bukkit Dev or hop onto IRC: #deprecatednether on irc.esper.net (web chat).
If you like this plugin, a donation is always appreciated. You can donate via PayPal or send me Bitcoins to 1EGtvgv8xrR7MqpiFWocsC5euYPPSeXQ1G :)
Inspired by mw74126's request.
xDDDD
I had an updated version of the plugin uploaded (waiting for approval). It introduced an auto-updater (which can, of course, be disabled in the configuration). Since there is a bug in the system it uses for update checking, everybody using the new version (0.3) would be downgraded to 0.2.
I've deleted the file (it hasn't even gone through the approval process at the time) and will get a fix for this, which will most likely involve disabling the update checking by default, unless I can think of a better way to fix this problem or the fine folks at Curse fix the issue.
Post about the issue with the Curse API: http://forums.bukkit.org/threads/servermods-api-not-refreshing.269228/
Thanks! It's awesome to see it as a plugin! Will be installing it ASAP!
@mw74126
Actually, it was your topic on Punchwood that gave me the initial idea :P I was going to put a link to the topic but couldn't find it anywhere (it's easier to find it now that I know your username). I've added a link in the description crediting you for the idea now :)
Looks cool! Out of curiousity, did you think of this from this suggestion? http://forums.bukkit.org/threads/req-compass-to-point-to-sethomes.170144/