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

KingGodzilla

#161 May 8, 2023, 07:11 PM Source
Pirobi said:
Hey so you'll need to send me your mail.json (located in the data folder in your repo) so I can see how it's formatted. You can send me a PM when you get the chance and I'll help you out!

EDIT:

~Update to version 2.51~

Added capability for restricting attachments by some criteria, evaluated as a script call

Not supported by the current mail editor so is in an experimental phase

Hotfix for mail scene crashing if the mailbox is empty

See the OP for the updated mail script. The demo will be updated upon release of the updated editor!

On the docket:

Updated Mail Editor

WILL finally include MACOS support!

RMMZ port

EDIT 2:

Mail editor 3.0 has now been released! See the Original post for the link. Please report any feedback/problems you have with the updated editor! Mac version is on the way!
Does this work for RMMZ or still not yet?
Pirobi

#162 May 12, 2023, 03:16 PM Source

KingGodzilla said:
Does this work for RMMZ or still not yet?
Hello,
Not yet, I have been in work travel on and off the past few years so haven't had time to properly sit down and work on it. I am hoping this summer things start to cool down enough for me to take a look at this.
JoyFilledStabbyBees

#163 Aug 21, 2023, 01:51 AM Source

I'm having a bizarre issue with the JK mail editor. Nothing I do in it seems to save to the json file at all. I have the json file in the data folder, and the editor is in the project folder. I thought my antivirus might be the problem, but the issue continued even after adding the folder the project is in and the mail editor to the exclusions list. I tried running the editor in administrator mode but had no luck there, either. I tried using it with a fresh project, but that didn't work, either. The json can be found by the editor, but it cannot be changed. I've included a video of what happens when I try to export any changes I make to the json file.
Pirobi

#164 Aug 21, 2023, 03:10 AM Source

JoyFilledStabbyBees said:
I'm having a bizarre issue with the JK mail editor. Nothing I do in it seems to save to the json file at all. I have the json file in the data folder, and the editor is in the project folder. I thought my antivirus might be the problem, but the issue continued even after adding the folder the project is in and the mail editor to the exclusions list. I tried running the editor in administrator mode but had no luck there, either. I tried using it with a fresh project, but that didn't work, either. The json can be found by the editor, but it cannot be changed. I've included a video of what happens when I try to export any changes I make to the json file.

Thanks I will take a look at the editor and hopefully get back to you within the week.

EDIT: @JoyFilledStabbyBees I have made some updates to the editor - please re-download it in the OP link and let me know if this resolves your issue.