Skip to content

Create portals in your Minecraft server made from alternative materials to teleport your users to different worlds. Custom world materials can be specified in the configuration file. Rewrite to latest MC version forked from https://github.com/incognitojam/CustomPortals

License

Notifications You must be signed in to change notification settings

jacob52571/CustomPortals

Repository files navigation

CustomPortals

Rewrite to the latest MC version forked from https://github.com/incognitojam/CustomPortals

Create portals in your Minecraft server made from alternative materials to teleport your users to different worlds. Custom world materials can be specified in the configuration file.

Download

Releases can be found here on GitHub.

Configuration

Below each configuration option is explained in detail.

Portal search options

portal-search-range: 64 This specifies the radius in which the plugin should search for portals at the target location, before deciding to create a new portal (as none are present for the user to teleport to). This value should always be written as an integer, not a decimal.

portal-creation-range: 24 The radius in which the plugin should search for a space to create a portal at the destination. If no space is found in this range then no portal is created and the teleport is cancelled. This value should always be written as an integer, not a decimal.

Miscellaneous

debug-mode: false Enables extra debugging in the console. If something doesn't seem right in the plugin, please enable debug mode, perform the action and report the full console log to a developer.

Portal materials

portal-materials:
    # Material used to construct a portal 
    # which returns the player to the overworld.
    world: "stone"
    
    # Material used to construct a portal
    # which will teleport players to the nether.
    # Note: It is recommended to keep the nether
    # portal material as obsidian to prevent
    # player confusion.
    world_nether: "obsidian"
    
    # Material used to construct a portal
    # which will teleport players to a custom
    # world: the "arcade".
    arcade: "orange_wool"

Materials should be specified with quotes surrounding them and written in the format "name".

World Scale

world-scale:
    world: 1.0
    world_nether: 8.0
    arcade: 2.0

You must provide a world scale for each world that a portal may be created for. If this isn't specified, the teleport will not work. Decimal values are accepted but not recommended (untested).

Example

When teleporting from world_nether to arcade, the x and y coordinates will be converted to universe coordinates by diving by the world-scale constant for world_nether (8.0). To convert the u coordiantes to world coordinates for arcade they must be multiplied by the world-scale for arcade (2.0).

Permissions

customportals.create: allows the user to create portals. Defaults to all players.

customportals.reset: allows the user to reset all portals in the server. Defaults to all operators.

Bugs/Planned Features

  • Custom details

Please open an issue thread here on GitHub or contact me directly if you encounter unexpected behavior.

Credits

This plugin is based off IncognitoJam's plugin, created at the request of Robotnik on the SpigotMC forums.

About

Create portals in your Minecraft server made from alternative materials to teleport your users to different worlds. Custom world materials can be specified in the configuration file. Rewrite to latest MC version forked from https://github.com/incognitojam/CustomPortals

Resources

License

Stars

Watchers

Forks

Languages