Djinn System (+demo)

What is it?

This script allows the user to create and use Djinn similar to the game "Golden Sun".  Djinn act as a "special piece of equipment" that can be used in battle to perform a special skill.  Djinn have 3 states: Equipped, Standby, and Cooldown.  When a Djinn is added to the party it starts out in standby.  A djinn on standby provides no special effects and must be equipped, either via the main menu option, or by selecting it from the menu in battle.  A djinn that is equipped provides special bonuses to the player based on what the piece of equipment does.  An equipped Djinn may also be released in battle to perform the skill associated with it.  A Djinn released in this way enters standby.  Cooldown has to do with the other ability in the game.  Djinn on standby can be used to perform a special kind of summon.  Djinn used in this way enter cooldown for a certain number of turns.  After the cooldown is over, they go back to the equipped state.

How can I use it?

This script works with a few note tags that get placed into skills and equips.

Equip Tags:

• <fire djinn 80> - This tag consists of 3 parts.  The first is the name of the element the djinn belongs to, in this case "fire".  Elements are set in the config section of the script.  The second is the word "djinn".  The third is a number.  This number relates to the skill that gets used when the djinn is released, in this case, skill ID 80.

Skill Tags:

• Skills are slightly different and use a several line tag.  To do this, you start out with the tag <summon>.  After this you put the summon costs for the skill in the format "# element", for example, to cost 2 fire djinn you would use "2 fire".  Finally, you finish with </summon>.  As an example, a skill that requires 2 water djinn and 3 earth djinn.
  
  <summon>
  2 water
  3 earth
  </summon>

What does it look like?

What does it work with?

This script adds commands to the menu and battle scenes.  I will most likely work with any battle system that keeps the Window_ActorCommand class mostly intact and any menu system that leaves the Window_MenuCommand class mostly intact.

This script is designed to work with CP's Battle Engine version 1.2 or higher, but is compatible with older versions.  In version 1.2 of CPBE there are additional block tags that add the menus to the actor command window.  There are :djinn and :djinn_summon.  See the instruction section in the script on how to use these.

How can I get the script?

Version 1.1b (base script, 8.19.2013) is available from my pastebin account here or my dropbox account here.

I would like to use this code.

This work is licensed under a Creative Commons Attribution-NonCommercial 3.0 Unported License.
Permissions beyond the scope of this license may be available at http://cphouseset.wo...d-terms-of-use/.

Author's Disclaimer:

So I decided one Sunday that I wanted to make this script.  No clue WHY I wanted to make it, I just did.  And so I did.  I guess this is what you call "practice".  I had no reason to make it.  I didn't need it.  No one asked for it.  I just made it.  And it turned out surprisingly well.  There have been some small issues with it, mostly lag which I am working to iron out of the system, but overall it runs quite excellently.  I'm not sure if I want to add the class system that Golden Sun uses, but I do have certain provisions in the script to make it easy to add if I choose to.  As always, enjoy!

How well can you customize? I like this system, but I was wondering if we could use it for something other than as "Djinn" Maybe as a pet that you can equip to you for battle?

I was going to use them as gems or something, sorta like materia with it's own twist.  The djinn add the bonuses of the equipment they are based on, so no issues there.  Cooldown timers can be customized, all text can be customized.  I don't have any way to disable the menus, though I could certainly add that if it's wanted.  I'm not sure exactly what you want to do, but you do have some decent amount of options.

keep getting error wen entering battle stating graphics/system/battlefloor is missing

oh, whoops, that has to do with the other script in there.  Comment out the battleback script and it will work fine.  I'll upload a new demo as soon as I think of it.

EDIT: New demo up.

Unfortunately, I found some bugs that are quite worth the mention.

1) 

Apparently I have negative 1 used Mercury Djinn? Lol...

2) The Djinn recovery speed is off. The turn a summon is used, if there are no currently recovering Djinn, then it should not recover that turn, which is right. HOWEVER, the 1st used Djinn's cooldown on the list is taking 2 turns to recover, when it should be one turn. (but not the same turn as the summon) I started the battle using Ifrit, and apparently the 1st taken Djinn on the list was set to recover in 2 turns later, the next was 3 turns later. Reduce the cooldown rate by 1.

Edit: I know it says in the script where you have base turns set to two, but it should be set to 1 as default, honestly it isn't something the user should have to fix on their own, it's kinda dumb. =/

3) You should really have a sound effect occur when the Djinns recover while walking on the fields. I had to notice it due to the small bit of lag it causes the game, which is not really healthy.

4) You're missing the Elemental Power buffs from using the Summons.

Hopefully you can fix that. Might be more bugs.

It's certainly not flawless, I had just done everything I could do with it without getting feedback.

1. Heh heh, I thought I had fixed that glitch.  Apparently not.  May have had to do with some of the de-lagging I did last minute.  I'll look back into that.  Out of curiosity, though, did you select a summon when you don't have the proper number of free djinn?  That could bring the number down to -1.

2. It's been a while since I played Golden Sun, so I hadn't remembered, but I thought there was a single turn in between summoning and re-equipping the first one.  Guess it was a turn between summoning and using.  Regardless, I don't consider this a "bug" that needs to be "fixed" since users should be balancing the cool down to their game in the first place.  Since I'm the one who made it, I used a value I though would be commonly used.  This is a "meh" thing.

3. Bleh... more lag.  Gonna have to toy with that a bit more as well.  Yeah, I guess a sound effect would help as well.  I'll get to that, too.

Update v1.0a -> v1.1

• Added a customizable sound effect for when a djinn leaves standby while on the map.
• Removed some redundant error checking that causes some lag.
• Fixed an issue involving selecting a summon then cancelling, which previously cause the wrong "adjusted free djinn" numbers to be displayed.

Hopefully this will hold out until I get back.  Get the new script from the main post.

Oh awesome a Djinn Script. =O I'm not 100% sure I'll be using it in the game I'm working on right now, but I remember searching for one of these a while back with no success. :3 Thanks for making one~ If I don't find a use for this in my current project, I'll find one for a future project. ;D

Sorry if this is a necro but I really, really, really need help with this script.  For some reason weapons and armor do not add the status from the weapon or armor.   I can't figure why it's doing this I need help please.  Thank you.

Script updated to version 1.1a:

• Fixed an issue related to item parameters.

You can get the new version of the script from the main topic.

Love this script, the only thing is that I'm getting an issue where it's reading ALL Weapons or Armour as Djinn, not just the ones that are labeled as such.

Updated to version 1.1b.  Give that one a try and tell me how it works.

That did it. Thanks.

Hi~ Thank you so much for making this! >_<

I just have a quick question. Is there a possible way to setup the system so that only one or a selected characters can use the Djinn instead of the entire party?

Great script man!  Only problem I've run into is that whenever I use a Djinn (haven't gotten into summons yet), the animation plays twice.  Is there something I'm doing wrong?

Is there a way I can link this up to Yanfly's Battle Engine?

I Found a bug.

When you select in the menu the Djinn options and you don't have Djinn, and you click two times ENTER,

the game crashes with the error:

Script "Djiin System" line 1106: NoMethodError occurred.

undefined method '[]' for Nil:NillClass

I could think of a good use for this if more types of djinn could be defined.  More than just the four.

You can use more than 4.  Scroll down to where it says "ELEMENTS ={" and add your own.