diff --git a/.gitattributes b/.gitattributes
index c9ca18b9..4c251bbb 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -4,11 +4,8 @@
.github export-ignore
docs export-ignore
screenshots export-ignore
-# Adjust GitHub linguist settings:
-ANKIWEB.md linguist-documentation
-README.md linguist-documentation
-# Adjust GitHub linguist settings:
-image_occlusion_enhanced/svg-edit/* linguist-vendored
-image_occlusion_enhanced/Imaging/* linguist-vendored
-image_occlusion_enhanced/imagesize/* linguist-vendored
-tools/fixiocards/* linguist-vendored
+addon.json export-ignore
+# Adjust GitHub linguist settings
+## Vendored
+src/*/libaddon linguist-vendored
+src/*/_vendor linguist-vendored
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 00000000..6deffc7d
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+
+patreon: glutanimate
+ko_fi: glutanimate
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 1fe68eb8..00000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-## Prerequisite checklist
-
-* [ ] In case of a bug: Have you tried restarting Anki?
-* [ ] Are you running the latest version of the add-on. Have you redownloaded the add-on from AnkiWeb to make sure?
-* [ ] Did you check the add-on documentation (e.g. AnkiWeb description, Wiki if it exists) for known issues?
-* [ ] Did you perform a cursory search through the existing issue reports?
-
-## What is the problem/feature you would like to see fixed/implemented?
-
-[Be as specific as possible. Provide screenshots if you think they can help.]
-
-## How can we reproduce the problem?
-
-[What were you doing when the problem occurred?]
-
-1. [First step]
-2. [Second step]
-3. [and so on...]
-
-**Expected behavior:** [What you expected to happen]
-
-**Actual behavior:** [What actually happened]
-
-**Reproducible?:** [Can you reliably reproduce the issue by following the steps above?]
-
-## Version information
-
-**Anki**
-
-[Please head to *Help* → *About Anki* and Paste the version string here, e.g.:]
-
-[Version 2.0.47]
-[Qt 4.8.1 PyQt 4.9.1]
-
-**System**
-
-- Operating system: [Windows/macOS/Linux]
-- Version: [e.g. 10, High Sierra, Ubuntu 18.04]
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..3b0be412
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,65 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+#### Problem description
+
+*Please describe the issue concisely in here. In case of an error: Walk us through the steps you took to get there. What happened? What did you expect to happen?*
+
+
+#### Checklist
+
+*Please replace the space inside the brackets with an **x** if the following items apply:*
+
+ - [ ] I've restarted Anki to see if it helps
+ - [ ] I've verified that I use the latest version of the add-on by redownloading it from AnkiWeb
+ - [ ] I've verified that I use the latest version of Anki by checking at https://apps.ankiweb.net#download
+ - [ ] I've tried to disable other add-ons to see if there are any interactions present
+ - [ ] My issue disappears when I hold shift while starting Anki.
+ - [ ] I've checked if anyone else reported this problem before by looking through the issue reports. I also checked to see if there is a section about known issues in the add-on description, documentation, or README.
+
+
+#### Information about your Anki set-up
+
+*Please fill out the section corresponding with your Anki version:*
+
+
+##### If you are using Anki 2.1
+
+*Please open Anki, go to Help → About, click on "Copy Debug Info", and paste the result between the backticks below (if the button does not appear you are using an older version of Anki 2.1 and will need to update first):*
+
+```
+
+```
+
+
+##### If you are using Anki 2.0
+
+*Please open Anki, go to Help → About, find the two lines starting with `Version:` and `Qt`, and copy-paste them between the backticks below:*
+
+```
+
+```
+
+*Please fill in details about your operating system (Windows/macOS/Linux, which version):*
+
+- OS:
+- version:
+
+*Please open Anki, go to Tools → Add-ons, take a screenshot of your installed add-ons, and paste it below:*
+
+
+
+#### Error message (if any)
+
+*If you've received an error message, please copy and paste it between the backticks below:*
+
+
+```python
+
+```
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..612d776d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,35 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+#### Checklist
+
+*Please replace the space inside the brackets with an **x** if the following items apply:*
+
+ - [ ] I've verified that I use the latest version of the add-on by redownloading it from AnkiWeb
+ - [ ] I've verified that I use the latest version of Anki by checking at https://apps.ankiweb.net#download
+ - [ ] I've checked if anyone else suggested this feature before by looking through the issue reports.
+
+#### Problem case
+
+*Is your feature request related to a problem? If so, please describe it here. E.g.: "My workflow is such and such, and this and that would help."*
+
+
+
+#### Solution
+
+*Concisely describe the solution you would like*
+
+
+*Concisely describe alternatives you've considered (if any)*
+
+
+
+#### More information
+
+*Additional context: Add any other context or screenshots about the feature request here.*
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 00000000..cc64cd02
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,21 @@
+---
+name: Question
+about: Ask a question about this project
+title: ''
+labels: 'question'
+assignees: ''
+
+---
+
+#### Checklist
+
+*Please replace the space inside the brackets with an **x** if the following items apply:*
+
+ - [ ] I've verified that I use the latest version of the add-on by redownloading it from AnkiWeb
+ - [ ] I've verified that I use the latest version of Anki by checking at https://apps.ankiweb.net#download
+ - [ ] I've checked if anyone else asked this question before by looking through the issue reports.
+
+
+#### Your question
+
+*A clear and concise question about the add-on.*
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..f99a7fb1
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,22 @@
+#### Description
+
+*Concisely describe what the pull request is trying to achieve. If pertinent, link to an existing issue report, or briefly explain the problem the PR is meant to solve. Feel free to attach screenshots or other media for UI-related changes.*
+
+
+#### Checklist:
+
+*Please replace the space inside the brackets with an **x** and fill out the ellipses if the following items apply:*
+
+- [ ] I've read and understood the [contribution guidelines](./CONTRIBUTING.md)
+- [ ] I've tested my changes against at least one of the following [Anki builds](https://apps.ankiweb.net/#download):
+ - [ ] Latest standard Anki 2.1 binary build [required for Anki-compatible 2.1 add-ons]
+ - [ ] Latest alternative Anki 2.1 binary build
+ - [ ] Latest Anki 2.0 binary build [required for Anki 2.0-compatible add-ons]
+- [ ] I've tested my changes on at least one of the following platforms:
+ - [ ] Linux, version:
+ - [ ] Windows, version:
+ - [ ] macOS, version:
+- [ ] My changes potentially affect non-desktop platforms, of which I've tested:
+ - [ ] AnkiMobile, version:
+ - [ ] AnkiDroid, version:
+ - [ ] AnkiWeb
diff --git a/.gitignore b/.gitignore
index c1d7308e..5a315709 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,14 +1,10 @@
+# Linux FM
+.hidden
+.directory
# Byte-compiled / optimized / DLL files
*.pyo
*.pyc
__pycache__/
-# Anki
-src/*/meta.json
-# Build files
-build
-src/*/forms*
-*-anki2*.zip
-*.ankiaddon
# Python
.python-version
.mypy_cache/
@@ -20,31 +16,34 @@ venv/
ENV/
env.bak/
venv.bak/
+# Javascript
+node_modules
# IDEs
*.sublime-project
*.sublime-workspace
.sublime-backup/
.idea/
.vscode/
+# Build files
+build
+src/*/gui/forms/anki*
+src/*/gui/forms/LICENSE*
+src/*/gui/resources/anki*
+src/*/gui/resources/LICENSE*
+*-anki2*.zip
+# Dev tools
+.bumpversion.cfg
+labels.toml
# Temp
.gitold
obsolete
research
-# Linux FM
-.hidden
-.directory
-# Docs and tools
-.github
-docs/specs.md
-docs/todo.md
-docs/*.todo
-docs/description.html
-tools/test.py
-# Add-on specific
-docs/contribs.ui
-image_occlusion_enhanced/svg-edit/build
-image_occlusion_enhanced/svg-edit/Makefile
-designer/
-image-occlusion-enhanced-*.zip
-tests/
+# Docs
+todo
+# Assets
+resources/icons/optional
+# Anki
+src/*/meta.json
+src/*/manifest.json
+# Repo
src/image_occlusion_enhanced/svg-edit/svg-edit-master/
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..22a7d5bb
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,461 @@
+# Changelog
+
+All notable changes to Image Occlusion Enhanced will be documented here. You can click on each release number to be directed to a detailed log of all code commits for that particular release. The download links will direct you to the GitHub release page, allowing you to manually install a release if you want.
+
+If you enjoy Image Occlusion Enhanced, please consider supporting my work on Patreon, or by buying me a cup of coffee :coffee::
+
+
+
+
+
+:heart: My heartfelt thanks goes out to everyone who has supported this add-on through their tips, contributions, or any other means (you know who you are!). All of this would not have been possible without you. Thank you for being awesome!
+
+## [Unreleased]
+
+
+## [v1.3.0-alpha4] - 2019-04-14
+
+### Added
+
+- Introduces .ankiaddon packaging format for GitHub builds
+
+### Fixed
+
+- Fixes error message when deleting current note in editing session (#87, thanks to @zjosua)
+- Fixes rare error message when closing card browser
+
+## [v1.3.0-alpha2] - 2018-12-11
+
+### Fixed
+
+- Quick hotfix for Anki 2.1.6 compatibility (now packages the UUID module which no longer seems to ship with Anki 2.1.6's Python distribution)
+
+## [v1.3.0-alpha1] - 2018-06-29
+
+### Notes
+
+This marks the first official release of Image Occlusion Enhanced for Anki 2.1! Porting the add-on to Anki 2.1 has been [an arduous journey](https://github.com/glutanimate/image-occlusion-enhanced/projects/1), but I'm happy we're finally here.
+
+Before we dive into the actual changelog I would just like to thank each and everyone of you who has helped in this effort, either by [contributing to the codebase](https://github.com/glutanimate/image-occlusion-enhanced/graphs/contributors), filing [bug reports](https://github.com/glutanimate/image-occlusion-enhanced/issues), or by supporting my work directly through [tips](https://glutanimate.com/tip-jar/), [Patreon](https://www.patreon.com/glutanimate), or add-on commissions!
+
+In particular I would like to thank the following awesome people who support me on Patreon / have supported me at some point during the development of Image Occlusion Enhanced for Anki 2.1:
+
+- Blacky 372
+- Sebastián Ortega
+- Edan Maor
+- Peter Benisch
+
+**Important**: This is an Anki 2.1-only release (for now)
+
+### Added
+
+The primary focus in this release was Anki 2.1 compatibility, but v1.3.0 also comes with a number of nifty **new features** which I would like to highlight first:
+
+- You can now **occlude images in any note type you want**, either by **right clicking** on them and selecting the respective option, or by using the Image Occlusion button!
+- As an added bonus: The new context menu introduced by the add-on will also allow you to **open any image with your default system viewer** – a great way to perform quick image editing tasks when needed.
+- The masks editor now allows you to **add hints to your occlusion shapes**. In order to do so, simply create a text element on top of a shape and group it with the shape.
+- You can now set a **custom hotkey** for invoking I/O. Gone are the days of conflicts with different keyboard locales!
+- In-app **help screens** now guide users through the basic use of the add-on (including how to add cards, edit them, group masks, label items, etc.)
+
+(Some of the changes above will likely also be part of a future release of v1.3.0 for Anki 2.0.)
+
+### Fixed
+
+v1.3.0 for Anki 2.1 also comes with a plethora of **bug fixes** (some of the bugs fixed in this update have plagued I/O ever since its original release!):
+
+- Fix: Automatically remove accidentally drawn shapes. This addresses instances where users would end up with more cards than they should have because of invisible shapes drawn by the oversensitive editor component (especially with touch interfaces)
+- Fix: Resolve issues with unicode characters in Anki path and/or image path. This should fix most of the problems users were experiencing with non-latin locales (e.g. the I/O editor screen remaining blank because SVG-Edit did not load, or various UnicodeError messages)
+- Fix: More robust I/O editor instantiation. Should help address some of the stability issues users experienced over longer card creation sessions (e.g. needing to restart Anki to get I/O working again).
+- and a large number of other smaller bug fixes and improvements
+
+### Changes
+
+There also some **changes to the workflow** in I/O v1.3.0 that you need to be aware of:
+
+- The default hotkey for invoking I/O is now Ctrl+Shift+O (customizable through the new settings entry)
+- The card generation options have been renamed and simplified: You can now choose between "Hide All, Guess One" (used to be "Hide All, Reveal One") and "Hide One, Guess One" (used to be "Hide All, Reveal All"). My hope with these new names is that they will be more intuitive for new users. (thanks a lot to Tiago Barroso for the suggestion!)
+- "Hide All, Reveal All" is no longer available as a mask generation option. With the mask reveal button introduced in recent I/O releases it no longer served much of a purpose and was mostly confusing new users as they expected it to work like a grouped occlusion of all shapes.
+
+ Just in case you were using this option and are now wondering how to cover the same use cases:
+
+ + In case you were using "Hide All, Reveal All" to uncover all labels on the back: Try to switch to using "Hide One, Guess One" coupled with the mask reveal button on the backside (hotkey: `G`)
+ + In case you were using "Hide All, Reveal All" to 'group' your shapes: Use the [actual grouping feature](https://github.com/glutanimate/image-occlusion-enhanced/wiki/Advanced-Use#grouping-items) instead
+
+### Limitations
+
+There are a number of known limitations to this alpha release that you need to be aware of:
+
+- Due to compatibility issues between SVG-Edit and the new Chromium renderer in Anki 2.1 some of the features in the masks editor no longer work correctly. My hope is to address these in the following beta release:
+ + [Pointer not changing to selection mode when clicking on shape](https://github.com/glutanimate/image-occlusion-enhanced/issues/54)
+ + [Path tool no longer working](https://github.com/glutanimate/image-occlusion-enhanced/issues/56)
+ + [https://github.com/glutanimate/image-occlusion-enhanced/issues/57](https://github.com/glutanimate/image-occlusion-enhanced/issues/57)
+- Please do not invoke the add-on's settings menu while the I/O Editor is running. There is currently no support for updating I/O editing sessions at runtime, and while most settings will simply only not be applied, others might cause the add-on to stop working correctly until the editor session is restarted. The same applies to modifications to the add-on's note type via Anki's built-in note type manager.
+
+Of course there also bound to be some unforeseen bugs and regressions in the alpha. If you experience any of these please make sure to either report them on the add-on's [bug tracker](https://github.com/glutanimate/image-occlusion-enhanced/issues) or in the [official support thread](https://anki.tenderapp.com/discussions/add-ons/8295-image-occlusion-enhanced-official-thread).
+
+## [v1.2.2] - 2017-04-04
+
+### Fixed
+
+- Fixed: rare AttributeError when changing the image
+- Fixed: GIFs should be supported on Windows and macOS now
+- Fixed: incompatibility with upcoming release of "Quick not and deck buttons" add-on
+
+## [v1.2.1] - 2017-02-14
+
+### Fixed
+
+- Fixed: Unicode TypeError on Windows
+
+
+## [v1.2.0] - 2017-02-14
+
+### Added
+
+- **New**: Hotkey for toggling masks on the answer side (`G`)
+- **New**: Preserve scrollbar position when revealing the answer
+- **New**: Reuse existing images when creating multiple occlusion sets from the same base image
+- **New**: Limit image display height in editor fields in order to improve navigating notes in the card browser
+
+### Changed
+
+- Changed: Updated default field order to move the question mask below the original image. Should make it easier to identify each respective card in the browser.
+
+### Fixed
+
+- Fixed: Remove card margins on mobile devices
+- Fixed: Increased size of mask toggle button on mobile devices
+
+### Notes
+
+Please note that the changes to the field order and card templates only apply to new installations of the add-on. I've decided against enforcing these changes on existing installations as that would undo any customizations you might have applied to the note type. If you'd like to update your cards with these changes, please follow [the instructions in the Wiki](https://github.com/Glutanimate/image-occlusion-enhanced/wiki/Troubleshooting#resetting-note-type-and-template-to-the-defaults) to reset your field order and card template to the (new) defaults.
+
+
+## [v1.1.1] - 2017-01-20
+
+### Fixed
+
+- Clicking on a context menu entry would launch the web browser under some circumstances (thanks to PolymorphicVTach for the report)
+
+
+## [v1.1.0] - 2017-01-14
+
+### Added
+
+- **New**: Grid-snapping for shapes can now be toggled via a button in the upper panel (hotkey: _Shift+S_)
+- **New**: Panning tool (hotkey: _Q_)
+- **New**: Control zoom levels with _+/-_
+- **New**: Reset zoom with _0_
+
+### Fixed
+
+- Fixed: Error when marking the Image field as sticky (thanks to vidale3 for the report)
+- Fixed: _Ctrl+Shift+T_ now focuses the tag field again
+
+### Changed
+
+- Improved: Images now use the available canvas space slightly more efficiently
+- plus a number of smaller improvements and bug fixes
+
+
+## [v1.0.4] - 2016-12-14
+
+### Added
+
+- add hotkeys for switching between layers (Ctrl+Shift+L and Ctrl+Shift+M)
+
+### Fixed
+
+- fix an encoding issue when editing labels
+
+## [v1.0.3] - 2016-12-01
+
+### Fixed
+
+- fix a runtime error that was occuring for some Windows users
+
+
+## [v1.0.2] - 2016-11-24
+
+### Fixed
+
+- Fix unicode support in labels
+
+
+## [v1.0.1] - 2016-11-16
+
+### Fixed
+
+- Restore proper window controls on Windows
+
+
+## [v1.0.0] - 2016-11-09
+
+The most comprehensive update to _Image Occlusion Enhanced_ since its inception:
+
+### Added
+
+- **Modify Existing Notes**
+ - Need to remove or add a shape, update a field, or resize all masks? Now you can!
+- **Change Images on the Fly**
+ - Simply switch to a different image to occlude right from the IO Editor
+- **New Occlusion Mode**
+ - Hides all labels on the question side, and reveals all of them on the back
+ - The different occlusion modes now also follow a new naming scheme. It should be self-explanatory what each of them does, but you can hover over the respective button to get a more detailed description
+- **Completely Reworked Note Type**
+ - 4 additional fields to give your notes enough space for all the extra information they might need
+ - New intuitive field order, with the Header and Image right on top. No more issues identifying your notes in the Browser!
+- **Full Customization**
+ - You can now add as many fields to the note type as you like
+ - New Options entry for renaming default fields
+
+### Changed
+
+- **Updated Options Interface**
+ - More options, fewer bugs
+- **Fully Rewritten Note Generator**
+ - Faster, more extensible, and less bug-prone
+- **Performance Improvements**
+ - Smaller memory footprint in general use (by about 30MB)
+
+### Fixed
+
+- **Stability Improvements**
+ - Bug fixes everywhere
+
+
+## [v1.0.0-beta6] - 2016-11-07
+
+### Added
+
+- **New**: Use a button instead of clicking the image to reveal all masks. The old method interfered with gesture support on mobile clients.
+- **New**: Default action hotkey (Ctrl+Return)
+
+### Changed
+
+- **Other**: Set Extra fields to be note-specific by default
+
+## [v1.0.0-beta5] - 2016-11-05
+
+### Added
+
+- **New**: Reveal all occluded areas when clicking image on answer side – This is a somewhat of an experimental change as there's no official support for JavaScript in Anki. Note: Normally this would require an update to the IO note type, but given that this is an experimental change I decided not to force the update. Instead, feel free to test this new feature on an empty Anki profile.
+
+### Fixed
+
+- **Fix**: Force media sync when updating mask files
+- **Fix**: Handle deleted IO note type more graciously
+
+### Changed
+
+- **Other**: Updated tooltips for occlusion types (@dgbeecher)
+
+
+## [v1.0.0-beta4] - 2016-10-18
+
+### Changed
+
+- Updated the default card template
+ - The new template includes the two new extra fields and uses a more elaborate layout for all sections below the image. It also provides much needed adjustments of the styling for AnkiMobile and AnkiDroid
+ - **Important**: This will overwrite any previous changes to the card templates you might have performed. If you've used a previous Beta and customized your template or styles please make sure to back them up before installing this version.
+ - FWIW, drastic changes like this will only happen with Beta releases. If I ever see the need to change the template for a stable update I will implement it in a way that asks you for confirmation first.
+
+### Fixed
+
+- Fixed a number of smaller issues (thanks to @dgbeecher for reporting these!)
+
+
+## [v1.0.0-beta3] - 2016-10-15
+
+### Added
+
+- New options for labels and lines
+- New option for ignoring fields when editing
+- New error dialog that provides a help button
+
+### Changed
+
+- More verbose tooltips when generating notes
+
+### Fixed
+
+- Line color and width should now be preserved when switching to a different tool
+- Lots of smaller bug fixes
+
+
+## [v1.0.0-beta2] - 2016-10-13
+
+### Fixed
+
+- Possible fix for a module import error on macOS
+
+## [v1.0.0-beta1] - 2016-10-12
+
+A tremendous version jump, I know, but this is the most comprehensive update to Image Occlusion since the release of _Image Occlusion Enhanced_
+
+### Added
+
+- **Modify Existing Notes**
+ - Need to remove or add a shape, update a field, or resize all masks? Now you can!
+- **Change Images on the Fly**
+ - Simply switch to a different image to occlude right from the IO Editor
+- **New Occlusion Mode**
+ - Hides all labels on the question side, and reveals all of them on the back
+ - The different occlusion modes now also follow a new naming scheme. It should be self-explanatory what each of them does, but you can hover over the respective button to get a more detailed description
+- **Completely Reworked Note Type**
+ - 4 additional fields to give your notes enough space for all the extra information they might need
+ - New intuitive field order, with the Header and Image right on top. No more issues identifying your notes in the Browser!
+- **Full Customization**
+ - You can now add as many fields to the note type as you like
+ - New Options entry for renaming default fields
+
+### Changed
+
+- **Updated Options Interface**
+ - More options, fewer bugs
+- **Fully Rewritten Note Generator**
+ - Faster, more extensible, and less bug-prone
+- **Performance Improvements**
+ - Smaller memory footprint in general use (by about 30MB)
+
+### Fixed
+
+- **Stability Improvements**
+ - Bug fixes everywhere
+
+## [v0.3.0] - 2016-09-28
+
+### Changed
+
+- SVGEdit: fixed most of the random opacity changes
+- SVGEdit: fixed some issues with the stroke and fill attributes
+- SVGEdit: changed default text font
+- SVGEdit: added initial fill color to the color palette
+- SVGEdit: updated hotkey assignments to improve usability
+- SVGEdit: added "Esc" hotkey to deselect current selection
+
+
+## [v0.2.6] - 2016-09-22
+
+### Changed
+
+- improved IO note type sanity checks
+
+## [v0.2.5] - 2016-09-12
+
+### Changed
+
+- New add-on name
+- Added link to new Wiki
+
+## [v0.2.4] - 2016-08-25
+
+### Fixed
+
+- Several bug fixes and improvements
+
+## [v0.2.3] - 2016-05-19
+
+### Changed
+
+- Update mask fill colour when upgrading from Image Occlusion 2.0
+
+
+## [v0.2.2] - 2016-04-16
+
+### Added
+
+- added support for preserving occlusions and labels when creating new notes based on old one
+
+
+## [v0.2.1] - 2016-04-04
+
+### Fixed
+
+- fixed an encoding error on Windows
+
+
+## [v0.2.0] - 2016-04-03
+
+### Changed
+
+- first release on AnkiWeb
+- fixes a number of issues with SVG-Edit
+
+
+## [v0.1.4] - 2016-04-01
+
+### Changed
+
+- improvements to the Masks editor
+- bug fix: support for special characters in file names on Windows
+
+
+## [v0.1.3] - 2016-04-01
+
+### Changed
+
+- update the Options window and Help link
+- remember window geometry across sessions
+- allow upgrading directly from I/O 2.0
+- a few miscellaneous fixes
+
+
+## [v0.1.2] - 2016-03-29
+
+### Fixed
+
+- More fixes.
+
+
+## [v0.1.1] - 2016-03-28
+
+### Fixed
+
+- A few smaller fixes.
+
+
+## v0.1.0 - 2016-03-28
+
+### Added
+
+- First release of Image Occlusion 2.0 Enhanced.
+- Still needs a lot of testing!
+
+
+[Unreleased]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.3.0-alpha4...HEAD
+[v1.3.0-alpha4]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.3.0-alpha2...v1.3.0-alpha4
+[v1.3.0-alpha2]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.3.0-alpha1...v1.3.0-alpha2
+[v1.3.0-alpha1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.2.2...v1.3.0-alpha1
+[v1.2.2]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.2.1...v1.2.2
+[v1.2.1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.2.0...v1.2.1
+[v1.2.0]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.1.1...v1.2.0
+[v1.1.1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.1.0...v1.1.1
+[v1.1.0]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.4...v1.1.0
+[v1.0.4]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.2...v1.0.3
+[v1.0.2]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.1...v1.0.2
+[v1.0.1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0...v1.0.1
+[v1.0.0]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0-beta6...v1.0.0
+[v1.0.0-beta6]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0-beta5...v1.0.0-beta6
+[v1.0.0-beta5]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0-beta4...v1.0.0-beta5
+[v1.0.0-beta4]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0-beta3...v1.0.0-beta4
+[v1.0.0-beta3]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0-beta2...v1.0.0-beta3
+[v1.0.0-beta2]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v1.0.0-beta1...v1.0.0-beta2
+[v1.0.0-beta1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.3.0...v1.0.0-beta1
+[v0.3.0]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.6...v0.3.0
+[v0.2.6]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.5...v0.2.6
+[v0.2.5]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.4...v0.2.5
+[v0.2.4]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.3...v0.2.4
+[v0.2.3]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.2...v0.2.3
+[v0.2.2]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.1...v0.2.2
+[v0.2.1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.1.4...v0.2.0
+[v0.1.4]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.1.3...v0.1.4
+[v0.1.3]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.1.2...v0.1.3
+[v0.1.2]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.1.1...v0.1.2
+[v0.1.1]: https://github.com/Glutanimate/image-occlusion-enhanced/compare/v0.1.0...v0.1.1
+
+-----
+
+The format of this file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..8e893dca
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+## How to Contribe to this Project
+
+Please see the [common contribution guidelines](https://github.com/glutanimate/docs/blob/master/anki/add-ons/CONTRIBUTING.md#how-to-contribute-to-my-anki-add-ons) for my Anki add-ons.
+
+Thanks!
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index dbbe3558..24d71b61 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,3 +1,16 @@
+This Program is licensed under the GNU Affero General Public License
+version 3 ("AGPL"), extended by a number of Additional Terms under
+Section 7 of the AGPL.
+
+If not otherwise noted, this License applies to all files included
+with this Program. Files subject to different licensing terms might
+also ship with this Program, but will be clearly marked as such in
+additional LICENSE files accompanying them.
+
+The AGPLv3 License and Additional Terms follow.
+
+==============================================================================
+
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
@@ -618,44 +631,68 @@ copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
- How to Apply These Terms to Your New Programs
+==============================================================================
+
+ ADDITIONAL TERMS APPLICABLE TO THIS PROGRAM
+ UNDER GNU AGPL VERSION 3 SECTION 7
+
+The following additional terms ("Additional Terms") supplement and modify the
+GNU Affero General Public License, Version 3 ("AGPL") applicable to the present
+Program.
+
+In addition to the terms and conditions of the AGPL, the present Program is
+subject to the further restrictions below:
+
+1. Trademark and Publicity Rights.
+
+ Except as expressly provided herein, no trademark or publicity rights are
+ granted. This license does NOT give you any right, title or interest in the
+ "Glutanimate" name or logo.
+
+ However, Licensees are granted a limited, non-exclusive right to use the
+ Glutanimate name and logo as part of the preservation of the legal notices
+ and author attributions within this Program and within Appropriate Legal
+ Notices displayed by works containing it.
+
+2. Origin of the Program.
+
+ The origin of the Program must not be misrepresented; you must not claim
+ that you wrote the original Program. Altered source versions must be plainly
+ marked as such, and must not be misrepresented as being the original
+ Program.
+
+3. Legal Notices and Author Attributions.
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
+ You must reproduce faithfully all trademark, copyright and other proprietary
+ and legal notices on any copies of the Program or any other required author
+ attributions. Legal notices or author attributions displayed as part of the
+ user interface must be preserved as such.
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
+4. Use of Names of Licensors or Authors for Publicity Purposes.
-
- Copyright (C)
+ Outside of the aforementioned legal notices and author attributions, neither
+ the name of the copyright holder or its affiliates, any other party who
+ modifies and/or conveys the Program, nor the names of the Program's
+ sponsors/supporters/patrons may be used to endorse or promote products
+ derived from this software without specific prior written permission.
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
+5. Indemnification.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
+ IF YOU CONVEY A COVERED WORK AND AGREE WITH ANY RECIPIENT OF THAT COVERED
+ WORK THAT YOU WILL ASSUME ANY LIABILITY FOR THAT COVERED WORK, YOU HEREBY
+ AGREE TO INDEMNIFY, DEFEND AND HOLD HARMLESS THE OTHER LICENSORS AND AUTHORS
+ OF THAT COVERED WORK FOR ANY DAMAGES, DEMANDS, CLAIMS, LOSSES, CAUSES OF
+ ACTION, LAWSUITS, JUDGMENTS EXPENSES (INCLUDING WITHOUT LIMITATION
+ REASONABLE ATTORNEYS' FEES AND EXPENSES) OR ANY OTHER LIABLITY ARISING FROM,
+ RELATED TO OR IN CONNECTION WITH YOUR ASSUMPTIONS OF LIABILITY.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see .
+6. Preservation of Licensing Terms.
-Also add information on how to contact you by electronic and paper mail.
+ Any covered work conveyed by you must include this license text in its
+ entirety.
- If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
+-------------------------------------------------------------------------------
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
-.
+If you have any questions regarding this license, about any other legal
+details, or want to report an infringement of the aforementioned licensing
+terms, please feel free to contact me at:
diff --git a/Makefile b/Makefile
deleted file mode 100644
index 99bfd910..00000000
--- a/Makefile
+++ /dev/null
@@ -1,63 +0,0 @@
-# Makefile for Anki add-ons
-#
-# Prepares zip file for upload to AnkiWeb
-#
-# Copyright: (c) 2017-2018 Glutanimate
-# License: GNU AGPLv3
-
-VERSION = `git describe HEAD --tags --abbrev=0`
-ADDON = image-occlusion-enhanced
-ADDONDIR = image_occlusion_enhanced
-
-
-###
-
-all: zip
-
-clean: cleanbuild cleanzips
-
-zip: cleanbuild ui builddir buildzip
-
-release: cleanbuild builddir buildrelease
-
-###
-
-cleanzips:
- rm -f *-anki2*.zip
-
-cleanbuild:
- rm -rf build
- find . \( -name '*.pyc' -o -name '*.pyo' -o -name '__pycache__' \) -delete
-
-ui:
- PYENV_VERSION=anki20tools ./tools/build_ui.sh "$(ADDONDIR)" 4
- PYENV_VERSION=anki21tools ./tools/build_ui.sh "$(ADDONDIR)" 5
-
-builddir:
- mkdir -p build/dist build/dist21
-
-buildzip:
- rm -f *-current-anki2*.zip
- cp src/*.py build/dist/
- cp -r "src/$(ADDONDIR)" build/dist/
- cp -r "src/$(ADDONDIR)/"* build/dist21/
- rm -rf "build/dist/$(ADDONDIR)/forms5" build/dist21/forms4
- cd build/dist && zip -r "../../$(ADDON)-current-anki20.zip" *
- cd build/dist21 && zip -r "../../$(ADDON)-current-anki21.zip" *
- rm -rf build
-
-buildrelease:
- rm -f *-release-$(VERSION)-anki2*.zip
- git archive --format tar $(VERSION) | tar -x -C build/dist/
- cp -r build/dist/* build/dist21
- rm -rf "build/dist/$(ADDONDIR)/forms5" "build/dist21/forms4"
- # cd build/dist && \
- # PYENV_VERSION=anki20tools ../../tools/build_ui.sh "$(ADDONDIR)" 4 &&\
- # cd src && \
- # zip -r "../../../$(ADDON)-release-$(VERSION)-anki20.zip" "$(ADDONDIR)" *.py
- cd build/dist21 && \
- PYENV_VERSION=anki21tools ../../tools/build_ui.sh "$(ADDONDIR)" 5 &&\
- cd src/"$(ADDONDIR)" && \
- zip -r "../../../../$(ADDON)-release-$(VERSION)-anki21-ankiweb.zip" * && \
- zip -r "../../../../$(ADDON)-release-$(VERSION)-anki21.ankiaddon" *
- rm -rf build
diff --git a/README.md b/README.md
index 15cbdaf1..f701e0eb 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,31 @@
-## Image Occlusion Enhanced
+
-*Image Occlusion Enhanced* is an add-on for the spaced repetition flashcard app [Anki](http://ankisrs.net/). It allows you to create flashcards that hide parts of an image to test your knowledge of that hidden information.
+Image Occlusion Enhanced for Anki
-### Table of Contents
+
+
+
+
+
+
+
+
+
-
+> Flashcards from images – the easy way
-- [Image Occlusion Enhanced](#image-occlusion-enhanced)
- - [Table of Contents](#table-of-contents)
- - [Screenshots](#screenshots)
- - [Changes Compared to Image Occlusion 2.0](#changes-compared-to-image-occlusion-20)
- - [Documentation](#documentation)
- - [Known Issues](#known-issues)
- - [Credits and License](#credits-and-license)
+*Image Occlusion Enhanced* is an add-on for the spaced repetition flashcard app [Anki](https://apps.ankiweb.net/) that allows you to create image-based cloze tests.
+
+### Table of Contents
+
+
+
+- [Screenshots](#screenshots)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [Building](#building)
+- [Contributing](#contributing)
+- [License and Credits](#license-and-credits)
@@ -27,39 +40,75 @@
-### Changes Compared to Image Occlusion 2.0
+### Installation
+
+#### AnkiWeb
+
+The easiest way to install Image Occlusion Enhanced is through [AnkiWeb](https://ankiweb.net/shared/info/1374772155).
+
+#### Manual installation
+
+Please click on the entry corresponding to your Anki version:
+
+
+
+Anki 2.1
+
+1. Make sure you have the [latest version](https://apps.ankiweb.net/#download) of Anki 2.1 installed. Earlier releases (e.g. found in various Linux distros) do not support `.ankiaddon` packages.
+2. Download the latest `.ankiaddon` package from the [releases tab](https://github.com/glutanimate/image-occlusion-enhanced/releases) (you might need to click on *Assets* below the description to reveal the download links)
+3. From Anki's main window, head to *Tools* → *Add-ons*
+4. Drag-and-drop the `.ankiaddon` package onto the add-ons list
+5. Restart Anki
-- **Modify Existing Notes**: Update and modify your IO notes to your heart's content
-- **Change Images on the Fly**: Switch to a different image right from the Editor
-- **Create Custom Labels**: Your image is lacking a specific label? Now you can create it yourself!
-- **Completely Overhauled UI**: Tabs, multi-line entry fields, numerous new hotkey assignments
-- **Completely Reworked Note Type**: 4 additional fields, new intuitive field order
-- **Updated Card Template**: New card layout, a button to reveal all masks, optimizations for AnkiMobile
-- **Full Customization**: Add and rename as many fields as you like
-- **Updated Options Interface**: More options, fewer bugs
-- **Fully Rewritten Note Generator**: Faster, more extensible, and less bug-prone
-- **Performance Improvements**: Smaller memory footprint in general use
-- **Stability Improvements**: Bug fixes everywhere
+
-For more information on recent improvements and additions make sure to check out the changelogs posted on the [Releases page](https://github.com/Glutanimate/image-occlusion-enhanced/releases).
+
+
+Anki 2.0
+
+1. Go to *Tools* → *Add-ons* → *Open add-ons folder*
+2. Find and delete the `Image Occlusion Enhanced.py` file if it already exists.
+3. See if you can find a `image_occlusion_enhanced` folder. If so:
+ 1. If the folder contains a `meta.json` file, copy the file to a safe location. This will allow you to preserve your current settings.
+ 2. Proceed to delete the `image_occlusion_enhanced` folder
+4. Download and extract the latest Anki 2.0 add-on release from the [releases tab](https://github.com/glutanimate/image-occlusion-enhanced/releases) (you might need to click on *Assets* below the description to reveal the download links)
+5. Move the extracted `Image Occlusion Enhanced.py` and `image_occlusion_enhanced` into the add-ons folder
+6. Optional: Place the `meta.json` file back into the directory if you created a copy beforehand.
+7. Restart Anki
+
+
### Documentation
The installation and use of this add-on is detailed in the [Wiki](https://github.com/Glutanimate/image-occlusion-enhanced/wiki) and a [series of video tutorials on YouTube](https://www.youtube.com/playlist?list=PL3MozITKTz5YFHDGB19ypxcYfJ1ITk_6o). More information may also be found in the [AnkiWeb description](docs/description.md).
-### Known Issues
+### Building
+
+With [Anki add-on builder](https://github.com/glutanimate/anki-addon-builder/) installed:
+
+ git clone https://github.com/glutanimate/image-occlusion-enhanced.git
+ cd image-occlusion-enhanced
+ aab build
-*Image Occlusion Enhanced* should now be stable for the most part. However, there still exist a number of longstanding issues that have less to do with the add-on itself and more with Anki and the libraries it's based on. macOS, in particular, has always suffered from compatibility issues with SVG-Edit.
+For more information on the build process please refer to [`aab`'s documentation](https://github.com/glutanimate/anki-addon-builder/#usage).
-For a list of known issues please check out the [Issues](https://github.com/Glutanimate/image-occlusion-enhanced/issues) page. Bug reports and suggestions are always welcome, but it might take me a while to get to them. If you know how to code please feel free to improve this project, file pull requests, etc.
+### Contributing
-### Credits and License
+Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) on how to:
+
+- Report issues
+- File pull requests
+- Support the project as a non-developer
+
+### License and Credits
+
+*Image Occlusion Enhanced* is
*Copyright © 2012-2015 [Tiago Barroso](https://github.com/tmbb)*
*Copyright © 2013 [Steve AW](https://github.com/steveaw)*
-*Copyright © 2016-2018 [Aristotelis P.](https://glutanimate.com/)*
+*Copyright © 2016-2019 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*
With code contributions from: Damien Elmes, Kyle Mills, James Kraus, Matt Restko
@@ -77,6 +126,9 @@ I would also like to extend my heartfelt thanks to everyone who has helped with
- [imagesize.py](https://github.com/shibukawa/imagesize_py) v0.7.1. Copyright (c) 2016 Yoshiki Shibukawa. Licensed under the MIT license.
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+Image Occlusion Enhanced is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the [LICENSE](https://github.com/glutanimate/image-occlusion-enhanced/blob/master/LICENSE) file that accompanied this program.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
\ No newline at end of file
+----
+**:heart: My heartfelt thanks goes out to everyone who has supported this add-on through their [tips, contributions, or any other means](https://github.com/glutanimate/docs/blob/master/anki/add-ons/CONTRIBUTING.md#how-to-contribute-to-my-anki-add-ons) (you know who you are!). All of this would not have been possible without you. Thank you for being awesome!**
diff --git a/addon.json b/addon.json
new file mode 100644
index 00000000..e6135b18
--- /dev/null
+++ b/addon.json
@@ -0,0 +1,16 @@
+{
+ "display_name": "Image Occlusion Enhanced",
+ "module_name": "image_occlusion_enhanced",
+ "repo_name": "image-occlusion-enhanced",
+ "ankiweb_id": "1374772155",
+ "author": "Glutanimate",
+ "contact": "https://glutanimate.com",
+ "homepage": "https://github.com/glutanimate/image-occlusion-enhanced",
+ "copyright_start": 2016,
+ "tags": "image-occlusion editor",
+ "conflicts": [],
+ "targets": [
+ "anki20",
+ "anki21"
+ ]
+}
\ No newline at end of file
diff --git a/docs/description-alpha.md b/docs/description-alpha.md
deleted file mode 100644
index 329f6164..00000000
--- a/docs/description-alpha.md
+++ /dev/null
@@ -1,102 +0,0 @@
-*Image Occlusion Enhanced* Alpha Release for Anki 2.1
-
-This is an alpha release of Image Occlusion Enhanced for the [Anki 2.1 Beta](https://apps.ankiweb.net/docs/beta.html). Please make sure to carefully read through this description and familiarize yourself with the official Anki 2.1 beta release notes before giving the add-on a try.
-
-The present AnkiWeb upload is temporary and will be removed in favor of the [regular add-on listing](https://ankiweb.net/shared/info/1111933094) once testing is complete.
-
-**RELEASE LOG**
-
-2018-06-30: **v1.3.0-alpha1** - First public release of Image Occlusion Enhanced for Anki 2.1
-2017-04-17: **v1.2.2** - Last Image Occlusion Enhanced release for Anki 2.0 as of 2018-06-29.
-
-**LATEST CHANGES AND NEWS**
-
-*2018-06-30*
-
-Today marks the first official release of Image Occlusion Enhanced for Anki 2.1! Porting the add-on to Anki 2.1 has been [an arduous journey](https://github.com/glutanimate/image-occlusion-enhanced/projects/1), but I'm happy we're finally here.
-
-Before we dive into the actual changelog I would just like to thank each and everyone of you who has helped in this effort, either by [contributing to the codebase](https://github.com/glutanimate/image-occlusion-enhanced/graphs/contributors), filing [bug reports](https://github.com/glutanimate/image-occlusion-enhanced/issues), or by supporting my work directly through [tips](https://glutanimate.com/tip-jar/), [Patreon](https://www.patreon.com/glutanimate), or add-on commissions!
-
-In particular I would like to thank the following awesome people who support me on Patreon / have supported me at some point during the development of Image Occlusion Enhanced for Anki 2.1:
-
-- Blacky 372
-- Sebastián Ortega
-- Edan Maor
-- Peter Benisch
-
-**v1.3.0-alpha1**
-
-The primary focus in this release was Anki 2.1 compatibility, but v1.3.0 also comes with a number of nifty **new features** which I would like to highlight first:
-
-- You can now **occlude images in any note type you want**, either by **right clicking** on them and selecting the respective option, or by using the Image Occlusion button!
-- As an added bonus: The new context menu introduced by the add-on will also allow you to **open any image with your default system viewer** – a great way to perform quick image editing tasks when needed.
-- The masks editor now allows you to **add hints to your occlusion shapes**. In order to do so, simply create a text element on top of a shape and group it with the shape.
-- You can now set a **custom hotkey** for invoking I/O. Gone are the days of conflicts with different keyboard locales!
-- In-app **help screens** now guide users through the basic use of the add-on (including how to add cards, edit them, group masks, label items, etc.)
-
-(Some of the changes above will likely also be part of a future release of v1.3.0 for Anki 2.0.)
-
-v1.3.0 for Anki 2.1 also comes with a plethora of **bug fixes** (some of the bugs fixed in this update have plagued I/O ever since its original release!):
-
-- Fix: Automatically remove accidentally drawn shapes. This addresses instances where users would end up with more cards than they should have because of invisible shapes drawn by the oversensitive editor component (especially with touch interfaces)
-- Fix: Resolve issues with unicode characters in Anki path and/or image path. This should fix most of the problems users were experiencing with non-latin locales (e.g. the I/O editor screen remaining blank because SVG-Edit did not load, or various UnicodeError messages)
-- Fix: More robust I/O editor instantiation. Should help address some of the stability issues users experienced over longer card creation sessions (e.g. needing to restart Anki to get I/O working again).
-- and a large number of other smaller bug fixes and improvements
-
-There also some **changes to the workflow** in I/O v1.3.0 that you need to be aware of:
-
-- The default hotkey for invoking I/O is now Ctrl+Shift+O (customizable through the new settings entry)
-- The card generation options have been renamed and simplified: You can now choose between "Hide All, Guess One" (used to be "Hide All, Reveal One") and "Hide One, Guess One" (used to be "Hide All, Reveal All"). My hope with these new names is that they will be more intuitive for new users. (thanks a lot to Tiago Barroso for the suggestion!)
-- "Hide All, Reveal All" is no longer available as a mask generation option. With the mask reveal button introduced in recent I/O releases it no longer served much of a purpose and was mostly confusing new users as they expected it to work like a grouped occlusion of all shapes.
-
- Just in case you were using this option and are now wondering how to cover the same use cases:
-
- + In case you were using "Hide All, Reveal All" to uncover all labels on the back: Try to switch to using "Hide One, Guess One" coupled with the mask reveal button on the backside (hotkey: `G`)
- + In case you were using "Hide All, Reveal All" to 'group' your shapes: Use the [actual grouping feature](https://github.com/glutanimate/image-occlusion-enhanced/wiki/Advanced-Use#grouping-items) instead
-
-
-**LIMITATIONS OF THIS ALPHA RELEASE**
-
-There are a number of known limitations to this alpha release that you need to be aware of:
-
-- Due to compatibility issues between SVG-Edit and the new Chromium renderer in Anki 2.1 some of the features in the masks editor no longer work correctly. My hope is to address these in the following beta release:
- + [Pointer not changing to selection mode when clicking on shape](https://github.com/glutanimate/image-occlusion-enhanced/issues/54)
- + [Path tool no longer working](https://github.com/glutanimate/image-occlusion-enhanced/issues/56)
- + [https://github.com/glutanimate/image-occlusion-enhanced/issues/57](https://github.com/glutanimate/image-occlusion-enhanced/issues/57)
-- Please do not invoke the add-on's settings menu while the I/O Editor is running. There is currently no support for updating I/O editing sessions at runtime, and while most settings will simply only not be applied, others might cause the add-on to stop working correctly until the editor session is restarted. The same applies to modifications to the add-on's note type via Anki's built-in note type manager.
-
-Of course there also bound to be some unforeseen bugs and regressions in the alpha. If you experience any of these please make sure to either report them on the add-on's [bug tracker](https://github.com/glutanimate/image-occlusion-enhanced/issues) or in the [official support thread](https://anki.tenderapp.com/discussions/add-ons/8295-image-occlusion-enhanced-official-thread). Any and all feedback is appreciated!
-
-**CREDITS AND LICENSE**
-
-*Copyright © 2012-2015 [Tiago Barroso](https://github.com/tmbb)*
-*Copyright © 2013 [Steve AW](https://github.com/steveaw)*
-*Copyright © 2016-2018 [Aristotelis P.](https://glutanimate.com/)*
-
-With code contributions from: Damien Elmes, Kyle Mills, James Kraus, Matt Restko
-
-*Image Occlusion Enhanced* is based on [Image Occlusion 2.0](https://github.com/tmbb/image-occlusion-2) by Tiago Barroso and [Simple Picture Occlusion](https://github.com/steveaw/anki_addons) by Steve AW. All credit for the original add-ons goes to their respective authors. *Image Occlusion Enhanced* would not exist without their work.
-
-I would also like to extend my heartfelt thanks to everyone who has helped with testing, provided suggestions, or contributed in any other way.
-
-Licensed under the [GNU AGPL v3](https://www.gnu.org/licenses/agpl.html). The code for this add-on is available on [ GitHub](https://github.com/glutanimate/image-occlusion-enhanced). For more information on the licensing terms and other software shipped with this package please check out the [README](https://github.com/Glutanimate/image-occlusion-enhanced#credits).
-
-**ADD-ON COMMISSIONS**
-
-A lot of my add-ons were commissioned by fellow Anki users. If you enjoy my work and would like to hire my services to work on an add-on or new feature, please feel free to reach out to me at:  ankiglutanimate [αt] gmail . com
-
-**MORE RESOURCES**
-
-Want to stay up-to-date with my latest add-on releases and updates? Feel free to follow me on Twitter: [@Glutanimate](https://twitter.com/glutanimate)
-
-New to Anki? Make sure to check out my YouTube channel where I post weekly tutorials on Anki add-ons and related topics: [ / Glutanimate](https://www.youtube.com/c/glutanimate)
-
-============================================
-
-**SUPPORT THIS ADD-ON**
-
-Writing, supporting, and maintaining Anki add-ons like these takes a lot of time and effort. If *Image Occlusion Enhanced* has been a valuable asset in your studies, please consider using one of the buttons below to support my efforts by buying me a **coffee**, **sandwich**, **meal**, or anything else you'd like:
-
- [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4FT9NG3NJMY4U&on0=Project&os0=image-occlusion "Buy me a coffee ☺") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YKSP7QF45Y7SJ&on0=Project&os0=image-occlusion "Buy me a burger 😊") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MVDM6JAL2R5JA&on0=Project&os0=image-occlusion "Buy me a meal 😄") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EYNV4ECSKBGE4&on0=Project&os0=image-occlusion "Contribute a custom amount ☺")
-
-Each and every contribution is greatly appreciated and will help me maintain and improve *Image Occlusion Enhanced* as time goes by!
diff --git a/docs/description-anki20.md b/docs/description-anki20.md
new file mode 100644
index 00000000..a00d0150
--- /dev/null
+++ b/docs/description-anki20.md
@@ -0,0 +1,113 @@
+*Image Occlusion Enhanced* is an updated version of *Image Occlusion 2.0*.
+
+Image Occlusion lets you create cards that **hide parts of an image** to test your knowledge of that hidden information. The cards generated by this add-on would be best described as **image-based cloze-deletions**:
+
+
+
+**COMPATIBILITY**
+
+This version of Image Occlusion Enhanced only works with Anki's stable release branch (Anki 2.0.x, version 2.0.30 and up). If you are using Anki 2.1, make sure to check out the latest [development release of the add-on](https://ankiweb.net/shared/info/1374772155).
+
+**CHANGES COMPARED TO IO 2.0**
+
+- **Modify Existing Notes**: Update and modify your IO notes to your heart's content
+- **Change Images on the Fly**: Switch to a different image right from the Editor
+- **Create Custom Labels**: Your image is lacking a specific label? Now you can create it yourself!
+- **Completely Overhauled UI**: Tabs, multi-line entry fields, numerous new hotkey assignments
+- **Completely Reworked Note Type**: 4 additional fields, new intuitive field order
+- **Updated Card Template**: New card layout, a button to reveal all masks, optimizations for AnkiMobile
+- **Full Customization**: Add and rename as many fields as you like
+- **Updated Options Interface**: More options, fewer bugs
+- **Fully Rewritten Note Generator**: Faster, more extensible, and less bug-prone
+- **Performance Improvements**: Smaller memory footprint in general use
+- **Stability Improvements**: Bug fixes everywhere
+
+[Here's a great overview](https://www.youtube.com/watch?v=7pU9L0XybyI) by *Med School Insiders* on YouTube that goes over the key differences compared to older versions of IO.
+
+**RELEASE LOG**
+
+This section will always be updated with the latest changes to *Image Occlusion Enhanced*. More details on major releases are listed in the next section. For a full release log, including smaller bug fix releases and more details on each entry, make sure to check out the [releases page on GitHub](https://github.com/Glutanimate/image-occlusion-enhanced/releases).
+
+2017-04-17: **v1.2.2** - Fixes a few smaller issues
+2017-02-14: **v1.2.0** - Usability improvements and under-the-hood changes
+2016-01-14: **v1.1.0** - New features, usability improvements, and bug fixes
+2016-11-10: **v1.0.0** - Ability to modify existing notes, among many other new features
+2016-09-28: **v0.3.0** - A large number of improvements to the Masks Editor
+2016-04-03: **v0.2.0** - Initial public release
+
+**LATEST CHANGES AND NEWS**
+
+*2018-06-30*
+
+An alpha version of Image Occlusion Enhanced for Anki 2.1 is now available [here](https://ankiweb.net/shared/info/1374772155).
+
+*2017-04-17*
+
+A recent iOS-update might be affecting Image Occlusion 2.0 cards that were created earlier than 2015. If your occlusion masks are not drawn properly please use [this supplementary](https://ankiweb.net/shared/info/1048682320) add-on to fix them (thanks to mrestko for coming up with this solution).
+
+**v1.2.2**
+
+- Fixed: rare AttributeError when changing the image (thanks to Renita and Joshua for the report)
+- Fixed: GIFs should be supported on Windows and macOS now (thanks to Tiago for the help)
+- Fixed: incompatibility with upcoming release of "Quick note and deck buttons" add-on (thanks to drroscoe for the reminder)
+
+**INSTALLATION**
+
+If you are starting from a fresh Anki installation you can simply follow the generic instructions listed below this add-on description.
+
+**UPDATING**
+
+Repeating the installation procedure will allow you to update to the latest release of the add-on. However, if you are upgrading from Image Occlusion 2.0 or early versions of Image Occlusion Enhanced please make sure to read [the Wiki section on upgrading](https://github.com/Glutanimate/image-occlusion-enhanced/wiki/Upgrading) first.
+
+**USAGE**
+
+The use of this add-on is detailed in the [Wiki](https://github.com/Glutanimate/image-occlusion-enhanced/wiki) and a [series of video tutorials on YouTube](https://www.youtube.com/playlist?list=PL3MozITKTz5YFHDGB19ypxcYfJ1ITk_6o).
+
+**HELP**
+
+Please check out the [Troubleshooting section](https://github.com/Glutanimate/image-occlusion-enhanced/wiki/Troubleshooting) in the Wiki if you are experiencing issues with the add-on.
+
+Bug reports and suggestions are always welcome, but it might take me a while to get to them. **Please do not post bug reports in the review section**, as I will not be able to help you or reply. Instead, please use the [official support thread](https://anki.tenderapp.com/discussions/add-ons/8295-image-occlusion-enhanced-official-thread) (no registration necessary!).
+
+**CREDITS AND LICENSE**
+
+*Copyright © 2012-2015 [Tiago Barroso](https://github.com/tmbb)*
+*Copyright © 2013 [Steve AW](https://github.com/steveaw)*
+*Copyright © 2016-2017 [Aristotelis P.](https://glutanimate.com/)*
+
+*Image Occlusion Enhanced* is based on [Image Occlusion 2.0](https://github.com/tmbb/image-occlusion-2) by Tiago Barroso and [Simple Picture Occlusion](https://github.com/steveaw/anki_addons) by Steve AW. All credit for the original add-ons goes to their respective authors. *Image Occlusion Enhanced* would not exist without their work.
+
+I would also like to extend my heartfelt thanks to everyone who has helped with testing, provided suggestions, or contributed in any other way.
+
+Licensed under the [GNU AGPL v3](https://www.gnu.org/licenses/agpl.html). The code for this add-on is available on [ GitHub](https://github.com/glutanimate/image-occlusion-enhanced). For more information on the licensing terms and other software shipped with this package please check out the [README](https://github.com/Glutanimate/image-occlusion-enhanced#credits).
+
+**OTHER ADD-ONS**
+
+Make sure to also give some of my other add-ons a try:
+
+- [Cloze Overlapper](https://ankiweb.net/shared/info/969733775) - memorize lists and enumerations effectively
+- [Review Heatmap](https://ankiweb.net/shared/info/1771074083) - tracks your review streaks and motivates you to keep on going
+- [Advanced Previewer](https://ankiweb.net/shared/info/544521385) - preview and review multiple cards at once right from within the previewer
+- [Search and Replace Tags](https://ankiweb.net/shared/info/138501288) - rename tags across multiple notes
+- [Batch Note Editing](https://ankiweb.net/shared/info/291119185) - makes batch-editing notes a breeze
+- [Sticky Searches](https://ankiweb.net/shared/info/594622823) - quick toggles for often used search terms in the browser
+
+**ADD-ON COMMISSIONS**
+
+A lot of my add-ons were commissioned by fellow Anki users. If you enjoy my work and would like to hire my services to work on an add-on or new feature, please feel free to reach out to me at:  ankiglutanimate [αt] gmail . com
+
+**MORE RESOURCES**
+
+Want to stay up-to-date with my latest add-on releases and updates? Feel free to follow me on Twitter: [@Glutanimate](https://twitter.com/glutanimate)
+
+New to Anki? Make sure to check out my YouTube channel where I post weekly tutorials on Anki add-ons and related topics: [ / Glutanimate](https://www.youtube.com/c/glutanimate)
+
+============================================
+
+**SUPPORT THIS ADD-ON**
+
+Writing, supporting, and maintaining Anki add-ons like these takes a lot of time and effort. If *Image Occlusion Enhanced* has been a valuable asset in your studies, please consider using one of the buttons below to support my efforts by buying me a **coffee**, **sandwich**, **meal**, or anything else you'd like:
+
+ [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4FT9NG3NJMY4U&on0=Project&os0=image-occlusion "Buy me a coffee ☺") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YKSP7QF45Y7SJ&on0=Project&os0=image-occlusion "Buy me a burger 😊") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MVDM6JAL2R5JA&on0=Project&os0=image-occlusion "Buy me a meal 😄") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EYNV4ECSKBGE4&on0=Project&os0=image-occlusion "Contribute a custom amount ☺")
+
+Each and every contribution is greatly appreciated and will help me maintain and improve *Image Occlusion Enhanced* as time goes by!
diff --git a/docs/description.md b/docs/description.md
index a00d0150..4938ac1f 100644
--- a/docs/description.md
+++ b/docs/description.md
@@ -1,113 +1,49 @@
-*Image Occlusion Enhanced* is an updated version of *Image Occlusion 2.0*.
+
Image Occlusion lets you create cards that **hide parts of an image** to test your knowledge of that hidden information. The cards generated by this add-on would be best described as **image-based cloze-deletions**:
-**COMPATIBILITY**
+### IMPORTANT
-This version of Image Occlusion Enhanced only works with Anki's stable release branch (Anki 2.0.x, version 2.0.30 and up). If you are using Anki 2.1, make sure to check out the latest [development release of the add-on](https://ankiweb.net/shared/info/1374772155).
+This is a test release of Image Occlusion Enhanced for the [Anki 2.1 Beta](https://apps.ankiweb.net/docs/beta.html). Please make sure to carefully read through this description and familiarize yourself with the official Anki 2.1 beta release notes before giving the add-on a try.
-**CHANGES COMPARED TO IO 2.0**
+The present AnkiWeb upload is temporary and will be removed in favor of the [regular add-on listing](https://ankiweb.net/shared/info/1111933094) once testing is complete.
-- **Modify Existing Notes**: Update and modify your IO notes to your heart's content
-- **Change Images on the Fly**: Switch to a different image right from the Editor
-- **Create Custom Labels**: Your image is lacking a specific label? Now you can create it yourself!
-- **Completely Overhauled UI**: Tabs, multi-line entry fields, numerous new hotkey assignments
-- **Completely Reworked Note Type**: 4 additional fields, new intuitive field order
-- **Updated Card Template**: New card layout, a button to reveal all masks, optimizations for AnkiMobile
-- **Full Customization**: Add and rename as many fields as you like
-- **Updated Options Interface**: More options, fewer bugs
-- **Fully Rewritten Note Generator**: Faster, more extensible, and less bug-prone
-- **Performance Improvements**: Smaller memory footprint in general use
-- **Stability Improvements**: Bug fixes everywhere
+
-[Here's a great overview](https://www.youtube.com/watch?v=7pU9L0XybyI) by *Med School Insiders* on YouTube that goes over the key differences compared to older versions of IO.
+### LIMITATIONS OF THIS ALPHA RELEASE
-**RELEASE LOG**
+There are a number of known limitations to this alpha release that you need to be aware of:
-This section will always be updated with the latest changes to *Image Occlusion Enhanced*. More details on major releases are listed in the next section. For a full release log, including smaller bug fix releases and more details on each entry, make sure to check out the [releases page on GitHub](https://github.com/Glutanimate/image-occlusion-enhanced/releases).
+- Due to compatibility issues between SVG-Edit and the new Chromium renderer in Anki 2.1 some of the features in the masks editor no longer work correctly. My hope is to address these in the following beta release:
+ + [Pointer not changing to selection mode when clicking on shape](https://github.com/glutanimate/image-occlusion-enhanced/issues/54)
+ + [Path tool no longer working](https://github.com/glutanimate/image-occlusion-enhanced/issues/56)
+ + [https://github.com/glutanimate/image-occlusion-enhanced/issues/57](https://github.com/glutanimate/image-occlusion-enhanced/issues/57)
+- Please do not invoke the add-on's settings menu while the I/O Editor is running. There is currently no support for updating I/O editing sessions at runtime, and while most settings will simply only not be applied, others might cause the add-on to stop working correctly until the editor session is restarted. The same applies to modifications to the add-on's note type via Anki's built-in note type manager.
-2017-04-17: **v1.2.2** - Fixes a few smaller issues
-2017-02-14: **v1.2.0** - Usability improvements and under-the-hood changes
-2016-01-14: **v1.1.0** - New features, usability improvements, and bug fixes
-2016-11-10: **v1.0.0** - Ability to modify existing notes, among many other new features
-2016-09-28: **v0.3.0** - A large number of improvements to the Masks Editor
-2016-04-03: **v0.2.0** - Initial public release
+Of course there also bound to be some unforeseen bugs and regressions in the alpha. If you experience any of these please make sure to either report them on the add-on's [bug tracker](https://github.com/glutanimate/image-occlusion-enhanced/issues) or in the [official support thread](https://anki.tenderapp.com/discussions/add-ons/8295-image-occlusion-enhanced-official-thread). Any and all feedback is appreciated!
-**LATEST CHANGES AND NEWS**
+### USAGE
-*2018-06-30*
+The use of this add-on is detailed in the [Wiki](https://github.com/Glutanimate/image-occlusion-enhanced/wiki) and a [series of video tutorials on YouTube](https://www.youtube.com/playlist?list=PL3MozITKTz5YFHDGB19ypxcYfJ1ITk_6o). Please note that most of these resources have yet to be updated for Anki 2.1, and as such might not cover recent releases of the add-on fully.
-An alpha version of Image Occlusion Enhanced for Anki 2.1 is now available [here](https://ankiweb.net/shared/info/1374772155).
+
-*2017-04-17*
-
-A recent iOS-update might be affecting Image Occlusion 2.0 cards that were created earlier than 2015. If your occlusion masks are not drawn properly please use [this supplementary](https://ankiweb.net/shared/info/1048682320) add-on to fix them (thanks to mrestko for coming up with this solution).
-
-**v1.2.2**
-
-- Fixed: rare AttributeError when changing the image (thanks to Renita and Joshua for the report)
-- Fixed: GIFs should be supported on Windows and macOS now (thanks to Tiago for the help)
-- Fixed: incompatibility with upcoming release of "Quick note and deck buttons" add-on (thanks to drroscoe for the reminder)
-
-**INSTALLATION**
-
-If you are starting from a fresh Anki installation you can simply follow the generic instructions listed below this add-on description.
-
-**UPDATING**
-
-Repeating the installation procedure will allow you to update to the latest release of the add-on. However, if you are upgrading from Image Occlusion 2.0 or early versions of Image Occlusion Enhanced please make sure to read [the Wiki section on upgrading](https://github.com/Glutanimate/image-occlusion-enhanced/wiki/Upgrading) first.
-
-**USAGE**
-
-The use of this add-on is detailed in the [Wiki](https://github.com/Glutanimate/image-occlusion-enhanced/wiki) and a [series of video tutorials on YouTube](https://www.youtube.com/playlist?list=PL3MozITKTz5YFHDGB19ypxcYfJ1ITk_6o).
-
-**HELP**
-
-Please check out the [Troubleshooting section](https://github.com/Glutanimate/image-occlusion-enhanced/wiki/Troubleshooting) in the Wiki if you are experiencing issues with the add-on.
-
-Bug reports and suggestions are always welcome, but it might take me a while to get to them. **Please do not post bug reports in the review section**, as I will not be able to help you or reply. Instead, please use the [official support thread](https://anki.tenderapp.com/discussions/add-ons/8295-image-occlusion-enhanced-official-thread) (no registration necessary!).
-
-**CREDITS AND LICENSE**
+### CREDITS AND LICENSE
*Copyright © 2012-2015 [Tiago Barroso](https://github.com/tmbb)*
*Copyright © 2013 [Steve AW](https://github.com/steveaw)*
-*Copyright © 2016-2017 [Aristotelis P.](https://glutanimate.com/)*
+*Copyright © 2016-2019 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*
+
+With code contributions from: Damien Elmes, Kyle Mills, James Kraus, Matt Restko
*Image Occlusion Enhanced* is based on [Image Occlusion 2.0](https://github.com/tmbb/image-occlusion-2) by Tiago Barroso and [Simple Picture Occlusion](https://github.com/steveaw/anki_addons) by Steve AW. All credit for the original add-ons goes to their respective authors. *Image Occlusion Enhanced* would not exist without their work.
I would also like to extend my heartfelt thanks to everyone who has helped with testing, provided suggestions, or contributed in any other way.
-Licensed under the [GNU AGPL v3](https://www.gnu.org/licenses/agpl.html). The code for this add-on is available on [ GitHub](https://github.com/glutanimate/image-occlusion-enhanced). For more information on the licensing terms and other software shipped with this package please check out the [README](https://github.com/Glutanimate/image-occlusion-enhanced#credits).
-
-**OTHER ADD-ONS**
-
-Make sure to also give some of my other add-ons a try:
-
-- [Cloze Overlapper](https://ankiweb.net/shared/info/969733775) - memorize lists and enumerations effectively
-- [Review Heatmap](https://ankiweb.net/shared/info/1771074083) - tracks your review streaks and motivates you to keep on going
-- [Advanced Previewer](https://ankiweb.net/shared/info/544521385) - preview and review multiple cards at once right from within the previewer
-- [Search and Replace Tags](https://ankiweb.net/shared/info/138501288) - rename tags across multiple notes
-- [Batch Note Editing](https://ankiweb.net/shared/info/291119185) - makes batch-editing notes a breeze
-- [Sticky Searches](https://ankiweb.net/shared/info/594622823) - quick toggles for often used search terms in the browser
-
-**ADD-ON COMMISSIONS**
-
-A lot of my add-ons were commissioned by fellow Anki users. If you enjoy my work and would like to hire my services to work on an add-on or new feature, please feel free to reach out to me at:  ankiglutanimate [αt] gmail . com
-
-**MORE RESOURCES**
-
-Want to stay up-to-date with my latest add-on releases and updates? Feel free to follow me on Twitter: [@Glutanimate](https://twitter.com/glutanimate)
-
-New to Anki? Make sure to check out my YouTube channel where I post weekly tutorials on Anki add-ons and related topics: [ / Glutanimate](https://www.youtube.com/c/glutanimate)
-
-============================================
-
-**SUPPORT THIS ADD-ON**
-
-Writing, supporting, and maintaining Anki add-ons like these takes a lot of time and effort. If *Image Occlusion Enhanced* has been a valuable asset in your studies, please consider using one of the buttons below to support my efforts by buying me a **coffee**, **sandwich**, **meal**, or anything else you'd like:
+Licensed under the _GNU AGPLv3_, extended by a number of additional terms. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. For more information on the license please see the [LICENSE file](https://github.com/glutanimate/image-occlusion-enhanced/blob/master/LICENSE) accompanying this add-on. The source code is available on [ GitHub](https://github.com/glutanimate/image-occlusion-enhanced). Pull requests and other contributions are welcome!
- [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4FT9NG3NJMY4U&on0=Project&os0=image-occlusion "Buy me a coffee ☺") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YKSP7QF45Y7SJ&on0=Project&os0=image-occlusion "Buy me a burger 😊") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MVDM6JAL2R5JA&on0=Project&os0=image-occlusion "Buy me a meal 😄") [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EYNV4ECSKBGE4&on0=Project&os0=image-occlusion "Contribute a custom amount ☺")
+
-Each and every contribution is greatly appreciated and will help me maintain and improve *Image Occlusion Enhanced* as time goes by!
+
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 00000000..6f27bcf7
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+aab
diff --git a/screenshots/logo.png b/screenshots/logo.png
new file mode 100644
index 00000000..fe816a53
Binary files /dev/null and b/screenshots/logo.png differ
diff --git a/src/image_occlusion_enhanced/LICENSE b/src/image_occlusion_enhanced/LICENSE
deleted file mode 100644
index dba13ed2..00000000
--- a/src/image_occlusion_enhanced/LICENSE
+++ /dev/null
@@ -1,661 +0,0 @@
- GNU AFFERO GENERAL PUBLIC LICENSE
- Version 3, 19 November 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-our General Public Licenses are intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
- A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate. Many developers of free software are heartened and
-encouraged by the resulting cooperation. However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
- The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community. It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server. Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
- An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals. This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU Affero General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Remote Network Interaction; Use with the GNU General Public License.
-
- Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software. This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time. Such new versions
-will be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
-.
diff --git a/src/image_occlusion_enhanced/_version.py b/src/image_occlusion_enhanced/_version.py
new file mode 100644
index 00000000..8e79046a
--- /dev/null
+++ b/src/image_occlusion_enhanced/_version.py
@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+# Image Occlusion Enhanced Add-on for Anki
+#
+# Copyright (C) 2016-2019 Aristotelis P.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version, with the additions
+# listed at the end of the license file that accompanied this program.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see .
+#
+# NOTE: This program is subject to certain additional terms pursuant to
+# Section 7 of the GNU Affero General Public License. You should have
+# received a copy of these additional terms immediately following the
+# terms and conditions of the GNU Affero General Public License that
+# accompanied this program.
+#
+# If not, please request a copy through one of the means of contact
+# listed here: .
+#
+# Any modifications to this file must keep this entire header intact.
+
+"""
+Version information
+"""
+
+__version__ = "v1.3.0-alpha4"
diff --git a/src/image_occlusion_enhanced/manifest.json b/src/image_occlusion_enhanced/manifest.json
deleted file mode 100644
index 63797104..00000000
--- a/src/image_occlusion_enhanced/manifest.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "name": "Image Occlusion Enhanced (alpha)",
- "package": "image_occlusion_enhanced",
- "conflicts": ["1374772155", "1111933094"]
-}
diff --git a/tools/build_ui.sh b/tools/build_ui.sh
deleted file mode 100755
index 87b75f4a..00000000
--- a/tools/build_ui.sh
+++ /dev/null
@@ -1,66 +0,0 @@
-#!/bin/bash
-#
-# Description: Generate PyQt forms from QtDesigner project files
-# Usage: build_ui.sh
-# Dependencies: pyuic4 pyuic5 pyrcc4 pyrcc5
-#
-# Copyright: (c) 2017-2018 Glutanimate
-# (c) 2016 Damien Elmes
-# License: GNU AGPLv3
-
-shopt -s nullglob
-
-project_prefix="$1"
-qt_version="$2"
-src_folder="src/${project_prefix}"
-
-if [[ -z "$project_prefix" ]]; then
- echo "Please supply a project prefix."
- exit 1
-fi
-
-if [[ -z "$qt_version" ]]; then
- echo "Please specify the qt version."
- exit 1
-fi
-
-if [[ ! -d "$src_folder" ]]; then
- echo "Source folder not found."
- exit 1
-fi
-
-if [[ ! -d "designer" ]]; then
- echo "No QT designer folder found (PWD: $PWD). Skipping UI build."
- exit 0
-fi
-
-if [[ -z "$(find designer -name '*.ui')" ]]; then
- echo "No designer files found. Skipping UI build."
- exit 0
-fi
-
-function build_for_qt_version () {
- version="$1"
- pyuic_exec="pyuic${version}"
- form_dir="${src_folder}/forms${version}"
- if ! type "$pyuic_exec" >/dev/null 2>&1; then
- echo "${pyuic_exec} not found. Skipping generation."
- return 0
- fi
- rm -rf "$form_dir"
- mkdir -p "${form_dir}"
- init_file="${form_dir}/__init__.py"
- echo "Writing init file for ${form_dir}..."
- echo "# This file was auto-generated by build_ui.sh. Don't edit." > "${init_file}"
- for i in designer/*.ui; do
- name="${i##*/}"
- base="${name%.*}"
- outfile="$form_dir/${base}.py"
- echo "Generating ${outfile}"
- "$pyuic_exec" "$i" -o "${outfile}"
- done
-}
-
-build_for_qt_version "${qt_version}"
-
-echo "Done."