PortalToggler
PluginMIT

PortalToggler

Manage whether players can create or enter Nether and End portals.

78
Downloads
0
Followers
4 months ago
Updated
📦
1
Versions

📖About PortalToggler

PortalToggler

A simple plugin to control Nether and End portal entry and creation on Paper/Spigot.

Description

PortalToggler lets server admins easily enable or disable Nether/End portal entry and creation. It's lightweight, easy to configure, and great for events, minigames, or any server that needs tight portal control.

Features

  • Toggle Nether/End entry and creation separately
  • Bypass permissions for trusted players
  • Fully customizable MiniMessage messages
  • Reload config without restarting
  • Built-in debug mode
  • Tab completion for all commands
  • Lightweight and simple to set up

Usage

Commands

<> = required, [] = optional

Command Description Permission
/portal or /portaltoggler Main plugin command portaltoggler.admin
/portal help Display command help portaltoggler.admin
/portal reload Reload configuration files portaltoggler.admin
/portal toggle <nether|end> <entry|creation> Toggle portal state portaltoggler.admin
/portal status [nether|end] Check portal status (all or specific) portaltoggler.admin
/portal enable <nether|end> <entry|creation> Enable specific portal function portaltoggler.admin
/portal disable <nether|end> <entry|creation> Disable specific portal function portaltoggler.admin

Configuration

config.yml

The main configuration file controls portal states and debug settings:

# PortalToggler Configuration

# Debug Settings
debug: false

# Portal Settings
portals:
  nether:
    entry:
      enabled: true
    creation:
      enabled: true
  end:
    entry:
      enabled: true
    creation:
      enabled: true

Configuration Options:

Option Type Default Description
debug boolean false Enable debug logging for troubleshooting
portals.nether.entry.enabled boolean true Allow players to enter nether portals
portals.nether.creation.enabled boolean true Allow players to create nether portals
portals.end.entry.enabled boolean true Allow players to enter end portals
portals.end.creation.enabled boolean true Allow players to create end portals (place eyes of ender)

messages.yml

Customize all plugin messages with MiniMessage formatting:

prefix: "<dark_gray>[</dark_gray><gradient:#ff55ff:#5555ff>PortalToggler</gradient><dark_gray>]</dark_gray>"

# Status Messages
status-enabled: "<green>Enabled</green>"
status-disabled: "<red>Disabled</red>"

# Portal Messages
portal-disabled: "<red>Disabled {portal} portal {mode}."
portal-enabled: "<green>Enabled {portal} portal {mode}."

disabled-portal-attempt: "<red>You cannot enter the {portal} as portal entry is disabled."
disabled-end-portal-creation: "<red>You cannot insert an eye of ender into an {portal} portal frame while it is disabled."
disabled-nether-portal-creation: "<red>You cannot create a {portal} portal while it is disabled."

# Command Messages
no-permission: "<red>You don't have permission to use this command."
reload-success: "<green>Configuration reloaded successfully!"

MiniMessage Formatting:

Command Examples

# Toggle nether portal entry
/portal toggle nether entry

# Disable end portal creation
/portal disable end creation

# Check all portal statuses
/portal status

# Check only nether portal status
/portal status nether

# Reload configuration
/portal reload

Permissions

Permission Description Default
portaltoggler.admin Access to all plugin commands op
portaltoggler.bypass.enter.nether Bypass nether portal entry restrictions op
portaltoggler.bypass.enter.end Bypass end portal entry restrictions op
portaltoggler.bypass.create.nether Bypass nether portal creation restrictions op
portaltoggler.bypass.create.end Bypass end portal creation restrictions op

Permission Examples

LuckPerms:

# Grant admin access to a group
/lp group admin permission set portaltoggler.admin true

# Allow VIP players to bypass nether portal restrictions
/lp group vip permission set portaltoggler.bypass.enter.nether true
/lp group vip permission set portaltoggler.bypass.create.nether true

PermissionsEx:

/pex group admin add portaltoggler.admin
/pex group vip add portaltoggler.bypass.enter.nether