Mouse-tracking plugin for OpenSesame
Python PostScript
Clone or download
PascalKieslich Ensure cursor is reset correctly in full screen
Ensure cursor is reset correctly in full screen mode by using show_cursor
Latest commit d42a9b7 Jul 12, 2018
Permalink
Failed to load latest commit information.
examples
plugins
validation
.gitignore
LICENSE
README.md
setup.py

README.md

Mousetrap plugin for OpenSesame

Easily build mouse-tracking experiments with OpenSesame.

[Installation] [Examples] [Forum] [Mailing list] [Paper]

The mousetrap plugin provides two items that implement mouse-tracking in OpenSesame. Both offer different ways of implementing mouse-tracking:

alt text The mousetrap_response item tracks mouse movements while another stimulus (e.g., a sketchpad) is presented.

alt text The mousetrap_form item allows tracking of mouse movements in custom forms specified using OpenSesame script.

More information about each item can be found in the corresponding helpfile (as linked above).

Once data have been collected with the mousetrap plugin, the data can be processed, analyzed and visualized using the mousetrap R package.

General information

Mousetrap is developed by Pascal Kieslich and Felix Henninger. Questions about using mousetrap can be asked in the forum.

It is published under the GNU General Public License (version 3).

If you use mousetrap in your published research, we kindly ask that you cite it as follows:

Kieslich, P. J., & Henninger, F. (2017). Mousetrap: An integrated, open-source mouse-tracking package. Behavior Research Methods, 49(5), 1652-1667. https://doi.org/10.3758/s13428-017-0900-z

Installation

Please select which mousetrap-os version to install depending on which OpenSesame version you are using:

Please sign up to our mailing list to be notified once this recommendation changes and a stable version of mousetrap-os for OpenSesame 3.2.0 and later is released.

Latest stable version

mousetrap-os is available on the Python Package Index. To install the latest release, please run the following commands in OpenSesame's debug window:

import pip
pip.main(['install', 'opensesame-plugin-mousetrap'])

You'll need to restart OpenSesame after the installation for the mousetrap items to work.

If the installation fails due to missing write access, you may have to run OpenSesame with administrator privileges for the installation (on Windows, right-click the OpenSesame program icon and select Run as Administrator).

The installation of plugins is covered in more detail in the OpenSesame documentation, which also covers alternate methods. To install mousetrap manually, please download the archive attached to the latest release

Release notes for the latest version are available, as for all previous releases.

Development version

To install the latest development version, please follow the above instructions, replacing the command with the following:

import pip
pip.main(['install', 'https://github.com/PascalKieslich/mousetrap-os/archive/master.zip'])

Examples

A number of example experiments that demonstrate the basic features of the items can be found in the examples folder.

Mailing list

If you would like to receive information about new releases, you can add your email to the mailing list. Questions about using mousetrap can be asked in the forum.

Validation

The results from a technical validation of the plugin can be found in the validation folder.

Acknowledgments

Mousetrap extends the many useful features of OpenSesame developed by the OpenSesame development team led by Sebastiaan Mathôt. Mousetrap uses modified icons from the Moka Icon Theme (by Sam Hewitt). We thank Anja Humbs for testing a development version. This work was supported by the University of Mannheim’s Graduate School of Economic and Social Sciences, which is funded by the German Research Foundation.