Item Concoction Skills VisuStella MZ

From Yanfly.moe Wiki
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 MZ.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

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.


Masterarbeit Writer


ItemConcoct Preview1.gif

ItemConcoct Preview2.gif

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

VisuMZ.137.jpg

Unleash the power of item mixing and crafting in your game! With the Item Concoctions plugin, you can create skills that allow players to combine two items—a base and a pair—to create powerful and unique effects. Explore a vast array of concoction types, each with its own set of combinations and outcomes, adding depth and versatility to your gameplay.

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

  • Setup skills that can perform Item Concoctions by mixing together two items, a base and a pair, to form an effect from a result item.
  • Skills can utilize different concoction types for different bases.
  • Bases can be merged with specified pair items to produce unique effects.
  • A separate help window can be displayed for item combinations for players to quickly see what effects can be produced.
  • These item combinations can be discovered over time or displayed all from the getgo.


Requirements

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.


Tier 3

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 Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Enemy Non-Usage

Enemies cannot use Item Concoction skills. Simply put, they don't have an item inventory to pick and concoct items from. Use a regular skill instead to give the illusion of an Item Concoction skill.

---

Force Action

You cannot use "Forced Action" with a skill that requires item concoctions. This includes commands that will chain into an Item Concoction skill. The reason behind this is that there is no item input entry for the player to select from for this action.

---


Notetags

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.


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.

---

Concoction-Related Notetags

ItemConcoct Preview1.gif

---

<Can Concoct: x>
<Can Concoct: x, x, x>

- Used for: Skill Notetags
- Sets this skill to be able to concoct items that have 'x' type as an item
  base (or bases).
- Replace 'x' with text marking the type or category.
  - Insert more 'x' entries to add more types.
  - Use 'any' or 'all' in place of 'x' to use any kind of item base.
- Types are determined by the <Concoct Type: x> or <Category: x> notetags.
- This cannot be used with skills that are made to be used as Active Chain
  Skills, Input Combo Skills, or Evolution Matrix Skills.
- Likewise, this cannot be used with Item Throw and Amplify effects.
- Concoctions will consume both of the selected items as well pay the skill
  cost from the selected skill to initiate this effect.
  - Key Items, nonconsumable items, and any items with a successful proc of
    the <Concoct Conserve: x%> notetag will not be consumed.

---

<Concoct Type: x>
<Concoct Types: x, x, x>

- Used for: Item Notetags
- These are the types that are used to determine what the Item Concoction
  skills can use as an item base. This does not affect item pairs.
- Replace 'x' with text marking the type.
  - Insert more 'x' entries to add more types.
- <Category: x> will also count as a concoct base type. However, this
  notetag will separate the concoction types from anything else that uses
  the <Category: x> notetag.

---

<Concoctions>
 list
 list
 list
 list
</Concoctions>

- Used for: Item Notetags
- Determines the list of items that can be paired with this item base.
- Replace 'list' with the section below to determiner the formatting:

  'list' can be formatted in any of these four ways:

  Item id: Item id
  Item id: name
  name: Item id
  name: name

- If you are using 'Item id', replace 'id' with the ID of the item you wish
  to refer to. If you are using a name version, replace name with the full
  name of the item (it is case sensitive). The first item on the list before
  the : is the pair item for item concoctions. The second item on the list
  after the : is the item effect that will occur when the base and pair
  items are combined. The effects of the first and second items are
  unrelated to the combined item effect.

Example:

<Concoctions>
 Item 51: Item 61
 Item 52: Item 62
 Item 53: Lucid Mist
 Item 54: Healing Mist
 Plum Essence: Inspiriting Mist
 Tomato Essence: Boosting Mist
 Onion Bloom: Item 67
 Curious Bloom: Item 68
</Concoctions>

---

<Concoct Conserve: x%>

- Used for: Item
- When this item is selected and used as a base or pair item for concocting,
  there is a 'x' percent chance of it not being consumed.
- Replace 'x' with a number representing the percent chance for this item to
  not be consumed.
  - 100% will mean it will never be consumed.
- If this notetag is not used, then the item will always be consumed unless
  it is a non-consumable item set by the database.

---


Script Calls

The following are Script Calls that can be used with this plugin. These are made for JavaScript proficient users. We are not responsible if you use them incorrectly or for unintended usage.

---

Item Retrieval-Related Script Calls

ItemConcoct Preview2.gif

---

$concoctItems

- This is a variable that gets updated upon the usage of any new action be
  it from an actor or enemy. It will return the items being used to make the
  current item concoction if any.
- The items are in their rawest form, which are their $dataItems[x] entries.

---

Plugin Parameters

Vocabulary Settings

ItemConcoct Preview1.gif

ItemConcoct Params1.png

These settings let you adjust the text displayed for this plugin.

---

Settings

 Base Item Help:
 - Help description used when selecting a base item.
 Pair Item Help:
 - Help description used when selecting a pair item.
 Unknown Combination:
 - Help description used when there is an unknown combination.

---


Window Settings

ItemConcoct Preview2.gif

ItemConcoct Params2.png

These settings let you adjust the windows displayed for this plugin.

---

Concoct Help Window

 Enable?:
 - Do you wish to enable this additional window?
 Background Type:
 - Select background type for this window.
 Window Scale:
 - Do you want to scale the size of the window?
 - 0.5 for 50%; 1.0 for 100%; 1.5 for 150%; 2.0 for 200%
 Mask Unknown Combos?:
 - Do you wish to mask unknown combinations?
   Show In Battle Test?:
   - Do you wish to bypass this in Battle Test mode?
   Masked Item Icon:
   - Which icon do you wish to use for unknown combinations?
   Masked Item Name:
   - What text should be displayed as the name for unknown items?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.
   Auto Adjust Y?:
   - For certain layouts, automatically adjust the Y position of the
     window and appear towards the bottom of the screen.
   - Mainly applies to Border layout and Frontview layout.
   - However, if you are using the mid-screen skill/item list, this will
     also apply.

---



Terms of Use

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".

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.

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.

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.

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.

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は一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

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

Team VisuStella


Changelog

Version 1.02: March 14, 2024

  • Bug Fixes!
    • Fixed a bug that prevented items from unmasking after usage. Fix made by Olivia.


Version 1.01: February 15, 2024

  • Bug Fixes!
    • Fixed a crash that would be caused by numeric ID combination registration for concoctions. Fix made by Olivia.
  • Optimization Update!
    • Plugin should run more optimized.


Version 1.00 Official Release Date: October 25, 2023

  • Finished Plugin!

See Also

End of Helpfile