Item Crafting System VisuStella MZ
- 1 Download
- 2 System
- 3 Required Plugins
- 4 VisuStella MZ
- 5 Support VisuStella
- 6 Introduction
- 7 Requirements
- 8 Major Changes
- 9 Notetags
- 10 Plugin Commands
- 11 Plugin Parameters
- 13 Credits
- 14 Changelog
- 15 End of File
This 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.
The following plugins are required in order to use this plugin.
Place the following plugins above this plugin located in the Plugin Manager.
This plugin is a part of the VisuStella MZ Plugin Library.
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:
This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.
Required Plugin List
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.
This plugin is a Tier 2 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.
This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.
Proxy Items are temporary substitutes for another. When they are acquired through crafting, they will turn into the item, weapon, or armor they are a proxy for. Only the icon, name, help description, and status details will match up. Everything else will remain separate such as the notetag data and the ingredients list. This allows you to effectively have multiple ways to craft the same item using different recipes.
For more details, look inside of the Notetags section for Proxy items.
RPG Maker MZ'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.
These notetags are used to mark the item as a craftable item or as items that can only be crafted through a custom crafting list.
<Crafting Ingredients> Item id: x Item name: x Weapon id: x Weapon name: x Armor id: x Armor name: x Gold: x Category name: x </Crafting Ingredients> - Used for: Item, Weapon, Armor Notetags - Turns this item/weapon/armor into a craftable item by using the listed ingredients to craft with. - If the 'Category name' variant is used, it will draw from all items, weapons, and armors that have matching <Category: x> notetag data. - Insert/delete any number of copies of the ingredients as needed. - Replace 'id' with the item/weapon/armor ID of the ingredient to be used. - Replace 'name' with the name of the item/weapon/armor/category to be used. - Replace 'x' with the number of ingredients needed to be used for crafting. Category Rules: - If the 'Category name' variant is used, it will draw from all items, weapons, and armors that have matching <Category: x> notetag data. - Multiples of the same category name can be used. However, the player must select different items each time. - If the selected category item already exists as a static ingredient, that item cannot be selected either. Examples: <Crafting Ingredients> Item 5: 1 Item 6: 3 Gold: 100 </Crafting Ingredients> <Crafting Ingredients> Item Potion: 1 Item Magic Water: 3 Gold: 100 </Crafting Ingredients> <Crafting Ingredients> Weapon 1: 4 Armor 2: 2 </Crafting Ingredients> <Crafting Ingredients> Weapon Sword: 4 Armor Hat: 2 </Crafting Ingredients> <Crafting Ingredients> Category Fruit: 2 Category Meat: 3 </Crafting Ingredients>
<Custom Crafting Only> - Used for: Item, Weapon, Armor Notetags - This item can only be crafted with custom crafting lists selected through the Plugin Command.
<Proxy: id> <Proxy: name> - Used for: Item, Weapon, Armor Notetags - REQUIRES the most up to date VisuMZ Items and Equips Core! - Turns this item, weapon, or armor into a proxy for another item, allowing you to create recipes with different ingredients in <Crafting Ingredients> notetag contents and yield the same item. - The proxy item itself will take on the name, icon, and description of the original item it is supposed to represent. - No other properties are carried over from the original. - When viewed through the Window_ShopStatus window, the contents will reference the original item and not the proxy item. - Proxy items themselves cannot be acquired. This includes event commands, item drops, or equips. - When crafted, the item yielded won't be the proxy item but the item it is a proxy for. - Replace 'id' with a number representing the item, weapon, or armor ID of the same item type. If the proxy is an item, this will reference an item. If the proxy is a weapon, this will reference a weapon. Same for armors. - Replace 'name' with text representing the item, weapon, or armor's name. The referenced item needs to be the same item type as the proxy. Item for item, weapon for weapon, armor for armor.
These notetags can make item crafting require certain switches to be on, or turn switches on/off upon crafting items.
<Crafting Show Switch: x> <Crafting Show All Switches: x,x,x> <Crafting Show Any Switches: x,x,x> - Used for: Item, Weapon, Armor Notetags - Determines the visibility of the craftable item in the crafting scene. - Replace 'x' with the switch ID to determine the item's visibility. - If 'All' notetag variant is used, item will be hidden until all switches are ON. Then, it would be shown. - If 'Any' notetag variant is used, item will be shown if any of the switches are ON. Otherwise, it would be hidden. - Insert as many switch ID's as needed. - This can be bypassed with the custom Item Crafting list plugin command option if enabled.
<Crafting Turn On Switch: x> <Crafting Turn On Switches: x,x,x> <Crafting Turn Off Switch: x> <Crafting Turn Off Switches: x,x,x> - Used for: Item, Weapon, Armor Notetags - Upon crafting this item, turn on/off the marked switch(es). - Replace 'x' with the switch ID to turn on/off.
These notetags can are used to determine name-masking properties for uncrafted items.
<Crafting Mask: text> - Used for: Item, Weapon, Armor Notetags - Displays the specific 'text' when the item has not yet been crafted. - Replace 'text' with the text you wish to display if the item has not yet been crafted by the player. - This can be bypassed with the custom Item Crafting list plugin command option if enabled.
<Crafting No Mask> - Used for: Item, Weapon, Armor Notetags - Bypasses name masking even if the item has not yet been crafted.
These notetags let you set custom crafting animations when a specific item, weapon, or armor is crafted so that way, they don't all have to use the default crafting animation from the plugin parameters.
<Crafting Animation: id> <Crafting Animation: id, id, id> - Used for: Item, Weapon, Armor Notetags - Plays the animation(s) when this item, weapon, or armor is crafted. - This will override the default animation settings found in the plugin parameters and use the unique one set through notetags instead. - Replace 'id' with the ID of the animation you wish to play. - If multiple ID's are found, then each animation will play one by one in the order they are listed.
<Crafting Fade Speed: x> - Used for: Item, Weapon, Armor Notetags - This determines the speed at which the item's icon fades in during the crafting animation. - Replace 'x' with a number value to determine how fast the icon fades in. - Use lower numbers for slower fade speeds and higher numbers for faster fade speeds.
<Crafting Picture: filename> <Picture: filename> - Used for: Item, Weapon, Armor Notetags - Uses a picture from your project's /img/pictures/ folder instead of the item, weapon, or armor's icon during crafting instead. - Replace 'filename' with the filename of the image. - Do not include the file extension. - Scaling will not apply to the picture. - Use the <Picture: filename> version for any other plugins that may be using this as an image outside of crafting, too. - The size used for the image will vary based on your game's resolution.
<Once Craft Common Event: id> <Repeat Craft Common Event: id> - Used for: Item, Weapon, Armor Notetags - Requires VisuMZ_2_ShopCommonEvents! - This will cause a specific Common Event to launch when crafted. - Replace 'id' with a number representing the ID of the Common Event that you wish to launch upon this item being crafted. - The "Once" notetag variant will only occur once when crafted. - Any subsequent purchases of the item will not launch the Common Event. - The "Repeat" notetag variant will occur repeatedly when crafted. - If both "Once" and "Repeat" notetags are present in the item, then the "Once" variant will take priority first. Any subsequent purchases will go to the "Repeat" variant. - Any switch requirement notetags need to be met in order for either notetag to have any effect. - Use the Plugin Command "Scene: Common Event Return" to return back to the last Item Crafting scene.
<Once Craft Common Event Switch: id> <Once Craft Common Event All Switches: id, id, id> <Once Craft Common Event Any Switches: id, id, id> <Repeat Craft Common Event Switch: id> <Repeat Craft Common Event All Switches: id, id, id> <Repeat Craft Common Event Any Switches: id, id, id> - Used for: Item, Weapon, Armor Notetags - Requires VisuMZ_2_ShopCommonEvents! - Requires the respective Craft Common Events to have these Switches enabled in the "ON" position in order for them to launch. - "Once" variant will only affect the "Once" notetag variants. - "Repeat" variant will only affect the "Repeat" notetag variants. - The "All" variant will require all listed Switch ID's to be "ON". - The "Any" variant will require only one listed Switch ID to be "ON". - Replace 'id' with a number representing the Switch ID that needs to be in the "ON" position for the requirement to be met. - Insert multiple 'id' to require more Switch ID's.
Here is a list of Plugin Command(s) that you may use:
Scene: Item Crafting (All) - Go to the Item Crafting scene. - All enabled recipes will be available.
Scene: Item Crafting (Custom) - Go to the Item Crafting scene. - Select specific items to craft here. - Some items can only appear through custom lists like this by using the <Custom Crafting Only> notetag. Items: - Select which Item ID(s) to become craftable. Weapons: - Select which Weapon ID(s) to become craftable. Armors: - Select which armor ID(s) to become craftable. Bypass Switches?: - Bypass any of the requirement switches? Bypass Masks?: - Bypass name masking for uncrafted items?
Scene: Common Event Return - Return to the last shop if coming from a Crafting Common Event. - Requires VisuMZ_2_ShopCommonEvents!
System: Enable Crafting in Menu? - Enables/disables Crafting menu inside the main menu. Enable/Disable?: - Enables/disables Crafting menu inside the main menu.
System: Show Crafting in Menu? - Shows/hides Crafting menu inside the main menu. Show/Hide?: - Shows/hides Crafting menu inside the main menu.
General settings pertaining to Item Crafting.
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.
Switch: Craft: - Crafting items in Crafting Scene turns this Switch to ON. - Switch reverts to OFF whenever the Crafting Scene opens.
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.
Owned: -Text used for how much of an item is owned.
Shift: - Text used for the change in value.
Net: - Text used for the net result.
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 related to uncrafted items.
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
Main Menu settings for Item Crafting.
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?
Default settings for playing animations after crafting.
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.
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
Default settings for the sound effect played when crafting an item.
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 for Scene_ItemCrafting.
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 pertaining to Item Crafting.
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.
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.
1. 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".
4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.
6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.
7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.
6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。
7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。
If you are using this plugin, credit the following people in your game:
Version 1.18: August 4, 2022
Version 1.17: July 14, 2022
Version 1.16: May 12, 2022
Version 1.15: April 7, 2022
Version 1.14: March 31, 2022
Version 1.13: January 20, 2022
Version 1.12: December 23, 2021
Version 1.11: July 9, 2021
Version 1.10: June 25, 2021
Version 1.09: March 12, 2021
Version 1.08: March 5, 2021
Version 1.06: December 25, 2020
Version 1.05: November 29, 2020
Version 1.04: November 15, 2020
Version 1.02: October 25, 2020
Version 1.01: October 18, 2020
Version 1.00: November 2, 2020
End of File