Mailbox

Mailbox

Build a mailbox in front of your house and let your friends leave you letters.

• Anyone can write, even inside your ward: walk up, press E and type a letter of up to 300 characters. Type \n for a new line. Building and removing the mailbox are still protected by the ward.
• Anonymous letters: press Shift + E instead of E to write without signing. The writer's name is not stored anywhere.
• Only the owner (whoever built it) can read the letters.
• The owner is notified anywhere: a sound, a message ("Nova carta de Fulano!") and a temporary marker on their map (only they see it).
• The red flag goes up while there is unread mail, and the owner gets a reminder when coming home.
• Letters are shown just like rune stones, including the decorative rune text.
• Read, re-read and delete:
• E: read the next new letter. With nothing new, it cycles through the old ones.
• Shift + E: delete the letter you just read.
• Up to 20 letters per mailbox. Letters are saved with the world.
• Like a chest with items, a mailbox with letters can't be removed with the hammer: delete the letters first. (If it is destroyed by damage, its letters are lost.)
• English and Brazilian Portuguese.

Building it

Hammer → Furniture → Mailbox. It needs a Workbench nearby and costs 4 Wood + 1 Copper.

Installation

Every player should install the mod, because the mailbox is a new piece and players without the mod can't see it.

The server doesn't need it, but installing it there is recommended: then players without the mod (or with a different version) can't join. Installing through r2modman also installs the dependencies.

Configuration (per player)

In game, press F1 (Configuration Manager) and find Mailbox. Changes apply immediately.

| Section | Setting | Default | Description |

|---|---|---|---|

| New letters | Notify | true | Sound and message when someone writes to you, wherever you are |

| New letters | MessageText | Nova carta de {player}! | {player} = who wrote it |

| New letters | MapPingSeconds | 30 | How long your mailbox stays marked on your map (only you see it). 0 = off |

| Sound | SoundPreset | MagicBells | MagicBells, DingDong, Knock, Forge or Custom |

| Sound | Volume | 0.7 | 0.0 to 1.0 |

| Sound | SoundFile | (empty) | Custom.wav,.ogg or.mp3. Pick it with Browse... |

| Sound | TestSound | | Button that plays the sound with the current settings |

Game sound presets only work inside a world. In the main menu, the built-in ding-dong plays instead.

Good to know

• If the owner is offline, the letter waits in the mailbox: the flag is up and they get a reminder when they come home.
• Letters are only shown to the owner in game, but they are stored in the world save, so don't write real secrets.

Changelog

See CHANGELOG.md.