Difference between revisions of "Main Menu Core VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Changelog)
(General Settings)
 
Line 90: Line 90:
 
   Auto Adjust Y:
 
   Auto Adjust Y:
 
   - Automatically adjust the Y position for the thinner Gold Window?
 
   - Automatically adjust the Y position for the thinner Gold Window?
 +
 +
---
 +
 +
Status Window
 +
 +
  Select Last?:
 +
  - When picking a personal command from the Command Window, select the
 +
    last picked actor or always the first?
  
 
---
 
---

Latest revision as of 02:45, 11 October 2020

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.

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.



MainMenuCorePortrait.png MainMenuCoreDefaultStyle.png
MainMenuCoreFullScreenStyle.png MainMenuCoreInnerSolo.png


VisuStella MZ

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


Support VisuStella

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


Introduction

The Main Menu Core plugin is designed to give you more control over the Main Menu outside of RPG Maker MZ's editor's control. Game devs are given control over how commands work, visual aesthetics pertaining to the Main Menu, and assign menu images to actors as background portraits.

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

  • Control over general Main Menu settings.
  • The ability to set Menu Background Portraits for individual actors.
  • Flexibility in changing which commands appear in the Main Menu.
  • Add new windows like the Playtime Window and Variable windows.
  • Change the style of how the windows are arranged in the Main Menu.
  • Change the way the status list is displayed and the way it's displayed.

Requirements

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


Tier 1

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


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.

---

Portrait-Related Notetags

MainMenuCorePortrait.png

<Menu Image: filename>
<Menu Portrait: filename>

- Used for: Actor
- Sets the menu image for the actor to 'filename'.
- Replace 'filename' with a picture found within your game project's
  img/pictures/ folder. Filenames are case sensitive. Leave out the filename
  extension from the notetag.

---

Plugin Commands

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.

---

Actor Plugin Commands

---

MainMenuCorePluginCommand.png

Actor: Change Menu Image (Group)
Actor: Change Menu Image (Range)
Actor: Change Menu Image (JS)
- Changes the actor's Menu Image.
- Each version has a different means of selecting Actor ID's.

  Step 1: Actor:
  - Select which ID(s) to affect.

    Single:
    - Select which specific ID to affect.

    Variable Reference:
    - Which variable is used to determine which ID to affect?

    Range Start:
    - Select where the ID range begins.

    Range End:
    - Select where the ID range ends.

    Group:
    - Select which group of ID(s) to affect.

    JavaScript:
    - JavaScript code to return an array on which ID(s) to affect.

  Step 2: Target:
  - Select operation on what to change the switch(es) to.
  - Depending on what you pick here, one of the following actions are used
    in combination with the ID's picked from Step 1.

    Filename:
    - Selected actor(s) will have their menu images changed to this.

    Variable Reference:
    - Select the variable used to determine filename used for the selected
      actor(s).

    JavaScript:
    - JavaScript code to determine what filename is used for the selected
      actor(s).

---

Plugin Parameters

General Settings

MainMenuCoreParam1new.png

These general settings contain various settings on how the Main Menu scene displays certain windows, alters how specific windows behave, and determines which scenes would display actor menu images as background portraits.

---

Gold Window

 Thinner Gold Window:
 - Make the Gold Window thinner in the Main Menu?
 - Used to match the Playtime and Variable Windows.
 Auto Adjust Height:
 - Automatically adjust the height for the thinner Gold Window?
 Auto Adjust Y:
 - Automatically adjust the Y position for the thinner Gold Window?

---

Status Window

 Select Last?:
 - When picking a personal command from the Command Window, select the
   last picked actor or always the first?

---

Solo Party

 Solo Quick Mode:
 - When selecting "Skills", "Equip", or "Status" with one party member,
   immediately go to the scene.

---

Sub Menus

 Menus with Actor BG's:
 - A list of the menus that would be compatible with Actor Menu Backgrounds
 JS: Actor BG Action:
 - Code used to determine how to display the sprites upon loading.

---


Party Window

 Show Reserve Memebers:
 - Show reserve members while on the Main Menu scene?
 Hide Main Menu Only
 - If reserve members are hidden, hide them only in the main menu or
   all scenes?

---

Command Window List

MainMenuCoreParam2.png

The Command Window functions as a hub to the various scenes linked from the Main Menu. These include 'Item', 'Skill', 'Equip', 'Status', 'Save', and so on. This Plugin Parameter is an array that lets you add, remove, and/or alter the Command Window's various commands, how they're handled, whether or not they're visible, and how they react when selected.

These will require knowledge of JavaScript to use them properly.

---

MainMenuCoreParam2a.png

Command Window List

 Symbol:
 - The symbol used for this command.
 Icon:
 - Icon used for this command.
 - Use 0 for no icon.
 STR: Text:
 - Displayed text used for this title command.
 - If this has a value, ignore the JS: Text version.
 JS: Text:
 - JavaScript code used to determine string used for the displayed name.
 JS: Show:
 - JavaScript code used to determine if the item is shown or not.
 JS: Enable:
 - JavaScript code used to determine if the item is enabled or not.
 JS: Ext:
 - JavaScript code used to determine any ext data that should be added.
 JS: Run Code:
 - JavaScript code that runs once this command is selected.
 JS: Personal Code:
 - JavaScript code that runs once the actor list is selected with this
   command highlighted.

---

Playtime Window

MainMenuCoreParam3.png

The Playtime Window is an optional feature that can be displayed in the Main Menu. As its name suggests, it displays the playtime of the player's current play through.

---

Playtime Window

 Enable:
 - Use the Playtime Window?
 Adjust Command Window:
 - Adjust the command window's height to fit in the Playtime Window?
 Background Type:
 - Select background type for the Playtime window.
 Font Size:
 - Font size used for displaying Gold inside the Playtime window.
 Time Icon:
 - Icon displayed for the 'Time' label.
 Time Text:
 - Text for the display of 'Time' in the Playtime window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for the Playtime window.

---

Variable Window

MainMenuCoreParam4.png

The Variable Window is an optional feature that can be displayed in the Main Menu. If enabled, the Variable Window will display variables of the game dev's choice in the Main Menu itself.

---

Variable Window

 Enable:
 - Use the Variable Window?
 Adjust Command Window:
 - Adjust the command window's height to fit in the Variable Window?
 Background Type:
 - Select background type for the Variable window.
 Font Size:
 - Font size used for displaying Gold inside the Variable window.
 Variable List:
 - Select variables to be displayed into the window.
   Use \i[x] to determine their icon.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for the Variable window.

---

Command Window Style & Command Style Settings

MainMenuCoreParam5.png

This determines how the Main Menu appears based on the Command Window Style. If anything but the 'Default' is used, then these settings will take over the window placement settings for the Main Menu. This means that even if you are using VisuStella's Core Engine, the window layouts will be overwritten.

---

Command Window Style: - Choose the positioning and style of the Main Menu Command Window. - This will automatically rearrange windows.

MainMenuCoreDefaultStyle.png

 Default Vertical Side Style:
 - The default Main Menu layout style.
 - Affected by VisuStella's Core Engine's Plugin Parameter settings.

MainMenuCoreTopHorzStyle.png

 Top Horizontal Style:
 - Puts the Command Window at the top of the screen.
 - Gold, Playlist, and Variable Windows are moved to the bottom.
 - The Actor List Window is placed in the middle.
 - Unaffected by VisuStella's Core Engine's Plugin Parameter settings.

MainMenuCoreTopThinHorzStyle.png

 Top Thin Horizontal Style:
 - Puts the Command Window at the top of the screen.
 - It's one line thick.
 - Gold, Playlist, and Variable Windows are moved to the bottom.
 - The Actor List Window is placed in the middle.
 - Unaffected by VisuStella's Core Engine's Plugin Parameter settings.

MainMenuCoreBottomHorzStyle.png

 Bottom Horizontal Style:
 - Puts the Command Window at the bottom of the screen.
 - Gold, Playlist, and Variable Windows are moved to the top.
 - The Actor List Window is placed in the middle.
 - Unaffected by VisuStella's Core Engine's Plugin Parameter settings.

MainMenuCoreBottomThinHorzStyle.png

 Bottom Horizontal Style:
 - Puts the Command Window at the bottom of the screen.
 - It's one line thick.
 - Gold, Playlist, and Variable Windows are moved to the top.
 - The Actor List Window is placed in the middle.
 - Unaffected by VisuStella's Core Engine's Plugin Parameter settings.

MainMenuCoreFullScreenStyle.png

 Mobile Full Screen Style:
 - Puts the Command Window at the center of the screen with larger buttons.
 - Gold, Playlist, and Variable Windows are moved to the bottom.
 - The Actor List Window is hidden until prompted to be selected.
 - Unaffected by VisuStella's Core Engine's Plugin Parameter settings.

---

MainMenuCoreParam5a.png

Command Style Settings

 Style:
 - How do you wish to draw command entries in the Command Window?
 - Text Only: displays only text.
 - Icon Only: displays only the icon.
 - Icon + Text: displays icon first, then text.
 - Automatic: determines the best fit for the size
 Text Alignment:
 - Decide how you want the text to be aligned.
 - Left, Center, or Right
 Rows:
 - Number of visible rows.
 - Applies only to Top, Bottom, and Mobile styles.
 Columns:
 - Number of maximum columns.
 - Applies only to Top, Bottom, and Mobile styles.
 Mobile Thickness:
 - The thickness of the buttons for mobile version.
 - Applies only to Top, Bottom, and Mobile styles.

---

Status Graphic, Status List Style, & List Style Settings

Choose how the contents Actor Status List Window in the Main Menu appears. This can range from the which actor graphic is drawn to the style used for the data that's displayed.

---

MainMenuCoreParam6.png

Status Graphic: - Choose how the graphic for actor graphics appear in status-like menus.

MainMenuCoreNoFace.png

 None:
 - Don't display any graphic for the actors.

MainMenuCoreDefaultStyle.png

 Face:
 - Display the actors' faces. This is the default option in RPG Maker MZ.

MainMenuCoreMapSprite.png

 Map Sprite:
 - Display the actors' map sprites.

MainMenuCoreSvBattler.png

 Sideview Battler:
 - Display the actors' sideview battlers.

---

MainMenuCoreParam6a.png

Main Menu List Style - Choose how the actor status list looks in the Main Menu.

MainMenuCoreParam6b.png

Inner-Menu List Style - Choose how the actor status list looks in the inner menus like Scene_Item,

 Scene_Skill, etc.

MainMenuCoreDefaultStyle.png

 Default Horizontal Style:
 - This is the default style found in RPG Maker MZ's Main Menu.

MainMenuCoreInnerVert.png

 Vertical Style:
 - Makes the display for the actor list vertical instead of horizontal.

MainMenuCorePortrait.png

 Portrait Style:
 - Similar to the vertical style, except each actor's Menu Image is
   displayed in the background instead. Portraits are required.

MainMenuCoreInnerSolo.png

 Solo Style:
 - Used for solo party member games. Extends the whole view of the Status
   Window to accomodate a single actor.

MainMenuCoreInnerThinHorz.png

 Thin Horizontal Style:
 - Makes the selectable menu entries for the actors a single line thin.

MainMenuCoreInnerThickerHorz.png

 Thicker Horizontal Style:
 - Makes the selectable menu entries for the actors two lines thick.

---

MainMenuCoreParam6c.png

List Styles

 JavaScript code used to determine how the individual styles are drawn.
 JS: Default:
 JS: Vertical:
 JS: Portrait:
 JS: Solo:
 JS: Thin:
 JS: Thicker:
 - Code used to draw the data for these styles.

---


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.05: October 11, 2020

  • Documentation Update!
    • Documentation added for the new plugin parameter.
  • New Features!
    • New plugin parameter added by Yanfly.
      • Plugin Parameters > General > Status Window > Select Last?
        • When picking a personal command from the Command Window, select the last picked actor or always the first?


Version 1.04: October 4, 2020

  • Feature Update!
    • Certain windows will now pre-load all associated image types for the actor upon being created to avoid custom JS drawing problems. Change made by Irina.
    • Failsafes have been added to prevent non-existent variables from crashing the game if a user does not remove them from the variable list. Change made by Irina.


Version 1.03: September 20, 2020

  • Documentation Update!
    • Added the alternative notetag <Menu Portrait: filename> that also works the same way as <Menu Image: filename>.


Version 1.02: September 13, 2020

  • Compatibility Update!
    • Better compatibility for SV Actor graphics.


Version 1.01: August 23, 2020

  • Bug Fixes!
    • Skill check plugin parameter for show fixed. Fixed by Yanfly and Shaz.
      • Users updating from version 1.00 will need to fix this problem by either removing the plugin from the Plugin Manager list and reinstalling it, or going to Plugin Parameters > Command Window List > skill > JS: Show > and changing 'this.needsCommand("item")' to 'this.needsCommand("skill")'


Version 1.00: August 20, 2020

  • Plugin released!

End of File