Difference between revisions of "Skill Shop VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
Line 305: Line 305:
 
Version 1.00 Official Release Date: May 26, 2023
 
Version 1.00 Official Release Date: May 26, 2023
 
* Finished Plugin!
 
* Finished Plugin!
 +
 +
 +
 +
== See Also ==
 +
 +
* [[Inspiration Behind Merchant Manager Volume 3]]
 +
 +
  
 
== End of Helpfile ==
 
== End of Helpfile ==

Revision as of 22:17, 29 May 2023

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


SkillShop Preview.png


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.123.jpg

This plugin allows you to call forth a Skill Shop that contains varying skills that the player can purchase with gold to teach to various party members as long as the shop's skill requirements are met.

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

  • Call forth a new scene in the form of a skill shop for the player to select and purchase skills to teach to various party members.
  • Skills can have custom cost amounts.
  • Skills can require certain party members to be at certain levels, classes, or even have learned other skills before being taught.
  • Skills can also be locked away behind switch requirements.
  • Different shops opened by different events can contain different skills.
  • Apply a discount rate to the shop to reduce the cost of all skills within that shop.


Requirements

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


Tier 4

This plugin is a Tier 4 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.


VisuStella MZ Compatibility

SkillShop Preview.png

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible.

---

Visual Gold Display VisuStella MZ

The cost of skills will be shown in Visual Gold Display format.

---


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.

---

Skill Shop-Related Notetags

SkillShop Preview.png

---

<Skill Shop Cost: x>

- Used for: Skill Notetags
- Changes the cost of this skill to 'x' in order for it to be learned from
  a skill shop.
- Replace 'x' with a number representing the cost of the skill to be learned
  from a skill shop.
- If this notetag is not used, use the default cost value found in the
  Plugin Parameters.

---

<Item id Learn Cost: x>
<Item name Learn Cost: x>

<Weapon id Learn Cost: x>
<Weapon name Learn Cost: x>

<Armor id Learn Cost: x>
<Armor name Learn Cost: x>

<Variable id Learn Cost: x>

- Used for: Skill Notetags
- Requires Imported.VisuMZ_2_MoreCurrencies!
- Allows purchase of skill using items, weapons, armors, or variables as
  extended currency.
- Replace 'id' with a number representing the ID of the item, weapon, armor,
  or variable to be taken (when bought).
- Replace 'name' with the name of the item, weapon, armor, or variable to be
  taken (when bought).
- Replace 'x' with the quantity of the item, weapon, armor, or variable that
  will be taken (when bought).
- Insert multiple copies of these notetags to add more item, weapon, armor,
  or variable costs.

---

<Skill Shop Require Class: id>
<Skill Shop Require Classes: id, id, id>

<Skill Shop Require Class: name>
<Skill Shop Require Classes: name, name, name>

- Used for: Skill Notetags
- This skill can only be learned by actors with the specified class(es)
  when taught through the skill shop.
- For 'id' variant, replace 'id' with a number representing the class ID.
- For 'name' variant, replace 'name' with the class's name.

---

<Skill Shop Require Level: x>

- Used for: Skill Notetags
- This skill can only be learned by actors who are at least level 'x'.
- Replace 'x' with a number representing the required level.

---

<Skill Shop Require Learned Skill: id>
<Skill Shop Require Learned Skills: id, id, id>

<Skill Shop Require Learned Skill: name>
<Skill Shop Require Learned Skills: name, name, name>

- Used for: Skill Notetags
- This skill can only be learned by actors who have learned the listed
  skill(s). All of the skills must be learned.
- For 'id' variant, replace 'id' with a number representing the skill ID.
- For 'name' variant, replace 'name' with the skill's name.

---


Plugin Commands

PluginCommandsMZ.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ.

Here is a list of Plugin Command(s) that you may use:

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Scene Plugin Commands

SkillShop Preview.png

---

Scene: Open Skill Shop
- Opens a skill shop with the below skills for sale.
- Cannot be used in battle.

  Skill ID(s):
  - Select which Skill ID(s) to include in the shop.

  Discount Rate:
  - Determine the discount rate used for this shop.
  - You may use JavaScript code.

---

Plugin Parameters

General Settings

SkillShop Preview.png

These are the general settings for this plugin.

---

General Settings

 Default Skill Cost:
 - What is the default skill cost for skills that lack the
   <Skill Shop Cost: x> notetag?

---

---


Background Settings

SkillShop Preview.png

Background settings for Scene_SkillShop.

---

Background Settings

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

---


Vocabulary Settings

SkillShop Preview.png

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

---

Command Window

 Learn Text:
 - Text used for this command.
   Icon:
   - Icon used for this command.
   Help Description:
   - Help window description used for this command.
   - Text codes allowed.
 Exit Text:
 - Text used for this command.
   Icon:
   - Icon used for this command.
   Help Description:
   - Help window description used for this command.
   - Text codes allowed.

---

Actor List Window

 Help Description:
 - Help window description used for actors.
 - %1 - Name, %2 - Level, %3 - Class Name, %4 - Skill Types
 Skill Type Joiner:
 - Text used to join together skill types for the help description.
 Joiner Space:
 - Adds a space after the join type, too.

---

Skill List Window

 Already Learned:
 - Text used for a skill that's already learned.
 No SType Access:
 - Text used for a skill that's missing SType access.
 - %1 - Skill Type Name
 Wrong Class:
 - Text used for a skill that needs certain classes.
 - %1 - Actor's Current Class Name
 For Class:
 - Text used for a skill that needs a certain class.
 - %1 - Specific Class Name
 Level Requirement:
 - Text used for a skill that requires a minimum level.
 - %1 - Needed Level
 Learned Skill:
 - Text used for a skill that requires a learned skill.
 - %1 - Needed Skill Name, %2 - Icon

---


Window Settings

SkillShop Preview.png

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

---

Help Window

 Background Type:
 - Select background type for this window.

---

Gold Window

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Command Window

 Background Type:
 - Select background type for this window.
 Style:
 - How do you wish to draw commands for this window?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Actor List Window

 Background Type:
 - Select background type for this window.
 Draw Actor Face?:
 - Draws the face of the actor.
 Draw Actor Name?:
 - Draws the name of the actor.
 Draw Actor Class?:
 - Draws the class of the actor.
 - If screen resolution UI is too small, class name won't be drawn.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Skill List Window

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---



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.01: May 18, 2023

  • Bug Fixes!
    • If faces weren't loaded ahead of time, they wouldn't show up in the shop. This should now be fixed. Fix made by Arisu.
  • Documentation Update!
    • Updated Plugin Parameter for "Draw Actor Class?" to have this line:
      • If screen resolution UI is too small, class name won't be drawn.
  • Feature Update!
    • If your screen resolution UI is too small, the class name won't be drawn. Update made by Arisu.


Version 1.00 Official Release Date: May 26, 2023

  • Finished Plugin!


See Also


End of Helpfile