Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Add-ons

Applies to: iPhone/iPad, Android native, Android Termux

Kioku runs Anki desktop’s add-ons. Install them as on a computer: Tools › Add-ons › Get Add-ons…, enter the add-on’s code from AnkiWeb, and restart Kioku. See Anki: Add-ons.

.ankiaddon files can be installed with Install from file… in the same window.

What works

On the native apps (iPhone, Android) add-ons work unless they need one of:

  • starting another program (iOS forbids it; on Android there is nothing to start). Example: MeCab readings in Japanese Support.
  • Qt WebEngine features, such as AnkiWebView Inspector. Use Safari’s Web Inspector or chrome://inspect instead.
  • Native libraries built for Windows, macOS or Linux PCs.

On the Termux variant, add-ons behave as on Linux.

Add-ons that other apps connect to (iPhone, iPad)

Applies to: iPhone and iPad

Some add-ons answer requests from other apps. AnkiConnect is the best known: dictionary and reader apps (Yomitan, Hoshi Reader and others) send it new cards at http://127.0.0.1:8765.

iOS pauses an app a few seconds after you leave it, and a paused app answers nothing. The other app then waits, or shows “can’t connect” or a spinner that never stops. On Android this doesn’t happen.

To keep such add-ons answering, turn on Preferences › Advanced › Background › Keep running in the background:

  1. Tick Keep running in the background, read the note and choose Yes.
  2. iOS asks whether Kioku may use your location: choose Allow While Using the App, and leave Precise off (iOS’s default for Kioku). Location is only the means, see below.
  3. The group shows On: Kioku keeps running in the background. Now switch to the other app.

When Kioku goes to the background, iOS shows the location arrow at the top of the screen; with approximate location it can disappear after a while, and Kioku keeps running. It keeps running, with the screen locked too, until you turn the option off or close Kioku from the app switcher.

Why location? iOS lets an app keep running in the background only for a few purposes: playing audio, navigation, calls and a few others. Location updates are the one that fits a server best; terminal apps such as Termius use them to keep connections open the same way.

Your location is not collected. Kioku asks iOS for the lowest accuracy it offers (about 3 km, from cell towers and Wi-Fi, without GPS) and ignores what it receives: the location isn’t read, saved, shown or sent anywhere. See the privacy policy.

Add-ons and location. iOS gives location access to the whole app, and add-ons are programs that run inside Kioku. Kioku protects your location from them:

  • Only Kioku’s own location request works. When an add-on, or a web page in a card or add-on window, asks iOS for location access or for locations, it gets nothing, and no permission prompt appears.
  • iOS gives Kioku approximate location (several kilometres) unless you turn Precise on in the Settings app. Leave it off: the option works without it.
  • Kioku never asks for Always access, and add-ons can’t ask for it.

An add-on written on purpose to get around these protections could still read your approximate location while access is allowed, since it runs inside Kioku. Install only add-ons you trust, as on a computer.

Turning it off. Untick the option and Kioku stops using location at once. iOS keeps the permission until you take it back: the Settings app › Apps › Kioku › Location › Never. The group reminds you of this while access is still allowed.

Battery: at this accuracy iOS uses no GPS and wakes Kioku rarely, but an app that stays running uses more battery than a paused one, especially if an add-on keeps working in the background. Turn the option off when you don’t need it.

If you chose Don’t Allow, the group says that location access is off: turn it on in the Settings app › Apps › Kioku › Location › While Using the App.

Extra files for add-ons

Applies to: iPhone/iPad, Android native

To keep the app small, some files that only a few add-ons use aren’t part of the app. Kioku downloads them when an add-on needs them:

Extra filesSizeFor add-ons that
Chinese word segmentation (jieba)5 MBsplit Chinese text into words
Code highlighting (Pygments)1 MBcolor source code
Text recognition languages (Tesseract)10 MBread text from images (OCR)
Speech voices (eSpeak NG)9 MBspeak with eSpeak
  • When you install an add-on that needs some, or start Kioku with one installed, Kioku asks whether to download them. Downloading runs in the background: keep using Kioku. If an add-on that loaded before the download still can’t find them, restart Kioku.
  • Tools › Add-ons › Extra Files… lists them: select an add-on first to see what it needs. Download, update or remove them there; removing frees the space until an add-on needs them again.
  • If you choose Not now, Kioku doesn’t ask again at start-up. It asks again when you install an add-on that needs them.

The files come from the Kioku repository on GitHub.

Tested

All load on iPhone and Android:

Add-onCodeResult
AnkiConnect2055492159works (HTTP API on 127.0.0.1:8765)
Review Heatmap1771074083works; slightly wider than a phone screen
Anki Simulator817108664opens
AnKing Note Types Easy Customization952691989works
Advanced Browser874215009loads
Fill the blanks1933645497loads
Colorful Tags / Hierarchical Tags594329229works
Customize Keyboard Shortcuts24411424loads
Edit Field During Review Cloze385888438works
Speed Focus Mode1046608507loads
True Retention613684242works
HyperTTS111623432works on Android
Color Confirmation1084228676works
Japanese Support3918629684Kanji Stats works; MeCab readings don’t
AnkiWebView Inspector31746032doesn’t work (needs Qt WebEngine)

Full results: docs/testing.md.

A broken add-on

If Kioku fails at start-up after installing an add-on:

  • Termux: use Safe mode on the error screen, then remove the add-on.
  • iPhone, iPad: delete the add-on’s folder in Files › Kioku › Anki2/addons21/ (Tools › Add-ons shows each add-on’s folder name).
  • Android, native: if Kioku still opens, disable the add-on in Tools › Add-ons. Otherwise open an issue on GitHub: reinstalling keeps the add-on.

Report add-ons that work or don’t on GitHub.