azooKey-Desktop

azooKey-Desktop

azooKey-Desktop is an open-source Japanese input method for macOS, written in Swift and powered by the Zenzai neural kana-kanji converter. It provides live conversion, optional LLM-based “Magic Conversions”, and Tuner-backed personalization for a smooth, desktop typing experience.

Stars: 532

Visit
 screenshot

azooKey-Desktop is an open-source Japanese input system for macOS that incorporates the high-precision neural kana-kanji conversion engine 'Zenzai'. It offers features such as neural kana-kanji conversion, profile prompt, history learning, user dictionary, integration with personal optimization system 'Tuner', 'nice feeling conversion' with LLM, live conversion, and native support for AZIK. The tool is currently in alpha version, and its operation is not guaranteed. Users can install it via `.pkg` file or Homebrew. Development contributions are welcome, and the project has received support from the Information-technology Promotion Agency, Japan (IPA) for the 2024 fiscal year's untapped IT human resources discovery and nurturing project.

README:

azooKey on macOS

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

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

動作環境

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

リリース版インストール

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

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

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

Install with Homebrew

または、Homebrewを用いてインストールすることもできます。

brew install azooKey

この場合も上記のログアウト・再ログイン後の設定は必要です。 アップグレードは以下のコマンドで実行できますが、再起動が必要になることがあります。

brew upgrade azooKey

コミュニティ

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

azooKey on macOSを支援する

GitHub Sponsorsをご利用ください。

機能

  • ニューラルかな漢字変換システム「Zenzai」による高精度な変換
    • プロフィールプロンプト機能
    • 履歴学習機能
    • ユーザ辞書機能
    • 個人最適化システム「Tuner」との連携機能
  • LLMによる「いい感じ変換」機能
  • ライブ変換
  • AZIKのネイティブサポート

開発ガイド

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

想定環境

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

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

まず、想定環境が整っていることを確認してください。 git-lfs のない状態では正しく clone できません。

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」を変更する必要がある場合があります
    • azooKeyMac.xcodeproj を Xcode で開く
    • azooKeyMac -> Signing & Capabilities から、 Team を Personal Team に変更する
    • リポジトリ内に存在する全てのバンドルID文字列を、適当な文字列に置換 (ex: dev.ensan.inputmethod.azooKeyMac -> dev.yourname.inputmethod.azooKeyMac)
  • 「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を配置してください。

v1.0リリースに向けて

meta: v1.0のリリースに向けたロードマップ(#181)をご覧ください.

Community Forks

@7ka-Hiira さんによるLinux系OS向けのクライアント実装です。

@fkunn1326 さんによるWindows向けクライアント実装です。

@gitusp さんによるSKKクライアント向けのSKKサーバ実装です。macOS向けGUIアプリケーションを含みます。

Reference

Thanks to authors!!

Acknowledgement

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

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for azooKey-Desktop

Similar Open Source Tools

For similar tasks

For similar jobs