anki-flashcards-koreader

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #go #android #machine-learning #docker #macos #nodejs #windows #kubernetes #vue #security #mcp

anki-flashcards-koreader

(★ 12)

A KOReader plugin that generates AI-powered Anki flashcards from highlighted text on your Kobo e-reader. Highlight a phrase, tap Anki Card, and get a full flashcard—definition, IPA, synonyms, cloze sentence, and an anime-style image—generated by Qwen and sent directly to Anki.

anki-flashcards-koreader 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# AnkiFlashcards KOReader Plugin

A KOReader plugin that generates AI-powered Anki flashcards from highlighted text on your Kobo e-reader. Highlight a phrase, tap **Anki Card**, and get a full flashcard—definition, IPA, synonyms, cloze sentence, and an anime-style image—generated by AI and sent directly to Anki.

## Features

- **One-tap card generation** — highlight any word, phrase, idiom, or phrasal verb and generate a complete Anki card in seconds
- **Context-aware definitions** — the AI sees the surrounding sentence, so definitions reflect how the phrase is actually used
- **Multi-language support** — generate cards in any language (English, Spanish, French, German, Japanese, etc.) with language-appropriate pronunciation notation (IPA, pinyin, romaji)
- **Full card content** — canonical phrase (normalized to base form), pronunciation, definition, synonyms, cloze sentence, and AI-generated image
- **My Cards** — browse all saved cards on-device, filter by book, tap to review, hold to send or delete
- **Anki Manage** — bulk send unsent cards, stats by book, batch import from all highlights in a book
- **AnkiConnect integration** — send cards directly to Anki over Wi-Fi, synced to all your devices
- **Quick Lookup on purple highlights** — tap any purple highlight to see a styled popup with IPA and definition (no full card needed). Saved to the annotation for instant offline access on subsequent taps
- **Cloud Sync** — sync cards across multiple Kobo devices via Dropbox or WebDAV using KOReader's built-in SyncService
- **Optional TTS audio** — ElevenLabs text-to-speech generates pronunciation audio attached to each card for playback during Anki review

## Compatibility

Developed and tested on a **Kobo Libra Colour** and a **Kindle** running KOReader. Since it uses only standard KOReader APIs, it should work on any device that runs KOReader (other Kobo models, PocketBook, Android, etc.).

## Requirements

- A Kobo e-reader running [KOReader](https://github.com/koreader/koreader)
- A [DashScope API key](https://www.alibabacloud.com/help/en/model-studio/get-api-key) (Qwen) — required for card text generation
- [AnkiConnect](https://ankiweb.net/shared/info/2055492159) add-on installed in Anki (for sending cards)
- The **English** note type in Anki (see [Note Type](#note-type) below)
- *(Optional)* A [Gemini API key](https://aistudio.google.com/apikey) for text/image generation via Google Gemini Flash
- *(Optional)* An [OpenAI API key](https://platform.openai.com/api-keys) for text (GPT-4o-mini) and image (GPT Image) generation
- *(Optional)* An [AnkiVocab API key](https://ankivocab.com/) for server-side card generation (text + image + audio in one call)
- *(Optional)* An [ElevenLabs API key](https://elevenlabs.io/) for TTS audio on cards

## AI Providers

The plugin supports multiple AI providers for both text and image generation. You can mix providers — e.g. use Gemini for text and DashScope for images.

### Qwen via DashScope (default)

DashScope is the default provider for both text and image generation.

To get an API key:

1. Sign up at [Alibaba Cloud Model Studio](https://modelstudio.alibabacloud.com/)
2. Follow the [Get an API key](https://www.alibabacloud.com/help/en/model-studio/get-api-key) guide — create a key for your region (Singapore, US Virginia, or China Beijing)
3. Paste it into `configuration.lua` as `dashscope_api_key`

The default model is `qwen-plus`. For better quality you can use `qwen-max`; for faster/cheaper responses, `qwen-turbo`.

### Cost Estimate

The plugin uses two DashScope APIs: **qwen-plus** for text and **qwen-image-plus** for images. Image generation dominates the cost — text is essentially free.

| Operation | Cost |
|-----------|------|
| Card generation (text + image) | ~$0.03 |
| Regen sentence (+ new image) | ~$0.03 |
| Regen image only | $0.03 |
| Full card regenerate | ~$0.03 |
| IPA regen / phrase edit | <$0.001 |

| Cards per month | Estimated cost |
|-----------------|---------------|
| 10 | ~$0.30 |
| 50 | ~$1.50 |
| 100 | ~$3.00 |
| 300 | ~$9.00 |

> Prices based on [DashScope international pricing](https://www.alibabacloud.com/help/en/model-studio/model-pricing) (Singapore region): qwen-plus at $0.40/$1.20 per 1M input/output tokens, qwen-image-plus at $0.03/image.

### Google Gemini Flash (alternative)

[Gemini 2.5 Flash](https://ai.google.dev/gemini-api) can be used for both text and image generation. A single API key covers both. Text generation on the free tier is generous (~500 RPD); image generation requires billing.

To set up:

1. Get an API key at [Google AI Studio](https://aistudio.google.com/apikey)
2. On the Kobo, go to **Anki Settings → Gemini API Key** and paste your key
3. Switch **Text Provider** to `gemini` and/or **Image Provider** to `gemini`

### OpenAI (alternative — text + image)

[OpenAI](https://openai.com/) provides GPT-4o-mini for text generation and GPT Image / DALL-E for image generation. A single API key covers both.

To set up:

1. Get an API key at [platform.openai.com/api-keys](https://platform.openai.com/api-keys)
2. On the Kobo, go to **Anki Settings → API Keys → OpenAI** and paste your key
3. Switch **Text Provider** to `openai` and/or **Image Provider** to `openai`

### OpenRouter (alternative — text only)

[OpenRouter](https://openrouter.ai/) is an API gateway that gives access to hundreds of models (Claude, GPT-4, Llama, Mistral, Gemma, etc.) through a single API key. Text generation only — pair with an image provider.

To set up:

1. Get an API key at [openrouter.ai/keys](https://openrouter.ai/keys)
2. On the Kobo, go to **Anki Settings → OpenRouter API Key** and paste your key
3. Switch **Text Provider** to `openrouter`
4. Optionally set the model in `configuration.lua` via `openrouter_model` (default: `anthropic/claude-haiku`). Browse models at [openrouter.ai/models](https://openrouter.ai/models)

### AnkiVocab Gateway (alternative — text + image + audio)

[AnkiVocab](https://ankivocab.com/) is a dedicated flashcard generation API that handles text, image, and audio generation server-side in a single request. No need to configure multiple providers — one API key covers everything.

To set up:

1. Get an API key at [ankivocab.com](https://ankivocab.com/)
2. On the Kobo, go to **Anki Settings → AnkiVocab Gateway** and paste your URL and API key
3. Switch **Text Provider** to `ankivocab`
4. Optionally switch **Image Provider** to `ankivocab` to use server-generated images

You can check your remaining credits on-device via **Anki Settings → AnkiVocab Gateway → Check Credits**.

## Multi-Language Support

The plugin supports any language the AI model can handle. By default it generates English flashcards, but you can change the target language on-device via **Anki Settings → Language**.

When set to a non-English language:
- **Definitions** are generated in the target language using simple vocabulary
- **Pronunciation** adapts automatically: IPA for European languages, pinyin for Mandarin, romaji for Japanese
- **Synonyms** and **cloze sentences** are in the target language
- **Cambridge Dictionary URL** is skipped (only available for English)

Supported languages include: English, Spanish, French, German, Italian, Portuguese, Chinese, Japanese, Korean, Russian, Arabic, and any other language the AI provider supports.

## Installation

1. Copy the `AnkiFlashcards.koplugin/` folder to your Kobo's plugin directory:
   ```
   /mnt/onboard/.adds/koreader/plugins/
   ```
2. Copy `configuration.lua.sample` to `configuration.lua` and fill in your credentials:
   ```lua
   local CONFIGURATION = {
       dashscope_api_key = "YOUR_DASHSCOPE_API_KEY",
       provider          = "https://dashscope-intl.aliyuncs.com/compatible-mode/v1/chat/completions",
       model             = "qwen-plus",

-- Optional: ElevenLabs TTS audio
       elevenlabs_api_key  = "YOUR_ELEVENLABS_API_KEY",
       elevenlabs_voice_id = "JBFqnCBsd6RMkjVDRZzb",  -- Rachel (default)
       tts_enabled         = false,

anki = {
           url   = "http://YOUR_HOST_IP:8765",  -- LAN IP of the device running Anki
           deck  = "English::Koreader",
           model = "English",
           tags  = { "KOReader" },
       },
   }
   return CONFIGURATION
   ```
3. Restart KOReader.

> **AnkiConnect URL**: The Kobo cannot reach `localhost` — you must use the LAN IP of the device running Anki (e.g. `192.168.1.100`). Find it in your system's network settings.

## Usage

1. Open a book and long-press on any word or phrase to highlight it
2. Tap **Anki Card** in the highlight dialog
3. Wait a few seconds — the flashcard appears with definition, synonyms, and cloze sentence
4. Tap **Save** to store the card on-device, or **Send to Anki** to push it directly
5. Access all saved cards via **My Cards** at any time
6. Tap any highlight that has a saved card to instantly review it

> **Tip:** If you have **"Dictionary on single word selection"** enabled in KOReader, selecting a single word will open the dictionary instead of the highlight menu. Disable it in **Settings → Taps and Gestures → Dictionary** so single-word selections go straight to the highlight menu with the Anki Card option.

## Note Type

The plugin uses an Anki note type named **English** with the following fields:

| Field | Content |
|-------|---------|
| `Phrase` | Canonical form of the phrase (base/infinitive, lowercase) |
| `IPA` | American English IPA notation |
| `Definition` | Context-aware definition (up to 20 words) |
| `Synonyms` | Up to 3 synonyms, comma-separated |
| `Text` | Cloze example sentence using `{{c1::...}}` |
| `Source` | Cambridge Dictionary URL for the phrase |
| `ImageFront` | AI-generated anime-style illustration (front) |
| `ImageBack` | AI-generated anime-style illustration (back) |
| `Sound` | TTS audio pronunciation (optional, requires ElevenLabs) |

Create the note type in Anki (**Tools → Manage Note Types → Add**) with the fields listed above before sending cards for the first time.

## TTS Audio (ElevenLabs)

The plugin can optionally generate text-to-speech audio for each card using [ElevenLabs](https://elevenlabs.io/). Audio is generated at send-time and attached to the Anki card's `Sound` field for playback during review on your phone or laptop. Audio cannot be played in KOReader (at least on Kobo).

The audio says: *"phrase ... example sentence"* (with the cloze revealed).

### Setup

1. Get an API key at [elevenlabs.io](https://elevenlabs.io/)
2. Add `elevenlabs_api_key` to your `configuration.lua` on the device
3. Enable TTS on-device: **Anki Manage → Anki Settings → TTS Audio (ElevenLabs): ON**
4. Optionally change the voice ID in **Anki Settings → ElevenLabs Voice ID**

The default voice is **Rachel** (`JBFqnCBsd6RMkjVDRZzb`). Browse available voices at [elevenlabs.io/voice-library](https://elevenlabs.io/voice-library).

### Cost Estimate

ElevenLabs charges per character. A typical card generates ~100–200 characters of speech.

| Cards per month | Estimated cost |
|-----------------|---------------|
| 10 | ~$0.01 |
| 50 | ~$0.05 |
| 100 | ~$0.10 |

> The free tier includes 10,000 characters/month (~50–100 cards).

## Provider Summary

Switch providers on-device via **Anki Settings** — Text Provider and Image Provider can be set independently.

| Provider | Text | Image | Cost (text) | Cost (image) | Image Speed | API Key |
|----------|:----:|:-----:|-------------|-------------|-------------|---------|
| **DashScope** (default) | yes | yes | ~free | ~$0.03/image | ~10-15s | Required |
| **Gemini Flash** | yes | yes | ~free (free tier) | $0.039/image | ~5-10s | Required |
| **OpenAI** | yes | yes | ~$0.01/card | $0.005–0.05/image | ~20-40s | Required |
| **OpenRouter** | yes | - | varies by model | - | - | Required |
| **AnkiVocab Gateway** | yes | yes | credit-based | credit-based | ~5-10s | Required |
| **Pollinations** | - | yes | - | Free | unreliable | None |

> **Tip:** You can mix providers — e.g. use OpenAI for text and Gemini for images to get the best speed/cost trade-off.

### Setting up Pollinations

No setup needed — just switch **Image Provider** to `pollinations`. No API key required. Note that the Pollinations API can be unreliable at times.

## Configuration via Settings UI

You can set the Anki URL, deck, tags, text/image providers, API keys, and TTS settings directly on the device without editing `configuration.lua`: long-press any text → **Anki Manage** → **Anki Settings**.

## License

This project is licensed under the [MIT License](LICENSE). You are free to use, copy, modify, distribute, sublicense, and sell the software, provided that you include the copyright and license notice in copies or substantial portions of it.

anki-flashcards-koreader

anki-flashcards-koreader 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

anki-flashcards-koreader

anki-flashcards-koreader 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README