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

ShadowDragon

#101 Aug 12, 2019, 07:35 AM Source

@Pirobi my PC resolution is 1920 x 1080.
Also I forgot the mention in your demo, there is a NPC that use a variable after reading the mail, but it says 0.

Also, I want to see if I can use this instead of the editor, if I know exacly how to update the kills in a variable
or how to make a switch ON.

This can than be used as a Memoso the player gain mail when variable reach x (which i think that is controlled in an event)
cirdian

#102 Sep 29, 2019, 07:05 PM Source

Hey, love the plugin it's really fun.

But the link in the op is redirecting for the 2.21 version of the plugin, not the 2.3 wich I suppose it should be directing.

Thanks for the word, @Pirobi
Pirobi

#103 Oct 3, 2019, 02:04 AM Source

cirdian said:
Hey, love the plugin it's really fun.

But the link in the op is redirecting for the 2.21 version of the plugin, not the 2.3 wich I suppose it should be directing.

Thanks for the word, @Pirobi

I just updated the plugin - let me know if there's still an issue. I'll be releasing version 2.4 soon, so be on the lookout for that as well!
Pirobi

#104 Oct 3, 2019, 11:56 PM Source
~Update to 2.4~
- Added compatibility with MOG custom background plugin.
  
  Will look into further compatibility with other MOG menu plugins
  
  Not sure about compatibility with other menu plugins.
- Added ability to open the mailbox scene from the menu, using plugins such as YEP MenuManager
- Updated the demo
  
  Changed the demo map
  
  Added new characters to the demo to reflect changes made in 2.3/2.4
  
  Fixed issues reported in previous versions of the demo
@ShadowDragon I re-uploaded a new JKMailEditor to the demo/on the OP. I am not sure if it fixes the issues you've been seeing, but please let me know if it looks any different when you get a chance!
ShadowDragon

#105 Oct 4, 2019, 11:41 AM Source

@Pirobi
the new version didn't fix teh UI editor though, Im not sure if the above broke too.
while I dont how its made or how to fix it.

But you can figure it out where it gone wrong?
the spacing need on the top and probably the same for below, also avatar tab isn't correct.

while it does it job, there is 1 thing so far I notice that should be fixed:
the mail "addMailAll send a mail to all boxex (mailbox 0, 1, 2 (main menu)), but you can get 3x 4x the same item.
it would be nice IF you read it from main menu or out of 1 of the mail boxes, that you cant claim it or its attachment
is removed if you take it. (if read it, all boxes should be white) so the item can be claimed only ones instead multiple times.
Pirobi

#106 Oct 8, 2019, 03:16 AM Source

ShadowDragon said:
@Pirobi
the new version didn't fix teh UI editor though, Im not sure if the above broke too.
while I dont how its made or how to fix it.

But you can figure it out where it gone wrong?
the spacing need on the top and probably the same for below, also avatar tab isn't correct.

View attachment 124907

while it does it job, there is 1 thing so far I notice that should be fixed:
the mail "addMailAll send a mail to all boxex (mailbox 0, 1, 2 (main menu)), but you can get 3x 4x the same item.
it would be nice IF you read it from main menu or out of 1 of the mail boxes, that you cant claim it or its attachment
is removed if you take it. (if read it, all boxes should be white) so the item can be claimed only ones instead multiple times.

The mail sent to each mailbox is treated as its own instance of mail. I could add an option to share the attachment and have this configurable per message.

I'll continue to look into the editor issues.
ShadowDragon

#107 Oct 8, 2019, 06:54 AM Source

the share option is nice, but once readed whereever should be treated as 1 unless stated otherwise (true / false)
if they use multiple mailboxes.

only from main menu is treated as 1, but multiple should be choses (personal opinion)
Pirobi

#108 Jan 3, 2020, 08:59 PM Source
~Update to 2.41~
- Updated how scrolling works in the messages to be much smoother.
  
  As a result, I removed the multiple pages option, and the allow scroll options. If multiple pages are still desired, I can put them back in a future update
- Added new plugin commands to add the same instance of mail to multiple mailboxes. If the mail is read in one mailbox and/or attachments/triggers are called, they will not be called again when looking at that mail from another mailbox. See the op for these plugin commands.
TakashiKumuro

#109 Jan 4, 2020, 09:29 AM Source

I get this weird error when I try opening a mailbox using a common event ingame. Any way to fix it?
btw, this plugin is so great! awesome work.
Pirobi

#110 Jan 5, 2020, 06:30 PM Source

TakashiKumuro said:
I get this weird error when I try opening a mailbox using a common event ingame. Any way to fix it?
btw, this plugin is so great! awesome work.

So I think what happened was you ran the MailBoxOpen plugin command, but did not specify a mailbox number. I could make a fix so that it opens the last opened mailbox, but the fix for you for now is to put the id of the mailbox you want to open:

MailBoxOpen x
bcarey13

#111 Feb 12, 2020, 07:38 PM Source

I just found this, and I saw earlier in the thread that you were looking into Mac compatibility. Just wondering, will it work on Mac yet? Because I'm trying and I keep getting a message whenever I start my game that says "Unexpected token f in JSON at position 433." All I have in my Mail.json is the example that you provided. Thanks!
Pirobi

#112 Feb 12, 2020, 11:29 PM Source

bcarey13 said:
I just found this, and I saw earlier in the thread that you were looking into Mac compatibility. Just wondering, will it work on Mac yet? Because I'm trying and I keep getting a message whenever I start my game that says "Unexpected token f in JSON at position 433." All I have in my Mail.json is the example that you provided. Thanks!
The plugin itself should be compatible with Mac as far as I'm aware. It's possible the example is outdated (in which case I'll update it to be more current).

I recommend trying to load the demo and see if that works for you
bcarey13

#113 Feb 13, 2020, 04:45 AM Source

Pirobi said:
I recommend trying to load the demo and see if that works for you
Ok, I did that, and it's working for me now. Thanks!
bcarey13

#114 Feb 18, 2020, 06:27 PM Source

Hey, sorry, another question... I'm sure I'm just missing something really simple, but I can't seem to get the editor to open/work on my Mac. I have everything in my game's file the same way as it is in the demo file, and it still just won't work for some reason.
Batfleck2016

#115 Mar 1, 2020, 06:18 AM Source

I don't know why, but I can't get the word wrap to work. It just appears as <warp> in the game, plain text...
SoSick.

#116 Mar 22, 2020, 04:54 PM Source

Hey there!
now starting to implement this plugin into my project! love how it looks with the mogbackground, although my cursor isn't showing at all in the mail box scene anymore, im having some trouble with making the mails in notepad++
below is how you say it should be set up...but i get error's with this. ERROR uncaught SyntaxError: Unexpected token f in JSON. even using the Editor i get this message.

[
{
"id":1,"sender":"Dad","subject":"Test","attachment":"0","trigger":"0",
"message":"Hello!"
},
{
"id":2,"sender":"Mom","subject":"Test2","attachment":"g100","trigger":"0",
"message":"Hi! Here's some money to help you out!"
},
{
"id":3,"sender":"Pirobi","subject":"Updates!","attachment":"i1","trigger":"c,30",
"message":"Here's a potion for your trouble!"
},
{
"id":4,"sender":"Dad","subject":"2.1!","attachment":"0","trigger":"0",flag:"s15",
"message":"Here's a message with a flag in it! It can only be deleted if switch 15 is ON"
}
]

The only way i can get the mail's to work is by having the code above in 1 whole long line in notepad++ lol which makes it very hard to add/edit the mail's. Just wanna know if anyone else is experiencing any of these issue's
ShadowDragon

#117 Mar 22, 2020, 06:51 PM Source

@SoSick. there is a JK editor at the download which is mostly required to build up the mails.
there is also a DEMO to see how it works if you didn't downloaded it yet.
Pirobi

#118 Apr 8, 2020, 12:00 AM Source

Sorry people, I haven't been on recently due to events, but I do have some updates coming within the next few days so bear with me!

bcarey13 said:
Hey, sorry, another question... I'm sure I'm just missing something really simple, but I can't seem to get the editor to open/work on my Mac. I have everything in my game's file the same way as it is in the demo file, and it still just won't work for some reason.

We are working on getting a Mac-compatible version of the editor running, but this will unfortunately require us to rewrite our editor so may take a while :(

Batfleck2016 said:
I don't know why, but I can't get the word wrap to work. It just appears as <warp> in the game, plain text...

Can I see what word wrap plugin are you using and how you have the mail plugin params and your mail set up? You can pm me this if it's easier.

SoSick. said:
Hey there!
now starting to implement this plugin into my project! love how it looks with the mogbackground, although my cursor isn't showing at all in the mail box scene anymore, im having some trouble with making the mails in notepad++
below is how you say it should be set up...but i get error's with this. ERROR uncaught SyntaxError: Unexpected token f in JSON. even using the Editor i get this message.

[
{
"id":1,"sender":"Dad","subject":"Test","attachment":"0","trigger":"0",
"message":"Hello!"
},
{
"id":2,"sender":"Mom","subject":"Test2","attachment":"g100","trigger":"0",
"message":"Hi! Here's some money to help you out!"
},
{
"id":3,"sender":"Pirobi","subject":"Updates!","attachment":"i1","trigger":"c,30",
"message":"Here's a potion for your trouble!"
},
{
"id":4,"sender":"Dad","subject":"2.1!","attachment":"0","trigger":"0",flag:"s15",
"message":"Here's a message with a flag in it! It can only be deleted if switch 15 is ON"
}
]

The only way i can get the mail's to work is by having the code above in 1 whole long line in notepad++ lol which makes it very hard to add/edit the mail's. Just wanna know if anyone else is experiencing any of these issue's

I definitely need to update the sample json in the original post. There may be some syntax things that have changed that aren't reflected.

And finally, @ShadowDragon we made some more tweaks to the editor that *should* fix your resolution issue. When we post our updated editor could you test it out and let me know how it looks?
Pirobi

#119 Apr 8, 2020, 12:44 AM Source
Never mind, I can push the updates now (and anything more if there are bugs):

~Update to 2.42~
- Adjusted sizing mode for buttons on the mail editor, other small tweaks
- Cleaned up the demo map
- Added fix that should prevent game from crashing if plugin is called without specifying a mailbox id (will default to the last opened mailbox)
- The example json provided in the original post and in the plugin description should work out of the box.
Known issues/bugs/items:
- Mail editor still has the option to insert a page break even though this is no longer supported by the plugin.
- Still no mac support - we are evaluating our options with regards to a full rewrite vs trying to leverage what we have
ShadowDragon

#120 Apr 8, 2020, 09:08 AM Source

@Pirobi unfortunately, its still the same as the image above. I dont know why though or why
it happen or why it does that. cheanging screen resolution did no good either.

I cant rescale the interface as well. but I wonder why the overlapping is there though.
the rest is working find.