anki-connect/README.md

30 lines
1.4 KiB
Markdown
Raw Normal View History

2016-09-07 04:15:55 +00:00
# AnkiConnect #
2016-05-30 02:59:21 +00:00
2016-07-07 03:48:10 +00:00
The AnkiConnect plugin enables external applications such as [Yomichan for Chrome](https://foosoft.net/projects/yomichan-chrome/) to
2016-07-05 03:24:53 +00:00
communicate with Anki over a remote API. This makes it possible to execute queries against the user's card deck,
automatically create new vocabulary and Kanji flash cards, and more.
2016-05-30 02:59:21 +00:00
2016-07-07 03:48:10 +00:00
## Requirements ##
2016-07-05 03:24:53 +00:00
* [Anki](http://ankisrs.net/)
2016-05-30 02:59:21 +00:00
## Installation ##
AnkiConnect can be downloaded from its [Anki shared addon page](https://ankiweb.net/shared/info/2055492159) or enabled
2016-07-03 02:46:01 +00:00
through the [Yomichan](https://foosoft.net/projects/yomichan) plugin if you have it installed. Once AnkiConnect is installed it is ready
2016-07-05 03:24:53 +00:00
for use; no further configuration is required. Windows users may have to take additional steps to make Windows Firewall
allows AnkiConnect to listen for incoming connections on TCP port 8765.
2016-07-03 02:46:01 +00:00
2017-01-28 20:20:38 +00:00
## Limitations on Mac OS X ##
While it is possible to use this plugin on this operating system, there is a known issue in which it is required that
the Anki application window to be on screen for card creation to work properly. The cause is apparently that Mac OS X
suspends graphical applications running in the background, thus preventing Anki from responding to Yomichan queries.
Until this problem is resolved, users of this Mac OS X will have to keep both the browser window and Anki on-screen.
Sorry for the lameness; I am researching a fix for this issue.
2016-07-03 02:46:01 +00:00
## License ##
GPL