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 3 of 9 View original ↗

jobar

#41 Mar 18, 2017, 04:16 PM Source

Hello Pirobi, is there a way I can use a script call or something else to return the sender or subject of a certain mail?
I would like to store it in a variable.

thanks
mpurnell

#42 Jun 11, 2017, 03:15 PM Source

any word on the above question?
Pirobi

#43 Jun 11, 2017, 05:31 PM Source

@styx92 @jobar @mpurnell

Apologies for such a late reply! For some reason I haven't been getting notifications on this thread. All of your issues/questions will be looked at within the next week!
mpurnell

#44 Jun 12, 2017, 02:58 AM Source

Pirobi said:
@styx92 @jobar @mpurnell

Apologies for such a late reply! For some reason I haven't been getting notifications on this thread. All of your issues/questions will be looked at within the next week!

Thanks. I didnt want to press the issue but was hoping you were still active lol
Pirobi

#45 Jun 12, 2017, 04:03 AM Source

mpurnell said:
Thanks. I didnt want to press the issue but was hoping you were still active lol

Just went on hiatus to get school out of the way. Now I should be free to work again haha

jobar said:
Hello Pirobi, is there a way I can use a script call or something else to return the sender or subject of a certain mail?
I would like to store it in a variable.

thanks

I will add a function that returns those fields as a string, is this what you are requesting?
jobar

#46 Jun 12, 2017, 06:09 AM Source

Yes, this is what I was asking. Thanks!!
styx92

#47 Jun 12, 2017, 01:47 PM Source

Pirobi said:
@styx92 @jobar @mpurnell

Apologies for such a late reply! For some reason I haven't been getting notifications on this thread. All of your issues/questions will be looked at within the next week!
Many thanks for this =)
I love this script and im happy that you work on it again
Pirobi

#48 Jun 12, 2017, 11:56 PM Source
~Update to 1.9~

Fixes/Changes:
- Static text in the mail scene is now customizable
- Added getter functions to return Sender and Subjects for a specified message, indicated by ID (see code for details)
- Adjusted attachments so that they can only be collected when the message is read.
- Updated mail scene to remove the default sound that plays (so now if you try to claim an attachment from a message that doesn't have one, no sound will play) (To go with the point above, unread messages will play buzzer sound if you try to claim the attachment.
To-do / Possible Changes for upcoming versions:
1. Adjust attachment window to display "????" If there's an attachment but the mail is unread (will reveal the item when the message is read).
2. To go with above - add ability to claim attachment while cursor is inside the message itself
3. Will look into possible spacing issues from JSON parsing
4. Will look into editor crashing issues
5. Will look into scaling compatibility (for higher resolutions, etc.)
Thanks for your feedback and support, everyone! Please let me know if there are any issues, questions, or concerns and I will try to address them as soon as I can!

The demo will be updated soon with the new version. For now, please use the script in the code tags to get the latest version!
Pirobi

#49 Jun 14, 2017, 12:03 AM Source
~Update to 1.95~
- Fixed a bug where using the MailAdd plugin command with more than one argument wasn't working
- Adjusted attachment window to display a message when the selected mail has an attachment, but hasn't been read yet
- That message is customizable in the plugin window
The demo and editor links are currently being updated and should be available soon!
styx92

#50 Jun 26, 2017, 01:39 PM Source

@Pirobi Many thanks! I attachment fix saved my life :D Very nice!
Rhino

#51 Jul 1, 2017, 04:33 PM Source

Thank you so much for this neat plugin!!!!! I love the fact it has it's own editor as well! :kaoluv:

I tested it with MV 1.5.0 and everything seems to be working well ^^ The only thing is that the menu stretches to fit my custom width, but the height hasn't changed, so it looks a odd, but still passable.
Spoiler

I have a suggestion, if you'd consider adding a parameter to flip the message order around? So that new messages appear at the top of the inbox instead of at the bottom of the list where the player has to scroll down to read it. Alternatively, allowing the player to 'delete' a message so their list doesn't become too full, or possibly having the cursor jump straight to the first unread message? :D

I also think a neat little add-on would be to the option to change the unread mail/from & subject text colours so it can be customised a little.

I've always loved getting mail in games. I know I'll probably write too many letters the player won't be bothered to read :kaoblush:Anyway, thanks again for all your hard work!
Pirobi

#52 Jul 1, 2017, 04:47 PM Source

Rhino said:
Thank you so much for this neat plugin!!!!! I love the fact it has it's own editor as well! :kaoluv:

I tested it with MV 1.5.0 and everything seems to be working well ^^ The only thing is that the menu stretches to fit my custom width, but the height hasn't changed, so it looks a odd, but still passable.
Spoiler

I have a suggestion, if you'd consider adding a parameter to flip the message order around? So that new messages appear at the top of the inbox instead of at the bottom of the list where the player has to scroll down to read it. Alternatively, allowing the player to 'delete' a message so their list doesn't become too full, or possibly having the cursor jump straight to the first unread message? :D

I also think a neat little add-on would be to the option to change the unread mail/from & subject text colours so it can be customised a little.

I've always loved getting mail in games. I know I'll probably write too many letters the player won't be bothered to read :kaoblush:Anyway, thanks again for all your hard work!

I will definitely be looking into everything you have brought up! Thanks for your support!

We are currently working on the next release version and are looking to fix/implement many different features. However, I will be going on vacation soon and will not be available, so I would expect the next updates to roll out around the end of August.
Pirobi

#53 Sep 9, 2017, 02:51 PM Source
~Update to 2.0~
- Added options to add, sub, mult, divide, and mod variables via triggers (see the script/first post for more info)
- Newest messages now appear at the top of the mailbox list.
- Changes to the editor are incoming! The biggest change will be the removal of word wrapping - formatting the message will be up to the user's implementation. For example, you should be able use Yanfly's wordwrap (Part of the message core). Another important change will be crash reporting - an email will be sent out to us with logs whenever the editor crashes(if you're connected to the internet), so we can more easily fix the issue! The editor is still underway, so please bear with us until we have more news!
- Deleting mail is being investigated to determine the best way to handle it.
mk-2

#54 Nov 29, 2017, 09:48 AM Source

That's a great plug-in! I will use it for the work under construction! When the work is completed, it is going to be released to the net. I am Japanese and I do not understand English, so I can not convey my gratitude without copying and pasting on the translation site. I'm sorry ... but, thank you!
Pirobi

#55 Feb 3, 2018, 04:45 PM Source
Sorry for the long delay, but we have finally rolled out our new changes! This was planned to happen during our 2.0 release back in September, but timing caused us to push it back. We will continue to optimize/update the plugin and editor tool, so please keep us informed of any and all issues you may encounter while using it! Thanks for your support!

~Update to 2.0.1~
Fixes
- Various Performance improvements in plugin and Editor Tool
Changes
- Added plugin properties to change the text color of the Sender/Subject headers
- Removed word-wrapping functionality, but added the ability to use <br> to indicate a line break
  
  Because of this, users MUST manually indicate when they wish to break the line (use <br>, press enter, or use \r\n)
- New Editor!!!
  
  The Editor has been re-vamped visually and works a little smoother (on the back end)
  
  Each message can be individually saved/restored to its previous version (before making changes to it). Each message's changes are tracked individually - i.e. trying to switch between messages will prompt you to save if changes are detected.
  
  Various performance improvements
  
  Adding ability to check for updates to the editor/plugin - still experimental!
  
  Window width matches the approximate width of the in-game mail window to make it easier to know when to put line breaks
Known issues, future improvements
- Resolution scaling
- Delete mail from inside the mailbox scene(This can currently be done through script/plugin commands though)
Cimmantti

#56 Feb 9, 2018, 03:21 AM Source

Love the idea! However, I keep getting an error "Uncaught Syntax Error: Unexpected Token."
It only just happened when I put in your plugin and the mail file. :(
Pirobi

#57 Feb 9, 2018, 03:32 AM Source

Cimmantti said:
Love the idea! However, I keep getting an error "Uncaught Syntax Error: Unexpected Token."
It only just happened when I put in your plugin and the mail file. :(

So you're using a brand new empty mail file? If that's the case then it might be because the json is improperly formatted. I will take a look soon to both fix that potential issue and look for any other issues!
Cimmantti

#58 Feb 9, 2018, 03:38 AM Source

Pirobi said:
So you're using a brand new empty mail file? If that's the case then it might be because the json is improperly formatted. I will take a look soon to both fix that potential issue and look for any other issues!
No I made my own .json file but copy and pasted what you had in the example. I did not change anything in it.
Randy

#59 Feb 9, 2018, 11:59 PM Source
Cimmantti said:
Love the idea! However, I keep getting an error "Uncaught Syntax Error: Unexpected Token."
It only just happened when I put in your plugin and the mail file. :(

From my experience that happens when the plugin doesn't have any mail information to show. Put an autorun event (that deletes itself or turns off after one iteration) with the plugin command "MailAddAll 0". As long as you have at least one entry in Mail.json (properly formatted) it should open properly.

Did you use the editor and change the "Project Directory"? I think that command actually loads up the Mail.json from the directory that you tell it to, but it could make it look like you have messages because it's actually loading from the Demo project directory.
Pirobi said:

Delete mail from inside the mailbox scene(This can currently be done through script/plugin commands though)
I like this plugin so far as I was thinking of adding something similar to my game. The thing that I'm looking forward to the most is the ability to delete from inside the mailbox scene. I could make a common event with a button press or something, but it'll be so much easier and future-proof if it's all in the same package.

So, thank you for making this plugin and good luck on any future updates.
Pirobi

#60 Feb 10, 2018, 01:08 PM Source

Cimmantti said:
No I made my own .json file but copy and pasted what you had in the example. I did not change anything in it.

I loaded the sample JSON exactly as I had it posted and it works if I remove the commented lines. Did you remove the commented lines from your json file? (Maybe I should remove those so others won't have this issue). If it's still giving you a problem let me know, but I think this is why.

Randy said:
From my experience that happens when the plugin doesn't have any mail information to show. Put an autorun event (that deletes itself or turns off after one iteration) with the plugin command "MailAddAll 0". As long as you have at least one entry in Mail.json (properly formatted) it should open properly

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 :)

Randy said:
The thing that I'm looking forward to the most is the ability to delete from inside the mailbox scene. I could make a common event with a button press or something, but it'll be so much easier and future-proof if it's all in the same package.

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