Mailboxes

Mailboxes

Mailboxes allow players to deposit items into claims for the owner to collect. GPExpansion supports both purchasable mailbox signs and instant self-mailboxes.

Types of Mailboxes

1. Self Mailboxes (Free)

Players with permission can instantly create mailboxes in claims they own or rent.

How to create:

1. Place a chest, barrel, or other container in your claim
2. Place a [Mailbox] wall sign on the container
3. The mailbox is immediately active!

2. Purchasable Mailboxes (Sign-Based)

Claim owners can sell mailbox access to other players.

How to create:

1. Run /mailbox or /mailbox <claimId>
2. Follow the setup wizard prompts
3. Configure price and protocol
4. Place the sign as instructed

Mailbox Protocols

Virtual Protocol

• No subdivision created
• Non-owners see a snapshot of contents at open time
• Changes save when menu closes
• Allows stacking multiple mailboxes
• Works with regular GriefPrevention

Real Protocol

• Creates 1x1x1 subdivision (GP3D) or 1x1 2D subdivision (regular GP)
• Grants public container trust
• Non-owners see live chest contents
• Requires GP3D for best experience
• Only one mailbox per location

Sign Formats (Purchasable)

Short Format (Inside Claim)

[mailbox]
<price>
<ecoType>

Example:

[mailbox]
500
money

Condensed Format (Outside Claim)

[mailbox]
<id>;<price>;<ecoType>

Example:

[mailbox]
12345;500;money

How Mailboxes Work

For Depositers (Non-Owners)

1. Click the mailbox sign
2. A virtual or real inventory opens
3. Deposit items
4. Close to save changes

Features:

• Can take back items before closing
• Items returned if mailbox fills while viewing
• Chest opening animation and sound

For Owners

1. Access the physical container directly
2. Collect deposited items
3. Full container access as normal

Storage Warnings

Owners receive warnings when mailbox is nearly full:

• 90% full: First warning
• 95% full: Second warning
• 100% full: Items may be returned to depositers

Commands

Command	Description
/mailbox	Start mailbox setup wizard for current claim
/mailbox <claimId>	Start wizard for specific claim
/mailbox help	Show mailbox help

Permissions

Permission	Description
griefprevention.sign.create.self-mailbox	Create instant self-mailboxes
griefprevention.sign.create.mailbox	Create purchasable mailbox signs
griefprevention.mailbox.use	Use mailboxes in claims you don't own

Configuration

# Mailbox protocol setting
# 'virtual' - Snapshot-based, works everywhere
# 'real' - Live chest, requires GP3D for subdivisions
mailbox-protocol: virtual

defaults:
  max-mailbox-signs-per-claim: 1
  max-self-mailboxes-per-claim: 3
  
mailbox:
  storage-warnings:
    enabled: true
    thresholds: [90, 95, 100]
  sounds:
    open: true
    close: true

Limits

Type	Default Limit	Permission Override
Purchasable signs	1 per claim	griefprevention.sign.limit.mailbox.<number>
Self mailboxes	3 per claim	griefprevention.sign.limit.self-mailbox.<number>

Troubleshooting

Mailbox sign not working?

• For purchasable: Verify format and claim ID
• For self-mailboxes: Must be wall sign on container in owned/rented claim
• Check griefprevention.sign.create.self-mailbox or griefprevention.sign.create.mailbox permission

Can't deposit items?

• Virtual protocol: Wait for previous depositer to close
• Real protocol: Verify container trust is granted

Mailbox full?

• Owner must clear physical container
• Or increase container size (use double chest)

Tips

• Use virtual protocol for regular GP servers (allows stacking)
• Use real protocol with GP3D for live updates
• Place self-mailboxes in easily accessible locations
• Set reasonable prices for purchasable mailboxes