Customizable Text Above Events Plugin for RPG Maker MZ

じ☆ve冰风

I was creating a plugin for my game and decided to share it with the community.

ToshA_TextIcon.js
This plugin allows you to display custom text above events on the map using event comments
Spoiler: screenshot

[/quote]

Spoiler: Font Settings[quote]Loading Fonts:
To use custom fonts in the text, follow these steps:
1. Copy the font file into the 'fonts/' folder of your RPG Maker project.
2. Open the plugin settings in the RPG Maker MZ editor.
3. Find the parameter responsible for font settings, 'Fonts'.
4. Enter the font file name (e.g., 'myfont.ttf') in the 'Filename' field.
5. Enter the name that will be used to refer to the font in the game (e.g., 'CustomFont') in the 'Family' field.
6. Use the assigned font name (e.g., 'CustomFont') in the 'fontName' parameter of the text comments to apply this font to the text.

Example usage in a text comment:
<Text - Hello, world!; fontName=CustomFont>

This will apply the loaded 'CustomFont' to the text 'Hello, world!'.

Spoiler: Parameters

Comment Parameters:
- fontName: the name of the font for the text, should match the name loaded through FontManager.
- fontSize: the font size of the text.
- bold: the boldness of the text (true for bold).
- color: the color of the text in RGBA format.
- bitmapWidth: the width of the text window in pixels.
- bitmapHeight: the height of the text window in pixels.
- offsetY: the vertical offset of the text above the event in pixels.
- visibilityRange: the distance at which the text starts to appear (0 for constant visibility).
- animationType: the type of animation (e.g., fadeIn).
- animationDuration: the duration of the animation in frames.

Spoiler: Usage examples

Usage Examples:
1. Basic text without additional parameters:
    <Text - Hello, world!>

2. Text with boldness and changed font size:
    <Text - Attention!; fontSize=20; bold=true; fontName=CustomFont>

3. Text with changed color and text window sizes:
    <Text - 50% Discount!; color=rgba(255,0,0,1); bitmapWidth=180; bitmapHeight=40>

4. Text with vertical offset and appearance distance:
    <Text - Danger Ahead!; offsetY=-20; visibilityRange=5>
    (Animation is not applicable in this case with visibilityRange)

5. Text with a smooth fade-in animation:
    <Text - Last Warning!; animationType=fadeIn; animationDuration=60>
    (Visibility range is not applicable in this case with animation)

6. Complex example using all parameters:
    <Text - Whatever the text\I[2]; fontName=CustomFont; fontSize=30; color=rgba(249,0,249,1); bitmapWidth=260; bitmapHeight=50; offsetY=48>
    - "Whatever the text" is the text that will be displayed.
    - \I[2] inserts the icon with index 2 from the icon set.
    - fontName=CustomFont uses the pre-loaded CustomFont.
    - fontSize=30 sets the font size to 30 pixels.
    - color=rgba(249,0,249,1) sets the text color to a bright fuchsia.
    - bitmapWidth=260 and bitmapHeight=50 set the dimensions of the text display area.
    - offsetY=48 raises the text 48 pixels above the default position.

Spoiler: Video

https://www.youtube.com/embed/QkxuGWSAfiY

Download the plugin

Spoiler: MIT License

This plugin is distributed under the MIT license. You are free to use, copy, modify, merge, publish, distribute, sublicense and/or sell copies of the software.

本贴来自国际rpgmaker官方论坛作者:ToshaAngel处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/customizable-text-above-events-plugin-for-rpg-maker-mz.168075/