GNOME Bugzilla – Bug 748545
Update End User Plugin Documentation
Last modified: 2018-08-17 19:45:18 UTC
This bug is to update the end user plugin documentation so that it accurately reflects the plugins used within mousetrap along with a brief description of what they do.
Created attachment 302472 [details] [review] Patch file Attached is the proposed patch to this bug.
Review of attachment 302472 [details] [review]: Looks reasonable to me.
Review of attachment 302472 [details] [review]: I've left a few in-line comments asking for clarification on some of these descriptions. I'm also not sure what "vision plugin" is being described, as far as I can tell there is not one in the MouseTrap code base. ::: README.md @@ +120,3 @@ +The display plugin is responsible for writing the user's image onto the screen so that the user can see their own image. + +* Nose It might be useful to mention the fact that there are two nose plugins, one that deals with the nose as a joystick and the other which aligns the pointer with the nose's position within the webcam image. The nose plugin does more than just get the point, it actually moves the pointer. @@ +122,3 @@ +The nose plugin is responsible for detecting the user's nose and uses the user's nose as a point to detect movement. + +* Eyes Saying that the eye plugin "detects motion" is slightly misleading, as it detects it for a complete different reason than the nose plugins. The eyes plugin is responsible for detecting the user's eyes. It checks whether or not the user's left eye has been closed and will trigger a left click as long as the eye is stationary. @@ +124,3 @@ +The eyes plugin is responsible for detecting the user's eyes. It detects motion of the eyes, checks whether or not an eye has been closed and has a class to detect the user's left eye. + +* Vision Do we _have_ a vision plugin? I know we have a `FeatureDetectorClearCachePlugin` plugin which resets the feature detection cache (for performance reasons), but what is described here sounds like the `mousetrap.vision` module.
mousetrap is not under active development anymore since 2015. Its codebase has been archived: https://gitlab.gnome.org/Archive/mousetrap/commits/master Closing this report as WONTFIX as part of Bugzilla Housekeeping to reflect reality. Please feel free to reopen this ticket (or rather transfer the project to GNOME Gitlab, as GNOME Bugzilla is deprecated) if anyone takes the responsibility for active development again.