portal

🌌 craftable nether star portal guns

View the Project on GitHub

🌌

portal
craftable nether star portal guns


Now you can use a Portal Gun to travel around various places in your Minecraft world!
Based off of the Bukkit reqest forum post made by user Shikishima.

Click to open up demo GIF in high quality


How to Play

Step One: Obtaining a Portal Gun

The actual Portal Gun item is a Nether Star with the destination coordinates displayed below the name. To make one, either issue the command /portalgun as an operator, or craft it with:

Step Two: Fueling the Portal Gun

For a Portal Gun to work, it will use up 1 Ender Pearl from the inventory of the player who opened up the portal.

Step Three: Setting the Portal Gun destination

Right click anywhere with the Portal Gun in your hand to open the Anvil GUI. Type in the world, x, y, and z coordinates here. The format looks like this:

world=world_name,x=1,y=1,z=1

Click the completed item to set the destination of your Portal Gun.

Step Four: Opening up a portal

Once you have set the destination of your Portal Gun, left click anywhere to open up a portal! The portal will immediately appear as green “Happy Villager” particles.

Unlike Nether Portals or End Portals, the Portal Gun openings only last for five seconds. Hurry up and jump through, before it closes, to instantly be teleported to the destination programmed into your Portal Gun!

Step Five: 🎉 Have fun

Store as many Portal Guns as you want in your inventory. Each one will stay linked to its destination forever, so you can grab whichever you need for the adventure at end!


What's included

.
├── LICENSE -- License for this repository.
├── makefile -- Makefile which uses simple bash commands to compile and build the JAR without an IDE.
├── README.md -- The file you are currently reading.
├── build -- Build directory generated by the makefile, can be deleted at any time.
│   ├── bin
│   │   ├── me
│   │   │   └── insanj
│   │   │       └── portal
│   │   │           └── *.class
│   │   └── plugin.yml
│   └── portal-version.jar
├── external -- External dependancies directory. You have to download these open source JARs and place them here; or change the PATH in the makefile.
│   └── craftbukkit-1.13.2.jar
├── plugin -- Source code directory, structured as a standard Java package.
│   ├── me
│   │   └── insanj
│   │       └── anvilgui -- Source of GUI, https://github.com/WesJD/AnvilGUI
│   │       └── portal
│   │           ├── Portal.java
│   │           ├── PortalGunClickListener.java
│   │           ├── PortalPlayerMoveListener.java
│   │           ├── PortalCommandExecutor.java
│   │           └── PortalGun.java
│   └── plugin.yml -- Configuration file which also defines current version number (see git tag as well).
└── server -- Optional directory for testing out the plugin on a local server.


Authors

Julian Weiss
me@insanj.com
github.com/insanj


Acknowledgements


License

portal

MIT License

Copyright (c) 2019 Julian Weiss

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

AnvilGUI

MIT License

Copyright (c) 2016 Wesley Smith

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.