<img src=".github/_migaku-logo-with-text.png" alt="Migaku Logo" width="200px"/>

<p> <a title="Rate on AnkiWeb" href="https://ankiweb.net/shared/info/1872210448"><img src="https://glutanimate.com/logos/ankiweb-rate.svg"></a> <a title="Support Migaku on Patreon" href="https://www.patreon.com/Migaku"> <img src="https://img.shields.io/badge/patreon-support-orange.svg"> </a> <a title="Subscribe to Immerse with Migaku" href="https://www.youtube.com/channel/UCQFe3x4WAgm7joN5daMm5Ew"> <img src="https://img.shields.io/badge/YouTube-Immerse%20with%20Migaku-red"> </a> <a title="Follow Migaku on Twitter" href="https://twitter.com/MigakuOfficial"> <img src="https://img.shields.io/badge/Twitter-Immerse%20with%20Migaku-blue"> </a> <a title="License: GNU AGPLv3" href="https://github.com/migaku-official/Migaku-Japanese-Addon/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-GNU AGPLv3-green.svg"></a> </p>

Migaku Kanji GOD Anki Addon

Learn kanji within the context of the vocab in your Anki collection. Includes kanji metadata (mnemonic stories, component part primitives/radicals), a kanji lookup browser for quick references, and note types for both production (writing) and recognition. And more.

<p> <img src=".github/_recognition-back-dark.png" alt="Recognition note type (back, dark mode)" width="250px"/> <img src=".github/_recognition-back-light.png" alt="Recognition note type (back, light mode)" width="250px"/> </p>

Installation

More details, and the installation code can be found on AnkiWeb. IF you want to get straight to the point - you can install the addon via the Anki menu Tools > Add-ons > "Get add-ons" button > type in 1872210448.

Main releases and updates are managed via AnkiWeb, and so your addon will automatically prompt you for updates.

For alpha and beta releases, you can install these directly via the releases page, downloading and opening the *.ankiaddon file. No special measures are required for the retention of your user data, you can simply install it over your existing addon.

User guide

A video guide is available on YouTube.

Questions, support, issues

If you have questions or are having difficulties setting up the addon, you can talk with us directly on the Migaku Discord server (available to Patreon supporters) in the #migaku-kanji-god channel. There is also a long channel history there you can search through for common questions.

To report bugs or request features, you can do so here by opening an Issue on GitHub. Please search issues (both open and closed) to see if your bug/feature already has an issue open for it. Voicing support for features you want to see will help us prioritise what will make it into the next release.

You can also:

• Ask questions or search in the the ImmerseWithMigaku subreddit.
• Request support from Migaku Staff via this Google Form.

Roadmap

You can have a look at the planned features we have for the next few releases here. Click on the version candidate title to see the GitHub issues assigned to it.

Note that we have a dedicated someday, maybe milestone where we archive long-term or uncertain plans. We keep these issues closed so long as we have no immediate plans to work on them in the foreseeable roadmap. However, if you feel strongly about a feature we encourage you to comment on the issue or give it a thumbs-up.

Changelog

If you'd like to see what has changed with each release, you can view our detailed changelogs:

• Main changelog.
• Detailed templates changelog
  • (development detail about the UI).

Contributing

Contributions of all kinds are welcome - please read the contribution guidelines (CONTRIBUTING.md) before submitting any issues or pull requests.

Development

Before diving into the code, make sure you read the development documentation (DEVELOPMENT.md) to learn how this repository is structured.

License

Migaku Kanji GOD is Copyright © 2022 Migaku Ltd.

Migaku Kanji GOD is free and open-source software. The add-on code that runs within Anki is released under the GNU GPLv3 license. For more information please see the LICENSE file that accompanied this program.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.