octospacc/nekotsume-ime
1
0
Fork 0
mirror of https://gitlab.com/octospacc/nekotsume-ime.git synced 2024-12-11 06:05:28 +01:00
Code Issues Packages Projects Releases Wiki Activity
main
nekotsume-ime/README.md

2.9 KiB
Raw Permalink Blame History

nekotsume IME | ネコツメIME

nekotsume IME is an efficient and privacy-friendly Japanese IME for (almost) any website in your web browser. It works fully locally: what you type is never sent on the Internet and stays private. With this, it's also pretty fast, and the suggestions dictionary should be decent.

Install Firefox Extension

Usage

General:

  • You can toggle the IME to ON [あ] to enable conversion of for all standard text input fields (<input type="text"> and <textarea>) of the current window, and to OFF [A] to disable conversion and write normally.
  • When the IME is enabled, type lowecase latin letters to have them converted to hiragana characters. Press ENTER to accept a direct conversion, or press SPACE to show other options (kanji, etc.).

Browser Extension:

  • The IME can be toggled ON and OFF by clicking the extension button in your browser's toolbar (for your comfort, please pin it). A textual tooltip indicates the current status of the IME: [あ] with blue background when enabled, [A] with gray background when disabled.

Building from Source

The core code is not compiled and doesn't need to be. However, it uses open-source third-party dependencies that require their own build procedures for the following library files:

Require compilation, and can optionally be minified:

Don't require any compilation, but can optionally be minified:

To prepare the dependencies:

  1. You will need a POSIX-compliant shell and NodeJS on your build system, and this repository cloned
  2. Make sure to init Git submodules (or clone the above Git repositories in the lib/ directory)
  3. Manually follow the libraries' instructions to setup a build environment and complete the process
  4. Copy the respective built files to the paths specified above

Alternatively, if requirements are met, you can just run the build.sh script and it should perform all the steps automatically, including building a ZIP/XPI file for the WebExtension distribution.

Copyright Notice

nekotsume IME is forked and readapted to work as a Web Extension from IgoIME by shogo82148 (Ichinose Shogo): https://github.com/shogo82148/IgoIME. IgoIME is based on Ajax IME by taku (Taku Kudo).

They are not legally open-source, as Ajax IME is available only under the terms of: (C) Taku Kudo, all rights reserve rd. Personal use only!

nekotsume IME is only being distributed in good faith and in the spirit of the fair use doctrine, in the hopes that it can be useful, but without any warranty.