LK Image Occlusion

A modified version of the Image Occlusion Enhanced Anki add-on by Glutanimate, made by LK and set up mainly for studying medicine. Everything about it is editable, so you can tailor it to your own subject and style.

Please read first

• This is an unofficial fork. It is not the original add-on and is not endorsed by, affiliated with, or supported by Glutanimate, the original authors, Anki, Ankitects or AnkiWeb. Do not contact them about problems with this version.
• It is provided "as is", without warranty of any kind, and the author accepts no liability for it. It has had limited testing, mostly on Windows with a recent version of Anki; macOS and Linux are untested.
• Back up your collection (File → Switch Profile → Backup, or Tools → Create Backup) before using it on a collection you care about.

What is different from the original

• Creates its own note type, LK-IO, with these 13 fields in this order: Id, Header, Image, Question Mask, Footer, Mnemonic, Extra, Lecture Notes, Source, AAMC QID, UWorld QID, Answer Mask, Original Mask
  • Mnemonic, Extra and Lecture Notes hold memory aids and explanations.
  • AAMC QID and UWorld QID hold the text of a linked practice question from those question banks. They are optional, and each shows as an expandable button on the card back only when filled.
  • Source holds one or more links, shown as link buttons.
• Default settings: question mask #9dbbd9, other masks #ffffff, label font Comfortaa, label size 20.
• Card back in a dark theme, with sections and buttons for the fields above. Empty fields show nothing.
• The options window saves its settings in current versions of Anki.
• Everything else (drawing editor, occlusion types, mask generation) works as in the original, and the image and mask layers sit on the card exactly as they do in the original.

If you want the original behavior and look, use the original add-on instead.

Make it your own

You are meant to adjust this to fit your subject:

• Rename fields (for example, change "AAMC QID" to "Practice Question"): Tools → LK Image Occlusion Options → Custom Field Names. Use that window rather than Anki's regular note type dialog.
• Change colors, label font and size, and which fields are hidden in the editor: the same options window.
• Change how the card looks (colors, fonts, spacing, buttons): Tools → Manage Note Types → LK-IO → Cards, then edit the Front Template, Back Template and Styling. Leave the occlusion layout part of the Styling (marked "OCCLUSION CSS") alone, because it keeps the mask exactly on top of the image.
• Change the defaults for new installs: edit config.py (settings and field names) and template.py (card layout) in the add-on folder. The source is included, and you are welcome to modify it under the license below.

Install

1. In Anki: Tools → Add-ons. If you have Image Occlusion Enhanced installed, select it and click Toggle Enabled to switch it off. Both add-ons must not be enabled together.
2. Click Install from file and choose LK-Image-Occlusion.ankiaddon.
3. Restart Anki.
4. In the Add window, click the I/O button in the editor toolbar (hotkey Ctrl+Shift+O). The LK-IO note type is created on first use.

Requires Anki 2.1.50 or newer. If an install or delete fails on Windows with "file is being used by another process", close Anki and start it again while holding Shift (safe mode), then try again.

Notes

• Font. The card styling uses the Comfortaa font. The add-on includes it and copies it into your media folder automatically (_Comfortaa-Regular.ttf and _Comfortaa-Bold.ttf), so cards use it on every device you sync to. The leading underscore stops Anki from deleting the files as unused. To also use Comfortaa as the label font in the drawing editor, install it on your computer (get it from https://fonts.google.com/specimen/Comfortaa). Text labels drawn inside masks are part of the mask images and use whatever fonts the device that shows the card has.
• Styling is stored in your note type. Later updates of this add-on do not change the styling of an existing LK-IO note type; edit it under Manage Note Types as described above.
• Existing image occlusion cards stay on their old note type. To move them, use Notes → Change Note Type in the browser and map the fields.
• Anki's built-in image occlusion feature is separate and unaffected.

License, credits and source

Licensed under the GNU Affero General Public License v3 with the original author's Additional Terms. See LICENSE.txt (must accompany every copy) and NOTICE.md (summary of changes and modification date). This package contains the complete source code. You may redistribute it under the same terms; keep LICENSE.txt, NOTICE.md and the file headers, mark your own changes, and do not present your version as the original.

The bundled Comfortaa font is copyright 2011 The Comfortaa Project Authors, licensed under the SIL Open Font License 1.1 (fonts/OFL.txt).

Credits: Image Occlusion Enhanced by Aristotelis P. (Glutanimate), based on work by Tiago Barroso and Steve AW. Fork by LK. Includes SVG-Edit (MIT license), imagesize (MIT license) and other third-party components described in the About dialog. Original project: https://github.com/glutanimate/image-occlusion-enhanced