https://github.com/ogblackdiamond/proxy-portals

A minecraft proxy plugin that allows players to transport between servers with nether portals.
https://github.com/ogblackdiamond/proxy-portals

minecraft-plugin

Last synced: 13 days ago
JSON representation

A minecraft proxy plugin that allows players to transport between servers with nether portals.

• Host: GitHub
• URL: https://github.com/ogblackdiamond/proxy-portals
• Owner: OGBlackDiamond
• Created: 2024-08-04T18:12:08.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-09-29T02:30:26.000Z (about 2 months ago)
• Last Synced: 2024-10-11T02:54:22.729Z (about 1 month ago)
• Topics: minecraft-plugin
• Language: Java
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Proxy-Portals

A minecraft proxy plugin that allows players to transport between servers with nether portals.

## Installation

This plugin works on the backend. No need for a proxy plugin. Simply place the jar file in the plugins folder of any server you want to use portals in, and restart your server. (Note, this plugin does not need to be on the server the player is teleporting to! If you have one central lobby server that has all of the portals, that is the only server that needs the plugin.)

Be sure in the `velocity.toml` file that `bungee-plugin-messaging-channel` is set to `true `

## Usage

To register an ordinary into a server switching portal, use the command `/register-server *server*`, in which you replace `*server*` with the name of the server you want the portal to transport you to. The `*server*` parameter must be the exact same that it appears in your `velocity.toml` (you can find a list of available servers and their exact names with the `/server` command). You will be promped to walk into the portal you want to register. After you do so, the entire portal (size and shape doesn't matter) will be registered to redirect the player to that server.

**Multiple portals can be registered to one server**!

To remove a registration from a portal without deleting your entire configuration, use the command `/deregister-server *server*` in which you replace `*server*` with the name of ther server you want to deregister. After running this command, all portals registered under `*server*` will return to regular portals. 

#### Disclaimer:

I use a recursive function to register the entirety of any portal the player steps into. With very large portals, the registration will not be immediate, and the server will throw a thread dump. This is normal, the plugin will still work perfectly fine.

### NOTE:

I highly highly recommend going into the `config.yml` and changing `lobby-mode` to `true` on any server that you configure portals on. This will prevent players from being locked out of a server because they spawn in a portal. It is `false` by default because this option sends everyone who joins the server to the server spawn when they join, no matter where the are in the world.

There is also a `no-player-die` configuration option. When `true`, this will prevent the player from dying of damage, drowning, or starving. This should be used for lobby-type worlds.

## Building

I use gradle to build this plugin. Ensure you have Java 21 or older and run `./gradle` build on Linux & MacOS, or `.\gradle.bat` build on Windows. Given that the build succeeds, the jar will spawn under the `ProxyPortalsPaper/build/libs/` directory.