メインコンテンツまでスキップ

インストール

IwashiIMEは UnityPackage 形式で配布しています。 Unityプロジェクトへインポートするだけで、すぐに使い始めることができます。

導入に関するご注意

現在、VCC (VRChat Creator Companion) 経由での自動インストールには対応しておりません。 手動でのパッケージ導入をお願いいたします。

事前準備:依存アセットの導入​

IwashiIMEを正常に動作させるため、あらかじめ以下の 2つのアセット の導入が必要です。

重要

IwashiIMEは、内部処理およびフォント表示において以下の外部アセットに依存しています。 本アセットをインポートする前に、必ずこれらをプロジェクトへ追加しておいてください。

1. GenericDataContainer​

Udon 標準の DataList や DataDictionary に対する、型安全なラッパーライブラリ(DataList<T> や DataDictionary<K,V>)です。
IwashiIME の内部処理で、データを安全かつ効率的に管理するために必須となります。
詳細な導入方法や最新バージョンについては、以下の配布元ページをご確認ください。

GenericDataContainer - GitHub リポジトリ

👉 koyashiro's vpm - インストール

2. TextMesh Pro VRC Fallback Font JP​

VRChat クライアントに内蔵されている日本語フォント を TextMesh Pro から参照・利用するためのフォントアセットです。
これを使用することで、数MBにもなる重たい日本語フォントファイルをワールドに同梱する必要がなくなり、アセット容量を大幅に削減 しつつ正しい日本語表示が可能になります。

👉 TextMesh Pro VRC Fallback Font JP - GitHub リポジトリ


UnityPackage を入手する​

BOOTH から Iwashiime-<version>.unitypackage をダウンロードしてください。

👉 BOOTH 商品ページ


UnityPackage のインポート​

ダウンロードしたパッケージをプロジェクトに取り込みます。

  1. プロジェクトの準備:Unity で IwashiIME を使用したいプロジェクトを開きます。
  2. パッケージの選択:メニューの Assets > Import Package > Custom Package... を開きます。
  3. ファイルの読み込み:入手した Iwashiime-*.unitypackage を選択してください。
  4. インポートの実行:内容一覧が表示されるので、そのまま Import をクリックして完了です。

メンテナンス(更新・削除)​

最新版へのアップデート​

不具合修正や機能追加を含む新しいバージョンへ更新する手順です。

  1. 旧バージョンの整理:安全のため、既存の Assets/IwashiAssets/Iwashiime フォルダを一度削除します。
  2. 新バージョンの導入:最新の UnityPackage をダウンロードし、再度インポートを行ってください。

カスタムデータの保護について

Assets/IwashiimeAsset フォルダには、ユーザーが作成した オリジナルのキーボード配列(プレハブ) や、カスタムテーマが保存されます。 アップデート時にこのフォルダを削除してしまうと、作り込んだ独自のキーボード設定が失われるためご注意ください。

アセットの削除​

プロジェクトから IwashiIME を完全に除去する場合は、以下のフォルダを削除してください。

  • Assets/IwashiAssets/Iwashiime
  • Assets/IwashiimeAsset (作成したカスタム配列やテーマが不要な場合のみ)

困ったときは​

インポート直後にエラーが発生する場合​

依存アセットが不足している可能性が高いです。

  • 「事前準備」のセクションを参考に、GenericDataContainer および Fallback Font が正しく導入されているか確認してください。
  • Unity の Package Manager を開き、該当アセットがインストールされているかチェックをお願いします。

動作環境の確認​

IwashiIME は以下の環境での動作を前提に設計されています。

  • Unity: 2022.3.22f1 以降
  • VRChat SDK: VRCSDK3-WORLD 3.10.1 以降
  • GenericDataContainer: 0.2.2 以降
  • TextMesh Pro VRC Fallback Font JP: 1.0.2
バージョンに関するポリシー

上記より古い環境でも動作する可能性はありますが、予期せぬ挙動を避けるため、上記以降の SDK 環境での利用を強く推奨しています。