LodeStar
LodeStar
Allows the creation of items that are bound to named destinations. An extension of the SpawnStar plugin, but not just for spawn anymore! You can set a destination, similar to warps, and then bind any item to that destination so that when used, it will teleport the player to the destination.
Features
- A fully configurable item that teleports a player to preset destinations. Default item is a netherstar, but can be changed to any item.
- Includes all the functionality of SpawnStars, and a whole lot more!
- Customizable display name and lore.
- Option to teleport back to overworld spawn from nether or the end.
- Configurable cool down period.
- Configurable warm up period, with optional particle effects during warm up.
- Individually configurable options to cancel teleport during warmup on damage, movement, or block interaction.
- Configurable option to remove item from inventory on use, after successful teleport, or never.
- Configurable option to prevent using LodeStar items in crafting recipes.
- Configurable option to require shift-click to use.
- Uses MultiVerse world aliases in messages, if installed
- Uses MultiVerse world spawn location, if installed. (So players will be looking in the right direction on respawn.)
- Configurable per message repeat delay (message cooldown) where appropriate.
- Customizable language support.
Quick Start Guide
This will get you started while I create some documentation.
Perimissions
Permission | Description | Default |
---|---|---|
lodestar.use | Gives a player the ability to use a LodeStar. | true |
lodestar.list | Allows displaying a list of all LodeStar destinations. | true |
lodestar.admin | Parent node that gives a player all of the following permissions: | op |
lodestar.set | Allows players to create LodeStar destinations. | op |
lodestar.set.overwrite | Allows players to change LodeStar destinations. | op |
lodestar.delete | Allows players to remove LodeStar destinations. | op |
lodestar.bind | Allows players to bind a LodeStar destination to an item in hand. | op |
lodestar.give | Allows players to give LodeStar items to other players. | op |
lodestar.destroy | Allows players to destroy a LodeStar item in hand. | op |
lodestar.reload | Allows reloading of configuration files. | op |
lodestar.status | Allows viewing configuration settings. | op |
Commands
Command | Description |
---|---|
/lodestar reload | Reloads the configuration without needing to restart the server. |
/lodestar status | Displays configuration settings. |
/lodestar set | Creates a LodeStar destination at current player location. |
/lodestar list | Displays a list of all LodeStar destinations. |
/lodestar delete | Removes a LodeStar destination. |
/lodestar give | Allows those with permission to give LodeStar items directly to players. |
/lodestar bind | Binds a LodeStar destination to an item in hand. |
/lodestar destroy | Destroys a LodeStar item in hand. |
Installation
Simply drop the LodeStar.jar file in your server's plugins folder, and restart the server. Once the plugin has been loaded, make any customizations to the config.yml file, or the appropriate language file in the languages sub-directory. All display settings such as item name and lore are contained in the appropriate language files rather than the config file. When you are satisfied with the configuration, simply issue the reload command to apply configuration changes; restarting the server is not necessary to affect configuration changes.
Configuration
Source Code
The source code for this project is hosted on github.
https://github.com/tim-savage/LodeStar
The current version (v1.0-beta2) requires a server restart to load changes that occur in the language files, such as item names and descriptions. This has been fixed so the next version will pick up any language file changes after a simple /lodestar reload.
@Ceress
The only particles that are accessible directly from the bukkit api are the ender particles used, and the flames that mob spawners give off, which really didn't look right at all when I tried them. Edit: and smoke too. There may have been one or two others, but none worked well for this application.
There are libraries that allow access to all of the different particle effects in the game, so it is possible I could use one of these external libraries in a future version.
Love it! Thanks so much to both of you, then!
Any chance the particles could be made selectable in the future, as a side feature?
@Ceress
Credit goes to keeganjohn for suggesting this addition to SpawnStar. It was so good, it warranted a plugin of its own.
I think this is going to be a very useful plugin, mainly due to its flexibility. I've tried to make it so that all messages and items are fully customizable.
There's a few bugs I've discovered so far and fixed, so expect a fresh v1.0-beta2 upload later tonight. The major bug I found prevents using the reload command, so that needed to be fixed right away.
Ooooh ho ho ho... Must try this one out! Have you been reading my mind Tim? This will be able to do several things so much more simply, for me!
I've already found and fixed a bug that was preventing the reload command for working properly. I will have the fixed version uploaded shortly. Stay tuned...
This plugin is an enhanced version of my SpawnStar plugin, with functionality similar to warps found in essentials and other plugins.
It is a work in progress, currently marked as beta. There will be bugs, but I'll try to squash them as quickly as possible when found.
The documentation is also a work in progress, but I'm trying to get it posted as quickly as I can write it. For now, see the Quick Start Guide.
Thanks for your interest, I hope to make this a polished plugin that will help you make a more immersive experience in your survival worlds, by using physical items rather than commands for teleportation.
- Tim Savage