Wormhole
Wormhole
Teleport to Saved Locations using Commands and Signs
Wormhole aims to be a secure sign- and command-based teleportation plugin, by separating jump destinations into private and public jumps.
Use commands to add/delete jump teleportation destinations for your player. Set signs to point to jumps, right-click the signs, and you're off! Need to go back to your last location? No problem, just use the "/worm back" command!
Don't be afraid to donate a little (top-right); college kids need cash :)
Features
- Use signs or commands to teleport to "jump" destinations.
- Separation of public and private (per-player) jumps.
- Charge or pay players for certain actions.
- Configurable visual and audible effects.
- Quick, easy, and extensive command syntax.
- Tab completion of commands and jump names.
- Extensive control through permissions.
Commands
Note: [This means optional] and <this means required>.
- /wormhole - Display all wormhole commands (alias "worm")
- /wormhole reload - Reload config
- /wormhole version - Display version information
- /worm add [player or "public"] <jump name> - Create a new jump destination
- /worm back - Jump back to previous location
- /worm cost - Display the cost of all actions
- /worm delete [player or "public"] <jump name> - Delete a jump
- /worm jump [player or "public"] <jump name> - Teleport directly to a jump
- /worm list [player or "public"] [page number] - List jumps
- /worm rename [player or "public"] <old name> <new name> - Rename an existing jump
- /worm replace [player or "public"] <jump name> - Replace an existing jump with the current location
- /worm search [player or "public"] <jump name> - Searches for jumps with a similar name
- /worm set [player or "public"] <jump name> - Set a sign to point to a jump
- /worm unset - Unset a sign from pointing to a jump
Examples
- Create a new private jump destination at current location:
/worm add my-jump-name
- Create a new public jump:
/worm add public public-jump-name
- Delete the jump "home" belonging to player "notch":
/worm delete notch home
- Jump directly to your favorite mine:
/worm jump favorite-mine
Permissions and Configuration
Installation
- Download the latest Wormhole .jar file.
- Remove any previously existing "Wormhole-x.y.z.jar" from your server's plugins directory.
- Move the new Wormhole .jar file into your server's plugins directory.
- Reload your server's plugins ("/reload") if it's already running, or start the server if it isn't.
- Set permissions and change Wormhole's config if you want.
- If you changed the permissions, reload your permission plugin's config (probably "/perms reload").
- If you changed the Wormhole config, give the "/worm reload" command as OP.
To Do
- Limit usage based on hunger and health?
- Increase exhaustion after teleporting?
- Teleport creatures that the player is leading?
Notes
- Wormhole is built for Java 1.8.
- Comments / suggestions appreciated!
How to use the money?
In reply to Forge_User_58460226:
Hey are you still supporting this one ?
In reply to Hmmcrunchy:
In reply to austinbowen:
I love the plugin. Could you make it possible to edit the message shown when you used a wormhole sign?
(I want to remove the Jumped to "example")
@SirAthos
Version 1.3.2!
Sorry, but not doing fallbacks :/ I'm keeping to the explicit syntax.
@austinbowen
I think the jumps I added for other players weren't working because I typed their names all lower caps, and the jumps weren't found when they tried to use them.
It's a good idea to at least show a message that the jump exists in pub and not in player. You could also make it a setting that each server admin can change - whether to fall back from player to pub or not. For example, my player age group is young enough that the fallback would be a help and not a confusion.
Yeah, I've thought about removing the case sensitivity, but I'm just lazy and I use tab complete instead lol but I will remove the case sensitivity soon.
If you leave out the player argument from the add command, then it will create a jump for your player. To add a home jump for player "someguy", you would need the player argument: "/worm add someguy home". Then that player can do "/worm jump home" to get to that location. To get to your server's public home, anyone can type "/worm jump pub home".
Falling back to public jumps when a private jump doesn't exist is something that I've thought about, but I decided that to avoid confusion, the command set should be as explicit as possible. I can imagine all kinds of scenarios (and as a server op, I'm sure you can too lol) where unintelligent players would get confused over that. The plugin command set is already fairly complex, and I don't want to add to that with implied commands.
What I can do, and I just thought of this, is have the plugin give suggestions when they get a jump name wrong. "Jump 'home' does not exist. Did you mean 'pub home'?"
@austinbowen
Nice, thanks for the quick fix! Players can now jump to locations, and you were right, if I add a location without player or pub, I can then jump to it the same way.
Here are some more ideas/findings:
- The player name is case sensitive in Wormhole. However, Minecraft itself doesn't care for upper/lower case. So if I try to add a location with my player name all in lower case, it won't let me, saying I can't add locations for other players (but I also can't have another player with my name all in lower case).
- Maybe /worm add player location should be the same as /worm add location. What I'm trying to do is, as an op, add initial locations (such as "home") for each player, and when they type /worm jump home, it works for them.
- In the same idea, if a player doesn't have a "home" location defined for him, the jump command could fall back to the pub "home", which is a more generic location defined as a safe spot for everyone (I run a cooperative server).
Thanks!
@SirAthos
Thanks for finding that economy bug, that was a big one!
Here's the new file, although not yet approved by Bukkit: Wormhole v1.3.1
As for your first bug, that has always worked fine for me and my players. Are you sure you added a jump without the pub/player arguments? "/worm add home" would create the private jump "home" for you alone. Doing "/worm add pub home" creates a public jump for everyone, which is what you did I think, and why "/worm jump pub home" works for you.
Bottom line: Try "/worm add home" and then "/worm jump home" and tell me if it works or not. If it does, you may want to remove the public "home" jump with "/worm del pub home", so others can't get to your home so easy ;)
@austinbowen:
First off, thanks for making this plugin!
I'm having some problems with v1.3.0:
1. The jump command only works if I use pub or a player name (like /worm jump pub home), so that /worm jump home will say the jump does not exist. Can you change it so if the parameter is missing, it looks for private jumps (and if not found, for public jumps) with the given name?
2. I don't have Vault installed, and the cost for all /worm commands is set to 0.0. Wormhole says "economy integration disabled" when it starts, but then non-ops can't use any of the commands (it says "you cannot afford" for every command you are trying to run).
Thanks!
@Sheepyy
There is currently no way of controlling access to individual jumps. What you could do is make the public jumps only accessible to your mods+, and leave the private jumps open to regular players. For example:
For regular group:
wormhole.jump.public: false
wormhole.use.public: false
For mod group:
wormhole.jump.public: true
wormhole.use.public: true
That is a good idea though, and I'll definitely consider adding a similar feature soon :)
Hello! I have a quick question, is there anyway to make the Wormhole be allowed to certain groups? For example, i would make a Wormhole to a bigger Plotworld for people who were Regular? Or a Wormhole for a world for Mod+?
This is the type of plugin i need! Please reply quick! - Shaun
@JuStCr4Zy
Forget that last comment; I figured out what the problem was. I've submitted the new file for review, but if you want to download it directly:
Wormhole-1.0.1.jar
(This file hasn't been approved by Bukkit, so use at your own risk, or wait until it gets approved.)
Remove the old Wormhole and its directory from your server, then drop the new Wormhole-1.0.1.jar file into your "plugins" directory, reload your plugins, and then it should hopefully work...
To get the plugin that you already have to work, all you need to do is create the "Wormhole" directory in the plugins directory and reload the plugins.
@JuStCr4Zy
Shutdown your server, remove the "Wormhole" directory, start the server, and tell me what the server.log file says about Wormhole during the server starting up. It'll log a [warning] or [severe] if anything goes wrong. If everything goes as expected, it'll create its own directory and config.yml.
Failed to add Jump: Jump "p1" (Public) already exists.
Just in case the question is there: I don't have anything against Sortal, and I've been using it on my server a ton since I even started running it. It is the inspiration for Wormhole.
By "limitations and insecurities" I refer to the lack of distinction between per-user and public warps (at least as far as I can tell). If you want to let all players create/delete warps (which I do), they can potentially erase all of them, or create a ton of useless public ones. This led me to create naming conventions for creating warps on my server, but that doesn't really solve the problem.
Also, that's when I discovered an insecurity, when I tried to create a warp name containing a ".". It crashed the plugin and had to be manually removed from the flatfile. But of course that could have been fixed by now (that was a while ago), and switching to the MySQL database option would probably fix that too, but IDK, just guessing.
I'll change the line though; I realize now that it looks like I'm saying something bad about Sortal.
"It was begun in order to address certain limitations and insecurities of the Sortal plugin."
Care to explain?