## **Important Notice** This plugin is an replugined version of a plugin that reached the end of support. The original Creator is XZot1K & AlessioGR contributated. [Link to the Original](https://www.spigotmc.org/resources/%E2%8D%9F-simple-portals-%E2%8D%9F-effective-regional-portals-bungeecord-compatible.56772/). This plugin is the majority of their work & only minor changes have been added to so far from the_n1n # Simple Portals Simple Portals is the simplest, yet effective way to create region-based portals. The plugin was heavily tested on many large live servers and put under stress to ensure performance was optimal. Simple Portals also allows the teleporting of players across your bungee cord server without even using the bungee cord API! ## Features - **Cross-Server Portals** - transfer players to other server even at specific locations with the help of MySQL - **Fancy Visuals** - selections and region display are highlighted with particles - **No Dependencies** - the plugin is standalone - **Per-Portal Permissions** - control which portals players can access - **Command Sympathy** - abbreviations are available for easier use - **Flow Control** - Fluids are frozen in the portal regions - **Lightweight Update Checker** - your configs will always be up-to-date - **Powerful Developer API** - full control over the plugin at your finger tips - **Simple To Manipulate** - all commands and features are made to be used with ease - **Entity Portal Transfer** - entities like items or vehicles can all teleport through portals maintaining velocity - **Nether/End Portal Destination Replacement** - Ability to replace the destination of all nether/end portals in any world - **Force Join** - Ability to force a player to return to spawn of a specified world upon joining the server ## Commands (Note: By typing an invalid command, a usage message will be displayed.) - `/simpleportals selectionmode` (or sm) - Toggles the player in and out of selection mode which allows them to create a region. - `/simpleportals reload` - reloads all configurations. - `/simpleportals info` - provides information about the plugin. - `/simpleportals create ` - creates a new portal if the player's region is full created. - `/simpleportals delete ` - deletes a existing portal. - `/simpleportals fill ` - attempts to fill the portal with the defined material (directional support is partial, meaning some materials may be better placed or created before portal creation). - `/simpleportals setlocation ` (or sl) - sets the teleport location of the specified portal to the sender's location. - `/simpleportals setlocation ` (or sl)- sets the teleport location of the specified portal to the center of the other entered portal. - `/simpleportals ` (or sr)- displays the specified portal's region. - `/simpleportals ` - enables/disabled the portal entirely untiled toggled again - `/simpleportals switchserver ` (or ss) - sets the server the portal will teleport a player to. Please note that to remove a server from a portal you must set it to 'none'. - `/simpleportals setswitchlocation ` (or ssl) - sets the destination of the portal when transferring to another server - `/simpleportals addcommand ` (or addcmd) - this command adds a command line that will be run when a player enters the portal (You are able to add a colon followed by PLAYER or CONSOLE to the end of the command to determine how the command is run). - `/simpleportals clearcommands ` (or clearcmds) - this command simply clears the commands in the list. - `/simpleportals togglecommandonly ` (or tco) - this command toggles command only mode for a portal. - `/simpleportals commands ` (or cmds) - provides a list of all commands on the defined warp in the order they were added. - `/simpleportals message ` - sets the message of the specified portal to the specified text (A colon followed by NORMAL, BAR, TITLE, or SUBTITLE can be used to define the type of message to be set). - `/simpleportals disablemessages ` (or dm) - disables all messages associated with the defined portal. - `/simpleportals cooldown ` - sets the cooldown for the specified portal, in seconds. - `/simpleportals delay ` - sets the delay for the specified portal, in seconds. - `/simpleportals find ` - finds 3 nearby portals within the specified range. ## Permissions - `simpleportals.showregion` - Allows the player to view a portal's region. - `simpleportals.setlocation` - Allows the player to set a portal's teleport location. - `simpleportals.info` - Allows the player to view the plugin's information. - `simpleportals.reload` - Allows the player to reload the configuration files. - `simpleportals.create` - Allows the player to create a portal. - `simpleportals.delete` - Allows the player to delete a portal. - `simpleportals.list` - Allows the player to list all portals. - `simpleportals.switchserver` - Allows the player to change the server a portal can teleport a player to using BungeeCord. - `simpleportals.setswitchlocation` - Allows the player to set a portal's switch server location. - `simpleportals.selectionmode` - Allows the player to enter/exit selection mode. - `simpleportals.portal.*` - Allows the player to use all portals. - `simpleportals.portal.` - Allows the player to use the specified portal. - `simpleportals.addcommand` - Allows the player to add a command to the specified portal. - `simpleportals.clearcommands` - Allows the player to clear all commands from the specified portal. - `simpleportals.togglecommandonly` - Allows the player to toggle command only mode for a portal. - `simpleportals.viewcommands` - Allows the player to view the commands of a portal. - `simpleportals.toggle` - Allows the player to toggle a portal entirely. - `simpleportals.message` - Allows the sender to use the message command for portals. - `simpleportals.dm` - Allows the sender to use the disable messages command for portals. - `simpleportals.fill` - Grants access to the portal fill commands. - `simpleportals.cooldown` - Allows the sender to use the /simpleportals cooldown command. - `simpleportals.delay` - Allows the sender to use the /simpleportals delay command. - `simpleportals.find` - Allows the sender to use the /simpleportals find command. - `simpleportals.admin` - Gives the player permission to everything in the plugin. - `simpleportals.cdbypass` - Allows the player to bypass the portal cooldowns. - `simpleportals.use` - Allows the sender to use the basic /simpleportals command. ### Servers Using SimplePortals: ** [Skade Gaming](https://skadegaming.com/) | This server has over 2500 Portals!** Below is a very brief look at the region visual display during the portal create process: ![Example of Portal Region visibility. Outdated](https://proxy.spigotmc.org/a5985e7ddf6e6b1e9122327b8af38d4ef9bdc7fc/68747470733a2f2f696d6775722e636f6d2f624d6e597967362e676966) ## Plugin Usage SimplePortals is made to be, well... simple! Therefore the portal creation process is quite straightforward. Please find instruction below: [NOTE] - The "Selection Mode" command is a toggle, meaning when ran once it will enable and twice it will disable. 1. In order to create a portal, you must first enter "selection mode" by using the command "/portals selectionmode" or "/portals sm". 2. The next step is to "left-click" the lowest block at the end of a cuboid or rectangular region and then "right-click" the highest block in the opposite corner of the region. This will set your current selection for any portals you wish to create soon. 3. To finish off the portal creation process you must use the command "/portals create " to create the portal using your WorldEdit-Like selection. 4. From this point, you have a created portal. Now by default the destination, the portal will teleport the user to will always be set to the lowest-block or Point-1. To change the portal's destination, use the command "/portals setlocation" or "/portals sl" at the location you wish your portal to take you to. Below is some extra information: You can fill a portal's region with a specific material by using the "/portals fill " command (Don't worry all liquid-based materials will not flow out of the region). You can relocate the portal's region by using the "/portals relocate " command after making another selection in "selection mode". For commands and some other features in the plugin, use {player} as the placeholder to obtain the player's name. To make a portal teleport the player to another server via Bungee simply set the server name using the command "/portals ss ". You can set this value to "none" to disable the feature for a portal. Don't forget to set the destination coordinates with "/simpleportals ". You may also send commands with the player to execute when they join the server by adding commands to the origin portal. As for adding commands to be run by the portal when entered you can add them using the "/portals addcmd :" command, where is PLAYER, CONSOLE or CHAT. To remove the commands you may use the "/portals clearcommands " **Command Examples**: ```: "/portals addcmd example-portal rtp:PLAYER" This command will run /rtp as if the player sent the command. "/portals addcmd example-portal rtp {player}:CONSOLE" This command will run /rtp as if the player sent the command. "/portals addcmd example-portal rtp:CHAT" This command will run /rtp as if the player typed it AS IS into chat. No, /rtp is not a feature of SimplePortals. ``` When adding a command ensure NOT to use a slash. Always END IT WITH A COLON followed by either PLAYER or CONSOLE. Another that can be used since v1.3.6 is CHAT which sends the command into chat for other plugins to use as fake commands! Similar to command adding, setting a portal's message requires a type. Behind the entered text, simply add either :NORMAL, ':BAR, :TITLE, or :SUBTITLE to indicate which message should be set (INCLUDE THE COLONS). This is the same concept as adding commands. ### Developer API ⍟ Currently, everything in the API can be found in the API package inside the plugin which can be found on the GitHub page. However, below you can find the API class names and their purpose. - Manager (Class) - this stores all general methods, calculations, and storage lists or maps. - PointType (Enum) - this is used inside the listener for the region selection. - Portal (Class Object) - this is an entire object that stores all information about a single portal. - Region (Class Object) - this is an entire object that stores all information about a region (Coordinates and Locations). - SerializableLocation (Class Object) - this is used to serialize a location and prevent future changes to the same location. - TaskHolder (Class Object) - this is used to store the visual effect tasks for each player. This class also manages them to make sure not too many are shown at once. - PortalEnterEvent (Event Object) - this event is called when a player enters a portal's region. ## FAQ (Q) Users are teleported to the nether/end when using a dedicated portal material for a simple portal. (A) This issue has been reported before, a majority of the time this is due to world manipulation plugins such as Multiverse or MultiWorld. Please ensure you test without the world plugin and also use their latest build (dev build) to ensure it was not something that was resolved. You can also increase the time for vanilla portals with the vanilla gamerule command! (Q) I'm getting an error/message involving the "simpleportals.cdbypass" permission node. How can I resolve this? (A) This is not actually an issue, the message is to notify the user who is either OP or has the permission that they have bypassed the cooldown for the feature. This message can be disabled by setting it to "" in the lang.yml. (Q) I'm getting an error in the console and I'm unable to teleport or use portals in general. How can I resolve this? (A) The plugin is native to the latest version of Minecraft; therefore, older versions may need tweaking within the configuration. Normally in this case setting the particle options in the config.yml will resolve this issue for you. (Q) How can I disable the portal titles, action bar, or subtitle messages? (A) If the portal has not been created yet, setting the default messages in the lang.yml will disable them for all newly created portals. For already made portals you must either disable the plugin and set the messages to "" in the portals.yml or use the "/portals message :NORMAL", "/portals message :BAR", "/portals message :TITLE", or "/portals message :SUB-TITLE" commands to simply disable each one individually. As of v1.5.1, the command "/portals dm " can be used to disable messages.

Jakeplays12

Jakeplays12

BiFrost

Skade Cobblemon