WorldPlugin v1.1.3

Per-world plugin management for Minecraft servers. Control which plugins work in each world.

---

Table of Contents

• WorldPlugin v1.1.3
  • Table of Contents
  • What is WorldPlugin?
  • Features
  • Installation
  • Quick Start
  • Configuration
    • 1. Worlds to Manage
    • 2. Plugin Modes
      • Mode A: allowed-plugins (Whitelist)
      • Mode B: blocked-plugins (Blacklist)
    • 3. Plugin Groups
    • 4. Player Exceptions
    • 5. Maintenance Mode
    • 6. World Templates
  • Block Behavior
  • Permissions
  • Commands
  • How It Works
  • Configuration Examples
    • Example 1: Simple Server
    • Example 2: Server with Groups
    • Example 3: Blocking Specific Plugins
    • Example 4: With Maintenance
  • Troubleshooting
    • Players can't do anything even without blocked plugins
    • Plugin not blocking
    • Performance issues
  • Support
  • License
  • Credits

---

What is WorldPlugin?

WorldPlugin allows you to manage plugins per world. You can specify which plugins work in each world of your Minecraft server.

When a player enters a managed world with blocked plugins, all their activity is blocked:

• Commands
• Movement
• Block breaking/placing
• Inventory access
• Item drop/pickup
• Damage
• And more...

This ensures players can't use plugins that aren't allowed in that world.

---

Features

• Per-world plugin management - Control plugins per world
• Two modes - allowed-plugins (whitelist) or blocked-plugins (blacklist)
• Plugin groups - Reusable groups with @group-name
• Player exceptions - Bypass specific plugins for specific players
• Maintenance mode - Disable worlds for maintenance
• World templates - Reusable world configurations
• Optimized performance - Uses caching for fast lookups
• Multi-language support - English and Spanish
• Discord webhooks - Notifications for events
• Detailed logging - Track blocked actions

---

Installation

1. Download WorldPlugin-1.1.1.jar
2. Drop it into your plugins/ folder
3. Start/restart your server
4. Edit config.yml to configure your worlds

---

Quick Start

1. Add worlds to manage:

worlds-to-manage: [world, lobby]

2. Set allowed plugins for each world:

worlds:
  world:
    allowed-plugins:
      - Essentials
      - Vault
  lobby:
    allowed-plugins:
      - Vault
      - LobbyScoreboard

3. Restart or run /wp reload

That's it! Players in world can only use Essentials and Vault.

---

Configuration

1. Worlds to Manage

Define which worlds are managed by WorldPlugin:

worlds-to-manage: [world, lobby, survival, creative]

Only worlds in this list will have plugin restrictions.

---

2. Plugin Modes

WorldPlugin supports two modes:

Mode A: allowed-plugins (Whitelist)

Only listed plugins work. All others are blocked.

worlds:
  world:
    allowed-plugins:
      - Vault
      - PlaceholderAPI
      - Essentials
      - PermissionsEx

Mode B: blocked-plugins (Blacklist)

Only listed plugins are blocked. All others work.

worlds:
  world:
    blocked-plugins:
      - MiPlugin2
      - EssentialsX

Note: If both are set, blocked-plugins takes priority.

---

3. Plugin Groups

Create reusable groups to avoid repetition:

plugin-groups:
  admin-plugins:
    - Essentials
    - Vault
    - PermissionsEx
    - WorldEdit
    - WorldGuard
  
  lobby-plugins:
    - LobbyScoreboard
    - BungeeUtil
    - HubAPI
    - AutoSpawner
  
  survival-plugins:
    - mcMMO
    - Jobs
    - GriefPrevention
    - Towny
    - Jobs

Using groups:

worlds:
  lobby:
    allowed-plugins:
      - @lobby-plugins
      - Vault
      - PlaceholderAPI
  
  survival:
    allowed-plugins:
      - @survival-plugins
      - Vault

Use @group-name to include all plugins from that group.

---

4. Player Exceptions

Bypass specific plugins for specific players:

player-exceptions:
  "player-uuid-here":
    worlds:
      - world
      - lobby
    bypass-plugins:
      - Essentials
      - Vault

Or bypass all plugins:

player-exceptions:
  "player-uuid-here":
    bypass-all: true

---

5. Maintenance Mode

Disable worlds for maintenance:

maintenance:
  world:
    enabled: true
    kick-message: "&cThis world is under maintenance"
    kick-world: lobby
  
  lobby:
    enabled: false

Players attempting to enter a world under maintenance will be kicked or moved to another world.

---

6. World Templates

Create reusable world configurations:

world-templates:
  default:
    allowed-plugins:
      - Vault
      - PlaceholderAPI
  
  pvp:
    allowed-plugins:
      - Vault
      - CombatTag
      - PvPMaster

Apply templates:

worlds:
  arena-pvp:
    template: pvp

---

Block Behavior

Configure what gets blocked:

block-behavior:
  block-commands: true        # Block all commands
  block-events: true         # Block movement, blocks, etc.
  block-inventories: true    # Block inventory opening
  block-teleports: true      # Block teleport commands
  block-chat-events: true   # Block chat
  notify-player: true       # Show message to player
  log-to-console: true      # Log to console
  log-to-file: true         # Log to file

---

Permissions

Permission	Description	Default
worldplugin.admin	Full admin access	OP
worldplugin.bypass.all	Bypass all restrictions	false
worldplugin.maintenance.bypass	Bypass maintenance mode	false
worldplugin.whitelist.bypass	Bypass world whitelist	false
worldplugin.notify	Receive admin notifications	OP

---

Commands

Command	Description
/wp or /worldplugin	Main command
/wp reload	Reload configuration
/wp list	List all worlds and plugins
/wp info <world>	Show world info
/wp add <world>	Add world to manage
/wp remove <world>	Remove world from manage
/wp allow <plugin> <world>	Allow plugin in world
/wp block <plugin> <world>	Block plugin in world

---

How It Works

1. Define managed worlds in worlds-to-manage
2. Set plugin rules using allowed-plugins OR blocked-plugins
3. Player enters managed world → Plugin checks which plugins are blocked
4. If blocked plugins exist → ALL player activity is blocked
5. Player exits managed world → Normal activity resumes

The blocking is instantaneous and comprehensive - players cannot interact with blocked plugins in any way.

---

Configuration Examples

Example 1: Simple Server

worlds-to-manage: [world, lobby]

worlds:
  world:
    allowed-plugins:
      - Essentials
      - Vault
      - PermissionsEx
  
  lobby:
    allowed-plugins:
      - Vault
      - LobbyScoreboard
      - BungeeUtil

Example 2: Server with Groups

worlds-to-manage: [world, lobby, survival]

plugin-groups:
  core-plugins:
    - Vault
    - PlaceholderAPI
    - Essentials
  
  lobby-plugins:
    - LobbyScoreboard
    - BungeeUtil
  
  survival-plugins:
    - mcMMO
    - Jobs
    - Towny
    - GriefPrevention

worlds:
  lobby:
    allowed-plugins:
      - @core-plugins
      - @lobby-plugins
  
  survival:
    allowed-plugins:
      - @core-plugins
      - @survival-plugins

Example 3: Blocking Specific Plugins

worlds-to-manage: [world]

worlds:
  world:
    blocked-plugins:
      - SomePlugin
      - AnotherPlugin

Example 4: With Maintenance

worlds-to-manage: [world, lobby]

worlds:
  world:
    allowed-plugins:
      - Essentials
      - Vault

maintenance:
  lobby:
    enabled: true
    kick-message: "&cLobby is under maintenance"
    kick-world: world

---

Troubleshooting

Players can't do anything even without blocked plugins

Make sure the world is in worlds-to-manage. If you want a world to work normally, remove it from the list.

Plugin not blocking

1. Check worlds-to-manage includes the world
2. Verify allowed-plugins or blocked-plugins is set
3. Run /wp reload
4. Check console for errors

Performance issues

WorldPlugin is optimized with caching. If you experience issues:

• Disable debug mode in settings
• Reduce log verbosity

---

Support

• GitHub: github.com/zSanchez31/worldplugin
• Issues: github.com/zSanchez31/worldplugin/issues
• Discord: Join our Discord server

---

License

MIT License

---

Credits

• Author: zSancheZ
• Version: 1.1.3