A downloadable RPG Maker MZ Plugin

Download NowName your own price

If you like my work, consider supporting me on Patreon!

Terms of use / Termos de uso

Introduction

We already know that we can type \V[ID] to get a variable value to show on the message window. So if we want to show custom information that's not covered by the default escape codes, we can simply put it on the variable and show it on
the message. But, this process can be tedious sometimes.
So, this plugin adds new Escape codes that can show a lot of game information inside any window that processes escape characters.

Features

Add several escape codes to windows that can show a lot of game information!

How to use

Almost plug and play!
All you need to know is the escape codes. But first I will give you a list to help you memorize what every escape codes mean:

  • AC      = Refers to actor
  • MB      = Refers to a party member
  • CL      = Refers to class
  • NK      = Nickname
  • LV      = Level
  • XP      = Current Xp
  • XP?     = Next required Exp
  • PR      = Default parameters
  • PRC     = Current parameters
  • PRX     = X parameters
  • PRS     = Special parameters
  • PRO     = Profile
  • SK      = Skills
  • EQ      = Equipments
  • MT      = Meta
  • IC      = Icon
  • IT      = Item
  • WE      = Weapon
  • AR      = Armor
  • EN      = Enemy
  • ST      = State
  • MAP     = Map
  • DN      = Display name
  • EV      = Event
  • QT      = Quantity
  • OBJ     = Refers to a property of the current object
  • BTNUM   = Battles Fought
  • BTWIN   = Battles Win
  • BTESC   = Battles escape
  • TLT   = Game title
  • STEP    = Step numbers
  • ALMB    = Alive members
  • PRTSZ   = Party Size
  • PLTM    = Play Time
  • EVAL    = Formula. Can be any valid javascript code.

Knowing that will help you use the plugin. Below contains how you can use the escape codes in the windows and every possible combination of them.

You will be able to show almost anything through escape codes. I did my best to cover all the database/game information. But if I miss some, you can still use the \EVAL[formula] and replace the formula for any valid javascript code.


Please, download the plugin to see all the possible combinations in the help file. 

Download

Download NowName your own price

Click download now to get access to the following files:

MZ - Escape Codes 4.0.0 9 kB
MV - Escape Codes 1.5.0 8 kB
MZ - Escape Codes Versions 36 kB

Development log

View all posts

Comments

Log in with itch.io to leave a comment.

Hi Hakuen, just wanted to thank you for all the plugins you've made! There's a problem with this one, though, as every time I download the MZ version it triggers a (false) alarm with my virus scanner, effectively disallowing the use of the plugin. For some reason, the MV version does not trigger the alarm.

The description of the alarm can be found here. Just thought I'd bring it up.

https://www.f-secure.com/v-descs/trojan-downloader_w32_kavala.shtml

Hi there!

Well, I tested the file with the windows defender here, and it seems fine. I don't know what is causing this for you, but you are the first one with this issue. I think that is probably only your anti-virus since Javascript files can trigger some "alarms". Like, every JS file that I download with chrome, says that it can be potential harm for my computer, but it ends on nothing. Either way, I will try to upload it again to see if can solve your problem.

Is there anyway to show skill description?

Hi! ^^
I believe there is no specific escape code for that(will add it on the next update). But you can use this for now:

Change the "1" for the id of the skill you want.

(1 edit)

Thank you so much man! Worked!

But, can i ask if you know the code to write skill description from a battler member?

Hi!

Nice, it worked! Well, is almost the same as the previous one. A skill description is a skill description, no matter if it is from a battle member or not. You just need to get the ID of the skill you want and replace the "1" with it.

Maybe you are trying to do something else? If so, can you explain better?

(2 edits)

Im trying to make a battle based on events and a need to show a skills and skills description from right battle member.

I mean something like that: show skill and skill description from first battle member.

Well, then you already have your answer. Get the skill id from the battle member, and replace it with the script call that I send it before.

Just replace 1 with the skill id that your battle member has.

Hey there - it strikes me that this could use your Custom Parameters system.  Would the EVAL be used for that, or is there part of that already in the code?

The eval will work!

=|$gameParty.members()[memberIndex].cparam(paramId)|=

But hey, why didn't I put escape codes for custom parameters? =O

Will do it today! ^^

Hi friend! I have added specific escape codes for the custom parameters into the plugin. Thanks for reminding me ^^

There appears to be some sort of issue with some of the escape codes.

When using \AcNk[ID] or \MbNk[Index] when the codes are used in normal text boxes it just put out a number

For example

Code:
    Hello \AcNk[2]

Result:
    Hello [1]

but if I use that same escape code in the name box for the text box it works

For example

Name: \AcNk[2]

Result: 
Name: [Whatever the actual nickname for that character is]

Hi there!

In case you are using MZ:
I made tests here and both escape codes work fine on the text box and name box. Are you using another plugin that adds escape codes or something like that? If yes, can I take a look at your plugin manager list?

In case you are using MV:
Indeed was a bug for these escape codes. So I made a fix and posted an update(version 1.3). See if it is working ok for you. But you also said, a name box, so I believe you are using a plugin for this. Can you send me your plugin manager list for me to see what plugin and what order do you put it?

I think I know the other plugin that messes with the escape codes, it's Cae_FaceOnRight, it's a plugin that allows for the positioning of portraits but it uses escape codes, I still don't see how it could be conflicting because Cae_FaceOnRight only adds \FacePos[Pos] and \FaceMirror[Direction]. Then again I may be wrong, i'm not super familiar with Javascript, and I really don't know how RPGmaker has it's code base set up.

Well, the most certain way of know if it is a plugin conflict, is to turn all the plugins off and turn them on one by one:

  • Turn one plugin on.
  • Test the game.
  • If everything works fine, repeat the process.
  • If not, you find the plugin with compatibility issues, then I can take a look at it.

I actually tried an iterative approach by turning on this plugin first, testing, then adding another plugin, then testing (all in a new project) My findings actually show that with just the 2 plugins (This plugin and Eli's book) it still yields the same result without any other plugin even listed

Got it. Well, I made the same tests here, and it's working for me. Can you upload a sample project with only Eli Book and Eli Escape codes for me to take a look at? Because I'm not being able to replicate the issue on this side. So I was wondering if you can upload this new project replicating the issue, so I can track down the error. Can you do that for me?