Difference between revisions of "Options Core VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Major Changes)
(Changelog)
Line 873: Line 873:
  
 
== Changelog ==
 
== Changelog ==
 +
 +
Version 1.03: September 20, 2020
 +
* Compatibility Update!
 +
** This plugin should offer better compatibility for future plugins! Update made by Yanfly.
 +
 +
  
 
Version 1.02: September 13, 2020
 
Version 1.02: September 13, 2020
 
* Optimization Update!
 
* Optimization Update!
 
** Scrolling through menus should consume less resources.
 
** Scrolling through menus should consume less resources.
 +
 +
  
 
Version 1.01: August 30, 2020
 
Version 1.01: August 30, 2020
 
* Bug Fixes!
 
* Bug Fixes!
 
** Before, already existing Options available in the RPG Maker MZ base code such as BGM Volume, Command Remember, Always Dash, and so on, would not have their default values declared through the Options Core. The Options Core now changes this functionality and gives priority to the Plugin Parameter settings declared by the game dev. Fix made by Yanfly.
 
** Before, already existing Options available in the RPG Maker MZ base code such as BGM Volume, Command Remember, Always Dash, and so on, would not have their default values declared through the Options Core. The Options Core now changes this functionality and gives priority to the Plugin Parameter settings declared by the game dev. Fix made by Yanfly.
 +
 +
  
 
Version 1.00: August 20, 2020
 
Version 1.00: August 20, 2020

Revision as of 01:53, 20 September 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

  • [link Mirror]

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.



OptionsCoreTab1.png OptionsCoreTab2.png
OptionsCoreTab3.png OptionsCoreTab4.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 Options Core plugin revamps the Options Menu Scene in RPG Maker MZ to be more extensive and sustain a larger variety of options. This plugin will add new options to the list in addition to options from other VisuStella MZ plugins provided that they're installed as well. Game devs that are adept with JavaScript are also able to add in their own options to the menu as well.

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

  • Revamped Options Menu Scene and layout.
  • The ability to add in your own Categories and options inside each of the individual categories.
  • Newly added options like Master Volume, Window Tone support, and more.
  • Integrated options added from other VisuStella MZ plugins.
  • An added Playtest options category that is only available during test play to help speed up the game debug process.

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.


Major Changes

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

---

Options Menu Scene

OptionsCoreTab2.png

The whole scene is revamped due to all the new additions provided by the Options Core plugin. While basic functions will still work, do not expect everything to integrate into it seamlessly.

---

Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list. Most of these enable new options for the Options Core to utilize as the code for them to work is found in the newer plugins.

---

  • VisuMZ_0_CoreEngine
  • VisuMZ_1_BattleCore
  • VisuMZ_1_MessageCore
  • VisuMZ_1_SaveCore
  • ...and more

Each of these plugins have options that become available when installed together with the Options Core plugin.

---

Options Categories

General


OptionsCoreTab1.png

The following are the options that have been added to the Options Menu. This is the default "General" category that appears with the plugin parameters. These can be added and/or removed. If a new option has been added through an update, then there's a likelihood of it not appearing due to the plugin parameters not being updated with them.

Exploration

OptionsCoreTab1a.png

These options adjust the general exploration aspects of the game.

---

Always Dash
- A default option that came with RPG Maker MZ.
- If ON, then this puts the player character in a constant state of dashing
  unless the Dash button is held down.
  - OFF: Walks normally. Holding down Dash button will make player dash.
  - ON: Dashes normally. Holding down Dash button will make player walk.

---

Autosave
- Requires VisuMZ_1_SaveCore
- Lets the player choose whether or not they want autosaving in their game.
  - OFF: Autosaves are disabled.
  - ON: Autosaves are enabled and occur at the set conditions.

---

Show Quest Tracker
- Requires VisuMZ_2_QuestSystem
- Player can choose if they want the Quest Tracker Window to appear on the
  map scene as they explore.
  - OFF: Quest Tracker Window does not appear.
  - ON: Quest Tracker Window is visible.

---

Quest Tracker Position
- Requires VisuMZ_2_QuestSystem
- Lets the player decide which half of the screen the Quest Tracker Window
  should appear.
  - ←: Quest Tracker Window appears on the left.
  - →: Quest Tracker Window appears on the right.

---

Random Encounters
- Sometimes, random encounters can really take away the enjoyment a player
  has for the game if it's too frequent. This option lets the player turn
  them off or reduce their frequency by half.
  - None: No random encounters while this is selected.
  - Half: Random encounters occur at half frequency.
  - Normal: Random encounters occur at normal frequency.

---

Battle

OptionsCoreTab1b.png

These options adjust the general battle aspects of the game.

---

Show Battle Animations:
- Players might want to turn off or some battle animations for various
  reasons. As examples, battle animations may take a toll on some players'
  computers while others might find them too distracting.
  - OFF: All battle animations are turned off.
  - SOME: Animations that aren't part of a skill/item's action sequence will
    not be displayed.
  - ON: All battle animations are visible.

---

Battle Animation Speed:
- Battles can become a slog for some types of players. This option comes
  with four speed types to blaze through the battle while animations are
  playing. Fret not, if it's time for an actor to input actions, then the
  battle speed will temporarily revert to normal speed.
  - Normal: The usual battle speed.
  - Fast: x2 the usual battle speed.
  - Faster: x3 the usual battle speed.
  - Fastest: x4 the usual battle speed.

---

Battle Camera
- Requires VisuMZ_3_ActSeqCamera
- Allows the player to turn on/off the camera in case the player is one
  who gets motion sick easily.
  - OFF: Battle camera is static and doesn't move/zoom.
  - ON: Battle camera has full range of movement and zoom.

---

Command Remember
- A default Options menu command that remembers the last position of the
  battle input window.
  - OFF: Cursor position resets each time the battle input window is active.
  - ON: Cursor position remembers last position for battle input window.

---

Active Battle Style
- Requires VisuMZ_2_BattleSystemATB
- Lets the player switch betweent "Wait" and "Active".
  - Wait: ATB gauges stop filling up the moment an actor can input.
  - Active: ATB gauges keep filling even if actors can input.

---

Active Battle Speed
- Requires VisuMZ_2_BattleSystemATB
- Lets the player control how fast ATB gauges fill up.
- 1 for slowest.
- 5 for fastest.

---

Auto Battle Start
- Requires VisuMZ_1_BattleCore
- Start battles with Auto Battle on/off?
  - OFF: Battles do not start with Auto Battle on.
  - ON: Battles start with Auto Battle on.

---

Auto Battle Style
- Requires VisuMZ_1_BattleCore
- Determine if Auto Battle for the player party will attack only or be
  allowed to use skills as well.
  - Attack: Auto Battle actors will attack only.
  - Skills: Auto Battle actors can also use skills.

---

Screen

OptionsCoreTab1c.png

These options adjust the general screen-related aspects of the game.

---

Display FPS
- Turns on/off the FPS counter in the upper left section of the screen.

---

Full Screen
- Switches the game client between windowed mode and full screen.

---

Stretch Screen
- If the game client is larger than the screen, then the game's canvas will
  stretch to fit the client. Turn this on or off.

---

Audio


OptionsCoreTab2.png

The following are the options that have been added to the Options Menu. This is the default "Audio" category that appears with the plugin parameters. These can be added and/or removed. If a new option has been added through an update, then there's a likelihood of it not appearing due to the plugin parameters not being updated with them.

Volume

OptionsCoreTab2a.png

These options adjust the volume-related aspects of the game.

---

Master Volume
- The master volume sets the volume of all the other volume types by a
  proportional amount from 0% to 100%.
- The Options Core allows players to adjust the volume in increments of 10%
  instead of the 20% by default.

---

BGM Volume
- Controls the background music volume by a value between 0% and 100%.
- The Options Core allows players to adjust the volume in increments of 10%
  instead of the 20% by default.

---

BGS Volume
- Controls the background ambience volume by a value between 0% and 100%.
- The Options Core allows players to adjust the volume in increments of 10%
  instead of the 20% by default.

---

ME Volume
- Controls the fanfare volume by a value between 0% and 100%.
- The Options Core allows players to adjust the volume in increments of 10%
  instead of the 20% by default.

---

SE Volume
- Controls the sound effect volume by a value between 0% and 100%.
- The Options Core allows players to adjust the volume in increments of 10%
  instead of the 20% by default.

---

Sound Effects

OptionsCoreTab2b.png

These options adjust the sound effects-related aspects of the game.

---

Sound Effects:
Cursor SFX:
Confirm SFX:
Cancel SFX:
Buzzer SFX:
- Not all sound effects register well with players and/or their computers.
- This lets players pick different sound effects if they have trouble
  hearing certain ones.

---

UI


OptionsCoreTab3.png

The following are the options that have been added to the Options Menu. This is the default "UI" category that appears with the plugin parameters. These can be added and/or removed. If a new option has been added through an update, then there's a likelihood of it not appearing due to the plugin parameters not being updated with them.

Windows

OptionsCoreTab3a.png

These options adjust the Windows UI-related aspects of the game.

---

Window Tone: Red:
Window Tone: Green:
Window Tone: Blue:
- Allows the player to adjust the Window Tone to their liking. This helps
  give players a more personal touch on their save file.

---

Text

OptionsCoreTab3b.png

These options adjust the Text-related aspects of the game.

---

Text Font:
- Certain fonts are harder to read for different players. Let the players
  pick the font the game uses to allow themselves maximum comfort.

---

Text Speed
- Requires VisuMZ_1_MessageCore
- Allows the player to set the speed at which text displays during messages.
- There are speeds 1 through 10, with 1 being the slowest and 10 being the
  fastest.
- Speed 11 is "Instant" which causes text to display instantly.

---

Touch Input

OptionsCoreTab3c.png

These options adjust the Touch UI-related aspects of the game.

---

Touch UI
- Requires VisuMZ_0_CoreEngine
- This sets the visibility of the UI elements that are touch-only in the
  game such as the cancel button and the left/right actor switch buttons.
  - OFF: The touch-only UI elements do not appear.
  - ON: The touch-only UI elements do appear.

---

Button Position:
- Requires VisuMZ_0_CoreEngine
- Moves the clickable Cancel button, Page Up button, and Page down button
  to either the top of the screen or bottom of the screen.

---

Hover Select:
- Turn on/off Hover Select when using the mouse. If Hover Select is on, then
  the window cursor will automatically follow the mouse when applicable.
  Otherwise, the player will have to manually move the cursor.

---

Menu Arrangement

OptionsCoreTab3d.png

These options adjust the Menu Arrangement-related aspects of the game.

---

Menu Style
- Switch between 'Recommended' and 'Custom'. Recommended will have the menus
  arranged in the way the game/plugins decide for them to be. Otherwise,
  the player will be able to customize the positions of these next windows:

---

Help Window Position:
Input Window Position:
- Adjust the positions of these windows in the various positions listed to
  allow the player to select what they're most comfortable with.

---

Battle UI

OptionsCoreTab3e.png

These options adjust the Battle UI-related aspects of the game.

---

Show Provoke Origin
- Requires VisuMZ_2_AggroControlSystem
- If a battler is under the effects of "Provoke", then a line tracing back
  to the origin of the "Provoke" effect can be found.
  - OFF: Hide the Provoke Origin lines.
  - ON: Show the Provoke Origin lines.

---

Show Aggro Gauge
- Requires VisuMZ_2_AggroControlSystem
- Displays the amount of aggro a party member has with a gauge.
  - OFF: The Aggro Gauge is hidden.
  - ON: The Aggro Gauge is visible.

---

Show HP Gauges
- Requires VisuMZ_3_VisualHpGauge
- Displays the amount of HP each battler has with a gauge under their feet.
  - OFF: The battlefield's HP Gauges are hidden.
  - ON: The battlefield's HP Gauges are visible.

---

Show ATB Gauges
- Requires VisuMZ_2_BattleSystemATB
- Displays ATB gauges on each battler showing how much time they have left
  before they can act.
  - OFF: The battlefield's ATB Gauges are hidden.
  - ON: The battlefield's ATB Gauges are hidden.

---

Playtest


OptionsCoreTab4.png

The following are the options that have been added to the Options Menu. This is the default "Text" category that appears with the plugin parameters. These can be added and/or removed. If a new option has been added through an update, then there's a likelihood of it not appearing due to the plugin parameters not being updated with them.

  • NOTE* Unless changed, this category only appears during playtesting and

does not appear outside of playtesting, which means deployed games should not display this unless you've given them access to playtest mode.

Effects

OptionsCoreTab4a.png

---

Playtest Effects:
- If this is 'OFF', then all the Playtesting options are turned off. If 'ON'
  then you can adjust them however you like.

---

Exploration

OptionsCoreTab4b.png

These options adjust the Playtest Exploration-related aspects of the game.

---

Map Update Speed:
- Allows you to speed up the events and movement on the map with four speed
  levels ranging from normal to x3 speed.
  - Normal: The usual update speed.
  - Fast: x2 the usual update speed.
  - Faster: x3 the usual update speed.
  - Fastest: x4 the usual update speed.

---

Random Encounters:
- Sometimes, random encounters can really take away the enjoyment a player
  has for the game if it's too frequent. This option lets the player turn
  them off or reduce their frequency by half.
  - None: No random encounters while this is selected.
  - Half: Random encounters occur at half frequency.
  - Normal: Random encounters occur at normal frequency.

---

Battle

OptionsCoreTab4c.png

These options adjust the Playtest Battle-related aspects of the game.

---

God Mode:
- If this is ON, then actors will be unable to die even if their HP reaches
  0. They will continue to act as if they still have HP left.

---

Resist Negative Effects:
- Requires VisuMZ_1_SkillsStatesCore.
- If ON, this will resist states with a <Negative State> notetag.
- If ON, this will also resist debuffs.

---

Instant K.O.
- If ON, then actors attacking enemies will deal fatal damage to enemies.

---

Skill Costs:
Consume Items:
- If OFF, then skills won't cost anything and items won't be consumed.

---

Rewards

OptionsCoreTab4d.png

These options adjust the Playtest Rewards-related aspects of the game.

---

EXP Multiplier:
Gold Multiplier:
Drop Multiplier:
- Allows you to adjust the multipliers for EXP gained, Gold gained, and
  Drop rates from x2 to x1024.

---

Spawners

OptionsCoreTab4e.png

These options adjust the Playtest Spawner-related aspects of the game.

---

Spawn Items:
Spawn Weapons:
Spawn Armors:
- Sends you to a "shop" where you can purchase any of the game's named items
  for 0 gold each.

---

Debug

OptionsCoreTab4f.png

These options adjust the Playtest Debug-related aspects of the game.

---

Debug Menu:
- Sends you to the Debug Menu Scene.

---

Plugin Parameters

Options Settings

OptionsCoreParam1.png

Allows you to adjust some default settings that may affect the way the Options Menu Scene looks and/or some of the options available inside it.

---

Categories

 Category Window Style:
 - How do you wish to draw commands in the Category Window?
 - Text Only: Display only the text.
 - Icon Only: Display only the icon.
 - Icon + Text: Display the icon first, then the text.
 - Auto: Determine which is better to use based on the size of the cell.
 Category Text Align:
 - Text alignment for the Command Window.

---

Sound

 Cursor Sounds:
 OK Sounds:
 Cancel Sounds:
 Buzzer Sounds:
 - SE files player can select from for OK SE.
 - The first in the list will always be the default SE.

---

Text

 Font Options:
 - Available fonts for the player to select from.
 - The first font in the list is always be the default font.

---

Button Assist Window

 Switch Category:
 - Button assist text used for switching categories.
 - For VisuStella MZ's Core Engine's Button Assist Window.

---

Options Categories

OptionsCoreParam2.png

Here, you can add/edit/remove the categories found in the Options Menu Scene and their related Options.

---

Options Categories

OptionsCoreParam2a.png

 Name:
 - The name of this category as seen in the Category Window.
 - Text codes are supported.
 Icon:
 - Icon used for this category.
 - Use 0 for no icon.
 JS: Show/Hide:
 - Code used to determine if this category is visible.
 Options List:
 - Add options to this category here.

---

Listed Options

OptionsCoreParam2b.png

These are the Options found within an Options Category's List. Add, edit, and/or remove them as you see fit. Adding or altering an option will require adequate knowledge of JavaScript to do so.

---

OptionsCoreParam2c.png

Basic

 Symbol:
 - Symbol used for this option when selected.
 - Make sure this is unique from other symbols.
 Icon:
 - Icon used for this option.
 - Use 0 for no icon.
 STR: Text:
 - Displayed text used for this option.
 - If this has a value, ignore the JS: Text version.
 JS: Text:
 - JavaScript code used to determine string used for the displayed name.

---

Accessibility

 JS: Show/Hide:
 - Code used to determine if this option is visible.
 JS: Enable:
 - Code used to determine if this option is enabled.
 JS: Ext:
 - Code used to determine if this option's ext value.

---

Functions

 JS: Draw Option:
 - Code used to draw this item into the List Window.
 JS: Process OK:
 - Code used when OK button is pressed while selected.
 JS: Cursor Right:
 - Code used when Right button is pressed while selected.
 JS: Cursor Left:
 - Code used when Left button is pressed while selected.

---

Data

 JS: Default Value:
 - Code used to determine the default value of this option.
 JS: Save Option:
 - Code used when saving this options setting.
 JS: Load Option:
 - Code used when loading this options setting.

---


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.03: September 20, 2020

  • Compatibility Update!
    • This plugin should offer better compatibility for future plugins! Update made by Yanfly.


Version 1.02: September 13, 2020

  • Optimization Update!
    • Scrolling through menus should consume less resources.


Version 1.01: August 30, 2020

  • Bug Fixes!
    • Before, already existing Options available in the RPG Maker MZ base code such as BGM Volume, Command Remember, Always Dash, and so on, would not have their default values declared through the Options Core. The Options Core now changes this functionality and gives priority to the Plugin Parameter settings declared by the game dev. Fix made by Yanfly.


Version 1.00: August 20, 2020

  • Finished Plugin!

End of File