Skip to content

Japanese Input Method "azooKey" for Desktop, supporting macOS

License

Notifications You must be signed in to change notification settings

ensan-hcl/azooKey-Desktop

Repository files navigation

azooKey on Desktop

iOSのキーボードアプリ「azooKey」のデスクトップ版です。

現在アルファ版のため、動作は一切保証できません

動作環境

macOS 14.3で動作確認しています。古いOSでの動作は検証していません。

リリース版インストール

Releasesから.pkgファイルをダウンロードして、インストールしてください。

その後、以下の手順で利用できます。

  • macOSからログアウトし、再ログイン
  • 「設定」>「キーボード」>「入力ソース」を編集>「+」ボタン>「日本語」>azooKeyを追加>完了
  • メニューバーアイコンからazooKeyを選択

コミュニティ

azooKey on macOSの開発に参加したい方、使い方に質問がある方、要望や不具合報告がある方は、ぜひazooKeyのDiscordサーバにご参加ください。

azooKey on macOSを支援する

GitHub Sponsorsをご利用ください。

機能

  • ニューラルかな漢字変換システム「Zenzai」による高精度な変換のサポート
  • iOSのキーボードアプリazooKeyと同レベルの日本語入力のサポート
  • ライブ変換のサポート
    • 設定メニューでのライブ変換の切り替え
  • 学習機能
  • ユーザ辞書機能
  • 「プロフィール付き変換」機能
  • .pkg形式のインストーラ

開発ガイド

コントリビュート歓迎です!!

想定環境

  • macOS 14+
  • Xcode 16+
  • Git LFS導入済み
  • SwiftLint導入済み

開発版のビルド・デバッグ

cloneする際には--recursiveをつけてサブモジュールまでローカルに落としてください。

git clone https://github.com/ensan-hcl/azooKey-Desktop --recursive

以下のスクリプトを用いて最新のコードをビルドしてください。.pkgによるインストールと同等になります。その後、上記の手順を行ってください。また、submoduleが更新されている場合は git submodule update --init を行ってください。

# submoduleを更新
git submodule update --init

# ビルド&インストール
./install.sh

開発中はazooKeyのプロセスをkillすることで最新版を反映することが出来ます。また、必要に応じて入力ソースからazooKeyを削除して再度追加する、macOSからログアウトして再ログインするなど、リセットが必要になる場合があります。

開発時のトラブルシューティング

install.shでビルドが成功しない場合、以下をご確認ください。

  • XcodeのGUI上で「Team ID」を変更する必要がある場合があります
  • 「Packages are not supported when using legacy build locations, but the current project has them enabled.」と表示される場合はhttps://qiita.com/glassmonkey/items/3e8203900b516878ff2cを参考に、Xcodeの設定をご確認ください

変換精度がリリース版に比べて悪いと感じた場合、以下をご確認ください。

  • Git LFSが導入されていない環境では、重みファイルがローカル環境に落とせていない場合があります。azooKeyMac/Resources/zenz-v2-gguf/zenz-v2-Q5_K_M.ggufが70MB程度のファイルとなっているかを確認してください

pkgファイルの作成

pkgbuild.shによって配布用のdmgファイルを作成できます。build/azooKeyMac.app としてDeveloper IDで署名済みの.appを配置してください。

TODO

  • 予測変換を表示する
  • CIを増やす
    • アルファ版を自動リリースする

Future Direction

  • WindowsとLinuxもサポートする

  • iOS版のazooKeyと学習や設定を同期する

Reference

Thanks to authors!!