自作のタイピングガンアクション「TypeGunner」から、日本語のローマ字入力を判定する部品を切り出して、godot-jp-typing としてGitHubで公開しました。Godot 4向け、MIT Licenseです。
使い方は README と別の記事にまとめたので、ここでは 10/21 から 10/24 までの作業を日記ふうに振り返ります。うまくいったこと、つまずいたことの記録です。
- 10/21: まずゲームの中で寄せる
- 10/24 昼: 別リポジトリへ移す
- 10/24 昼〜夕方: 公開前の整理
- 10/24 夜: 記事を書いていて見つけたもの
- 10/24 夜: 「ci」の顛末
- 振り返り
10/21: まずゲームの中で寄せる
いきなり別リポジトリに移すのはやめて、最初は TypeGunner の中で整理しました。
- タイピング関連のファイル(入力判定の Autoload、表示部品、キーボード表示、かな→ローマ字の変換表)を
addons/typing_core/に集める - そこからゲーム固有の Autoload やシーンを参照しないようにする
- 移動の前に、入力判定の回帰試験を書いておく
もうひとつ、出題語を選ぶ処理がストーリーのバトル・LastStand・ボーナスステージの3か所でそれぞれ書かれていたので、WordPicker.gd という1つの関数群にまとめました。抽選の結果が変わるとゲームの体感が変わってしまうので、旧実装と新実装で3000回選ばせて、結果が一致することを確かめてから置き換えています。
この段階で「ゲームの中にあるけれど、ゲームには依存していないフォルダ」ができたので、後の作業がずいぶん楽になりました。
10/24 昼: 別リポジトリへ移す
git subtree split で addons/typing_core の履歴ごと新しいリポジトリに移し、TypeGunner 側はそのフォルダを git submodule に置き換えました。
git submodule add https://github.com/Czmirror/godot-jp-typing.git addons/typing_core
つまずき: 手元の Mac で submodule が取れない
この時点ではまだリポジトリを非公開にしていたので、手元の Mac で git submodule update すると HTTPS のパスワード認証で失敗しました。GitHub はパスワードでの git 操作を受け付けていないためです。
submodule の URL を SSH に切り替えるか、gh auth setup-git で GitHub CLI の認証を git に使わせると解決します。今は公開したので、この問題は起きません。
# どちらか一方
git config submodule.addons/typing_core.url git@github.com:Czmirror/godot-jp-typing.git
gh auth setup-git
10/24 昼〜夕方: 公開前の整理
人に使ってもらうなら、ゲームの中にあったときの事情で書かれた部分を直しておきたいところです。公開前にコード全体を見直して、次のことをしました。
- かな→ローマ字の候補を作る処理を、入力判定の Autoload から
RomajiConverter.gdに分けた。状態を持たない部品なので、Autoload なしで試験できる - addon 単体で試験を回せる
tests/run_tests.shを用意した。一時フォルダに最小の Godot プロジェクトを作って走らせる - 「ん」の後ろのお手本表示がおかしくなる不具合を直した
- キーボード表示のキー配列を、コードから JSON に出した
- カタカナをそのまま登録できるようにし、「てぃ」「ゔぁ」のような外来語のかなを変換表に足した
- MIT License、英語の README、Godot のプラグインとして有効にできる
plugin.cfgを追加した
最後に v0.1.0 のタグを付けて、リポジトリを公開しました。
10/24 夜: 記事を書いていて見つけたもの
紹介記事を書くために、記事に載せるサンプルコードを実際に Godot で動かしていたところ、「きって」のお手本表示が kixtsute になっていることに気づきました。
原因は「っ」の候補の並び順です。お手本は候補の先頭を使って作るのですが、「っ」の候補は xtsu などの単独入力が先、次の子音を重ねる t が後ろに並んでいました。入力はどちらでも通るので、遊んでいるときには気づきにくい不具合です。並びを入れ替えて、kitte と表示されるようにしました。
ドキュメントを書くためにコードを動かすと、試験では見ていなかった角度から不具合が見つかるものですね。
10/24 夜: 「ci」の顛末
公開の告知で「『し』は si / shi / ci どれでもOK」と書いて投稿したあとで、変換表を見直すと「し」は shi と si だけでした。ci は入っていなかったのです。
投稿を訂正するか、部品のほうを投稿に合わせるか考えて、後者にしました。Windows の MS-IME では ci で「し」が打てるので、そちらに慣れている人にとっても自然な打ち方です。ちなみに「せ」の ce はもともと入っていました。
「っ」の修正と合わせて1つの PR にし、TypeGunner の submodule も更新して、v0.1.1 として出しました。
小さな反省: plugin.cfg のバージョン
v0.1.1 のタグを付けたあとで、plugin.cfg の version が 0.1.0 のままだったことに気づきました。動作には影響しませんが、Godot のプラグイン一覧には 0.1.0 と表示されます。次からは、plugin.cfg を先に上げてからタグを付けます。
振り返り
- 先にゲームの中で依存を断ってから移すのは正解でした。移す作業そのものはファイルを動かすだけで済みました
- リファクタの前後で結果を比べる(抽選を3000回比べる、など)と、安心して置き換えられます
- 公開すると、自分では見ていなかったところに目が行きます。記事のためにサンプルを動かしたことで、表示の不具合が見つかりました
- 書いたことと実装が食い違ったときは、どちらに合わせるのが使う人にとって自然かで決めればいい
TypeGunner はブラウザで遊べます。godot-jp-typing も、日本語タイピングのゲームを作るときに使ってもらえたらうれしいです。
- TypeGunner: https://unityroom.com/games/typegunner
- godot-jp-typing: https://github.com/Czmirror/godot-jp-typing



