Skip to content

Japanese Input Method "azooKey" for Desktop, supporting macOS

License

Notifications You must be signed in to change notification settings

azooKey/azooKey-Desktop

Folders and files

NameName
Last commit message
Last commit date
Aug 4, 2024
Mar 8, 2025
Mar 15, 2025
Mar 18, 2024
Mar 18, 2024
Mar 21, 2024
Mar 24, 2024
Feb 8, 2025
Nov 30, 2024
Feb 14, 2025
Feb 14, 2025
Mar 24, 2024
Sep 16, 2024
Mar 24, 2024
Aug 25, 2024

Repository files navigation

azooKey on macOS

azooKeyのmacOS版です。高精度なニューラルかな漢字変換エンジン「Zenzai」を導入した、オープンソースの日本語入力システムです。

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

動作環境

macOS 14とmacOS 15で動作確認しています。macOS 13でも利用できますが、動作は検証していません。

リリース版インストール

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

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

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

コミュニティ

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

azooKey on macOSを支援する

GitHub Sponsorsをご利用ください。

機能

  • ニューラルかな漢字変換システム「Zenzai」による高精度な変換

    • プロフィールプロンプト機能
    • 履歴学習機能
    • ユーザ辞書機能
    • 個人最適化システム「Tuner」との連携機能
  • ライブ変換

  • LLMによる「いい感じ変換」機能

  • その他の

開発ガイド

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

想定環境

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

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

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

git clone https://github.com/azooKey/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が導入されていない環境では、重みファイルがローカル環境に落とせていない場合があります。azooKey-Desktop/azooKeyMac/Resources/zenz-v3-small-gguf/ggml-model-Q5_K_M.ggufが70MB程度のファイルとなっているかを確認してください

pkgファイルの作成

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

TODO

  • 予測変換を表示する
  • CIを増やす
    • アルファ版を自動リリースする
  • 「いい感じ変換」の改良
  • 「Tuner」との相互運用性の向上

Future Direction

  • WindowsとLinuxもサポートする

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

Reference

Thanks to authors!!

Acknowledgement

本プロジェクトは情報処理推進機構(IPA)による2024年度未踏IT人材発掘・育成事業の支援を受けて開発を行いました。