WarpPortals
Create portals of any shape/size/block! Functional, robust, customizable, and API extensible... this is WarpPortals!
Features
- Portals of any shape, size, or block type!
-
Now has an API!
- Documentation can be found at WarpPortals/API
- An example implementation can be found at example/WarpPortalsEventListener.java.
- Create portals with any block type!
- Portals without frames or with frames of any material
- Portals that work between worlds
- Easy to create Portals
- Easy to set destinations
- Precise teleportations
- Global Enable or Disable normal portals functionality
- Per-portal permissions. Setup donor portals!
Commands
Check out the Table of Commands
FAQ
How do you create a Portal?
- First choose the Portal destination and set it using "/wpdc [name]". This command will set the destination to your current location, world AND angle of view.
- Second, build a portal of any shape out of Gold Blocks. These will make up the Portal's body.
- Third, hold a non-block item and run the command "/wppc [portalName] [destName] [portalBlockMaterial]". This will make it so the next Gold Block you click will turn them into a Portal made of the specified portalBlockMaterial, eg WATER.
- Fourth, right-click any one of the Gold Blocks you built. The plugin will find all adjacent Gold Blocks and turn them all into a Portal!
- Fifth, profit.
Who can use a WarpPortal?
Any one can use a WarpPortal by default. You can revoke someone's WarpPortal rights by setting their permission "warpportal.enter" to false. New: The WarpPortals' Event API allows for this to be overridden!
How do you use WarpPortals?
WarpPortals are always active and simply walking though one will teleport you to its destination.
Who can create/admin a WarpPortal?
Only players who are ops or have the "warpportal.admin" permission.
What settings are there?
- You can change whether normal Nether/End portals function. For example, setting this to false would mean that when a player walked through a Nether portal that they activated with flint, nothing would happen.
- You can change the general Text Color used by the plugin. By default Yellow.
- You can adjust the max portal size. This limit exists so that a Portal so large that it would eternally crash the server can't be created. By default 1000.
- You can change the teleportation message. By default it is "Wooooooooosh!"
- You can change the teleportation message Text Color. By default Purple.
Is there Economy support?
No. Portals are always active and currently don't support any form of Economy plugins. New: The WarpPortals' Event API provides the means for an external plugin to be written to handle this.
What bugs are there?
<s>Ghost Portals: Currently, anyone can break the Portal Blocks that make up the Portal and that will cause the PORTALENTERED event to never fire. This means that to the plugin the Portal still exists but realistically it isn't there anymore. To keep this from happening something like WorldGuard should be used to protect the Portals (though this protection may be a built-in feature in the future). To deal with the possibility of all the Portal blocks getting broken in a Portal, you can use the "/pdelete [portalName]" command to return the Portal to its original Gold Block form. If only a few blocks get broken, simply replacing them with new Portal Blocks should work._</s> Fixed in version 4.1.3
<s>Bad Text Colors: Also, the Text Color settings don't appear to be cross OS Compatible. By default they are setup for Windows but if they don't work for you (if you get white text from the plugin) all Text Color Codes are editable in the Plugin's settings file.</s> Fixed in version 2.0.1
<s>Single Width Portals: Single width portals can only face East or West. This is a very weird bug but it is an unfortunately un-fixable problem. Portal block orientation is decided off of the adjacent portal blocks. Therefore, if two portal blocks are side-by-side, they will connect and face the right way. (Side Note: Even this was a hack and required overriding portal block physics). Sadly, a single portal block doesn't have anything to base it's orientation upon and will then default to East/West. This forum thread details the problem <https://forums.bukkit.org/threads/rotating-portal- blocks.12598/forums.bukkit.org/threads/rotating-portal-blocks.12598/></s> Only applies to WarpPortals made of Nether Blocks as of version 4.1.3
Install
- Download the latest version right here!
- Drop it into the Plugins folder in your CraftBukkit install.
- Go create some spiffy, funky, wild, seriously fun Portals!
Source Code and Downloads
The latest Bukkit approved version to can be found attached to this page! Though you can always find the absolute latest version at [Latest Version](https://github.com/McCraftaholics/Bukkit- WarpPortals/raw/master/WarpPortals_latest.jar)
Source code can be found at github.com/McCraftaholics/Bukkit- WarpPortals
- Please feel free to make changes!
- Pull requests are awesome. Issues can be posted at github.com/McCraftaholics/Bukkit-WarpPortals/issues
API
WarpPortals now has an Event API. Bukkit explains Events at Event API Reference. WarpPortals triggers custom events allowing other plugins to tie into these events. The events provide player & portal information and allow other plugins to cancel the portal teleportation.
Further documentation can be found at WarpPortals/API
Open an Issue on the GitHub page if you have any questions!
Changelog
5.6.5
- Replace usage of player name's with new player UUID standard
- Rename portal.yml backups to "*.yml.bac" in order to signify the data type
5.6.4
-
Merge PR #28 from xxyy
- Fix Nether portals not disappearing when frame destroyed
- Thank you xxyy!
- Devs, this plugin is now built using maven
5.6.3
-
Restore original permission system - Fixes 'OP only' errors!
- Portals are mass turned on/off for players
-
New per-portal permission system can be enabled
- Set 'portals>permission>checkIndividualPortalPermissions' to 'true' in the config file
- This setting requires wildcard permission support for normal operation
5.5.2
-
Teleportation messages can now be disabled, properly.
- Set portals>teleport>message to "&none", without the quotes, in the config.yml file # for real this time
-
WarpPortals now handles World unloads and deletions
- This should fix all known issues causing data to be deleted
- The portal ID tool is multi-use, it won't dequip after each ID.
-
Per-portal permissions can now be set (eg, donor rank portals)
- WarpPortals now check for if a player has "warpportals.enter.{PortalName}" permission before teleporting
- By default ever player has "warpportals.enter.*", this can be changed and allows for donor rank portals and such
- You can set whether players are told that they don't have permission, or make the portal "silent"
- Faster onPlayerMove algorithm that is over 100% more efficient in some situations!
-
Users are alerted when they run commands without proper permission
- Should help permission debugging
- CommandHandler polished for more efficiency as well
4.2.1
-
Teleportation messages can now be disabled.
- Set portals>teleport>message to "&none", without the quotes, in the config.yml file
-
WarpPortals now auto backups the data file after every portal creation
- This should allow for easy recovery in the event of data loss
- As of now, there is no limit on the number of backup files that can be created. Manual cleanup may be necessary.
-
New API event added: WarpPortalsCreateEvent
- Triggered when a user creates a WarpPortal
- Allows access to the new portals name, destination, blocks
- Allows these elements to be modified by other plugins
4.1.4 Critical Fix
-
WarpPortals now handles permissions properly
- Non-ops can use WarpPortals
- Follows Bukkit Permissions structure
- Thank you WeaselSqueezer
4.1.3
-
New portal interaction engine on the backend
- WarpPortals can be made of any block type!
- WarpPortals activate faster for players in survival mode
- Protect WarpPortals from getting destroyed
- Keeps liquids from flowing inside portals so that portals can be made of water/lave
-
Renamed all WarpPortal commands in a more logical manner
- Separated commands into wp-portal-* and wp-destination-*
- Abbreviations added for ease-of-typing, checkout Aliases
3.0.0 (2.1.1 merged in)
- Added soft-depends to hopefully fix all the lost portals errors!
-
Added WarpPortals Event API
- Plugins can be written that tie into WarpPortals
- Example: An economy plugin can be created that charges people for portal use
- Allows 3rd parties to add missing features
2.01
-
ENDER PORTALS!!!!
- Horizontal portals can now be made out of Ender Portal!
- Instead of using Gold Block to create the portal, use Quartz Block.
- Unlike Normal Portals which are vertical, Ender Portals are horizontal beasts.
- BugFix: Chat Colors are now used for portal creation.
- BugFix: Portal Creation Tools stay active for retries when a portal fails to create due to MaxRecursionLimit or similar.
- Minor: Portal Delete Tools now alert when they are equipped.
1.93
-
Chat Colors are now handled properly, the Bukkit way.
- Setting a Chat Color doesn't require any special characters in the config file anymore! Just the color code. (eg. '3' instead of '&3')
- In addition to convenience, this should fix all of the config problems! @R4m8o, @DarkenInsanity, @SpookyPirate
- Portals now also save their state to disk on creation. This should fix any lost portal errors. @getnjr, @iDazzah
1.81
- Error reporting for Config File Loading and Portal Saving has been improved. Instead of receiving an obscure message, the actual error is now reported.
1.70
- Compiled and coded against Java SE 6. Supports Java 6 finally! Use it on both Java 6 and 7 :)
1.64
- Added MCStats support (http:mcstats.org) for my own personal enjoyment and motivation! Don't worry, you can opt-out of course. Everything about it is explained at this forum thread MCStats / Plugin Metrics (R7) - Easy & advanced Plugin Statistics.
1.63
- WarpPortals requests highest priority on Portal Enter events. This should fix normal portals acting weird (@SpookyPirate) and Warp Portals taking a while to teleport (@mrchasez)
1.61
- The functionality (as in: the ability to teleport like normal) of traditional Nether/End portals is now toggleable via settings. @sgtcaze
1.50
- Non-WarpPortals now function like normal! @SpookyPirate
1.43
- Hopefully fixed any File Reading / Scanner errors. Thanks Zylithi!
- Fixed command conflict with WorldGuard concerning teleporting to Portals/Destinations.
1.31
- First offical release!
Enjoy :)
@EarlyReflex
I just updated the dev version to fix the delayed Block Movement detection, it was a negation error.
The other symptoms you are reporting are worrying me. Can you post your portals.yml file on pastebin and share it here? Also, what is your world setup? And what is the /wps /wpl sequence that causes the errors?
@awendland
Thank you! Putting it to the test right now.
Edit: It choked on 1st try with the previous working portals file. We restarted from scratch and everything seems fine. But it no longer detects fast moving players, like in a freefall, even if I make it several blocks thick. It did very well before with 1-block thick portals. This may be a feature more than a bug but we need a couple of these freefall portals, they need to be reliable otherwise players are gonna fall in the void instead of being tp'ed.
Edit 2: Well, the same /wps - /wpl sequence as before scrambled everything again. All portals lost, and of 17 destinations, only 1 remained, the 1st one I made. Everything is stuck until all files deleted and server restarted. Can't create any new portal or destination.
@Keyman1986, @EarlyReflex, @GetRidaHim
Can you checkout the dev release at https:github.com/McCraftaholics/Bukkit-WarpPortals/raw/master/WarpPortals_latest.jar.
Null World issues should be solved but I want confirmation before pushing it live. Also, the plugin should be more efficient in its WarpPortalEnter detection.
Same here... here is what server says.... issued server command: /wppl 12:59:38 PM [SEVERE] null 12:59:38 PM org.bukkit.command.CommandException: Unhandled exception executing command 'wppl' in plugin WarpPortals v4.2.1 12:59:38 PM at org.bukkit.command.PluginCommand.execute(PluginCommand.java:46) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks] 12:59:38 PM at us.Myles.PWP.FakeSimpleCommandMap.dispatch(FakeSimpleCommandMap.java:99) [?:?] 12:59:38 PM at org.bukkit.craftbukkit.v1_7_R1.CraftServer.dispatchCommand(CraftServer.java:544) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks] 12:59:38 PM at net.minecraft.server.v1_7_R1.PlayerConnection.handleCommand(PlayerConnection.java:932) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks] 12:59:38 PM at net.minecraft.server.v1_7_R1.PlayerConnection.a(PlayerConnection.java:814) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks] 12:59:38 PM at net.minecraft.server.v1_7_R1.PacketPlayInChat.a(PacketPlayInChat.java:28) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks] 12:59:38 PM at net.minecraft.server.v1_7_R1.PacketPlayInChat.handle(PacketPlayInChat.java:47) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks] 12:59:38 PM at net.minecraft.server.v1_7_R1.NetworkManager.a(NetworkManager.java:146) [craftbukkit.jar:git-Bukkit-1.7.2-R0.2-14-g15b04d8-b2991jnks]
By far the most useful and straightforward portal plugin. But for the 3rd time in 2 days, all portals got wiped out. The last time, all destinations remained intact but all portals were deleted. For some reason the portals.yml gets corrupted or blanked out. It seems to happen randomly when the plugin writes to the file. We're using v4.2.1.
Please help! I don't want to go back to RandomLocation!
Edit: If I issue the /wppl command, I get "An internal error occured while attempting to perform this command." The /wpdl command works as expected and returns all destinations. Fortunately, there's the /wpb command. Thanks a lot for this one!
Edit: Might be related or not. I started fresh. Created a couple of destinations and portals pointing to them. After doing /wpdl and /wppl, everything's present, and everything works good. Then I did /wps, waited a few seconds, then /wpl to reload file. All destinations and portals are gone. Tried to recreate them but I got "Portal X could not be created because it overlapped existing portals: [X]" although both destinations and portals lists are empty, and nothing works anymore.
@GetRidaHim
You've been hit by the infamous null-world bug. No promises, but a fix should be dropping by anytime soon...
In the meantime, v4.2.1 has some protective, though not preventative, measures built in.
@armanisbeast
I can look into this but it may be a necessary side-effect in order to keep the plugins tick impact down. I'll keep it on my radar for sure.
I enjoy this plugin, its the only easy portal plugin I can use. Their is an annoying bug that rises a lot of complaints. When you destroy a nether portal frame, (the obsidian), the portal stays no matter what. If you dont run into a portal and just stand near it, if the portal is made from portal blocks it will take you to the nether and dump you into lava. If these could be fixed, it'd be amazing :D
:( I have set up about 75 portals in total, I love this plugin but now the config.yml says:
# I highly recommend that you don't edit this manually! destinations: {} portals: {}
It seems as if the Plugin has reset itself entirely!
I have lost many locations due to this HUGE bug.
Please help, if there is any way other than re-creating the portals...
(I was using V 4.1.4 when this happened)
@AlkorZ3
Thanks for reminding me. I have responded to the ticket.
@AlkorZ3
Hello,
Did you notice my ticket "Issue #15" and have you got any idea about-it ?
Is-it a Warp-Portals problem or a PermissionEX one ?
Thanks in advance for your reply.
@StormLasj
Single width NETHER_PORTAL can only face one direction. You can use other block types for single width portals, or, create a portal at least 2-blocks wide.
@darkpuma4
Concerning the flow of economy support:
When a player enters a portal, would it ask them if they wanted to pay for it, then if they say yes teleport them? Or would it charge them and teleport them the second they step in?
@R6Nick
There is currently a bug in the messaging setting. YAML treats the '&' symbol as a special character when not in writes. Therefore, until the next release, to disable the message set portals>teleport>message to "&none", with the quotes. I'll update the docs later to reflect this.
Economy support, please!
@151baccardi
I have created the portals bu they keep saying woosh! in a light purple. I just decided to put &a-=Teleported=- It shows up ok but i still would like it to have no message.
@mikesmiffy128
Why don't you just make the destination for each portal the block immediately in front of the other portal, facing outward?
Is there a way to make the portal face another direction? Mine when I make it out of nether portal blocks (90) they always face EAST-WEST. Any way to make the face NORT-SOUTH?
Really awesome plugin! One question though (I might be being daft): is there a way to make two way portals? The only way I can think of is to do /wpdc inside the first portal, which of course I can't do manually because I would either teleport, or if I /j inside there, I would lose the ability to type because of the portal blocks. My three hackish workaround ideas are to edit it manually, to use the (currently outdated) Macro / Keybind Mod and bind the command, or to delete the portal temporarily. To be honest, I'll probably just go for the third option right now, but if you could tell me of an easier way or add one to the plugin that would be awesome!
EDIT: Oh no. Almost all the portal stuff I did is now gone, and there are no useful backups to restore. That's it. Until this gets fixed I'm just gonna have to use Multiverse-Portals, which is annoying because it's the only world on the server (I'm using Bungee), but it will be a lot easier so I'll just deal with it. Sorry.
151 as always, has a request: Add a portal redraw command. Gates get world edited out or destroyed by flying TNT, etc - Would love to just redraw all gates (or individual gates). Exceptionally smooth plugin once you get used to wpdp and wppc :/ Rebuilding gates is tedious and a pain in the neck because it's invisible.
@R6Nick: I noticed other plugins using woosh. Remove the portal plugin.jar and see if you still get the whooosh. I disabled whoosh and it whooshed.
You need to hold an entity like a stick or swords, etc to activate portal creation.