Welcome to PGMV! 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.
FTKR Display Command Frame - FTKR_DisplayCommandFrame.js
Plugin desc : v1.2.2 Command frame plugin
License : MIT License
Author : Futokoro
Desc page : https://github.com/munokura/futokoro-MV-plugins
Download Page : https://raw.githubusercontent.com/munokura/futokoro-MV-plugins/refs/heads/master/FTKR_DisplayCommandFrame.js
File name : FTKR_DisplayCommandFrame.js
Help of plugin :
@plugindesc v1.2.2 Command frame plugin @author Futokoro @url https://github.com/munokura/futokoro-MV-plugins @license MIT License @help English Help Translator: munokura This is an unofficial English translation of the plugin help， created to support global RPG Maker users. Feedback is welcome to improve translation quality (see: https://github.com/munokura/futokoro-MV-plugins ). Original plugin by Futokoro. Please check the URL below for the latest version of the plugin. URL https://github.com/futokoro/RPGMaker ----- ----------------------------------------------------------------------------- Overview ----------------------------------------------------------------------------- By implementing this plugin， you can add borders to commands (*1) and lists (*2) in menus， etc. You can choose from single-line， double-line， and image borders. You can also choose when to add the border. (*1) In this plugin， "commands" refer to the commands for windows created using the Window_Command object. In the standard MV， these correspond to the following windows: 1. Title Command 2. Menu 3. Item Type List after Item Selection 4. Lists for Equipment Changes， Optimize， etc. after Equipment Selection 5. Skill Type List after Skill Selection 6. Options 7. Shop Menu 8. Selection Command 9. Battle Command 10. Game End Command Each function can be individually enabled/disabled using the plugin parameters. (*2) In this plugin， "lists" refer to the following windows: 1. Menu Screen Skill List 2. Battle Screen Skill List You can individually enable/disable the function for each using the plugin parameters. ----------------------------------------------------------------------------- Setup Instructions ----------------------------------------------------------------------------- 1. Add this plugin to the "Plugin Manager." 2. When using it in conjunction with FTKR_ExBattleCommand.js， place this plugin at the bottom. FTKR_ExBattleCommand.js FTKR_DisplayCommandFrame.js ----------------------------------------------------------------------------- Basic Settings ----------------------------------------------------------------------------- Basic settings such as frame type and display timing can be changed using the following plugin parameters. <Display Frame Type> : Sets the frame type to display. : 0 - Hidden， 1 - Single Line， 2 - Double Line， 3 - Image : 4 - Single Line + Image， 5 - Double Line + Image : 6 - Single Line + Fill， 7 - Double Line + Fill <When To Display Frame> : Sets when the frame is displayed. : 0 - Always， 1 - When the cursor overlaps， 2 - When the cursor does not overlap. <Change Frame On Cursor> : Sets whether the frame changes when the cursor overlaps. : 0 - Disabled， 1 - Enabled <Hide Cursor> : Sets whether the cursor is hidden. : 0 - Disabled， 1 - Enabled ----------------------------------------------------------------------------- Single Line/Double Line Settings ---------------------------------------------------------------------------- When the frame type is set to single line or double line， the display settings can be changed using the following plugin parameters. <Default Line Color> : The default color number for the border line. <Line Color On Cursor> : The color number used when the cursor is over the border. <Line Thick> : The thickness of the border line. <Sub Line Color> : The color number for the border line when using multiple lines. : The line color for multiple lines remains the same even when the cursor is over the line. <Sub Line Thick> : The thickness of the border line when using multiple lines. ----------------------------------------------------------------------------- Frame Fill Settings ----------------------------------------------------------------------------- When the frame type is set to "filled，" the display settings can be changed using the following plugin parameters. <Default Fill Color> : The default color number used to fill the frame. <Fill Color On Cursor> : The color number used when the cursor is over the frame. <Fill Color Opacity> : The transparency of the fill color. ----------------------------------------------------------------------------- Image Settings ----------------------------------------------------------------------------- When the frame type is set to image， the display settings can be changed using the following plugin parameters. <Image Name> : Sets the image name to use. : Save images in /img/system/ in your project folder. (*1) <Image Width> : Sets the width of the frame image. (*1) <Image Height> : Sets the height of the frame image. (*1) <Enabled Change Scale> : Sets the automatic resizing function (*2) when the frame image and cursor sizes differ. : 0 - Disabled， 1 - Enabled <Image Offset X> : Set this to shift the frame image display position in the X direction relative to the cursor frame. : The unit is pixels. Positive values shift the image to the right. <Image Offset Y> : Set this to shift the border image display position relative to the cursor frame in the Y direction. : The unit is pixels. Positive values shift the image toward the bottom. <Image Offset Width> : Set this to change the border image width relative to the width of the cursor frame. (*3) : The unit is pixels. Positive values increase the width. <Image Offset Height> : Set this to change the border image height relative to the height of the cursor frame. (*3) : The unit is pixels. Positive values increase the height. <Default Image Index> : Set the default image index. (*4) <Image Index On Cursor> : Set the image index to display when the cursor is over it. (*4) (*1) To use multiple border images， arrange multiple border images in the image file. Up to four images can be arranged horizontally. In this case， each border image must be the same size. Set the size in <Flame Image Width> and <Flame Image Height>. (*2) The auto-sizing function fixes the 6x6 corners of the frame image and scales the rest. Therefore， to enable this function， the frame image must be at least 13x13 in size. (*3) The auto-sizing function must be enabled. (*4) The frame images in the image file are numbered 0， with the top-left image being number 0. Numbers are counted to the right from there， 1， 2， etc. ----------------------------------------------------------------------------- License for this plugin ----------------------------------------------------------------------------- This plugin is released under the MIT License. Copyright (c) 2017 Futokoro http://opensource.org/licenses/mit-license.php Plugin Publisher https://github.com/futokoro/RPGMaker/blob/master/README.md ----------------------------------------------------------------------------- Change History ----------------------------------------------------------------------------- v1.2.2 - 2020/05/17: Bug Fixes 1. Fixed an issue where the frame image would sometimes not display the first time. (by emptybraces) v1.2.1 - 2017/11/24: Bug Fixes 1. Avoided a conflict with FTKR_ExBattleCommand.js. v1.2.0 - 2017/11/20: Traits Additions 1. Added the ability to display frames in the skill list. 2. Revised the plugin parameter input method. v1.1.1 - April 21， 2017: Added support for border image deployment. v1.1.0 - March 31， 2017: Specification Changes 1. Changed border display specifications. 2. Added transparency settings for border fill. v1.0.5 - March 15， 2017: Traits Additions 1. Added the ability to fill the border with a specified color. v1.0.4 - March 10， 2017: Traits Additions 1. Added the option to display both border lines and border images to the border display type. v1.0.3 - March 9， 2017: Traits Additions 1. Added the ability to enable or disable borders for each command. 2. Modified so that borders can also be added to selection commands. v1.0.2 - March 9， 2017: Traits additions 1. Added frame image resizing functionality. v1.0.1 - March 8， 2017: Bug fixes and some processing revisions. 1. Fixed a mis-description of the FTKR.DCF.frame.image.offsetX and FTKR.DCF.frame.image.offsetY plugin parameters. 2. Fixed an issue where the <Line Thick> plugin parameter was not being applied to the single-line frame thickness. 3. Some processing revisions. v1.0.0 - March 8， 2017: First version created. ----------------------------------------------------------------------------- @param --Basic Setting-- @param Display Frame Type @desc Sets the type of command pane to display @default 1 @type select @option hidden @value 0 @option Single track @value 1 @option double track @value 2 @option image @value 3 @option Single track + image @value 4 @option Double track + image @value 5 @option Single line + fill @value 6 @option Double line + fill @value 7 @param When To Display Frame @desc Timing for displaying the command pane @default 1 @type select @option Always @value 0 @option When overlapping with the cursor @value 1 @option When not overlapping with the cursor @value 2 @param Change Frame On Cursor @desc Param to change frame when cursor overlaps @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Hide Cursor @desc Param to hide command cursor @default 0 @type select @option invalid @value 0 @option valid @value 1 @param --Frame Line Setting-- @param Default Line Color @desc Default color number for borders @default 0 @param Line Color On Cursor @desc Color number to use when hovering over the cursor @default 17 @param Line Thick @desc Border Thickness @default 2 @param Sub Line Color @desc Color number of the frame line used when multiple lines are used @default 15 @param Sub Line Thick @desc The thickness of the frame line used when drawing multiple lines @default 1 @param --Rect Frame Setting-- @param Default Rect Color @desc Standard color number used to fill the frame @default 11 @param Default Rect Color2 @desc The default color number used to fill the frame (the second color number for gradation display) @param Rect Color On Cursor @desc Color number to use when hovering over the cursor @default 3 @param Rect Color On Cursor2 @desc Color number to use when the cursor is over it (second color number for gradation display) @param Rect Color Opacity @desc Transparency of the frame fill color: 0 - transparent， 255 - opaque @default 255 @param --Image Frame Setting-- @param Image Name @desc Image name to use. File should be saved in /img/system/ @type file @require 1 @dir img/system/ @param Image Width @desc Border image width Note: This is not the width of the image file. @param Image Height @desc Frame image height Note: This is not the height of the image file @param Enabled Change Scale @desc Automatic size adjustment function when the frame image and cursor size are different @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Image Offset X @desc X-axis offset of the frame image relative to the cursor frame @default 0 @param Image Offset Y @desc Y-axis deviation of the frame image relative to the cursor frame @default 0 @param Image Offset Width @desc Difference in width of the frame image relative to the cursor frame @default 0 @param Image Offset Height @desc Height difference of the frame image relative to the cursor frame @default 0 @param Default Image Index @desc Default image number @default 0 @param Image Index On Cursor @desc Image number to display when cursor is over it @default 1 @param --Enabled Command-- @param Enabled Title Command @desc Add a border to the title command @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Menu Command @desc Whether to frame menu commands @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Item Command @desc Add a border to item commands @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Skill Command @desc Should skill commands have a frame? @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Equip Command @desc Add a frame to the equip command @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Option Command @desc Whether to frame option commands @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Shop Command @desc Do you want to add a border to shop commands? @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Choice Command @desc Do you want to add a border to shop commands? @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Battle Command @desc Should battle commands be framed? @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled GameEnd Command @desc Do you want to add a border to shop commands? @default 1 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Menu Skill List @desc Whether to add a frame to the skill list on the menu screen @default 0 @type select @option invalid @value 0 @option valid @value 1 @param Enabled Battle Skill List @desc Should I add a border to the skill list on the battle screen? @default 0 @type select @option invalid @value 0 @option valid @value 1