https://github.com/nuskey8/romajihelper
Japanese Romanization parser for typing games in .NET / Unity
https://github.com/nuskey8/romajihelper
dotnet romaji unity
Last synced: about 12 hours ago
JSON representation
Japanese Romanization parser for typing games in .NET / Unity
- Host: GitHub
- URL: https://github.com/nuskey8/romajihelper
- Owner: nuskey8
- License: mit
- Created: 2026-05-02T12:33:28.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-09T06:09:50.000Z (about 2 months ago)
- Last Synced: 2026-07-06T19:04:27.504Z (1 day ago)
- Topics: dotnet, romaji, unity
- Language: C#
- Homepage:
- Size: 244 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RomajiHelper
Japanese Romanization parser for typing games in .NET / Unity
## 概要
RomajiHelperは.NET / Unity向けのローマ字解析ライブラリです。ひらがな/カタカナの入力から有向非巡回グラフ(DAG)を作成し、ローマ字の入力として有効なパターンを取得できます。
各ノードがアルファベットに対応するため、ノードを辿ることで入力先の候補を容易にチェックできます。これを用いることで、タイピングゲームの入力判定などを容易に実装することが可能になります。
## インストール
### .NET CLI
```bash
$ dotnet add RomajiHelper
```
### Unity
[NuGetForUnity](https://github.com/GlitchEnzo/NuGetForUnity)を利用してNuGetからRomajiHelperをインストールします。
## コンセプト
ローマ字入力を扱うには、「し」に対する`si`、`shi`や「きゃ」に対する`kya`、`kixya`, `kilya`など、同一の仮名に対して複数のパターンを考慮する必要があります。これは各アルファベットをノードとして、以下のような有向非巡回グラフ(DAG)で表現することが可能です。
RomajiHelperはひらがな/カタカナの文字列を入力として上のようなグラフを構築する機能を提供します。
## 使い方
```cs
using RomajiHelper;
var node = RomajiNode.Parse("きょうはいいてんきですね");
// 現在のnodeから全ての有効なローマ字のパターンを列挙する
foreach (var pattern in node.Patterns())
{
Console.WriteLine(pattern);
}
// 単一のパターンのみを取得する
var first = node.FirstPattern();
// nodeを順にたどって解析する
// Rootのノードは対応する文字を持たないことに注意
var currentNode = node;
foreach (currentNode.IsTerminal) // ノードの終了判定
{
var key = Console.ReadKey().KeyChar;
foreach (var nextNode in node.Nodes)
{
if (nextNode.Character == key) // ノードのアルファベットと比較
{
node = nextNode;
break;
}
}
}
```
## ライセンス
このライブラリは[MITライセンス](LICENSE)の下で公開されています。