Tutorial Panel System 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.


... by Free-Counters.org


TutorialPanelSys Preview1.gif

TutorialPanelSys Preview2.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.112.jpg

The plugin adds the ability to display tutorial panels seen in many recent JRPG's. The tutorial panel system allows the player to read forward and backward at their own pace while having visuals displayed on the relevant tutorial pages. The player can later reread the tutorials found in a dedicated Tutorial List scene that is accessible through the main menu.

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

  • Adds modern JRPG Tutorial Panel system.
  • Players can read tutorials at their own pace, advancing forward and backward as needed, all while tutorials provide visuals.
  • The list of already read tutorials can be accessed from the Main Menu if enabled and made visible through the Plugin Commands/Parameters.
  • Tutorials can be viewed from the map scene or battle scene.
  • Tutorial calls can be bypassed if the player has already viewed them, in order to prevent tediousness.
  • Tutorials can be bypassed manually by the player through the Options scene if they do not wish to read tutorials for whatever reason (such as their second or third playthrough of the game).
  • Tutorials can still be forcefully opened ignoring the bypass options of having already been read or turned off through the Options menu.
  • Game devs can silently register tutorials to be placed into the Tutorial List scene for the player to read without having to show the tutorial.
  • Within the Tutorial List scene, tutorials are separated into categories, allowing players to sort through them easily.
  • Players can expand and collapse categories as needed if there are too many tutorials to navigate through.
  • Some tutorials can already be made visible and registered by default.

Requirements

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


Tier 2

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.


Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Core Engine VisuStella MZ

TutorialPanelSys Preview1.gif

This plugin provides vocabulary that can be used for the Button Assist Window added through the VisuMZ Core Engine.

---

Main Menu Core VisuStella MZ

TutorialPanelSys Preview5.png

The latest version of the VisuMZ Main Menu Core already has the settings for the Tutorial List command.

---

Options Core VisuStella MZ

TutorialPanelSys Preview4.png

The latest version of the VisuMZ Options Core should have the settings for showing/hiding tutorials.

---

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.

---

Tutorial Plugin Commands

---

TutorialPanelSys Preview1.gif

TutorialPanelSys Command1.png

Tutorial: Call
- Call forth a tutorial of the designated Tutorial ID Key.
- Use on the map or battle scenes.

  Tutorial ID Key:
  - What is the tutorial identification key?

  Force View?:
  - Forcefully opens the tutorial regardless of the Options settings or if
    "Bypass if Registered?" is enabled.

  Bypass if Registered?:
  - Ignores opening the tutorial if the tutorial has already been
    viewed once.

  Register Tutorial?:
  - Registers the tutorial to the Tutorial List that the player can revisit.

---

TutorialPanelSys Command2.png

Tutorial: Register ID Key(s)
- Register specific Tutorial ID Key(s) without opening the tutorial.

  Tutorial ID Key(s):
  - Add which tutorial identification key(s)?

---

System Plugin Commands

---

TutorialPanelSys Preview5.png

TutorialPanelSys Command3.png

System: Enable Tutorial List in Menu?
- Enables/disables "Tutorial List" menu inside the main menu.

  Enable/Disable?:
  - Enables/disables "Tutorial List" menu inside the main menu.

---

TutorialPanelSys Command4.png

System: Show Tutorial List in Menu?
- Shows/hides "Tutorial List" inside the main menu.

  Show/Hide?:
  - Shows/hides "Tutorial List" inside the main menu.

---

Plugin Parameters

Category List Settings

TutorialPanelSys Preview2.png

TutorialPanelSys Param1.png

List of categories that are used for this plugin. Categories will be listed in the order they appear with "Unlisted" category displayed first.

---

Category

 ID Key:
 - This category's identification key.
 - Categories require unique keys for the plugin to differentiate them.
 Title:
 - This category's title.
 - You may use text codes.

---

Tutorial List Settings

TutorialPanelSys Preview2.png

TutorialPanelSys Param2.png

List of tutorials that are used for this plugin. Here is where you add all the tutorials seen in game. How they appear and such is all handled here.

---

Tutorial

 ID Key:
 - This tutorial's identification key.
 - Tutorials require unique keys for the plugin to differentiate them.
 Title:
 - This tutorial's title. Displayed in a separate window.
 - You may use text codes.
 Category:
 - The category this tutorial is listed under.
 - If unlisted, the tutorial will be listed under "Unlisted".
 Pages:
 - List of pages that are shown for this tutorial.
 - Pages are displayed in the order listed.

---

TutorialPanelSys Param2a.png

Page Settings

 Filename:
 - Displayed image associated with this page.
 - Found in the game project's /img/pictures/ folder.
 Description:
 - The description text displayed for this page.
 - Text codes are allowed.

---

Scene_TutorialData Settings

TutorialPanelSys Preview1.gif

TutorialPanelSys Param3.png

Settings for Scene_TutorialData. This scene is where the contents of the tutorials are displayed.

---

Background

 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.

---

Button Assist Vocab

 Change Page:
 - Vocabulary used for changing pages.
 - You may use text codes.
 Next Page:
 - Vocabulary used for moving to the next page.
 - You may use text codes.
 Done Tutorial:
 - Vocabulary used for being done with the tutorial.
 - You may use text codes.

---

Windows > Pages Window

 Active Page Text:
 - Vocabulary used for active page.
 - You may use text codes.
 Inactive Page Text:
 - Vocabulary used for inactive page.
 - You may use text codes.
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Windows > Description Window

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

---

Windows > Picture Window

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

---

Windows > Title Window

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

---

Scene_TutorialList Settings

TutorialPanelSys Preview2.png

TutorialPanelSys Param4.png

Settings for Scene_TutorialList. This is the scene where the player can go to reread previously viewed tutorials.

---

Main Menu Settings

 Command Name:
 - Name of the 'Tutorials' option in the Main Menu.
 Show in Main Menu?:
 - Add the 'Tutorials' option to the Main Menu by default?
 Enable in Main Menu?:
 - Enable the 'Tutorials' option to the Main Menu by default?

Background

 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.

---

Button Assist Vocab

 View Tutorial:
 - Text for viewing tutorial.
 Expand Category:
 - Text for expanding categories.
 Collapse Category:
 - Text for collapsing categories.

---

Windows > List Window

 Open Categories:
 - Text format for an open category.
 - %1 - Category Name, %2 - Quest Amount
 Closed Categories:
 - Text format for an open category.
 - %1 - Category Name, %2 - Quest Amount
 Unlisted Category:
 - Text used for "unlisted" category.
 - You may use text codes.
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Scene_Battle Settings

TutorialPanelSys Preview3.png

TutorialPanelSys Param5.png

Settings for Scene_Battle. This governs how tutorials appear in battle.

---

Windows > Battle Status Window

 Hide During?:
 - Hide the battle status window during tutorials?
 - Does NOT affect VisuMZ_3_SideviewBattleUI!

---

Windows > Pages Window

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

---

Windows > Description Window

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

---

Windows > Picture Window

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

---

Windows > Title Window

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

---

Options Settings

TutorialPanelSys Preview4.png

TutorialPanelSys Param6.png

Options settings for this plugin.

---

Options

 Add Option?:
 - Add the 'Tutorials' option to the Options menu?
 Adjust Window Height:
 - Automatically adjust the options window height?
 Option Name:
 - Command name of the option.

---

Sound Settings

TutorialPanelSys Param7.png

Sound settings when changing tutorial pages.

---

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.

---


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.00 Official Release Date: January 2, 2023

  • Finished Plugin!


See Also


End of File