TheNextLvlTheNextLvl

Overview

Create and manage custom portals

GitHub Edit on GitHub

Portals

Portals is a powerful Minecraft server plugin for Folia and Paper that allows you to create custom portals with advanced functionality. Create portals that teleport players across worlds, link to other portals, transfer players to different servers, or execute commands.

Features

Portal Actions

  • Linked Portals: Create bidirectional or one-way portals that connect to each other
  • Coordinate Teleports: Teleport players to specific coordinates across worlds
  • Random Teleports: Teleport players randomly within defined bounds or radius
  • Server Transfers: Transfer players to external servers (hostname + port)
  • Network Connects: Connect to servers within your BungeeCord/Velocity network
  • Command Execution: Run commands as the player or console when entering a portal

Access Control

  • Entry Permissions: Restrict portal access with custom permissions
  • Entry Fees: Charge players using ServiceIO or Vault economy integration
  • Cooldowns: Set cooldown periods between portal uses

Portal Creation

  • WorldEdit Integration: Use WorldEdit selections for easy portal creation
  • Manual Bounds: Define portal regions with coordinate arguments
  • Flexible Regions: Create portals of any shape and size

Quick Start

Basic Usage

The main command of Portals is /portal, and requires the permission portals.command.<subcommand>:

# Create a portal using WorldEdit selection
/portal create spawn-portal

# Set the portal to teleport to spawn
/portal action spawn-portal teleport minecraft:overworld 0 64 0 0 0

# Add a cooldown of 30 seconds
/portal cooldown spawn-portal 30s

# Set an entry fee of 100
/portal cost spawn-portal 100

# List all portals
/portal list

Common Scenarios

Linked Portals

Create two portals that link to each other:

# Create first portal
/portal create portal-a

# Create second portal
/portal create portal-b

# Link portal-a to portal-b
/portal action portal-a teleport-portal portal-b

# Link portal-b to portal-a (for bidirectional)
/portal action portal-b teleport-portal portal-a

Random Teleport Portal

Create a portal that teleports players randomly:

# Create the portal
/portal create random-portal

# Set random teleport with radius of 1000 blocks around 0, 64, 0 with a 100 block height limit
/portal action random-portal teleport-random minecraft:overworld 0 64 0 1000 100

Server Transfer Portal

Connect players to another server in your network:

# Create the portal
/portal create lobby-portal

# Connect to lobby server (BungeeCord/Velocity)
/portal action lobby-portal connect lobby

Premium Portal with Fee

Create a portal with entry requirements:

# Create the portal
/portal create vip-portal

# Set entry fee
/portal cost vip-portal 500

# Set entry permission
/portal permission vip-portal server.vip

# Set cooldown (60 seconds)
/portal cooldown vip-portal 60s

Permission System

Command Permissions

Portals uses fine-grained permissions following the pattern:

  • portals.command.create - Create portals
  • portals.command.delete - Delete portals
  • portals.command.list - List portals
  • portals.command.action - Set portal actions
  • portals.command.redefine - Redefine portal bounds
  • portals.command.cost - Set entry fees
  • portals.command.cooldown - Set cooldowns
  • portals.command.teleport - Teleport to portals
  • portals.command.permission - Set entry permissions

Entry Permissions

Portal entry permissions are custom and set per-portal using /portal permission.

WorldEdit Integration

Portals optionally integrates with WorldEdit for easier portal creation:

  1. Use //wand to get the WorldEdit selection tool
  2. Select the portal region by clicking two corners
  3. Run /portal create <name> to create the portal with your selection

Alternatively, you can specify bounds manually:

/portal create my-portal x1 y1 z1 x2 y2 z2 world

Last updated on