Eye on Cursor

Let your desktop "keep an eye" on your mouse!

Overview

Eye on Cursor is a fun and practical extension that gives your panel eyes that constantly follow your mouse. This quirky feature, combined with a highly customizable mouse tracker that highlights clicks, makes it easier than ever to monitor your mouse movements, ensuring your pointer gets all the attention it needs.

Features

• Eyes Follow Cursor: As many eyes as you want in the panel to follow the cursor movements, providing a fun and interactive experience.
• Customizable Mouse Tracker: Highlights clicks and tracks mouse movements with customizable settings to fit your preferences.
• Click Highlighting: Visual feedback for mouse clicks, making it easier to keep track of your actions, especially useful for presentations or demonstrations.

Installation

From the GNOME Extensions Website (recommended)

From GitHub

1. Go to the latest release and download the extension zip file.

2. At the location of the downloaded zip file, run:

   gnome-extensions install [email protected]

3. Log out and back in, then enable the extension in your extensions app or with:

   gnome-extensions enable [email protected]

Acknowledgements

This extension is forked from Eye and Mouse Extended by Alexey Lovchikov.

Eye and Mouse Extended also has a fork for the Cinnamon Desktop, c-eyes, created by anaximeno.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or find any bugs.

Translations and new glyphs for the mouse tracker are greatly appreciated as well!

If you have contributed in any way, feel free to add yourself to the credits.js file in settings.

Development

Here are a few steps to get you set up:

1. Create a fork to start working on the changes you want to implement.
2. Clone your repository.
3. In the root of the repo, run npm install to enable linting and formatting (you need the nodejs package installed on your system). You will then be able to run npm run lint and npm run format to check the code.
4. Run make install && make enable to use the extension or make test to debug it. The Makefile contains a few other commands that should be useful for debugging.

Known Issues

• On Wayland, the mouse tracker click highlighting feature does not function within application windows.

  Wayland handles events differently compared to X11, isolating them to the window where they occur. On x11, Eye on Cursor uses Atspi to listen to mouse clicks, which doesn't work at all on Wayland. On Wayland, the extension thus resorts to listening with globe.stage instead, with its caveat that only clicks in the Shell (background, panel, etc.) are registered.

• On x11, middle click is not registered.

  Atspi does not register middle clicks.

Documentation on Developing GNOME Extensions

Resources to get you started:

• GJS Guide
• GNOME Shell Extensions Review Guidelines
• GNOME Human Interface Guidelines