JK Mail System

Pirobi · 2016-02-16T04:33:03+0900

JK MailSystem v2.51 Author: Pirobi and JK Software Introduction This plugin adds a mailbox and messaging system to a project. Messages can be sent to the player's "inbox" through plugin commands and read. Features A json file called Mail.json must be placed in your data folder. This file will contain the collection of messages that the plugin will interact with. The formatting for the json should be as follows: Code: [ { "sender":"Dad","subject":"Test","attachment":"0", "message":"Hello!","trigger":"0","flag":"n","imgName":"","imgIndex":0 }, { "sender":"Mom","subject":"Test2","attachment":"g100", "message":"Hi! Here is some money to help you out!", "trigger":"c,1","imgName":"","imgIndex":0 }, { "sender":"Pirobi","subject":"Updates!","attachment":"i1", "message":"Here is a potion for your trouble!", "trigger":"0","imgName":"Actor1","imgIndex":3 } ] (Experimental) NEW FEATURE ~ Attachment Restrictions As of version 2.5, you can specify attachment criteria! Do you have a plugin that restricts inventory? Maybe the attachment is encrypted and you can only collect it if you solve a puzzle? To do this, specify attachment criteria (default is true, always claim)! Examples: "attachmentCriteria":"$gameSwitches.value(10)" - only claim attachment if switch 10 is ON "attachmentCriteria":"$gameVariables.value(1) == 4" - only claim attachment if variable 1 equals 4 "attachmentCriteria":"SomePlugin.hasRoomForItem()" - only claim attachment if the plugin script call (SomePlugin.hasRoomForItem()) returns true Note: Current mail editor does not support this and thus is an experimental feature. This was planned to be rolled out with the new editor but due to delays, I am releasing this now. FEATURE ~ Shared Mail Introduced in version 2.41, you can now add the same instance of mail to multiple mailboxes. All triggers/attachments/read status will be shared among the mailboxes it is placed into. New plugin commands are provided for this (see the Plugin Commands section). FEATURE ~ Optional Avatar Introduced in version 2.3, you can now make a message display a portrait at the top of the message text (to the left of the sender and subject text). For now, you can choose from any image in the img/faces folder. The syntax in the json is as follows: "imgName":x,"imgIndex":y Where x is the name of the file in img/faces, and y is the index of the portrait to use. FEATURE ~ Updated Plugin Parameters As of version 2.2, we have updated our plugin parameters to utilize the new features in MV 1.5! If you have plugin parameters set, you will probably need to update them to be compatible! FEATURE ~ Scrolling! As of version 2.41, scrolling is always enabled, and multiple pages have been removed. Word wrapping is also now supported with scrolling. (Credit to Yanfly for the inspiration). A plugin parameter has been provided to indicate what the wordwrap command is. For example, if you type in to specify word wrapping, the plugin parameter will read "WordWrap". You will need to add the command (e.g. ) to the beginning of the mail body for each message. FEATURE ~ Flags! Introduced in version 2.1, you can now flag a message so that the player cannot delete it from the mailbox scene. The following line must be placed inside each mail json object: "flag":"w,x,y,z" Where x is the type of flag you want to set: s - allow this message to be deleted only after a switch with an ID of x is set to ON. v - allow this message to be deleted only after a variable with an ID of x passes the given condition In this case, y can be set to the following: 0 - pass if the variable at x is equal to z 1 - if the variable at x is greater than z 2 - if the variable at x is greater than or equal than z 3 - if the variable at x is less than z 4 - if the variable at x is less than or equal to z 5 - if the variable at x is not equal to z y and z are only looked at in this case. n - never allow the message to be deleted j - allow this message to be deleted if and only if the script at x evaluates to true RULES FOR FLAGS: - Only a message that has no attachment can be deleted - meaning you must collect any attachments before you can delete it. - PLUGIN COMMANDS WILL STILL REMOVE THE MESSAGE, EVEN IF IT IS SET TO NEVER. The reason for this is because plugin commands are at the discretion of the developer, which should override the player's extent of control. - Triggers will still execute even if a READ message is deleted. If an UNREAD message is deleted, the trigger will NOT execute. One way to guarantee your trigger will run is to use a common event trigger that does your processing, then sets a switch at the end. Then, give the message a switch flag using that switch. That way, the message can't be deleted until the trigger runs! - Because triggers don't activate until you leave the mail scene, if a message's flag is set to a switch that gets set in a trigger, you need to exit the mail scene before you're allowed to delete the message. EXAMPLES OF FLAGS: "fla…

● ARCHIVED · READ-ONLY

Started by Pirobi Feb 15, 2016, 07:33 PM 164 posts Page 4 of 9 View original ↗

Pirobi

#61 Feb 10, 2018, 04:49 PM Source

~Update to 2.0.2~

This is a hotfix for an issue introduced in 2.0.1 where saving/loading the game would not properly save/load the state of the mailbox (i.e. if you had a mailbox with 5 messages in it and you saved, then loaded the game, all 5 messages would disappear).

I only updated the plugin in the code tags in the original post - I will update the demo itself when I push out the next changes (mail deleting).

If anyone still notices this issue when using this update, please let me know!
Randy

#62 Feb 10, 2018, 07:02 PM Source

Pirobi said:
I'm actually thinking of having that specific error pop up if the Mail Json is empty or improperly formatted for any reason. Thanks for reminding me :)

My current plan is to not only add this functionality, but make it optional, since in the game I'm currently working on I don't want the player to accidentally delete these messages and lose some key info.

I'm also thinking of the logistics. It would have to be a key event, like pressing D or something like that when the cursor is inside the message, followed by a prompt to delete, but I need to remind myself how to make sure these commands will be useable if a controller is being used - guess I gotta test that out too haha

It could get a little complicated but I would probably make a conditional branch where certain switches can allow the deleting of a message. That way important messages can't be deleted while they're still needed but once they're not useful any more you can delete them. I would add that functionality to the mail editor so it would stay simple for new users. I would also have a confirmation for deleting the message and only allow it after the attachment has been received.

I would stay away from the D button for people that use WASD controls. It should probably be user determined.

One small thing I noticed with the editor. It doesn't seem to track the ID of each mail. That's fine for 10 or less items but gets confusing above that.

Thank you once again! Loving the amount of progress. It's looking very promising.
Pirobi

#63 Feb 11, 2018, 02:26 AM Source

Ok so I do have a planned path forward regarding deleting messages. I won't disclose yet in case I end up changing it ^^

Also, please note that the mail editor has a bug where attachments will always be set to 'None' when a message is loaded. If you set it to the intended type it should still have your info saved, and saving should still produce a proper json. The bug is caused by me not setting the index of the comboBox when the attachment fields are populated. This fix will come out in 2.1 along with the message deletion feature. Thanks for your patience!

~EDIT~
The above bug has been fixed and both the Editor and Demo links have been updated!
Pirobi

#64 Feb 25, 2018, 02:08 AM Source
~Update to 2.1~

Fixes:
- Fixed resolution scaling...Actually, it looked like it should have been working. But, please let me know if you see any issues!
- Plugin optimizations and fixes
- Editor optimizations and fixes
  
  Most notably, Item and Armor attachment types were switched, so selecting one would actually get you the other.
NEW FEATURES:
- Added ability to delete mail from the mailbox scene
- Updated the mailbox UI to reflect this change.
  
  New UI look is attached to this post!
  
  Added command window with the options Read, Attachment, and Delete (Pretty self-explanatory)
  
  Removed the left and right commands to go between the mail list and the window, so this should make controls and interactions (e.g. claiming attachments) much more transparent and intuitive.
- Added Message Flags to prevent certain messages from being deleted
  
  See the OP for more details
- Added new plugin parameter to override Message Flags if desired
Known Issues:
- The editor doesn't resize to help with different resolutions. Looking into it!
- Before anyone even asks, yes I will consider making the command text based on plugin parameters!
- The mailbox does NOT prompt you when you want to delete the mail. Blame incremental development :p
Future considerations:
- When I designed flags, I wanted to be able to use a script eval, as well as variable eval, but I cut them from this version due to complexity. This may be my first priority moving forward since I got the flag system working!
As always, if you find any issues please let me know!
styx92

#65 Feb 25, 2018, 08:36 AM Source

@Pirobi Thanks you!
A great plugin and you still support it! Awesome work :)

EDIT: And i found a bug :D If the mailbox has no letters and you try to read than i get an error. In your demo, too.
The error says:

Spoiler
Randy

#66 Feb 25, 2018, 05:29 PM Source

@Pirobi Wow, this has all the functionality that I could possibly hope for. Now that the menu is looking so slick, one of the minor annoyances is becoming more apparent. The message scrolling is still a little clunky. It would be nice to scroll the entire message at once, instead of line-by-line.

Again, totally love this plugin!
Pirobi

#67 Mar 9, 2018, 01:45 AM Source

styx92 said:
@Pirobi Thanks you!
A great plugin and you still support it! Awesome work :)

EDIT: And i found a bug :D If the mailbox has no letters and you try to read than i get an error. In your demo, too.
The error says:

Spoiler
View attachment 83747

Looking into the 0 messages thing.

Randy said:
@Pirobi Wow, this has all the functionality that I could possibly hope for. Now that the menu is looking so slick, one of the minor annoyances is becoming more apparent. The message scrolling is still a little clunky. It would be nice to scroll the entire message at once, instead of line-by-line.

Again, totally love this plugin!

So I've been fighting with myself ever since I first thought of this plugin for the ability to scroll whole chunks instead of going line-by-line, kind of like "flipping through pages". I kept it as it is because I used Yanfly's profile plugin as an example, deciding to take the easy way out. However, it might be finally time to tackle that beast haha. Not to go into detail, but during the very first stages I had the message as one whole block of text (so word wrapping would be handled), but I didn't know how to determine a good spot to chunk the message and create a second page, but as I type this, I think I just figured it out...back to work!

As a general heads up, I am currently testing through another round of optimizations for the editor, including new flag options - now you should soon be able to delete a message based on a variable, or based on a script evaluation. How useful this will be would be up to the developer I guess, but it'll be there :D
Pirobi

#68 Mar 19, 2018, 12:08 AM Source
~Update to 2.2~

Fixes:
- Fixed issue where an empty mailbox would result in the game crashing.
NEW FEATURES:
- Added new flag options
  
  Script - Message can be deleted if the expression evaluates to true
  
  Variable - Check the OP/Plugin for the expanation here. Basically, you specify the ID, an operator, and a value.
- Added ability to create multiple pages
  
  Insert a page break <pg> into the message. Any text after this will appear in the next page.
  
  Pages can be seen within the scene by pressing left/right while inside the mail window (when you select the READ button)
  
  Note that mail will only be counted as read if ALL pages have been seen
- Added ability to toggle scrolling
  
  Default value is enabled
  
  When enabled:
  
  Word wrapping is not supported since each line is broken up into its own string of text
  
  Must manually insert line breaks to get the text to fit the window, but you can have as many lines as possible in a single page
  
  When disabled
  
  Cursor will STILL appear, but only 1 row (on first page there are 3 rows for the Subject and Sender)
  
  Message text will be appended as a single block, allowing for word wrapping on that text
  
  Note that if you have to insert a <wrap> (a la Yanfly's word wrapping plugin), you MUST insert this for each page (do a <pg><wrap>)
  
  If you do not use word wrapping, you will still need to manually insert line breaks to get the text to fit the window.
- Updated plugin parameters to use MV 1.5 notation
  
  You MUST update your parameters because they will most likely be broken!
- Editor has been updated to work with all applicable functionality
Known Issues:
- The editor doesn't resize to help with different resolutions.
- Will consider making the command text based on plugin parameters!
- The mailbox does NOT prompt you when you want to delete the mail.
Future considerations:
- A more visual indication that a message has multiple pages?
- What to do with the cursor when scrolling is disabled
- I'll probably notate scrolling enabled/disabled as something more fitting
- Will update the messages in the demo because some of them are getting chopped off.
As always, if you find any issues please let me know!
styx92

#69 Mar 19, 2018, 09:28 PM Source
Pirobi said:
~Update to 2.2~

Fixes:

Fixed issue where an empty mailbox would result in the game crashing.

NEW FEATURES:

Added new flag options

Script - Message can be deleted if the expression evaluates to true

Variable - Check the OP/Plugin for the expanation here. Basically, you specify the ID, an operator, and a value.

Added ability to create multiple pages

Insert a page break <pg> into the message. Any text after this will appear in the next page.

Pages can be seen within the scene by pressing left/right while inside the mail window (when you select the READ button)

Note that mail will only be counted as read if ALL pages have been seen

Added ability to toggle scrolling

Default value is enabled

When enabled:

Word wrapping is not supported since each line is broken up into its own string of text

Must manually insert line breaks to get the text to fit the window, but you can have as many lines as possible in a single page

When disabled

Cursor will STILL appear, but only 1 row (on first page there are 3 rows for the Subject and Sender)

Message text will be appended as a single block, allowing for word wrapping on that text

Note that if you have to insert a <wrap> (a la Yanfly's word wrapping plugin), you MUST insert this for each page (do a <pg><wrap>)

If you do not use word wrapping, you will still need to manually insert line breaks to get the text to fit the window.

Updated plugin parameters to use MV 1.5 notation

You MUST update your parameters because they will most likely be broken!

Editor has been updated to work with all applicable functionality

Known Issues:

The editor doesn't resize to help with different resolutions.

Will consider making the command text based on plugin parameters!

The mailbox does NOT prompt you when you want to delete the mail.

Future considerations:

A more visual indication that a message has multiple pages?

What to do with the cursor when scrolling is disabled

I'll probably notate scrolling enabled/disabled as something more fitting

Will update the messages in the demo because some of them are getting chopped off.

As always, if you find any issues please let me know!
Awesome!!! I love your support for these great plugin! Thanks!
DanTTGamer

#70 Mar 30, 2018, 06:06 PM Source

Any chances of mac release for the program please?
Casia

#71 Mar 31, 2018, 10:49 AM Source

I'd like to point out an error. In the demo, when I tried to delete the first mail at the mailbox on the right, an error message popped up: "Cannot read property 'replace' of undefined"
Pirobi

#72 Apr 8, 2018, 11:46 PM Source

DanTTGamer said:
Any chances of mac release for the program please?

We're looking into compatibility for Mac.

Casia said:
I'd like to point out an error. In the demo, when I tried to delete the first mail at the mailbox on the right, an error message popped up: "Cannot read property 'replace' of undefined"

Looking into the issue! The entire demo as a whole will be updated/cleaned up, so bear with us!
Pirobi

#73 Apr 22, 2018, 11:16 PM Source
~Update to 2.21~
- Fixed issue where deleting mail while on a different page could cause outOfBounds issue if next mail has less pages.
- QoL change - exiting out of the message window will reset the view back to the first page.
- Fixed issue where exiting mail and then pressing left/right would still cause the mail pages to change.
The demo is still being updated, and will hopefully be available soon! Meanwhile, the script has been updated at the link in the original post.

Future considerations:
- Looking into Mac Support for the editor! This is probably going to turn into a summer project based on my schedule.
suryaansh

#74 May 15, 2018, 01:26 PM Source

Can you please upload a video tutorial explaining that how to install this plugin as I am new to MVmaker.
grubfisher

#75 May 15, 2018, 08:07 PM Source

Just out of curiosity, is there a system in place to respond to e-mails like you would other player choice prompts during dialogue?
suryaansh

#76 May 19, 2018, 07:08 AM Source

ohhhhhhhh! its not working :( when i tries to delete a mail then it reports an error and if i tries to add an id to the mail then it doesnt adds so if no id then no mail so it s useless right now.
creator please reply if you can fix this bug or can give be a bug free version
Pirobi

#77 May 25, 2018, 01:22 AM Source

grubfisher said:
Just out of curiosity, is there a system in place to respond to e-mails like you would other player choice prompts during dialogue?

The way I would handle this is to create a trigger that calls a common event, and in there you set the choices, though this does bring up a good point - Triggers only activate when you exit the mailbox because of how the game is "paused" when opening scenes, so I'm not too sure what happens when multiple Triggers have been lined up from reading multiple messages...

suryaansh said:
ohhhhhhhh! its not working :( when i tries to delete a mail then it reports an error and if i tries to add an id to the mail then it doesnt adds so if no id then no mail so it s useless right now.
creator please reply if you can fix this bug or can give be a bug free version

Could you please send me a picture of the exact error you're getting? I will take a look at this as soon as possible! Also, please send me the exact command you're using to add to the mailbox.
suryaansh

#78 May 25, 2018, 08:24 AM Source

Pirobi said:
The way I would handle this is to create a trigger that calls a common event, and in there you set the choices, though this does bring up a good point - Triggers only activate when you exit the mailbox because of how the game is "paused" when opening scenes, so I'm not too sure what happens when multiple Triggers have been lined up from reading multiple messages...

Could you please send me a picture of the exact error you're getting? I will take a look at this as soon as possible! Also, please send me the exact command you're using to add to the mailbox.
Here https://drive.google.com/open?id=1ApPwTEtO2TgrPxc4HplhjWND6i0whATG is the problem video fully described
Pirobi

#79 May 25, 2018, 12:25 PM Source

suryaansh said:
Here https://drive.google.com/open?id=1ApPwTEtO2TgrPxc4HplhjWND6i0whATG is the problem video fully described

Oh ok I understand your problem. I will work on it as soon as possible!
Pirobi

#80 May 26, 2018, 03:21 PM Source

@suryaansh actually, did you get the editor from the demo? I believe that one might be outdated since I'm still working on updating the demo in general. Try replacing it with the one provided in the original post (the link to the editor itself) and let me know if you experience the same issues.