Skip to content

Home

Jump to bottom
SkulZYT15 edited this page Sep 23, 2026 · 4 revisions

MaskUI

🎭 MaskUI Wiki

Official documentation for MaskUI on Paper and PocketMine-MP.

📖 About MaskUI

MaskUI is a Minecraft server plugin that introduces a mask system where players can obtain and equip special masks that provide unique effects and abilities.

The project originated as a modern revision of the original MaskShop plugin and is now available as separate implementations for Paper and PocketMine-MP.

Although both editions share the same core concept and seven-mask progression system, they are developed separately and their features, commands, economy systems, configuration, and gameplay mechanics may differ.

Always use the documentation for your server platform.

☕ Paper Edition

The Paper edition is the Java Edition implementation of MaskUI and contains major changes and new systems compared with the original PocketMine-MP version.

Highlights

  • 🎭 7 mask tiers with unique survival roles and effects
  • 🛒 Interactive mask shop
  • 🖱️ Right-click to equip masks
  • 💰 Economy integration
  • 💵 Mask selling and configurable refunds
  • 🧾 Purchase tracking
  • 🔒 Transaction safety and recovery system
  • ⚡ Automatic mask effects
  • 🏷️ Persistent mask identification through item tags
  • 🔧 Configurable prices and gameplay settings
  • 🌐 Support for Minecraft 1.16.x–1.21.x

🛏️ PocketMine-MP Edition

The PocketMine-MP edition is the Bedrock Edition implementation of MaskUI.

Players can purchase masks through an interactive shop using BedrockEconomy. Each mask provides its own effects while equipped.

Highlights

  • 🛒 Interactive Mask Shop UI
  • 🎭 7 unique masks with different prices and effects
  • 💰 BedrockEconomy integration
  • ⚡ Automatic effects while masks are equipped
  • 🔧 Configurable prices and messages through config.yml
  • 🔌 Lightweight and simple setup
  • 📱 Designed for PocketMine-MP 5.x

Requirements

Commands

The PMMP edition currently provides:

/mask open
/mask wiki
/mask help
/mask github

🔀 Paper vs PocketMine-MP

Paper and PocketMine-MP editions are separate implementations of MaskUI.

They share the same project identity and core mask concept, but you should not assume that a feature available on one platform also exists on the other.

☕ Paper 🛏️ PocketMine-MP
Minecraft Edition Java Edition Bedrock Edition
Server Software Paper PocketMine-MP
Source Branch paper pmmp
Mask System 7 mask tiers 7 unique masks
Mask Shop ✅ ✅
Automatic Effects ✅ ✅
Economy Vault & EssentialsX BedrockEconomy
Right-click Equip ✅ —
Mask Selling / Refunds ✅ —
Purchase Tracking ✅ —
Transaction Recovery ✅ —
Shop Interface Inventory GUI PMMP Form UI

A dash (—) means the feature is not documented for that edition. Check the platform-specific pages for the current feature set.

🌿 Project Branches

MaskUI uses separate branches for each platform:

  • paper — Paper implementation
  • pmmp — PocketMine-MP implementation

The implementations may evolve independently while remaining part of the same MaskUI project.

📚 Choose Your Documentation

Using Paper?

Start here:

➡️ Paper — Getting Started

Using PocketMine-MP?

Start here:

➡️ PocketMine-MP — Getting Started

🤝 Contributing

Contributions, bug reports, suggestions, and documentation improvements are welcome.

When opening an issue or submitting a contribution, please specify which implementation you are using:

Clone this wiki locally