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

ShadowDragon

#121 May 25, 2020, 06:19 PM Source

@Pirobi any changes lately on the editor? or figure out the issue that might be the cause of it?
if not, than I just keep on using it though while the functions works correctly.

if there is a new update, I download it anyway, also I wonder why the variable dont update
when it should work if you add +1 variable.
katoriina

#122 Jul 3, 2020, 05:38 AM Source

This is a wonderful plugin! It has served me well for quite some time- but I've run into an issue that I can't quite identify. I downloaded the new version and I am now met with an "undefined is not a function" error anytime I try to open the mail scene, even from the main menu. I tried to replicate the problem in a new project, but everything worked fine. I thought it may be another plugin causing the problem, but I replicated my game's plugin list in the new project (right down to the order of the plugins), everything still worked. I'm not sure what the problem is here.
Pirobi

#123 Jul 3, 2020, 10:43 PM Source

katoriina said:
This is a wonderful plugin! It has served me well for quite some time- but I've run into an issue that I can't quite identify. I downloaded the new version and I am now met with an "undefined is not a function" error anytime I try to open the mail scene, even from the main menu. I tried to replicate the problem in a new project, but everything worked fine. I thought it may be another plugin causing the problem, but I replicated my game's plugin list in the new project (right down to the order of the plugins), everything still worked. I'm not sure what the problem is here.

View attachment 149907
Thanks for your support! The only thing I can think of us, is the main scripts in your old project the same version as your new one? There may be a version mismatch between projects. Try copying the scripts from your new project into your old one (so things like rpg_windows, rpg_objects, etc. As well as the pixel stuff) and let me know how that goes!

ShadowDragon said:
@Pirobi any changes lately on the editor? or figure out the issue that might be the cause of it?
if not, than I just keep on using it though while the functions works correctly.

if there is a new update, I download it anyway, also I wonder why the variable dont update
when it should work if you add +1 variable.

Still trying to figure out what could possibly be wrong...
katoriina

#124 Jul 3, 2020, 11:35 PM Source

Pirobi said:
Thanks for your support! The only thing I can think of us, is the main scripts in your old project the same version as your new one? There may be a version mismatch between projects. Try copying the scripts from your new project into your old one (so things like rpg_windows, rpg_objects, etc. As well as the pixel stuff) and let me know how that goes!

Yep, that seemed to do the trick! Silly me. xD Thank you so much! And thanks again for such a fantastic plugin! The changes are absolutely incredible!
Pirobi

#125 Jul 3, 2020, 11:43 PM Source

katoriina said:
Yep, that seemed to do the trick! Silly me. xD Thank you so much! And thanks again for such a fantastic plugin! The changes are absolutely incredible!

Good to know it worked!

On that note, I should probably include a version dependency now because of the issue. Do you know what version your old scripts came from so I can correlate it with any rpg maker mv updates (I've been out on the loop on patch notes and stuff)
katoriina

#126 Jul 4, 2020, 02:03 AM Source

Pirobi said:
On that note, I should probably include a version dependency now because of the issue. Do you know what version your old scripts came from so I can correlate it with any rpg maker mv updates (I've been out on the loop on patch notes and stuff)

Turns out they were quite old- I believe they were version 1.4.0.
YizuzG

#127 Jul 23, 2020, 06:19 AM Source

Pirobi said:
Good to know it worked!

On that note, I should probably include a version dependency now because of the issue. Do you know what version your old scripts came from so I can correlate it with any rpg maker mv updates (I've been out on the loop on patch notes and stuff)

(First of all, hello, and sorry for my bad English haha)

Hi! I've been testing this plugin and it's excellent, only, as it happens to @katoriina, I have the problem of old "rpg_ .js", but when I replace them the game stops opening (the program does)

(this error appears with the files of my project (it is an old version, 1.3.4))
spec3

#128 Jul 23, 2020, 06:24 AM Source

Wow, very indepth! Very cool!
ShadowDragon

#129 Jul 23, 2020, 04:53 PM Source

@YizuzG its work nicely on 1.5.x and higher, not lower.
its best if you update your project behind 15.x though.
YizuzG

#130 Jul 23, 2020, 06:30 PM Source

ShadowDragon said:
@YizuzG its work nicely on 1.5.x and higher, not lower.
its best if you update your project behind 15.x though.

If I update, is it possible that some plugins stop working? because I change the files to a new version and the game doesn't open
YizuzG

#131 Jul 23, 2020, 06:41 PM Source

I get this error, what can it be?
YizuzG

#132 Jul 23, 2020, 06:53 PM Source

solved! it was a problem with the index.html and the "libs" folder
ShadowDragon

#133 Jul 23, 2020, 08:16 PM Source

mostly it doesn't if the plugin is written nicely for byond 1.3.x, but stops after 1.5.x.
so sometimes you need to replace those plugins for similair or better with the same
feature.

not only that can cause errors, but compability issue.
either that, if shifting plugins in a better order doesn't work :)

but it can also be a typo in a scriptcall which has to be checked first.

But im happy you got it to work :)
Pirobi

#134 Jul 23, 2020, 11:40 PM Source

@YizuzG @katoriina As a general guidance, please refer to this post for upgrading projects to 1.5.x
Coolie

#135 Nov 9, 2020, 11:51 PM Source

Awesome plugin!

The only suggestions I could make to you to improve using it, @Pirobi is that the Mail Editor should show the mail's ID number so it would be easier to know what ID to put into plugin commands when adding new mail in-game to player mailboxes.

Also, the program outputs the Mail.json information completely on ONE line. It is a nightmare to find the mail you want to edit, if you are directly editing the Mail.json file.
Pirobi

#136 Nov 10, 2020, 12:39 AM Source

WCouillard said:
Awesome plugin!

The only suggestions I could make to you to improve using it, @Pirobi is that the Mail Editor should show the mail's ID number so it would be easier to know what ID to put into plugin commands when adding new mail in-game to player mailboxes.

Also, the program outputs the Mail.json information completely on ONE line. It is a nightmare to find the mail you want to edit, if you are directly editing the Mail.json file.

An earlier version of the editor had the IDs, and I don't remember our justification for removing it. But yes we can definitely put that back in!

As for the output, I understand the frustration since the other json files in RPG Maker do the same thing. We did make a script that auto formats the json files and I can either provide that, or build it into the editor somehow.

Thanks for the input!
Manfilth

#137 Jan 4, 2021, 06:55 AM Source

Hey there!
No idea yet what I'm doing wrong but i can't seem to be able to use this plugin.
Though it seems easy to implement, i somehow always get it to crash the game.
I've tried disabling all my plugins and my project is on the latest version of the engine.
I feel like i'm really not seeing something blatantly obvious here, but i've double-checked with the demo and even tried using it's commands.

This is the message i'm getting.
Hopefully somebody knows what i'm doing wrong!

Nevermind!
I'm an idiot.
For anyone who ever has an issue with this, don't set the ID that you're enabling to something that doesn't exist. I thought that wasnt as important and mistook it with the switch id because the editor doesnt show id's (as far as i know)
LBGames

#138 Mar 6, 2021, 05:53 AM Source

Hi, this looks like a great plugin, but I keep getting this error every time I open the editor. Any ideas what's wrong?
ShadowDragon

#139 Mar 6, 2021, 09:49 AM Source

@yoluko is the software placed inside the project? if not, it might cause
that error, if it keeps giving this even outside the project,
try to re-download the JS and GUI Editor and retry again.

if it's still popping up, I hope @Pirobi know what the cause can be.

Also what version of windows do you use? and Version of MV?
LBGames

#140 Mar 6, 2021, 11:55 PM Source

ShadowDragon said:
@yoluko is the software placed inside the project? if not, it might cause
that error, if it keeps giving this even outside the project,
try to re-download the KS and GUI Editor and retry again.

if it's still popping up, I hope @Pirobi know what the cause can be.

Also what version of windows do you use? and Version of MV?
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.