Skip to content

Paper Wiki

SkulZYT15 edited this page Sep 23, 2026 · 1 revision

MaskUI — Survival Guide

Current version: 1.0.0

MaskUI provides seven mask tiers designed for different survival roles. Every mask grants Night Vision I by default.

Effect levels shown on this page are the levels displayed in-game, not internal potion amplifiers.

Mask Tiers

Tier Mask Default Price Role Additional Effects
1 Skeleton 5,000 Land, cave, and underwater exploration Speed II, Haste I, Water Breathing I
2 Zombie 10,000 Early combat durability and recovery Strength II, Resistance I, Regeneration I
3 Creeper 15,000 Fast mobility and defense Speed III, Jump Boost I, Resistance II
4 Piglin 20,000 Nether exploration Speed II, Strength II, Resistance II, Fire Resistance I
5 Steve 25,000 Mining and building Speed II, Haste III, Resistance II, Water Breathing I, Fire Resistance I
6 Wither Skeleton 30,000 High-level combat Speed II, Strength III, Resistance II, Regeneration I, Absorption II, Fire Resistance I
7 Dragon 35,000 Strongest all-round survival mask Speed III, Strength III, Haste III, Resistance III, Regeneration II, Absorption III, Fire Resistance I, Water Breathing I

Effect Design

Each mask is designed around a particular survival role rather than simply inheriting every effect from the previous tier.

  • Skeleton — Speed II, Haste I, and Water Breathing provide useful exploration bonuses without turning it into a powerful combat mask.
  • Zombie — Strength II, Resistance I, and Regeneration I provide durability and recovery without a Slowness penalty.
  • Creeper — Speed III, Jump Boost I, and Resistance II focus on mobility. Jump Boost is intentionally kept low for easier movement control.
  • Piglin — Fire Resistance, Strength II, and Resistance II make it suitable for Nether exploration. The mask does not provide immunity to every Nether hazard or make normally hostile mobs neutral.
  • Steve — Haste III, Water Breathing, Fire Resistance, and Resistance II focus on mining and building without excessive combat buffs.
  • Wither Skeleton — Strength III, Resistance II, Regeneration I, and Absorption II make it a high-durability combat option.
  • Dragon — Speed III, Strength III, Haste III, Resistance III, Regeneration II, and Absorption III are combined with Fire Resistance and Water Breathing for strong general-purpose survival utility. It intentionally avoids permanent high Jump Boost or Slow Falling effects that could interfere with normal movement.

A higher tier represents greater overall power and utility. It does not mean that every effect from a lower-tier mask is automatically included in higher tiers.

Default prices remain unchanged and can be customized through the plugin configuration.


Equipping Masks

Hold a mask and right-click either the air or a block to equip it.

Masks can be equipped from either the main hand or off-hand. The helmet slot must be empty.

When equipped:

  • One mask is moved from the player's hand into the helmet slot.
  • The item is not duplicated, including in Creative mode.
  • The mask can be removed normally through the armor slot in the inventory.
  • Tagged MaskUI masks are not placed as blocks when right-clicked.
  • Regular mob heads continue to behave normally.

Effect Handling

Mask effects are checked every second.

Effects last for 30 seconds and are refreshed when approximately 20 seconds remain. This prevents Night Vision from flickering near the end of its duration.

Effects provided by the mask are removed approximately one second after the mask is removed or replaced.

Existing external effects are left active until they expire naturally. Absorption is refreshed together with the other mask effects, allowing the additional hearts to refill when the effect is refreshed.

/mask wiki, the shop, status displays, and mask lore all use the same effect definitions.

Older MaskUI masks automatically receive the new effects through their item tags. However, old lore text is not automatically rewritten.


Balance and Selling Masks

The main /mask menu displays the player's current balance using the emerald icon at the top of the menu.

Click the balance icon or the Refresh button to update the displayed balance. The plugin checks the player's balance and transaction eligibility again during confirmation.

Masks can be sold through:

  • Sell Masks in the main menu
  • /mask sell
  • /mask sell <mask>

Select a mask and confirm the displayed refund amount. Each transaction sells one item.

Selling Requirements

A mask can only be sold when all of the following requirements are met:

  1. The mask was purchased through the MaskUI shop after the purchase-record system was installed.
  2. The current holder may sell the purchased mask. The seller does not need to be the original buyer.
  3. The item containing the purchase ID must be in the player's main inventory, hotbar, or off-hand. Masks must be removed from the helmet slot first. Items on the cursor, inside chests, or inside Ender Chests are not counted.
  4. The purchase record must still be active and must not have been sold previously.

Copies of an item containing the same purchase ID do not receive additional refund rights.

Refund Calculation

The default refund is 50% of the price that was actually paid, rounded down to two decimal places.

For example:

Skeleton purchase price: 5,000
Default refund:          2,500

The refund remains based on the original purchase price even if the current shop price changes later.

The percentage can be configured using:

selling:
  refund-percent: 50

The value must be greater than 0 and no greater than 100. An invalid value disables refunds.

Selling can be completely disabled using:

selling:
  enabled: false

Masks That Cannot Be Sold

The following masks are not eligible for refunds:

  • Free masks
  • Masks obtained through /mask give
  • Regular mob heads
  • Older MaskUI masks without a purchase record

These masks can still be equipped as long as they contain a valid MaskUI mask tag.

MaskUI's selling system is not a generic item-selling system based on material or display name.

Transaction Safety

If an economy provider normally rejects a payment, the item and its selling rights are restored.

If the server disconnects or the transaction result cannot be determined safely, the pending transaction record is locked for administrator review. The plugin does not automatically issue another payment for an uncertain transaction.

See the recovery documentation in the project README for administrator recovery procedures.


Commands and Interface

Mask effects are shared across the plugin's interfaces and commands, including:

/mask wiki
/mask sell
/mask sell <mask>

The Effect Guide button has been removed from the main menu.

Effect information remains available through:

  • Shop items
  • Mask item lore
  • /mask wiki

Any future changes to mask effects should also be reflected on this Wiki page.


Display Compatibility

MaskUI targets Minecraft server versions 1.16.x–1.21.x.

On versions where a native Piglin Head is unavailable, the Piglin mask uses a Player Head with the appropriate Piglin name and MaskUI tags.

This fallback only affects the displayed head item. The mask's effects remain unchanged.

Fallback Piglin masks continue to be recognized after upgrading the server to a newer Minecraft version.