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

Pirobi

#141 Mar 7, 2021, 02:23 AM Source

yoluko said:
The editor was placed in the main project folder. I’m using Windows 10 and I’m guessing the most up to date version of MV (had to redownload it on Thursday)

One thing I hadn’t checked when I posted this, I was also unable to launch the game itself. I got an error that was something to do with the json file not having a defined end, or something like that?

Will try redownloading the plugin and editor later.
So it seems like the issue is your mail.json file is not formatted correctly. You should grab the one from the demo as your base
LBGames

#142 Mar 7, 2021, 05:26 AM Source

Pirobi said:
So it seems like the issue is your mail.json file is not formatted correctly. You should grab the one from the demo as your base
Thanks, that worked! However, I did run into some other problems. When I tried to delete a message in editor, it came up with a similar error message and crashed. (Of course, the solution is to edit the messages in the editor, rather than delete them, but thought I'd mention it.)

Secondly, and it's not really a problem with this plugin, but I'm getting a really annoying conflict with Yanfly's Message Core. Basically, with that plugin enabled only half of the message appears. I thought it might have been limited by the number of message rows, but using the message row plugin command from the Yanfly plugin to expand it didn't work. *sigh* It's not like I built every cutscene up to know with the Message Core functionality, not at all...
ShadowDragon

#143 Mar 7, 2021, 09:59 AM Source

@yoluko there are oher plugins that has a conflict with YEP_Message core,
I dont know if things are overwritten or how it changed things.

similair has happen to an achievement plugin I like alot, this is fixed,
but that fix might also work here (depending how it's made), for now,
you can turn of the message core if not using the extension pack of it.
until a fix is been made.

there is no way around it unless he made the fix, so if you are in early game,
you can do that and turn it on when the fix is made for the message core.
Pirobi

#144 Mar 7, 2021, 07:15 PM Source

yoluko said:
Thanks, that worked! However, I did run into some other problems. When I tried to delete a message in editor, it came up with a similar error message and crashed. (Of course, the solution is to edit the messages in the editor, rather than delete them, but thought I'd mention it.)

Secondly, and it's not really a problem with this plugin, but I'm getting a really annoying conflict with Yanfly's Message Core. Basically, with that plugin enabled only half of the message appears. I thought it might have been limited by the number of message rows, but using the message row plugin command from the Yanfly plugin to expand it didn't work. *sigh* It's not like I built every cutscene up to know with the Message Core functionality, not at all...
Were working on a new version of the editor so hopefully that first problem will go away. Sorry for the inconvenience!

In my own game I use yanfly message core and do not have an issue with the messages in the way you are describing. Could you send me a zip of your game (or a reproducible example) so I can take a look?
LBGames

#145 Mar 9, 2021, 02:57 AM Source

Pirobi said:
Were working on a new version of the editor so hopefully that first problem will go away. Sorry for the inconvenience!

In my own game I use yanfly message core and do not have an issue with the messages in the way you are describing. Could you send me a zip of your game (or a reproducible example) so I can take a look?
My mistake, I was still using YED Worswrap as well, which was where the conflict was
TWU_Games

#146 Mar 18, 2021, 04:46 PM Source

Pirobi said:
Were working on a new version of the editor so hopefully that first problem will go away. Sorry for the inconvenience!

In my own game I use yanfly message core and do not have an issue with the messages in the way you are describing. Could you send me a zip of your game (or a reproducible example) so I can take a look?
I'm having some issues binding this to the main menu via Yanfy's Main Menu Manager. The binding is proper, but I don't have the symbol.
ShadowDragon

#147 Mar 18, 2021, 07:35 PM Source

@TWU_Games symbol is mostly the same as the name you use, as long
it is unique.

Name: "Mailbox"
Symbol: mailbox

or

Name: "MailBird"
Symbol: mailbird

and so on, so no problems, as long it match and in lowercase (and not used
else where in your game).
jlusco

#148 May 28, 2021, 05:53 PM Source

Any plans of porting this to MZ?
Pirobi

#149 May 28, 2021, 06:52 PM Source

jlusco said:
Any plans of porting this to MZ?
Hello!

Yes, there is a plan to port. I plan to do this alongside the release of an updated editor. I just need time to work on it unfortunately.
Passingbyposts

#150 Sep 4, 2021, 09:47 PM Source

I was also thinking there is a huge lack of mailbox plugins so i hope your's makes it over to MZ it has so much potential :kaojoy:
Pirobi

#151 Sep 6, 2021, 10:46 PM Source

Passingbyposts said:
I was also thinking there is a huge lack of mailbox plugins so i hope your's makes it over to MZ it has so much potential :kaojoy:

Wanted to post an update on the new editor - working through getting the basic functionality in. Once it's done I can finally turn my attention to the MZ port!

New editor progress
Passingbyposts

#152 Sep 7, 2021, 11:03 AM Source

Looks cool :kaojoy:
ScreenyBeanie

#153 Sep 24, 2021, 11:20 PM Source

Hopefully you're still available for questions, but for some bizarre reason, my messages erase half way through? Like, I'm even using your original mail.json file and for some reason it'll just show only the first half of the message. I have the YED word wrap plugin and I have the mail plugin parameters to the word "wrap" like the demo does, but am I missing something? Do I need one of the MOG plugins or something or have I managed to break something?

Edit: Never mind, I guess my letters were just too long?? Which is weird, but I guess it's something that's either wrong with how I put in the plugin or with the fact I'm using a mac book. Oh well, I can make due with a limit of letter size. Amazing plugin regardless of any issues tho!
Pirobi

#154 Oct 24, 2021, 01:28 AM Source

ScreenyBeanie said:
Hopefully you're still available for questions, but for some bizarre reason, my messages erase half way through? Like, I'm even using your original mail.json file and for some reason it'll just show only the first half of the message. I have the YED word wrap plugin and I have the mail plugin parameters to the word "wrap" like the demo does, but am I missing something? Do I need one of the MOG plugins or something or have I managed to break something?

Edit: Never mind, I guess my letters were just too long?? Which is weird, but I guess it's something that's either wrong with how I put in the plugin or with the fact I'm using a mac book. Oh well, I can make due with a limit of letter size. Amazing plugin regardless of any issues tho!

What's the word limit you're running into? I want to see if there's anything I can do about that since I don't want that limit to be influencing anything :(
ScreenyBeanie

#155 Oct 25, 2021, 05:12 PM Source

Pirobi said:
What's the word limit you're running into? I want to see if there's anything I can do about that since I don't want that limit to be influencing anything :(
So this is a thing from my game

"sender":"Mayor Samson","subject":"Welcome!","attachment":"i11",
"message":"<Wrap>Welcome \\n[1]! Did you receive our gift alright? It's not a lot, but we hope the new farming tools can help get you started here in Humble Acres! The town can't wait to see you! Happy farming! Mayor Samson",
"trigger":"0","flag":"n","imgName":"","imgIndex":0}]

This is roughly what I can put in, maybe a few characters more, but otherwise, the text will abruptly cut off.

This is an example copying your subject 2.4 letter without any alterations what so ever other than mail placement since I only have 3 letters in my game so far, and for some reason, the text just cuts off despite working perfectly fine in your demo. I don't know if my own mail.json is messed up, though I've only copy and pasted and replaced pieces for formatting help, so I'm really at a loss for what's going on.

Personally, I can probably find a work around, but it would be nice to not be limited to a certain character limit.
Pirobi

#156 Oct 25, 2021, 05:17 PM Source

ScreenyBeanie said:
So this is a thing from my game

"sender":"Mayor Samson","subject":"Welcome!","attachment":"i11",
"message":"<Wrap>Welcome \\n[1]! Did you receive our gift alright? It's not a lot, but we hope the new farming tools can help get you started here in Humble Acres! The town can't wait to see you! Happy farming! Mayor Samson",
"trigger":"0","flag":"n","imgName":"","imgIndex":0}]

This is roughly what I can put in, maybe a few characters more, but otherwise, the text will abruptly cut off.

This is an example copying your subject 2.4 letter without any alterations what so ever other than mail placement since I only have 3 letters in my game so far, and for some reason, the text just cuts off despite working perfectly fine in your demo. I don't know if my own mail.json is messed up, though I've only copy and pasted and replaced pieces for formatting help, so I'm really at a loss for what's going on.
View attachment 204892

Personally, I can probably find a work around, but it would be nice to not be limited to a certain character limit.

For that demo message to have the same problem, something else must be going on...

Can you send me a sample game where you have recreated the problem? That would help me dig deeper into this issue.
ScreenyBeanie

#157 Oct 25, 2021, 05:30 PM Source

Pirobi said:
For that demo message to have the same problem, something else must be going on...

Can you send me a sample game where you have recreated the problem? That would help me dig deeper into this issue.
Sorry, I'm very new to this sort of thing, would I just export it onto something like itch.io? Or is there a different method entirely for that?
Pirobi

#158 Oct 25, 2021, 05:42 PM Source

ScreenyBeanie said:
Sorry, I'm very new to this sort of thing, would I just export it onto something like itch.io? Or is there a different method entirely for that?
If you have Dropbox or onedrive you could zip your project, put it there, and dm me the link. Not sure if itch allows for private zips
YuukiToyaro

#159 Dec 2, 2021, 06:54 PM Source

Hi @Pirobi! First, greet Plugin! I really love the concept, but I can't get it to work ...

Attached I have put the errors, I would need a hand to understand what exactly I am doing wrong ...

Thanks in advance!
Pirobi

#160 Dec 2, 2021, 11:17 PM Source
Yukkito said:
Hi @Pirobi! First, greet Plugin! I really love the concept, but I can't get it to work ...

Attached I have put the errors, I would need a hand to understand what exactly I am doing wrong ...

Thanks in advance!
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!