メッセージにルビ記法を追加します – Torigoya_TextRuby.js

タイトル
メッセージにルビ記法を追加します
作者名
ヘルプ
文章中に

\ruby[ルビを振りたい単語](ふりがな)

のように書くことで、ルビを振ることができるようになります。

------------------------------------------------------------
■ 上級者向け設定

事前に以下のどちらかの設定を行うことで、
ふりがなを省略することができます。

(例)
\ruby[魔導書](グリモワール) → \ruby[魔導書]

※注意
「ふりがな」を省略できるだけです。
文章に自動的にふりがなを振る機能ではありません。


ふりがなを省略するためには、以下のどちらかの方法で、
ふりがなを事前登録しておく必要があります。


(方法1) プラグインの設定で「ふりがなの事前登録」をする

画面右側に表示されている「■ 上級者向け設定」の中にある
「Dictionaries」から、ふりがなを事前に登録しておくことができます。

(方法2) イベント中にプラグインコマンドでふりがなを登録する

プラグインコマンドに以下のように入力することで、
ふりがなを省略できるようになります。

ふりがな登録 魔導書 グリモワール

また、プラグインコマンドに以下のように入力することで、
プラグインコマンドで登録したふりがなを削除できます。

ふりがなリセット

------------------------------------------------------------
■その他のプラグインコマンド

以下のプラグインコマンドで、
ルビを振りたい単語とふりがなの色を変更できます。
XにはRPGツクールMVの色番号を入力してください。

ふりがな色 X

ルビを振りたい単語のみ色を変えたい場合は以下のコマンドを、

ふりがな色メイン X

ふりがなのみ色を変えたい場合は以下のコマンドを利用してください。

ふりがな色サブ X

つけた色をリセットしたい場合は以下のコマンドを利用してください。

ふりがな色リセット
パラメータ
param ■ 基本設定

param Main Text Scale
desc ルビを振る対象文字の拡大率 (default: 0.9)
type number
max 1.0
min 0.5
decimals 2
default 0.9

param Sub Text Scale
desc ルビとして振る小さい文字の拡大率 (default: 0.35)
max 1.0
min 0.1
decimals 2
default 0.35

param Ignore Escape Characters
desc ルビを振りたい単語やふりがなに含まれる制御文字を無視します
type boolean
default false

param ■ 上級者向け設定

param Dictionaries
desc ふりがなの事前登録
type struct<Dictionary>[]

ライセンス表記
"Torigoya Plugins" is published under public domain.
The part quoted from the RPG Maker MV CoreScript is MIT License. (Please look at each file for detailed license)

紹介ページ https://github.com/rutan/torigoya_rpg_maker_mv_plugins/tree/master/control_character