View source for Item Crafting System VisuStella MZ

{{MzPlugin
|preview = <youtube>https://www.youtube.com/watch?v=44nhdhWTSbM</youtube>
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/786776" width="552" height="167"><a href="https://visustellamz.itch.io/item-crafting-system">Item Crafting System by VisuStellaMZ</a></iframe></html>
|link2 = {{VisuStella Wave 4}}
|link3 = {{VisuStella All Waves Collection}}

}}

<!-- Preview -->

[[File:ItemCraftingSys_Preview1.png|600px]]

[[File:ItemCraftingSys_Preview2.png|600px]]

[[File:ItemCraftingSys_Animation.gif]]

{| style="width: 800px;" cellspacing="0" cellpadding="0"
| style="width: 100%; vertical-align: top;" |

{{RequiredPluginsMZ}}
* [[Items and Equips Core VisuStella MZ]]

<!--
{{ExtensionPluginsMZ}}
* [[Extension Plugin 1|Name1]]
* [[Extension Plugin 2|Name2]]
* [[Extension Plugin 3|Name3]]
-->

{{Visustella MZ}}

== Introduction ==

Item crafting has become a common feature in many RPG's. However, it is not
a feature included by default with RPG Maker MZ. This plugin adds in a scene
that supports item crafting, either through the main menu, or through an
event initiated command.

Craftable items are normally all available by default, but they can be
barred away through switch requirements. Upon crafting items, switches can
also be turned on/off to make a progression system if desired.

Item ingredients can be items, weapons, armors, and cost gold as well.
Multiple ingredients can be required at a time or just one. Some items can
also be set to only be craftable at custom crafting areas.

Features include all (but not limited to) the following:

* Adds an item crafting scene to the game.
* Item crafting scene can be accessible from the Main Menu or through event-based Plugin Commands.
* Crafting ingredients can consist of items, weapons, armors, and gold.
* Crafting specific items can require switches to be turned on in order to be listed in the crafting list.
* Upon crafting specific items, they can also turn on/off other switches, making a progression system to be possible.
* Custom item crafting effects can occur for those who understand JavaScript to implement.
* This plugin can mask the names of uncrafted items, too.

== Requirements ==

This plugin is made for RPG Maker MZ. This will not work in other iterations
of RPG Maker.

'''Required Plugin List'''

* [[Items and Equips 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 2}}

{{Notetags MZ}}

{{VisuMZ Item Crafting System Notetags}}

{{Plugin Commands MZ}}

{{VisuMZ Item Crafting System Plugin Commands}}

== Plugin Parameters ==

=== General Settings ===

[[File:ItemCraftingSys_Preview1.png|600px]]

[[File:ItemCraftingSys_Param1.png]]

General settings pertaining to Item Crafting.

---

Scene_ItemCrafting

  Assist Button:
  - Text used to for the Button Assist Window's OK button when about ready
    to craft an item.

  Crafted Icon:
  - Icon used to depict of an item has already been crafted.

  Ingredient Bridge:
  - Text used to bridge ingredients in the item crafting scene.

---

Switches

  Switch: Craft:
  - Crafting items in Crafting Scene turns this Switch to ON.
  - Switch reverts to OFF whenever the Crafting Scene opens.

---

Categories

  Category Title:
  - Text format used for display categories.
  - %1 - Category Name, %2 - Needed Quantity

  Selected Color:
  - Use #rrggbb for custom colors or regular numbers for text colors from
    the Window Skin.

  Selected Text:
  - This is the add on text that is displayed after an item's name that's
    already an ingredient.

  Uncategorized Text:
  - Text used for an uncategorized item category.

  Uncategorized Icon:
  - Icon used for uncategorized item category.

---

Global JS Effects

  JS: Listing:
  - Code that is run globally across all items when checking if an item
    should be listed or not.

  JS: Craft Effect:
  - Code that is run globally across all items when crafted.

---

=== Masking Settings ===

[[File:ItemCraftingSys_Preview1.png|600px]]

[[File:ItemCraftingSys_Param2.png]]

Masking settings related to uncrafted items.

---

Masking

  Enable Masking:
  - Enable masking for uncrafted items?

  Italics For Masking:
  - Use Italics when masking?

  Mask Character:
  - Text used for masking per individual character.

---

=== Main Menu Settings ===

[[File:ItemCraftingSys_MainMenu.png|600px]]

[[File:ItemCraftingSys_Param3.png]]

Main Menu settings for Item Crafting.

---

Main Menu

  Command Name:
  - Name of the 'Crafting' option in the Main Menu.

  Show in Main Menu?:
  - Add the 'Crafting' option to the Main Menu by default?

  Enable in Main Menu?:
  - Enable the 'Crafting' option to the Main Menu by default?

---

=== Animation Settings ===

[[File:ItemCraftingSys_Animation.gif]]

[[File:ItemCraftingSys_Param4.png]]

Default settings for playing animations after crafting.

---

General

  Show Animations?:
  - Show animations when crafting an item?

  Show Windows?:
  - Show windows during an item crafting animation?

  Default Animations:
  - Default animation(s) do you want to play when crafting.

---

Sprite

  Scale:
  - How big do you want the item sprite to be on screen?

  Fade Speed:
  - How fast do you want the item to fade in?

---

=== Crafting Sound Settings ===

[[File:ItemCraftingSys_Animation.gif]]

[[File:ItemCraftingSys_Param5.png]]

Default settings for the sound effect played when crafting an item.

---

Sound

  Filename:
  - Filename of the sound effect played.

  Volume:
  - Volume of the sound effect played.

  Pitch:
  - Pitch of the sound effect played.

  Pan:
  - Pan of the sound effect played.

---

=== Background Settings ===

[[File:ItemCraftingSys_Preview2.png|600px]]

[[File:ItemCraftingSys_Param6.png]]

Background settings for Scene_ItemCrafting.

---

Background Settings

  Snapshop Opacity:
  - Snapshot opacity for the scene.

  Background 1:
  Background 2:
  - Filename used for the bottom background image.
  - Leave empty if you don't wish to use one.

---

=== Window Settings ===

[[File:ItemCraftingSys_Preview2.png|600px]]

[[File:ItemCraftingSys_Param7.png]]

Window settings pertaining to Item Crafting.

---

Windows

  Requirement Font Size:
  - Font size used for requirement quantity.

  Show Tooltips:
  - Show tooltips when the mouse hovers over an ingredient?

  Custom Window Skin:
  - Select a custom window skin if you want the tooltip window to have one.

---

Background Types

  Help Window:
  Category Window:
  Gold Window:
  List Window:
  Status Window:
  Ingredient Title:
  Ingredient List:
  Number Window:
  Button Assist Window:
  - Select background type for the specific window.

---

{{VisuStella MZ Terms of Use}}

== Credits ==

If you are using this plugin, credit the following people in your game:

Team VisuStella

* [[Yanfly]]
* [[Arisu]]
* [[Olivia]]
* [[Irina]]

== Changelog ==

Version 1.08: March 5, 2021
* Feature Update!
** Plugin Commands and Item Crafting Scene option will not appear if you do not have any recipes prepared at all in your game. Update made by Irina.




Version 1.07: February 26, 2021
* Documentation Update!
** Help file updated for new features.
* New Features!
** New Plugin Parameters added by Irina and sponsored by AndyL:
*** Plugin Parameters > General Settings > Switches > Switch: Craft
**** Crafting items in Crafting Scene turns this Switch to ON.
**** Switch reverts to OFF whenever the Crafting Scene opens.
**** This can be used after an "Item Crafting" plugin command to determine if the player has crafted an item or not.



Version 1.06: December 25, 2020
* Documentation Update!
** Help file updated for new features.
* New Features!
** New notetag added by Yanfly.
*** <Crafting Picture: filename> and <Picture: filename>
**** Uses a picture from your project's /img/pictures/ folder instead of the item, weapon, or armor's icon during crafting instead.



Version 1.05: November 29, 2020
* Bug Fixes!
** If on-screen touch buttons are disabled, they will no longer cause crash errors. Fix made by Arisu.



Version 1.04: November 15, 2020
* Optimization Update!
** Plugin should run more optimized.



Version 1.02: October 25, 2020
* Bug Fixes!
** Masked Names no longer show in the number input window. Fixed by Irina.
** Plugin no longer requires a new game to be started in order for Item Crafting to work for the main menu. Fix made by Irina.
** Touch Button for OK will no longer bypass the item requirements. Fix made by Irina.
** Uncategorized items will now default to a newly created Uncategorized list of items. Fix made by Irina.
* Documentation Update!
** Plugin Parameters > General will is updated with "Uncategorized Text" and "Uncategorized Icon" for uncategorized items.



Version 1.01: October 18, 2020
* Feature Update!
** Bounce SFX pitch plugin parameter is now uncapped.
* Bug Fixes!
** Color matches no longer crash the game if the matching amount is set to zero. Bug fixed by Yanfly.
** Selecting a category without modern controls will now activate the list window. Bug fixed by Yanfly.
** The Category Window no longer disappears when there's only one category. Bug fixed by Yanfly.
* Compatibility Update!
** Plugins should be more compatible with one another.



Version 1.00: November 2, 2020
* Finished Plugin!

== End of File ==

|}

<!-- 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 Battle Plugins]] -->
[[Category: RPG Maker MZ Item Plugins]]
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
[[Category: RPG Maker MZ Gameplay Plugins]]
<!-- [[Category: RPG Maker MZ Movement Plugins]] -->
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
<!-- [[Category: RPG Maker MZ Eventing Plugins]] -->
<!-- [[Category: RPG Maker MZ Utility Plugins]] -->
[[Category: RPG Maker MZ Mechanical Plugins]]
[[Category: RPG Maker MZ Visual Plugins]]
[[Category: RPG Maker MZ Menu Plugins]]
<!-- [[Category: RPG Maker MZ Message Plugins]] -->
<!-- [[Category: RPG Maker MZ Quality of Life Plugins]] -->
<!-- [[Category: Action Sequences (MZ)]] -->
<!-- [[Category: Comment Tags (MZ)]] -->
<!-- [[Category: Main Menu Manager Integration (MZ)]] -->
<!-- [[Category: Notetags (MZ)]] -->
<!-- [[Category: Options Core Integration (MZ)]] -->
<!-- [[Category: Plugin Commands (MZ)]] -->
<!-- [[Category: Script Calls (MZ)]] -->
<!-- [[Category: Text Codes (MZ)]] -->