Skip to content

Commit 34ad698

Browse files
Update README.md
1 parent 246113d commit 34ad698

File tree

1 file changed

+52
-2
lines changed

1 file changed

+52
-2
lines changed

README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
1-
# auto-clicker
2-
Simple Electron auto clicker.
1+
# Auto Clicker App
2+
3+
Automate mouse clicks with ease using this Electron Forge application. The app includes a user-friendly interface and a profile system for managing different auto-click options, each with customizable labels.
4+
5+
## Features
6+
7+
- **Mouse Click Automation:** Effortlessly automate mouse clicks for repetitive tasks.
8+
- **Profile System:** Create and manage multiple auto-click profiles for various use cases.
9+
- **Custom Labels:** Easily identify and switch between different auto-click profiles with customizable labels.
10+
11+
## Getting Started
12+
13+
### Prerequisites
14+
15+
Make sure you have Node.js and npm installed on your machine.
16+
17+
### Dependencies
18+
- [RobotJS](https://github.com/octalmage/robotjs)
19+
- [sqlite3](https://github.com/mapbox/node-sqlite3)
20+
21+
### Installation
22+
23+
Clone this repository: https://github.com/programmingKyle/auto-clicker
24+
cd auto-clicker
25+
npm install
26+
27+
## How To Use
28+
First in the auto-clicker directory open a terminal and input 'npm start'.
29+
Then simply select an input value you desire and click F9 on the keyboard.
30+
31+
### How To Setup a Profile
32+
Once you've input your desired inputs click the + button at the top left and input a title for your profile and click add. Now your profile will be visible on the right side of the application for quick selection.
33+
34+
### How to Edit a Profile
35+
- To edit a profile, choose the desired profile and click the "Edit" button located to the left of the active profile text. Upon clicking, you will enter the profile edit mode, where all inputs are restricted to the selected profile. Changes will only be applied when you click the "Save" button.
36+
- Click the back button to undo all changes made while in edit mode
37+
- While in edit mode click the active profile text and edit the profile title
38+
39+
### Thank you
40+
Thank you for checking out Auto Clicker. Any contributions are welcome.
41+
42+
![Screenshot 2024-02-12 220357](https://github.com/programmingKyle/auto-clicker/assets/155344874/1c3ee3c7-781a-436f-a20e-84abf471a368)
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+

0 commit comments

Comments
 (0)