jp-netsis / rubytextmeshpro

Unity Text Mesh Proでルビ(フリガナ)のタグを追加しました.

Ruby(Furigana) Text Mesh Pro

TextMeshProに振り仮名(ふりがな、フリガナ、ルビ)タグを追加します。

This plugin adds ruby tag support to "Text Mesh Pro" Unity plugin.

TextMeshProが必要なため、Package Managerからインストールしてください。

You need to have TextMeshPro plugin in your project. You can install TMPro via Package Manager.

チェックしたUnityバージョンとTextMeshProは以下の通りです。

I checked Unity and TextMeshPro Version are below.

UnityVer:2022.3.13f1 
TextMeshProVer:3.0.6

[Ja]

TextMeshProはUnity 2023.2から非推奨になります。

この意味は、namespaceは変わらず、現状のベータ版ではTextMeshProが com.unity.ui に統合されたため、TextMeshProパッケージをパッケージマネージャからインストールすると重複しエラーが起こる状態になります。

そのため、RubyTextMeshProをそのまま使用することは現状可能だと思われます。

[En]

TextMeshPro will be deprecated starting Unity 2023.2.

What this means is that the namespace remains the same, but in the current beta version, TextMeshPro has been integrated into com.unity.ui, so installing the TextMeshPro package from the package manager will result in duplication and errors.

Therefore, it is currently possible to use RubyTextMeshPro as is.

Disruptive change

ver 1.2

[Ja]

追加 : RubyTextMeshProDefinitions に BASE_NO_OVERRAP_RUBY_ALIGNMENT を追加しました。

追加 : BASE_NO_OVERRAP_RUBY_ALIGNMENT 用に rubyMargin を追加しました。 ルビの隙間を指定します。

変更 : SerializeField パラメータを _<xyz> に変更しました。 以前のバージョンと互換性を保つため FormerlySerializedAs(<xyz>) を定義していますが、ご注意ください。

変更 :　BASE_NO_OVERRAP_RUBY_ALIGNMENT 用にルビとベースの文字の描画位置を計算する処理を追加しました。負荷が上がっている可能性があります。

削除 : RubyTextMeshPro.UnditedText / RubyTextMeshProUGUI.UnditedText : 削除されました。 uneditedText をご使用ください。

[En]

Added : BASE_NO_OVERRAP_RUBY_ALIGNMENT for RubyTextMeshProDefinitions.

Added : rubyMargin for BASE_NO_OVERRAP_RUBY_ALIGNMENT. Specify the ruby margin.

Changed : SerializeField parameter to _<xyz>. Note that FormerlySerializedAs(<xyz>) is defined for compatibility with previous versions.

Changed : Added processing for BASE_NO_OVERRAP_RUBY_ALIGNMENT to calculate the drawing position of ruby and base characters. This may have increased the load.

Removed : RubyTextMeshPro.UnditedText / RubyTextMeshProUGUI.UnditedText : removed. Please use uneditedText.

ver 1.1

[Ja]

削除 : allVCompensationRuby / allVCompensationRubyLineHeight : rubyLineHeight が空文字の場合、 いままでの allVCompensationRuby:false と同等の効果になります。また、 rubyLineHeight に値が入っている場合、 allVCompensationRubyLineHeight の値と同様の効果になります。

削除予定 : RubyTextMeshPro.UnditedText / RubyTextMeshProUGUI.UnditedText : 次のバージョンで削除されます。uneditedTextをご使用ください。

[En]

Removed : allVCompensationRuby / allVCompensationRubyLineHeight : If rubyLineHeight is an empty string, it will be the allVCompensationRuby:false value up to now, and if rubyLineHeight is a value, it will be the allVCompensationRubyLineHeight value.

Obsolete : RubyTextMeshPro.UnditedText / RubyTextMeshProUGUI.UnditedText : Will be removed in the next version. Please use uneditedText.

Features

Realtime Ruby Text

あなたは<ruby=にほんご>日本語</ruby>タグもしくは省略した<r=にほんご>日本語</r>タグを使用できます。

また、半角ダブルクォーテーションで囲っても動作します。

<ruby="にほんご">日本語</ruby>タグも<r="にほんご">日本語</r>タグもOKです。

You can use <ruby=ice>fire</ruby> tag or <r=ice>fire</r> tag. Both are the same.

It can also work with double quotes.

<ruby="ice">fire</ruby> tag or <r="ice">fire</r> tag.

How To Use

1. Load from github

[Ja]

GitHubからインストールをすることが可能です。

この場合、TextMeshPro3.0.6の依存情報を残しているため、TextMeshProをインストールしていない場合、インストールされます。

[En]

There is a way to install from GitHub.

In this case, the dependency information for TextMeshPro 3.0.6 is retained, so if TextMeshPro is not installed, it will be installed.

[Install]

Unity > Window > PackageManager > + > Add package from git url... > Add the following

https://github.com/jp-netsis/RubyTextMeshPro.git?path=/Assets/RubyTextMeshPro#v1.2.0

2. Copy Source Only

ソースのみコピーする方法があります。 これは。Unity2023.2 以降で現在有効です。 Unity2023の安定版が出たら、RubyTextMeshProは com.unity.ui に依存するよう変更します。

There is a way to copy only the source. This is. Currently valid for Unity2023.2 and later. Once a stable version of Unity2023 is available, RubyTextMeshPro will be changed to depend on com.unity.ui.

• (1). あなたにはTextMeshProプラグインが必要です。Package Managerからインストールしてください。Asset StoreからのText Mesh Proのインストールはしないでください。

• (1). You need to have TextMeshPro plugin in your project. You can install TMPro via Package Manager. DO NOT Install Text Mesh Pro from Asset Store.

• (2). RubyTextMeshProディレクトリをコピーすれば使用可能です

• (2). You can use it by copying the RubyTextMeshPro directory

Usage Description

<ruby=かんじ>漢字</ruby>

RubyShowType

RUBY_ALIGNMENT ルビに合わせて文字を表示します

BASE_ALIGNMENT 元の文字に合わせて文字を表示します

rubyLineHeight

この機能により、rubyを使用しない場合でも、同じ隙間を持つことができます。 この文字列を空にすることで、この機能はスキップされます。

This function allows you to have the same gap even if you don't use ruby. Empty this string to skip this feature.

Known Issues

• (1).TextMeshPro のソースは改変していません。アラインでいくつか問題が起こります。

• (1).TextMeshPro source has not changed. So text alignment is problematic.

• (2).ルビの最大文字数よりもテキストボックスを小さくしないでください。表示崩れが起きます。

• (2).Do not make the text box smaller than the maximum number of characters in ruby. Display collapse will occur.

• (1)_1.'BASE_ALIGN'で左寄せの場合かつルビが行頭にありつつ元の文字より多い場合、枠の外まで表示されます

• (1)_1.'BASE_ALIGN' setting is left align and the ruby is at the beginning of the line but more than the original character, it will be displayed outside the frame.

• (1)_2.'BASE_ALIGN'で**寄せの場合かつルビが元の文字より多い場合、**に表示されません。 'RUBY_ALIGN' を使用すると解消される場合があります。
• (1)_2.'BASE_ALIGN' setting is center align and the ruby is at more than the original character, can't displayed center. 'RUBY_ALIGN' used, it may be solved.

• (1)_3.'BASE_ALIGN'で右寄せの場合かつルビが行頭にありつつ元の文字より多い場合、(1)_1と違い、枠の内まで表示されます
• (1)_3.'BASE_ALIGN' setting is left align and the ruby is at the beginning of the line but more than the original character, Different from (1)_1 it will be displayed in the frame.

Use Font File

Rounded M+

http://jikasei.me/font/rounded-mplus

ありがとうございます！

Thank You!

Reference list

https://forum.unity.com/threads/how-to-display-extra-little-characters-above-characters-in-a-text.387772/

http://baba-s.hatenablog.com/entry/2019/01/10/122500

ありがとうございます！

Thank You!

Other

• (1).TextMeshProは素晴らしいプラグインですので、rubyタグの追加はいつか行われるでしょう。そのときこのプロジェクトは削除します。

• (1).TextMeshPro is very nice Plugin. If TextMeshPro add ruby tag well, delete my git project.

• (2).日本語以外のチェックはしていません。

• (2).Not checked anything other than Japanese

Contribution

すべての貢献を歓迎します。必ずプロジェクトのコードスタイルに従ってください。

All contributions are welcomed. Just make sure you follow the project's code style.

Contact: [email protected]

rubytextmeshpro's Issues

Error : TextMeshPro v2.1.1

RubyTextMeshProUGUI.cs : error CS0103: The name 'm_layoutAlreadyDirty' does not exist in the current context

Furigana not lining up with base text

First of all, thank you for the great asset!

I noticed that our furigana are not correctly aligning with the base text:

This could be from the font we're using (EPSON 教科書体Ｍ (epkyouka.ttf)).

Is there a way to correctly align the furigana?

Exception "StackOverflowException: The requested operation caused a stack overflow."

1. Open Sample "RubySampleScene4" Scene
2. Change RubyTextMeshPro Component Off and AutoSize Enable
3. Exception "StackOverflowException: The requested operation caused a stack overflow."

Issue with text alignment

I'm experiencing an issue with text alignment / centering, please see below's screenshots:

Here, the text is not aligned / not horizontally centered.

Here, the text is correctly aligned / horizontally centered (same TMP object).

This is in Unity 2021.3.28f1, TMP version 3.0.6 and the latest version of this plugin.

Furigana is misaligned when used with Autosize

When using the Auto Size feature of TMP, the Furigana seems to get misaligned.

Without Auto Size

With Auto Size

Small auto-sized text issue

When adding text to an auto-sized RubyTextMeshProUGUI (editor or programmatically), the furigana positions are not correctly updated:

At the end of the clip, you can see that the furigana position changes. This happens when manually editing the RubyTextMeshProUGUI UneditedText field in the editor (eg. by adding a space at the end):

Compared to this, when changing the max font size directly in the editor, the position updates correctly:

Let me know if you need any more details for this!

Dynamically setting the text won't replace Ruby tags

I recently tried changing the text of a RubyTextMeshProUGUI component to dynamically replace the Japanese text. Something like this:

this.japaneseText.text = "<ruby=ほん>本</ruby>

The expected behavior would be the text changing and properly parsing the ruby tags, but instead, it becomes the literal string "<ruby=ほん>本", without the ruby tags parsing.

I solved it by using the SetTextCustom method from RubyTextMeshProUGUI, but I had to change its visibility from private to public, so I was wondering if there's a better way to do this already in the package or if it's a bug.

Thanks for the great work with this package! 😄