[CGMZ] Mailbox (Patreon)

Add a mail system to your game, where you can send the player in-game which they can open. Complete with attachments & more.

! SEE BOTTOM OF POST FOR UPDATES !

Hi all, introducing [CGMZ] Mailbox!

The Mailbox plugin adds a mailbox system to your game. With it, you can send the player mail via plugin commands, and the player can check the mailbox scene to read the mail. Mail can have images mixed in between the text similar to how a custom entry works in my Encyclopedia plugin.

Mail can have attachments which the player can take, which can be either items, weapons, armor, or currency (including support for CGMZ Currency System currencies). Attachments can be collected only once, and then they will no longer display on the mail.

In the mailbox scene, players can mark mail as read which can display a separate mail icon next to the list window. Each mail can have its own separate mail icon(s) for read/unread mail. You can use this to coordinate mail types, such as maybe romantic letters in your game are colored red while some other type of letter is colored a more standard brown color. Mail is also sorted by order received, with the most recent pieces of mail being shown first in the list.

Want additional features not already present/listed above? Make suggestions on the Patreon Post or in my discord under the #suggestions channel! https://discord.gg/Gbx7JXP

This update adds toast manager integration for receiving letters and collecting attachments. Now you can show a toast window when the player receives a letter, and you can also show one for each item collected from an attachment to a letter when the mail is opened.

This update also adds a sound effect parameter to play when a piece of mail is opened. There is a default sound effect parameter which will play if a letter does not have a sound effect, or you can also assign different sound effects for each letter.

 This update adds some requested features, such as the option to show when attachments have been collected from a letter already. Previously, it would not show attachments at all after having collected them, but now you can show that there were attachments but they have already been collected. You can also now automatically turn a switch ON when a letter is first read. This should help your events in case you need to know if a letter has been read.

This update also added some standard window options I have been adding to all of my plugins. You can now change each window in the mailbox scene's windowskin, padding, background opacity, and tone.

The Body Text parameter for letters changed to a different type that does not require additional parsing in the code. Unfortunately, this change also means you will need to edit your letter's Body Text parameters if you had any set up to get them appearing how they used to.

This version adds the option to delete letters. You can now allow your players to delete a letter if it has been opened. See below gif for how it can look:

It also adds the option to hide letter info before it is read. This will cause the display window to show text prompting the player to open the letter by pressing a button. Once the letter is opened, the player can then collect the attachments.

This update also makes the mailbox scene work much better when using custom font sizes for various headers or information lines. Along with this, a new custom space option was added to allow more control over blank space in the display window.

This update also added some integrations. You can optionally show a custom scene background including scrolling images or weather with [CGMZ] Scene Backgrounds. You can also show a [CGMZ] Controls Window with keyboard or gamepad controls based on the player's last input type. 

This version fixes a bug with the sort order of the mail, as it should be sorted by the received order rather than plugin param order. I also added a parameter so you can reverse this order as well in case you want the mail to be sorted by oldest on top. 

This version adds a plugin command to unsend mail. This will allow you to repeat sending the same letter in your game if you have need to do so, such as a weekly or monthly letter if your game uses a time system or something like that. Unsending a letter also undeletes it and allows the player to collect any attachments again if it gets sent again.

This update also made deleting letters optional. You can now disable the ability of your player to delete letters. Of course, the delete letter plugin command is not affected by this.

This update also added integrations with both [CGMZ] Window Backgrounds and [CGMZ] Window Settings. These allow you to show your own images as a window background including scrolling animated parallax images, and control any window's tone, windowskin, style, etc. respectively.

This version updates the [CGMZ] Toast Manager integration. It now uses the preset id system for the fallback attachment and received toasts. The text codes have also been simplified, as you can now use %name, %icon, and %amount for attachments. You can still use %subject for the received toast.

In addition to the fallback toasts, you can now add a per-letter override of each toast to use a different preset. This can make it so your special letters stand out more than your standard letters by using a different preset id.

The order with [CGMZ] Toast Manager in the Plugin Manager is no longer important.

This version adds a Single Letter scene, where you can show an individual letter without the letter select or delete windows to worry about. This might come in handy if you have an especially important letter you want to be sure the player reads.

See below gif for how this can look:

This update also includes a lot of minor quality of life updates. The display window now supports automatic space after label text, and the integration parameters were organized. Delete window padding now considers custom padding from [CGMZ] Window Settings. The integration with [CGMZ] Toast Manager now supports all toast types instead of just text.