Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha R6
Made for RPG Maker MZ 1.9.0
Text CodesIn the Body of the letter, you can use special text codes to display images. Use the text code:
%img[x]
where x is the corresponding body image you want to display.

For example, %img[1] will display the first body image. If using this text code, please make sure the body image actually exists, otherwise you will run into a crash. For example, if you use %img[5] but you only have 1 body image set up in the plugin, this will crash.
Integrations[CGMZ] Menu Command Window
This plugin can be used to easily add the Mailbox scene to the main menu. To do so, use the following JavaScript: SceneManager.push(CGMZ_Scene_Mailbox);
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - This calls the mailbox scene.

Send Mail - This sends a piece of mail to the player via letter id
Saved GamesThis plugin is fully compatible with saved games. This means you can:

✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.
Filename

The filename for this plugin MUST remain CGMZ_Mailbox.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.

Known Issues

This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.

Compatibility

This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.

Version HistoryVersion AlphaR2
  • Added sound effects for opening letters
  • Added Toast Manager integration for receive letter and collect attachment
Version AlphaR3
  • Added option to show when attachments have been collected already
  • Added option to turn a switch ON when letter opened
  • Added windowskin, padding, back opacity, tone options for each window
  • Body text parameter type has been changed to avoid needing parsing
Version AlphaR4
  • Added option to delete letters
  • Added option to hide letter display info until opened
  • Added option to show a custom amount of blank space in display window
  • Added [CGMZ] Scene Backgrounds integration
  • Added [CGMZ] Controls Window integration
  • All window background types now selectable
  • Mailbox display now works with custom font sizes better
Version AlphaR5
  • Add option to reverse sort order
  • Fix bug with sort order of mail
Version AlphaR6
  • Added option to allow or not allow deleting letters
  • Added plugin command to unsend mail
  • Added integration with [CGMZ] Window Settings
  • Added integration with [CGMZ] Window Backgrounds

Back to Plugin