Abyss
Abyss is a flexible portal system designed for players. In Abyss, a portal is a square pool of water, no smaller than two by two blocks, and no shallower than two blocks deep. Portals are linked together into networks, and travel between them is optionally limited by distance. Portals can go to other worlds, and minecarts can make use of portals.
Traveling through a portal is easy. Just jump in, and you'll be instantly ejected out of the first available destination. Momentum is preserved through portals, and minecarts will be placed on rails when at all possible.
Trailer
There are also a few older videos. If anyone would like to make a tutorial video, please contact me. I'd do it myself, but between the day job and working on features for Abyss, I'm rather busy at the moment.
Portal Features
Easy Configuration
The majority of portal configuration is performed by manipulating a set of item frames within the body of the portal, as detailed below.
Networks
Every portal in Abyss is placed on a network based on a two-part key consisting of an item and a color, making for thousands of possible networks. Damage values of items are taken into account as well, making it possible to use unique items like specific maps as keys. The network frames are always the top, center item frames of a portal.
To set an item as the network item, right click the network item frame with the item in your hand. Doing so will not consume the item. Left clicking the network item frame will reset the portal to the default network. Repeatedly left clicking the network item frame will destroy a portal. To change the portal's color, left or right click on the color item frame to cycle through the available colors.
The Human Head item creates a special, player-specific network for the owner of the portal and is the default network item, giving players a secure network of portals straight away. Of course, if this isn't desirable for your server, you can simply change the default item to something else in the configuration.
IDs and Destinations
At times, you might want to connect a portal to a specific destination, ensuring that it goes to that destination and only that destination. To that end, portals may be assigned an ID consisting of two colors, making for 288 possible IDs per network when you include IDs that leave one of the color slots empty.
Use the two item frames to the left of the network key to set a portal's ID and the two item frames to the right to set a portal's destination. Left and right click the frames to cycle through the available colors.
Modifiers
Every portal has a number of item frames devoted to Portal Modifiers, positioned below the network key frames. Modifiers are special items that add behavior to portals, both when a player is exiting from a portal and when a player is arriving at a portal. For example, using a Dispenser as a modifier will fetch items from a chest and dispense them to players, storage minecarts, and other things with storage passing through a portal. Using a pressure plate for a modifier will toggle a lever momentarily after something arrives, making it easy to start redstone contraptions when a portal is used.
A list of all the possible modifiers and other information is available at the page about Portal Modifiers.
Covers
Leaving an unguarded portal into the heart of your base open at all hours is, of course, quite silly if you're in a bad neighborhood. To that end, portals may be temporarily closed by building a protective cover over the surface of the portal. Any block within two blocks above the surface of a portal will prevent that portal from being used, in either direction, making it simple to protect yourself from invaders, or to control the flow of entities through your portal systems.
Commands
Commands in Abyss can be performed either as a normal command, or through the use of a Portal Wand. Portal Wands are unique items that can have limited uses, and that use separate permissions from the normal commands. This makes the wands ideal for use by players. A Portal Wand's configuration is stored as a combination of a custom name and item lore, making it possible to create villagers that sell such wands. When checking for a wand's custom name, Abyss requires that a color code be present in the string to ensure that a player didn't craft the item themselves using an anvil.
To create a Portal Wand, use the command: /abwand <uses> [command] <arguments>
A list of sub-commands may be found on the Commands page.
Permissions
Permission | Default | Description |
---|---|---|
abyss.use | Everyone | Allows the player to travel through and manipulate portals. |
abyss.moderate | Ops | Allows the player to manipulate portals created by other players. |
abyss.bypass_protection | Ops | Allows the player to bypass portal block protection by sneaking. Useful for modifying frames without having to destroy and recreate the portal. |
abyss.modifers.<material> | Everyone | Allows the player to use a portal modifier of the material in question. |
abyss.detail.uuid | Ops | Allows the player to see portal UUIDs with the Information command. |
abyss.detail.distance | Ops | Allows the player to see exact distances between portals. |
abyss.detail.location | Ops | Allows the player to see the precise root locations of portals. |
abyss.command.base | Ops | Gives access to the root /abyss command used to perform all sub-commands. |
abyss.command.<command> | Ops | Allows the player to use the Abyss command in question. |
abyss.wand.<command> | Everyone | Allows the player to use a Portal Wand to perform the command in question. |
Updates
As of v4, Abyss includes automatic update functionality. If you wish to disable it, set auto-update to false in your configuration file. Alternatively, you may set auto-update to check to have it merely inform you of available updates.
Statistics
As of v7, Abyss submits usage statistics to MCStats.
Source Code
The source code for Abyss is available on GitHub at https://github.com/stendec/Abyss.
@stendec
Hello there,
I love this mod soo much but I ran into a problem
The problem is i use Multiverse because i have a server hub but when i make the portals in
1 world than it works but when i make it in 2 different world than it say
"No valid destination within range"and i have multiverse support=true
I just downloaded 2day so ill mess with config and see
Thank you
@TheGameBug
There was an issue in previous builds with plugins like Multiverse, as worlds weren't guaranteed to be loaded when Abyss was starting up and it tried blindly to build locations using them. However, that should be fixed and working now. Hopefully that was your problem.
I'm glad it's working for you. Enjoy!
There is no reports coming from the server on the error, I just downloaded the updated version and now the issue seems to be gone. I had originally downloaded this the other day and finally got to use it in my new world. In my folder I noticed a new portals.yml which was not there before either, so I assume it was an issue from the previous build.
@TheGameBug
Congratulations, you've found a bug. Abyss is supposed to save out all of its portals and recover gracefully when the server is restarted. Can you check your server log for any errors coming from Abyss?
Also, the output of the /ablist command can be used to determine if it really isn't loading the portals at all, or if there's something else going wrong.
The portals work great, but is there a way to save them so when you reload the server at a later time that they would still be connected? As it stands I have to go around re-linking all the portals after each server restart, even after the save-all command.
@Kubixster
I'm glad that it's working for you, and it makes me happy to hear that your players are enjoying it thus far.
You can actually change the configuration so that it doesn't require corner blocks to create a portal by setting
corner-depth
to0
.You can also add half-slabs to the list of valid
frame-materials
. I don't recommend doing this though, because if you touch the water before you start moving down, it won't register you as using the portal. This was done to reduce the number of times the plugin has to scan for portals when a player is moving.@stendec365
Okay works, my bad. Corner block was a one stoneslab.. :D Sorryy.. haha players on my server says that's a great plugin! Thanks to you ! :)
@Kubixster
Are you sure that you've got a proper frame? Using the default configuration, a portal must be a square hole of at least 2x2 and not more than 4x4, and at least 2 blocks deep. The first layer of the frame must be complete, including corner blocks, and it must be made of a complete block. No half slabs, stairs, or the like.
Try being *inside* the water when you try creating it, to make sure that it's not getting hung up on a block on the wall (like a sign or something) that you happen to be standing inside.
Already made 2 working portals. When trying to make 3rd it says Invalid portal location.
@Dogtag93
That's fine with me. Either way, we should move this conversation to private messages to keep from flooding the project's comment stream.
I haven't figured out how to use all the commands yet. The only other command that doesn't work including the /abwand info is /abwand. If you want to test these are more in depth I can send my server address.
+ Sorry Yes, I don't get any errors, the commands simply don't do anything when I enter them.
@Dogtag93
If I might ask, which commands do work? And does it just not work at all, or does it display a message that it cannot find a portal? I'm assuming that there weren't any errors in your server logs when enabling Abyss, as you haven't mentioned them.
There are a few commands that don't work including the one you asked me to use. I have done both, restarting my server and use the reload command with no success.
@Dogtag93
I currently know about a bug with version 3 that makes a portal's configuration frames stop working if they're used and then the chunk the portal is in is unloaded. The frames will work again when the server is reloaded though, so it sounds like that isn't your bug.
Can you use the Information Wand (/abwand info) to view information on any portals, or do they just not work at all? Also, are you stopping your server or using the reload command?
I'm going to be trying to release version 5 tonight, which contains several bug fixes. Hopefully that will help.
The plugin breaks when I reload my server. I thought it was because I was messing with the configure file to figure out how to trance port between worlds. Even when I make new portals they are created but down work.
@diannetea
Certainly. If you place an obsidian block as one of a portal's modifiers, you will only be able to travel away from a portal and not to it. Soul sand does the opposite.
I'll be writing up a proper list of modifiers soon, hopefully.
Is there a way to do one way portals?
@fuzyfeet
I really do need to make a proper video, but I'm far more concerned with getting the plugin done at this point. The basics are all there, but it still needs polish.
You're absolutely right about setting a network. Networks are defined by an item and a color. To set a network, you right click on the network frame using the item you want to set. It won't consume the item, making it feasible to use expensive items. Though... I'll probably make that a setting.
Item damage values are taken into account, so different colors of wool or different dyes all count as different networks. On top of that, maps are stored as damage values too, so you can use unique maps to create unique portal networks.
On top of that, the player skull item creates a personal network for each player, based on whoever created the portal in question. That's the default network for all newly created portals, making it fairly friendly to use.
From the video 'teasers' (not sure what to call them) this looks like it will be a great plugin. From the looks of the video you can set a network of portals using a specified block (though I hope that it's not limited to one block, having to set a block combination would make it so much easier to make 'secure' portals) is a nice touch.
This mod looks really good. If it was available for download, I would use it because I really like this idea of water holes being portals. If I had it, I would also report any bugs, I'm sure I'm not the only one who thinks this mod looks really good.