Installation

Get MineMail running on your server in a few minutes.

Requirements

Requirement	Detail
Server software	Paper or Spigot
API version	1.20
Built against	Spigot API 1.20.4-R0.1-SNAPSHOT
Java	17
Soft dependency	Vault - required for economy costs and currency attachments
Soft dependency	DecentHolograms - required for the floating mailbox name tags

MineMail runs without Vault or DecentHolograms installed - it simply disables the features that depend on them (economy costs/currency become free/no-ops, and holograms are skipped with a startup warning).

---

Install Steps

1. Build or download the MineMail jar.
2. (Optional but recommended) Install Vault and an economy plugin, plus DecentHolograms.
3. Place MineMail.jar in your server's plugins/ directory.
4. Restart the server. MineMail generates its data folder and default config.yml on first run.
5. (Optional) Edit plugins/MineMail/config.yml to taste.
6. Run /minemail reload - or restart the server - to apply your changes.

After first start you should see:

plugins/
└── MineMail/
    ├── config.yml
    ├── messages.yml
    ├── mailboxes.yml
    └── mail.yml

mailboxes.yml and mail.yml are created once at least one mailbox or mail exists.

---

Quick Start

For most servers the defaults are sensible. A typical first pass:

1. Open plugins/MineMail/config.yml.
2. Decide how many mailboxes a player may own with mailbox.max-per-player (default 5).
3. Decide whether creating a mailbox or sending mail should cost money with economy.mailbox-creation-cost / economy.mail-send-cost (both 0.0 by default - free). Requires Vault + an economy plugin.
4. Decide whether holograms and ambient particles should show above mailboxes with mailbox.hologram.enabled / mailbox.particles.enabled (both true by default).
5. Run /minemail reload to apply changes without restarting.

Test it: place a barrel, run /minemail create Test Box, left-click the barrel with a stick to confirm, then right-click it to open your new mailbox.

---

Building from Source

MineMail is a Maven project.

Setting	Value
Group ID	org.modularsoft.minemail
Artifact ID	MineMail
Main class	org.modularsoft.minemail.MineMail
Java source/target	17
Spigot API	1.20.4-R0.1-SNAPSHOT

Build the jar:

mvn clean package

The compiled (shaded) jar is produced in the target/ directory. Drop that jar into your server's plugins/ directory.