Dragonbones Map Sprites (Irina)

From Yanfly.moe Wiki
Revision as of 19:39, 28 January 2020 by Irina (talk | contribs)
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.


Masterarbeit Writer

Atelier Irina

IrinaAvatar.png

This is a plugin created by Atelier Irina.

You can also follow Atelier Irina on itch.io.

RPG Maker Version

This plugin is made for and tested on RPG Maker MV with version 1.6.2. I cannot guarantee if it works on lower versions. Some of the plugin parameters require the later updates of RPG Maker MV for you to be able to use their entries so please update RPG Maker MV to the latest version if you want the best experience in using this plugin.

Terms of Use

You are only allowed to use the plugins made by Atelier Irina if you agree to all of the following:

  1. These plugins may be used in free or commercial games.
  2. 'RPG Maker Irina' must be given credit in your games.
  3. You are allowed to edit the code.
  4. Do NOT change the filename, parameters, and information of the plugin.
  5. You are NOT allowed to redistribute these Plugins.
  6. You may NOT take code for your own released Plugins.

Introduction

The plugin enables the ability to attach Dragonbones armatures to characters on the map to use as map sprites and animate them through plugin commands or movement Script Calls. Dragonbones map sprites can (optional) have unique animations for standing idle, walking, dashing, jumping, and/or climbing as well as (also optional) unique animations for each direction.

This is an extension plugin for KELYEP_DragonBones.

Place this plugin under KELYEP_DragonBones in your Plugin Manager list.

Credit to TheGreenKel, Yanfly, and Irina must be given upon using this.

The required Dragonbones Integration plugin can be downloaded from here:

Behaviors

The following are behaviors that you will need to come to expect out of Dragonbones armatures when used with map sprites.

1. When a Dragonbones armature is loaded, it will play the "Idle" animation upon loading. Make your Dragonbones armatures with this in mind.

2. The Dragonbones armature will always be anchored at the X, Y coordinates of the picture. This X, Y coordinate point will be where the root/pivot point of the Dragonbones armature will be located.

3. The properties used by a picture (ie the opacity, scale, rotation, and tint) will also be shared and/or amplified with the Dragonbones armature. The exception to this will be Blend Modes aren't supported.

When Designing Dragonbones Armatures

1. Try not to use more than 99 vertices for meshes. The reason behind this is because the Dragonbones armature is added as a sprite to the game's Tilemap. Any and all sprites added to the Tilemap have some restrictions placed on them as per Pixi JS's design. The Dragonbones armatures are no exception to this.

If the number of vertices exceeds 99, strange things will occur to the Dragonbones armature that are outside of this plugin's control. While it won't stop the plugin from functioning properly, expected behaviors may happen due to the threshold.

2. When using Dragonbones armatures that are too tall or wide, they may clip into the tile layer above or to the side due to how the Tilemap works. Things that you would see happen would include clipping into the tops of trees and structures.

3. Certain motions will request specific animations from the Dragonbones armature. If the animations exist, it will play those motions. If they don't, the motions may request a different animation down the line. The request orders are as follows:

   Jumping:
   - jump, walk, idle

   Ladder (Climbing):
   - ladderclimb, walk, ladderidle, idle

   Ladder (Idle):
   - ladderidle, idle

   Dashing:
   - dash, walk, idle

   Walking:
   - walk, idle

   Idle:
   - idle

Name the animations for the Dragonbones armature as such to make the most out of the motion priority lists.

4. You can add directional animations for your Dragonbones armature motion animations. To do so, add a number after the animation's name like such: walk2, walk4, walk6, walk8. These numbers are based off the NumPad directions to determine which way to face:

   7 8 9
   4   6
   1 2 3

These numbers are added onto the priority system listed in #3 above, too. Diagonal directions also become split and added multiple times for better streamlining, with a priority given to the horizontal direction before the vertical direction. For example, dashing becomes the following:

   Dashing (Upper Left):
   - dash7, dash4, dash8, dash,
     walk7, walk4, walk8, walk,
     idle7, idle4, idle8, idle

   Dashing (Right):
   - dash6, dash,
     walk6, walk,
     idle6, idle

5. When a Dragonbones armature is moving, it will animate slower or faster depending on the character's current movement speed. At speed '4: Normal', it will animation 4x faster than what's seen in Dragonbones. At speed '6: x4 Faster', it will animate 6x faster while '1: x8 Slower' will be at x1 speed seen in Dragonbones. In other words, the speed animated is equal to the number written on the left of the movement speed.

When dashing, that multiplier increases by 1 in order to match movement speeds and the Dragonbones armature will do the same to follow.

You will need to create your Dragonbones armatures with these 5 key rules in mind in order to make the armatures animate smoothly within your game.

Notetags

NotetagsMV.png

RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.

---


Changelog

There is none yet.