Skip to content

Latest commit

 

History

History
180 lines (133 loc) · 8.14 KB

README.md

File metadata and controls

180 lines (133 loc) · 8.14 KB
Raw
logo

Auto Clicker for macOS

A simple auto clicker for macOS Big Sur (11), Monterey (12) and Ventura (13) built with ♥️ in Swift 5 & SwiftUI.


📔 Table of Contents

🌟 About the Project

All the auto clickers out there were either really outdated, old, buggy and/or have legacy code bases. This one aims to fix all that giving you flexibility and style. Plus, I get to write in easter eggs, who says love can't be colourful.

📷 Screenshots

screenshot

👾 Tech Stack

🎯 Features

  • An auto clicker of mouse buttons and presser of keyboard keys!
  • Allows for pressing or clicking;
    • ... of any mouse or keyboard button
    • ... at a given interval
    • ... for a given amount of presses per interval
    • ... for a given amount of times
    • ... after a delayed start
  • Custom keyboard shortcuts to start and stop the clicking or pressing globally
  • Option to keep the window on top for easy access
  • Persists all your options between sessions
  • Fresh and modern UI/UX
  • Lots of colour schemes to suit what ever you prefer

💾 Download

Download: v1.5.0

When first using the app, you will need to right click the app and click 'Open', then on the macOS popup window select 'Open' again to trust this version of the app going forward. This is as at the moment I don't have a paid Apple developer account in order to notarize the app.

For more downloads, checkout the releases page for app downloads of any version you want to use, even pre-release builds too.

⚙️ Preferences Storage

The configuration for the app is stored using NSUserDefaults, via the sindresorhus/Defaults package, meaning all the applications preferences are stored in the following location:

~/Library/Preferences/com.othyn.auto-clicker.plist

This file can be backed up and/or be used transfer your preferences to other machines, although I'll leave the mechanism for doing so up to you.

If you are looking for ideas on how to achieve this, I often like to use Symbolic Links (symlink). By placing the real version of the file in the backup location (in something like a git repo, cloud storage or local/remote storage) and then creating a symlink to the location that the application is expecting, you can safely store the file in the backup location without having to manually move it around or setup auto copy tasks. I accept no responsibility for using this approach, this is for education purposes only, do this at your own risk.

The following commands are an example of how you can achieve this, making sure to close the app first before doing this to avoid any issues:

# Firstly, move the preferences file to the backup location
mv "${HOME}/Library/Preferences/com.othyn.auto-clicker.plist" /path/to/backup/directory/com.othyn.auto-clicker.plist

# Secondly, create a symlink from our backup location to the expected file location for the app
ln -s /path/to/backup/directory/com.othyn.auto-clicker.plist "${HOME}/Library/Preferences/com.othyn.auto-clicker.plist"

Note that both paths used must be the absolute path to the file, any relative paths won't resolve and the symlink will be created but silently fail as it will be pointed at a path that cannot resolve to the target.

🐭 Contributing

See the contribution guide on how to get started. Thank you for contributing!

Detailed within that guide are steps on how...

  • ... issues should be used.
  • ... to setup the project.
  • ... to contribute new languages via the app's localisation support.
  • ... branches should be used.
  • ... commits should be formatted.
  • ... pull requests should be submitted.
  • ... the build process works and the automation that drives it.

This gold star ⭐ can be yours if you can figure out why the emoji is a mouse.

⚠️ License

Distributed under the MIT License. See LICENSE for more information.

💎 Acknowledgements

Useful resources and libraries that have been used in the making of this project.

Why a mouse emoji? Auto Clicker > Click with a mouse > Mouse! ... yeah, I know... I know...