Stvad / CrowdAnki

Plugin for Anki SRS designed to facilitate cooperation on creation of notes and decks.
MIT License
520 stars 44 forks source link

Add manifest.json #186

Closed aplaice closed 1 year ago

aplaice commented 1 year ago

I do not think that keeping manifest.json in the source tree has any disadvantages (e.g. for manual install or for uploading to AnkiWeb). Having a manifest.json allows users to install the zipped add-on via the new-ish "sharing outside ankiweb" install process[0].

Not all the fields are specified in the docs, but they can be sleuthed by inspecting Anki's source code[1].

It might make sense for mod and human_version, to be updated automatically, when releasing, or we could just drop them.

If we ever have beta builds, the conflicts field could allow the release builds to conflict with the beta builds (and vice-versa), to allow users a way to quickly and easily switch.

A positive max_point_version does not indicate maximum 2.1.x compatible Anki version, but the highest version tested.

[0] https://addon-docs.ankiweb.net/sharing.html#sharing-outside-ankiweb

[1] https://github.com/ankitects/anki/blob/c32f14f7cbc9461e35548afa5b42c5424606008f/qt/aqt/addons.py#L186


For the moment I manually added a manifest.json to the latest release.