Welcome to PGMZ! My goal is to make it easy for everyone to find and share great plugins for creating amazing games. As a plugin developer myself, I'm excited to grow this community with all of you.
Option Ex - OptionEx.js
Plugin desc : Extends the option scene.
License : MIT License
Author : nz_prism
Website : https://github.com/nz-prism/RPG-Maker-MZ/blob/master/OptionEx/js/plugins/OptionEx.js
Desc page : https://github.com/nz-prism/RPG-Maker-MZ/blob/master/OptionEx/js/plugins/OptionEx.js
Download Page : https://raw.githubusercontent.com/nz-prism/RPG-Maker-MZ/master/OptionEx/js/plugins/OptionEx.js
File name : OptionEx.js
Help of plugin :
* @target MZ * @plugindesc Extends the option scene. * @author nz_prism * @url https://github.com/nz-prism/RPG-Maker-MZ/blob/master/OptionEx/js/plugins/OptionEx.js * * @help OptionEx.js * ver. 1.5.0 * * [History] * 02/28/2021 1.0.0 Released * 03/03/2021 1.0.1 Corrected default tone glitches and calibrated the window * height. * 03/05/2021 1.0.2 Fixed bugs when dash speed or fast message is unused. * 04/05/2021 1.1.0 Added Switch A/B Buttons and plugin parameters to disable * standard items. * 06/22/2021 1.2.0 Added several parameters and make it compatible with sub- * folder. * 07/06/2021 1.2.1 Supported sub-folder improvement of RMMZ 1.3.2 * 02/20/2022 1.2.2 Supported NovelGameUI.js * 02/21/2022 1.2.3 Improved conflicts against other option-providing plugins. * 02/24/2022 1.3.0 Added a plugin parameter to lower the window under the * buttons and rewrote this description. * 03/03/2022 1.3.1 Fixed to reflect the default values for a new game. * 08/24/2023 1.4.0 Added 2 plugin parameters as to the Control Characters * behavior when Fast Message option is ON. * 04/10/2023 1.5.0 Enabled ME/BGS Volumes to be merged with BGM/SE Volume. * * This plugin extends the option scene. * The functionalities include not only changing the option window cosmetics * and placing gauges for some options， such as Volumes， but also adding new * option items; * * 1. Switch A/B Buttons * 2. Fast Message * 3. Dash Speed * 4. Windowskins * 5. Window Color * 6. Window Opacity * * It also adds a button to reset all the option values to default. * For numeric and gauge options， players can use pageup/pagedown buttons * (touch UI buttons available) to change the values greatly. For gauges， * players can drag/swipe to change the vaulues. * You can choose whether to enable each of option items. * * There are several plugin parameters as to dimensions/location of the * option window. If option items don’t fit within the window due to too many * items， try changing the values of them. ”Option Item Height” is the height * of each item. By lowering the value， you can increase the number of visible * items. If the texts of the items exceed the rectangles， lower ”Font Size”， * too. ”Default Command Offset” is a distance between the downmost item and * the Reset to Default button. By setting ”Place Option Window Under Buttons” * true， the window will be placed under the touch UI button area. If so， the * window height will get smaller. Then， try lowering the parameters above to * make all the items visible. * * If the plugin parameter ”Hide Touch UI Option for Mobile Devices” is set * true (true by default)， the ”Touch UI” option will not appear on * tablets/smartphones. It prevents a problem that if players unintentionally * set the option OFF， the menu button disappears and 2-finger tap is required * to invoke menu， which is not famous for players. * * 1. Switch A/B Buttons * If ON， the OK/Cancel buttons of a gamepad will be swapped. If the plugin * parameter ”Hide Switch A/B Buttons if Gamepad Unconnected” is set true * (true by default)， this option will not appear when no gamepad is connected. * * 2. Fast Message * If ON， texts appear instantly on the message window. * The plugin parameter ”Wait Time Factor for Fast Message” can set a factor * with which you can shorten or remove the wait time for Control Characters * ”￥.” and ”￥|”. The plugin parameter ”Button Input Wait for Fast Message” * enables you to remove the wait for button input brought by Control Characer * ”￥!”. * * 3. Dash Speed * 3 speeds can be selected. ”1” is the same speed as MZ default. * * 4. Windowskin * Provides alternative windowskins. To use this option item， add window image * files (originally ”Window.png” but whatever file name is acceptable) to the * img/system folder. Then， add them to the plugin parameter ”Windowskin * Images”. If the parameter has only an image file， this option item does not * appear. * * 5. Window Color * Changes the tone for the windows. Gauges are placed and players can * drag/swipe the gauge. * * 6. Window Opacity * Changes the opacity for the windows. Gauges are placed and players can * drag/swipe the gauge. * * * This plugin is released under MIT license. * https://opensource.org/licenses/mit-license.php * * * @param placeWindowUnderButtonArea * @text Place Option Window Under Buttons * @desc Specify whether the option window is placed under the UI buttons. * @default false * @type boolean * * @param windowWidth * @text Option Window Width * @desc Specify the width for the option window. * @default 560 * @type number * @min 400 * @max 3840 * * @param itemHeight * @text Option Item Height * @desc Specify the height for the individual option items. * @default 28 * @type number * @min 8 * @max 64 * * @param fontSize * @text Font Size * @desc Specify the font size for the option window. * @default 23 * @type number * @min 8 * @max 48 * * @param defaultCommandOffset * @text Default Command Offset * @desc Specify the Y-axis offset for a command to reset to default. * @default 12 * @type number * @min 0 * @max 36 * * @param titleColor * @text Option Name Color * @desc Specify the color for each option name. * @default 6 * @type number * @min 0 * @max 31 * * @param alwaysDash * @text Always Dash * @desc The settings for Always Dash option. * * @param useAlwaysDash * @text Use Always Dash * @desc Specify to enable an option to toggle auto-dash. * @parent alwaysDash * @default true * @type boolean * * @param defaultAlwaysDash * @text Default Always Dash * @desc The default value for the always dash option. * @parent alwaysDash * @default false * @type boolean * * @param commandRemember * @text Command Remember * @desc The settings for Command Remember option. * * @param useCommandRemember * @text Use Command Remember * @desc Specify to enable an option to toggle command remember. * @parent commandRemember * @default true * @type boolean * * @param defaultCommandRemember * @text Default Command Remember * @desc The default value for the command remember option. * @parent commandRemember * @default false * @type boolean * * @param touchUI * @text Touch UI * @desc The settings for Touch UI option. * * @param useTouchUI * @text Use Touch UI * @desc Specify to enable an option to toggle touch UI. * @parent touchUI * @default true * @type boolean * * @param hideTouchUIForMobiles * @text Hide Touch UI Option for Mobile Devices * @desc Specify to hide ”Touch UI” option if a player uses a smart phone or a tablet. * @parent touchUI * @default true * @type boolean * * @param defaultTouchUI * @text Default Touch UI * @desc The default value for the touch UI option. * @parent touchUI * @default true * @type boolean * * @param volumes * @text Volumes * @desc The settings for volume options. * * @param useBgmVolume * @text Use BGM Volume * @desc Specify to enable an option to tune BGM volume. * @parent volumes * @default true * @type boolean * * @param useBgsVolume * @text Use BGS Volume * @desc Specify to enable an option to tune BGS volume. If Merge with SE Volume， it will refer to SE Volume. * @parent volumes * @default 2 * @type select * @option Yes * @value 2 * @option Merge with SE Volume * @value 1 * @option No * @value 0 * * @param useMeVolume * @text Use ME Volume * @desc Specify to enable an option to tune ME volume. If Merge with BGM Volume， it will refer to BGM Volume. * @parent volumes * @default 2 * @type select * @option Yes * @value 2 * @option Merge with BGM Volume * @value 1 * @option No * @value 0 * * @param useSeVolume * @text Use SE Volume * @desc Specify to enable an option to tune SE volume. * @parent volumes * @default true * @type boolean * * @param defaultVolume * @text Default Volume * @desc Specify the default volume for BGM， BGS， ME and SE. * @parent volumes * @default 75 * @type number * @min 0 * @max 100 * * @param switchABButtons * @text Switch A/B Buttons * @desc The settings for Switch A/B Buttons option. * * @param useSwitchABButtons * @text Use Switch A/B Buttons * @desc Specify to enable an option to switch A/B buttons. * @parent switchABButtons * @default true * @type boolean * * @param hideSwitchABButtonsIfGamepadUnconnected * @text Hide Switch A/B Buttons if Gamepad Unconnected * @desc Specify to hide an option to switch A/B buttons if gamepad is unconnected. * @parent switchABButtons * @default true * @type boolean * * @param switchABButtonsName * @text Switch A/B Buttons Name * @desc Specify the name of an option to switch A/B buttons. * @parent switchABButtons * @default Switch A/B Buttons * @type string * * @param defaultSwitchABButtons * @text Default Switch A/B Buttons * @desc The default value for the switch A/B buttons option. * @parent switchABButtons * @default false * @type boolean * * @param fastMessage * @text Fast Message * @desc The settings for Fast Message option. * * @param useFastMessage * @text Use Fast Message * @desc Specify to enable an option to show messages immediately. * @parent fastMessage * @default true * @type boolean * * @param waitTimeForFastMessage * @text Wait Time Factor for Fast Message * @desc The wait time factor for Control Characters ”￥.” and ”￥|” when Fast Message option is ON. * @parent fastMessage * @default 1 * @type select * @option x 1 * @value 1 * @option x 1/3 * @value 3 * @option x 1/5 * @value 5 * @option x 0 * @value 0 * * @param buttonWaitForFastMessage * @text Button Input Wait for Fast Message * @desc If false， it will not wait for button input even though Control Character ”￥!” exists. * @parent fastMessage * @default true * @type boolean * * @param fastMessageName * @text Fast Message Name * @desc Specify the name of an option to show messages immediately. * @parent fastMessage * @default Fast Message * @type string * * @param defaultFastMessage * @text Default Fast Message * @desc The default value for the fast message option. * @parent fastMessage * @default false * @type boolean * * @param dashSpeed * @text Dash Speed * @desc The settings for Dash Speed option. * * @param useDashSpeed * @text Use Dash Speed * @desc Specify to enable an option to change the player dash-speed. * @parent dashSpeed * @default true * @type boolean * * @param dashSpeedName * @text Dash Speed Name * @desc Specify the name of an option to change the player dash-speed. * @parent dashSpeed * @default Dash Speed * @type string * * @param defaultDashSpeed * @text Default Dash Speed * @desc Specify the default value for dash-speed (0-2). Note it appears +1 on the screen. * @parent dashSpeed * @default 0 * @type number * @min 0 * @max 2 * * @param windowskin * @text Windowskin * @desc The settings for Windowskin option. * * @param useWindowskin * @text Use Windowskin * @desc Specify to enable an option to change the windowskin. * @parent windowskin * @default true * @type boolean * * @param windowskinName * @text Windowskin Name * @desc Specify the name of an option to change the windowskin. * @parent windowskin * @default Windowskin * @type string * * @param windowskins * @text Windowskin Images * @desc Add as many windowskin files as you want users to choose. * @parent windowskin * @default [”Window”] * @type file[] * @dir img/system * * @param windowTone * @text Window Color * @desc The settings for Window Color options. * * @param useWindowTone * @text Use Window Color * @desc Specify to enable options to change the window tone. * @parent windowTone * @default true * @type boolean * * @param windowToneRedName * @text Window Color Red Name * @desc Specify the name of an option to change the red value of windows. * @parent windowTone * @default Window Color R * @type string * * @param windowToneGreenName * @text Window Color Green Name * @desc Specify the name of an option to change the green value of windows. * @parent windowTone * @default Window Color G * @type string * * @param windowToneBlueName * @text Window Color Blue Name * @desc Specify the name of an option to change the blue value of windows. * @parent windowTone * @default Window Color B * @type string * * @param windowOpacity * @text Window Opacity * @desc The settings for Window Opacity option. * * @param useWindowOpacity * @text Use Window Opacity * @desc Specify to enable an option to change the window opacity. * @parent windowOpacity * @default true * @type boolean * * @param windowOpacityName * @text Window Opacity Name * @desc Specify the name of an option to change the opacity of windows. * @parent windowOpacity * @default Window Opacity * @type string * * @param defaultWindowOpacity * @text Default Window Opacity * @desc The defalt value for the window opacity. You don’t have to specify it if your RMMZ version is 1.3.0 or later. * @parent windowOpacity * @default 195 * @type number * @min 0 * @max 255 * * @param defaultCommandName * @text Default Command Name * @desc Specify the name of a command to reset to default. * @default Reset to Default * @type string *