Difference between revisions of "Weapon Animation VisuStella MZ"
(Created page with "{{MzPlugin |preview = <youtube>link</youtube> |link1 = <html>link</html> |link2 = {{VisuStella Wave 5}} |link3 = {{VisuStella All Waves Collection}} }} <!-- Preview --> {|...") |
|||
Line 37: | Line 37: | ||
{{Visustella MZ}} | {{Visustella MZ}} | ||
− | == | + | == Introduction == |
− | < | + | Ever wanted to give your swords different images despite being the same |
− | This plugin | + | sword type? Or how about your axes? Or any weapon? Now you can! On top of |
− | </ | + | that, you can even use custom images to accomplish this. |
+ | |||
+ | This plugin allows you to go past the standard weapon images and even using | ||
+ | custom images. | ||
+ | |||
+ | Features include all (but not limited to) the following: | ||
+ | |||
+ | * Select different weapon animation from the weapon sprite sheets. | ||
+ | * Use custom images for weapon animations. | ||
+ | * Allow weapons to have their own unique weapon animation sprites. | ||
+ | * Customize hues and motions for the weapon animations. | ||
+ | |||
+ | == Requirements == | ||
+ | |||
+ | This plugin is made for RPG Maker MZ. This will not work in other iterations | ||
+ | of RPG Maker. | ||
+ | |||
+ | === Required Plugin List === | ||
+ | |||
+ | * [[Battle Core VisuStella MZ]] | ||
+ | |||
+ | This plugin requires the above listed plugins to be installed inside your | ||
+ | game's Plugin Manager list in order to work. You cannot start your game with | ||
+ | this plugin enabled without the listed plugins. | ||
+ | |||
+ | {{MZ Tier 3}} | ||
+ | |||
+ | == Major Changes == | ||
+ | |||
+ | This plugin adds some new hard-coded features to RPG Maker MZ's functions. | ||
+ | The following is a list of them. | ||
+ | |||
+ | --- | ||
+ | |||
+ | === Sprite_Weapon loadBitmap function Change === | ||
+ | |||
+ | Due to how this plugin works, loading bitmaps for the Sprite_Weapon | ||
+ | prototype class is now different. Depending if there is any data found for a | ||
+ | custom weapon animation, the bitmap data will be loaded differently to | ||
+ | accommodate the differences in file structure. | ||
+ | |||
+ | --- | ||
+ | |||
+ | === Sprite_Weapon updateFrame function Change === | ||
+ | |||
+ | Due to how this plugin works, updating frames for the Sprite_Weapon | ||
+ | prototype class is now different. Depending if there is any data found for a | ||
+ | custom weapon animation, the frame data will be setup differently to | ||
+ | accommodate the differences in file structure. | ||
+ | |||
+ | --- | ||
+ | |||
+ | ============================================================================ | ||
+ | Notetags | ||
+ | ============================================================================ | ||
+ | |||
+ | The following are notetags that have been added through this plugin. These | ||
+ | notetags will not work with your game if this plugin is OFF or not present. | ||
+ | |||
+ | --- | ||
+ | |||
+ | === Weapon Image-Related Notetags === | ||
+ | |||
+ | --- | ||
+ | |||
+ | <Weapon Image: x> | ||
+ | |||
+ | - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags | ||
+ | - Changes the weapon image used for the affected battler to a numeric type. | ||
+ | - Replace 'x' with a number representing the weapon image's ID. | ||
+ | - You'll get an image from "img/system/" folder's weapon sheets. | ||
+ | - Each sheet contains 12 weapon images. If you wish to load a weapon from | ||
+ | the first sheet, it'll be within 1-12. | ||
+ | - If you wish to load a weapon from the second sheet, it'll be within 13-24, | ||
+ | and so on. | ||
+ | - The weapon sheets increase in increments of 12, which means that if you | ||
+ | wish to load a weapon from weapon sheet 50, x will be between 589 to 600. | ||
+ | |||
+ | By default, these are the number values associated with each: | ||
+ | |||
+ | 1 - Dagger 7 - Long Bow 13 - Mace 19 - Slingshot 25 - Book | ||
+ | 2 - Sword 8 - Crossbow 14 - Rod 20 - Shotgun 26 - Custom | ||
+ | 3 - Flail 9 - Gun 15 - Club 21 - Rifle 27 - Custom | ||
+ | 4 - Axe 10 - Claw 16 - Chain 22 - Chainsaw 28 - Custom | ||
+ | 5 - Whip 11 - Glove 17 - Sword#2 23 - Railgun 29 - Custom | ||
+ | 6 - Staff 12 - Spear 18 - Iron Pipe 24 - Stun Rod 30 - Custom | ||
+ | |||
+ | --- | ||
+ | |||
+ | <Weapon Image: filename> | ||
+ | |||
+ | - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags | ||
+ | - Changes the weapon image used for the affected battler to a unique file. | ||
+ | - Replace 'filename' with the name of the file found in the "img/weapons/" | ||
+ | folder (or whichever folder you've set it to in the plugin parameters). | ||
+ | - This is case sensitive. | ||
+ | - Do not include the file extension. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <Weapon Image: Beam Sword> | ||
+ | |||
+ | --- | ||
+ | |||
+ | <Weapon Motion: thrust> | ||
+ | <Weapon Motion: swing> | ||
+ | <Weapon Motion: missile> | ||
+ | |||
+ | - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags | ||
+ | - This notetag requires a <Weapon Image: x> or <Weapon Image: filename> | ||
+ | notetag on the same trait object. | ||
+ | - Forces the weapon to play a specific motion when attacking. | ||
+ | - If this is not defined, the played motion will be the custom motion | ||
+ | declared in the plugin parameters. | ||
+ | - You can also replace the motion type with the following: | ||
+ | |||
+ | walk wait chant guard damage evade | ||
+ | thrust swing missile skill spell item | ||
+ | escape victory dying abnormal sleep dead | ||
+ | |||
+ | --- | ||
+ | |||
+ | <Weapon Hue: x> | ||
+ | |||
+ | - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags | ||
+ | - This notetag requires a <Weapon Image: x> or <Weapon Image: filename> | ||
+ | notetag on the same trait object. | ||
+ | - Changes the hue of the custom weapon image. | ||
+ | - Replace 'x' with a hue number between 0 and 255. | ||
+ | |||
+ | --- | ||
+ | |||
+ | == Plugin Parameters == | ||
+ | |||
+ | === General Settings === | ||
+ | |||
+ | There's a couple of plugin parameters that can be adjusted for this plugin. | ||
+ | |||
+ | --- | ||
+ | |||
+ | General | ||
+ | |||
+ | Image Filepath: | ||
+ | - The filepath used for custom weapon images folder. | ||
+ | - This defaults to "img/weapons/" | ||
+ | |||
+ | Default Motion: | ||
+ | - Default motion used for custom weapon images. | ||
+ | |||
+ | --- | ||
{{VisuStella MZ Terms of Use}} | {{VisuStella MZ Terms of Use}} | ||
Line 51: | Line 200: | ||
Team VisuStella | Team VisuStella | ||
− | * | + | * [[Yanfly]] |
− | * | + | * [[Arisu]] |
− | * | + | * [[Olivia]] |
− | * | + | * [[Irina]] |
== Changelog == | == Changelog == | ||
− | + | Version 1.00: November 25, 2020 | |
− | * | + | * Finished Plugin! |
== End of File == | == End of File == | ||
Line 67: | Line 216: | ||
<!-- This is a comment, remove the arrows surrounding this for the categories you want to show --> | <!-- This is a comment, remove the arrows surrounding this for the categories you want to show --> | ||
<!-- [[Category: RPG Maker MZ Core Plugins]] --> | <!-- [[Category: RPG Maker MZ Core Plugins]] --> | ||
− | + | [[Category: RPG Maker MZ Battle Plugins]] | |
<!-- [[Category: RPG Maker MZ Item Plugins]] --> | <!-- [[Category: RPG Maker MZ Item Plugins]] --> | ||
<!-- [[Category: RPG Maker MZ Skill Plugins]] --> | <!-- [[Category: RPG Maker MZ Skill Plugins]] --> | ||
Line 79: | Line 228: | ||
<!-- [[Category: RPG Maker MZ Utility Plugins]] --> | <!-- [[Category: RPG Maker MZ Utility Plugins]] --> | ||
<!-- [[Category: RPG Maker MZ Mechanical Plugins]] --> | <!-- [[Category: RPG Maker MZ Mechanical Plugins]] --> | ||
− | + | [[Category: RPG Maker MZ Visual Plugins]] | |
<!-- [[Category: RPG Maker MZ Menu Plugins]] --> | <!-- [[Category: RPG Maker MZ Menu Plugins]] --> | ||
<!-- [[Category: RPG Maker MZ Message Plugins]] --> | <!-- [[Category: RPG Maker MZ Message Plugins]] --> | ||
− | + | [[Category: RPG Maker MZ Quality of Life Plugins]] | |
<!-- [[Category: Action Sequences (MZ)]] --> | <!-- [[Category: Action Sequences (MZ)]] --> | ||
<!-- [[Category: Comment Tags (MZ)]] --> | <!-- [[Category: Comment Tags (MZ)]] --> |
Revision as of 19:26, 9 November 2020
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Download
| ||
SystemThis is a plugin created for RPG Maker MZ. | ||
Click here for help on how to install plugins and an explanation on the Tier Hierarchy System. |
Click here to learn how to update plugins. |
Click here for how to troubleshoot plugins if you get an error. |
VisuStella MZThis plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. IntroductionEver wanted to give your swords different images despite being the same sword type? Or how about your axes? Or any weapon? Now you can! On top of that, you can even use custom images to accomplish this. This plugin allows you to go past the standard weapon images and even using custom images. Features include all (but not limited to) the following:
RequirementsThis plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Required Plugin ListThis plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.
This plugin is a Tier 3 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5). This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.
Major ChangesThis plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- Sprite_Weapon loadBitmap function ChangeDue to how this plugin works, loading bitmaps for the Sprite_Weapon prototype class is now different. Depending if there is any data found for a custom weapon animation, the bitmap data will be loaded differently to accommodate the differences in file structure. --- Sprite_Weapon updateFrame function ChangeDue to how this plugin works, updating frames for the Sprite_Weapon prototype class is now different. Depending if there is any data found for a custom weapon animation, the frame data will be setup differently to accommodate the differences in file structure. --- ================================================================Notetags ================================================================The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present. --- Weapon Image-Related Notetags--- <Weapon Image: x> - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags - Changes the weapon image used for the affected battler to a numeric type. - Replace 'x' with a number representing the weapon image's ID. - You'll get an image from "img/system/" folder's weapon sheets. - Each sheet contains 12 weapon images. If you wish to load a weapon from the first sheet, it'll be within 1-12. - If you wish to load a weapon from the second sheet, it'll be within 13-24, and so on. - The weapon sheets increase in increments of 12, which means that if you wish to load a weapon from weapon sheet 50, x will be between 589 to 600. By default, these are the number values associated with each: 1 - Dagger 7 - Long Bow 13 - Mace 19 - Slingshot 25 - Book 2 - Sword 8 - Crossbow 14 - Rod 20 - Shotgun 26 - Custom 3 - Flail 9 - Gun 15 - Club 21 - Rifle 27 - Custom 4 - Axe 10 - Claw 16 - Chain 22 - Chainsaw 28 - Custom 5 - Whip 11 - Glove 17 - Sword#2 23 - Railgun 29 - Custom 6 - Staff 12 - Spear 18 - Iron Pipe 24 - Stun Rod 30 - Custom --- <Weapon Image: filename> - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags - Changes the weapon image used for the affected battler to a unique file. - Replace 'filename' with the name of the file found in the "img/weapons/" folder (or whichever folder you've set it to in the plugin parameters). - This is case sensitive. - Do not include the file extension. Example: <Weapon Image: Beam Sword> --- <Weapon Motion: thrust> <Weapon Motion: swing> <Weapon Motion: missile> - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags - This notetag requires a <Weapon Image: x> or <Weapon Image: filename> notetag on the same trait object. - Forces the weapon to play a specific motion when attacking. - If this is not defined, the played motion will be the custom motion declared in the plugin parameters. - You can also replace the motion type with the following: walk wait chant guard damage evade thrust swing missile skill spell item escape victory dying abnormal sleep dead --- <Weapon Hue: x> - Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags - This notetag requires a <Weapon Image: x> or <Weapon Image: filename> notetag on the same trait object. - Changes the hue of the custom weapon image. - Replace 'x' with a hue number between 0 and 255. --- Plugin ParametersGeneral SettingsThere's a couple of plugin parameters that can be adjusted for this plugin. --- General Image Filepath: - The filepath used for custom weapon images folder. - This defaults to "img/weapons/" Default Motion: - Default motion used for custom weapon images. ---
Terms of Use1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com. 2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella". 3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code. 5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code. 8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed. Terms of Use: Japanese『VisuStella MZ』利用規約 1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。 2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。 3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。 5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。 8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。 CreditsIf you are using this plugin, credit the following people in your game: Team VisuStella ChangelogVersion 1.00: November 25, 2020
End of File |