https://github.com/gregives/squeak

An open-source mouse recorder and desktop automation software
https://github.com/gregives/squeak

Last synced: 10 months ago
JSON representation

An open-source mouse recorder and desktop automation software

• Host: GitHub
• URL: https://github.com/gregives/squeak
• Owner: gregives
• Created: 2019-06-26T16:11:14.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-31T15:25:13.000Z (over 2 years ago)
• Last Synced: 2024-10-31T01:13:05.342Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 3.74 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![Squeak logo](assets/banner.png)




> An open-source mouse recorder and desktop automation software

Squeak is an electron app for desktop automation, including controlling the mouse, keyboard input, waiting for a period of time or until a pixel changes colour and more.

[![Download for Windows](https://img.shields.io/static/v1?label&message=Download%20for%20Windows&logo=windows&style=for-the-badge&color=0078D6)](https://github.com/gregives/Squeak/releases/tag/v1.0.0-alpha)

In theory, Squeak is built for **Windows, Linux and Mac** as it uses [robotjs](https://github.com/octalmage/robotjs) and [iohook](https://github.com/wilix-team/iohook), however, I have only tested Squeak on Windows at the time of writing.




![Screenshot of Squeak](assets/screenshot.png)

## Roadmap

If you have any feature requests, please create an issue and I will add it to the roadmap. Or you could make a pull request!

- [x] Keyboard output (raw keystrokes)

- [ ] Text output (arbitrary string with randomness)

- [ ] Scroll output

- [x] Abstract actions into single file modules

- [ ] Multiple monitor support

- [ ] Recent files

- [ ] Wait for image on screen

- [ ] Playback speed

- [ ] Record input from mouse and keyboard

- [ ] Switching applications

- [ ] Hotkeys e.g. for cancelling playback

- [ ] Set up Travis for Linux and Mac builds

- [ ] Some tests would be good!

## Development

``` bash

# Install dependencies

npm install

# Serve with hot reload at localhost:9080

npm run dev

# Build electron application for production

npm run build

# Lint all JS/Vue component files in `src/`

npm run lint

```

---

This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).