D Text Picture - DTextPicture.js

Plugin desc : Dynamic String Picture Generation Plugin

License : MIT License

Author : Triacontane

Website : https://triacontane.blogspot.com

Desc page : https://github.com/triacontane/RPGMakerMV/tree/mz_master/DTextPicture.js

Download Page : https://raw.githubusercontent.com/munokura/triacontane-MZ-plugins/refs/heads/main/DTextPicture.js

File name : DTextPicture.js

Help of plugin :

@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/DTextPicture.js
@plugindesc Dynamic String Picture Generation Plugin
@author Triacontane
@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/triacontane-MZ-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

This command dynamically generates a picture using a specified string.
Various control characters (such as ￥v[n]) can be used in the string， and the
picture content can be updated in real time when the value of the variable
displayed using the control characters changes.

Use the following steps to display the picture.
1: Prepare the drawing content using the plugin command [Prepare String
Picture].
2: Deselect ”Image” in the event command ”Show Picture.”
*The picture will not be displayed at step 1， so be sure to call the command
as a set.

Special Control Characters
￥V[n，m] (Variable value filled with m digits of the parameter)
￥item[n] Item information for item n (icon + name)
￥weapon[n] Weapon information for weapon n (icon + name)
￥armor[n] Armor information for armor n (icon + name)
￥skill[n] Skill information for skill n (icon + name)
￥state[n] State information for state n (icon + name)
￥oc[c] Set outline color to ”c” (*1)
￥ow[n] Set outline width to ”n” (e.g.， ￥ow[5])
￥f[b] Bold font
￥f[i] Italic font
￥f[n] Return bold and italic font to normal

*1 How to specify outline color
￥oc[red] Specify by color name
￥oc[rgb(0，255，0)] Specify by color code
￥oc[2] Specify the same as the character color number ￥c[n]

If you want to change the font of dynamic string pictures，
please load it using the separate font load plugin.
https://github.com/triacontane/RPGMakerMV/blob/mz_master/FontLoad.js

This plugin requires the base plugin ”PluginCommonBase.js.”
”PluginCommonBase.js” is located in the following folder
under the RPG Maker MZ installation folder:
dlc/BasicResources/plugins/official

Terms of Use:
You may modify and redistribute this plugin without permission， and there are
no restrictions on its use (commercial， 18+， etc.).
This plugin is now yours.

@param frameWindowSkin
@text Frame Window Skin
@desc The skin file name for the frame window. Must be specified if you are using a window builder.
@type file
@require 1
@dir img/system/

@param frameWindowPadding
@text Frame Window Margins
@desc The frame window margins.
@type number
@default 18

@param padCharacter
@text Filler characters
@desc When drawing a numeric value， this is the character to be filled in if the specified number of digits is not met. Please specify only one half-width character.
@default 0

@param prefixText
@text prefix string
@desc This is the text that is inserted before all string pictures. It mainly specifies default control characters etc.

@param widthVariable
@text Width storage variable
@desc This variable stores the width (number of pixels) of the dynamic string that was last drawn.
@type variable
@default 0

@param heightVariable
@text Height storage variable
@desc This variable stores the height (in pixels) of the dynamic string that was last drawn.
@type variable
@default 0

@param betweenVariableId
@text Character spacing variable number
@desc This is the variable number that acquires the character spacing value (in pixels). A separate character spacing setting plug-in is required.
@type variable
@default 0

@command dText
@text String Picture Preparation
@desc Prepares the string to be displayed in the string picture.
@arg text
@text Display string
@desc The text to display as a string picture.
@type multiline_string
@arg fontSize
@text Font size
@desc The initial font size of dynamic text. If you specify 0， it will use the default size set by the system.
@type number
@default 0

@command dTextSetting
@text String Picture Settings
@desc Settings for how to display string pictures. Changed settings will be retained even after drawing. Items that are not set will remain as they are.
@arg backGroundColor
@text background color
@desc The background color of the string picture.
@arg gradationLeft
@text Left Gradient
@desc Number of pixels in the left gradient of the string picture’s background.
@type number
@arg gradationRight
@text Right Gradient
@desc Number of pixels in the right gradient of the string picture’s background.
@type number
@arg realTime
@text Real-time drawing
@desc If you use the control character ￥v[n]， the picture will be redrawn if the contents of the variable change.
@type boolean
@arg window
@text window
@desc Displays a window behind a string picture.
@type boolean
@arg windowOpacity
@text Window Opacity
@desc String Picture background window opacity.
@type number
@arg pictureWidth
@text Width
@desc The width of the string picture. Used when the size is specified independently of the character drawing width.
@type number
@arg pictureHeight
@text height
@desc The height of the string picture. Used when you specify a size independent of the text drawing height.
@type number
@arg align
@text Alignment
@desc Dynamic string justification.
@type select
@option Left-justified
@value left
@option Centered
@value center
@option Right-justified
@value right
@arg fontFace
@text font
@desc Font of the string picture. Specify the name of the font loaded by the font load plug-in.
@arg lineHeight
@text Line Height
@desc The height of one line of the string picture.
@default 0
@arg vertical
@text Simple vertical writing
@desc This function writes text pictures vertically. This is a simple function. Texts with more than two lines cannot be written vertically.
@type boolean
@default false

@command dTextSettingClear
@text Unset string picture
@desc This will clear all settings related to the display method of string pictures and initialize them.

@command windowCursor
@text Window Cursor Settings
@desc Displays the cursor in the background window of the displayed string picture.
@arg pictureId
@text Picture Number
@desc The target picture number. It must be a picture that is already being displayed.
@type number
@default 1
@arg x
@text X coordinate
@desc The X coordinate of the cursor.
@type number
@default 0
@arg y
@text Y coordinate
@desc The Y coordinate of the cursor.
@type number
@default 0
@arg width
@text Width
@desc The width of the cursor.
@type number
@default 100
@arg height
@text height
@desc The height of the cursor.
@type number
@default 100
@arg activateSwitch
@text Enable Switch
@desc If specified， it will only be active when the switch is ON. If not specified， it will always be active.
@type switch
@default 0

munokura

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.