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.
@slimpyman
frame-materials
is a YAML list, and you can specify block IDs or the names of the materials as found in Bukkit's Material enum. As an example:As noted, you can use a space in place of an underscore, and the names aren't case sensitive.
For the permissions, you have to use the lower case names of those materials (from the list), with underscores. So,
abyss.modifiers.bed
,abyss.modifiers.stone_button
,abyss.modifiers.wood_button
, etc.Corner depth means from the top of the portal. Setting it to 1 requires corners in just the top layer. 2 for the top 2 layers, etc.
@stendec365
ok so im trtying to find some documentation for this. the frame as certain blocks seems like a solid solution... so in the config, it says frame materials: occluding... does that mean any opaque blocks ? lmao. if i wanted emerald blocks, and gold blocks would i put frame materials: GOLD_BLOCK, EMERALD_BLOCK?
i really have no idea what i should put there... block ids, followed by commas?
oh yeahl, also, im trying to set the permissions for the modifiers. how do i address the modifier. by the standard bukkit block id or name?
sorry for the questions, its just i couldnt find any documentation about the config or what <modifier> would be in a perm.
also, corner depth just means from top of the portal, the corners must be this "deep"?
@slimpyman
You can configure the portals so that the frames must be made out of certain blocks, though that could end up getting quite expensive if they have to make portals of any specific depth.
I'm currently working on a new version with a crafting system involving surrounding the top of the portal with blocks and throwing an item into the water.
The only current way to charge players for portals is to sell limited use portal wands from a shop or villager.
does this plugin have a flat way to implement a currency? so any way a player tries to make an abyss pool, it will cost them money? like say you use emerald block as currency, you need to make the construction of the pool using some emerald blocks?
essentially, all im trying to do is force players to use 1 network id, an emerald block. :)
@Thrystor
Yes. Portal wands use item names and lore to store their configuration, so you can trade the items around just fine as long as whatever you're using doesn't strip that information away.
On my server, we're selling them from villagers.
To make sure players can't just rename an item into a portal wand at an anvil, the name has to keep its colorization.
This looks really neat, I've been wanting a simple self-service portal maker for a while. If I sell portal wands, as long as the name is unchanged, does it still work as a portal wand?
@thunder54328
I'm glad you like the mod. A good wand for setting up a dispenser to fully equip someone is: /abwand mod clone; select: all; full stack
That will give someone a copy of everything in a chest. Armor automatically gets equipped by default.
@thunder54328
It's already possible to create infinite chests with Abyss by setting a flag on the modifier. To set such a flag, create the modifier wand with /abwand mod clone and right-click on the modifier frame.
See Portal Modifiers for more information.
I would just like to take time out of my day just to say Thank you for making this amazing plugin, it's one of the simplest Teleport plugins out there and I recommend it to anyone who wants an easy to use plugin. Keep up the good work!
@dfg260
Thank you for your report. I've determined why it's doing that, and it'll be fixed for the next version. I'm glad you like my plugin.
Really awesome plugin! But i get this error if an TNT explodes:
Pls fix this!
@Kubixster
If the portals save using /abreload, they should save when you restart the server. Still, please make sure that newly created portals are saving properly without the /abreload command.
Also, I've just identified a bug that might stop portals from saving if
use-static-effect
is set tofalse
.@superperson15
Thank you. I'm glad you like it.
D8 this is the BEST Teleportation user plugin i have ever seen! I will sugest this to all the servers i play on
@stendec365
awwwwwwwwwwwwwwwwwwwwww.. Thanks to You again! /abreload just saved all portals and now they are all working even after server restart !
Thanks for you FAST reply....Love it......this is your 1st plugin and its so good
Really simple to make..Configuration is the easiest can`t get any better...
Thanks
@Kubixster
Could you run the /abreload command while in the game after making a portal or two and tell me if it has any errors, as well as the state of portals.yml after doing so?
@CaptainBlastXD
Portals are limited in range by default to prevent players from being able to do too much, though the inter-world costs aren't quite finalized yet. If you use /abwand dest, it'll give you a Destinations Wand, and you can use that on a portal to see how far out of range its destinations are. Then you can use /abwand config range: 10000 for a wand that modify's a portal's range appropriately, substituting 10000 for however large a value you need.
Alternatively, you can set
limit-distance
tofalse
in your configuration file and portals will all have unlimited range.Hi! It's me again.. :D Today I launched a server and I've noticed that portals aren't working. Maybe it's the same problem that TheGameBug had, but I actually have the updated version of plugin and wtf I don't really know what to do :D I can only tell that file "portals.yml " is empty and I'm not using Multiverse but other similar plugin.