Skip to content

Commit bf8a0be

Browse files
committed
feat: Add files for GitHub Pages site
1 parent ca9a038 commit bf8a0be

4 files changed

Lines changed: 72 additions & 0 deletions

File tree

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-minimal

docs/images/screenshot.png

49.3 KB
Loading

docs/index.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# SimpleKeyClicker
2+
3+
![SimpleKeyClicker Logo](logo.png)
4+
5+
A powerful and user-friendly GUI automation tool for simulating keyboard and mouse inputs. Built with Python and ttkbootstrap. Perfect for gaming macros, testing, or automating repetitive input tasks.
6+
7+
![SimpleKeyClicker Screenshot](images/screenshot.png)
8+
9+
---
10+
11+
## Key Features
12+
13+
* **Action Sequencing**: Create and run sequences of keyboard presses and mouse actions.
14+
* **Repetition Control**: Run sequences indefinitely or for a specific number of times.
15+
* **Customizable Timing**: Set delays *after* each action and specify hold durations.
16+
* **Theme Support**: Toggle between Light (Flatly) and Dark (Darkly) themes.
17+
* **Advanced Mouse Control**: Perform clicks and movements at specific screen coordinates (`moveto(x,y)`, `click(x,y)`).
18+
* **Coordinate/Color Capture**: Easily capture mouse coordinates (X,Y) and screen pixel color (R,G,B) with a single click.
19+
* **Color Detection**: Pause execution until a specific color appears at designated coordinates (`waitcolor`) with timeout error handling.
20+
* **Reliable Typing**: Type strings accurately, preserving case and handling symbols.
21+
* **Save/Load Configurations**: Save/Load sequences and run settings (repetition mode/count) to JSON files.
22+
* **Safety Features**: Toggleable Safe Mode and Emergency Stop (ESC key).
23+
* **Visual Feedback**: Highlights the current row, shows loop counts, and overall status.
24+
* **Organized UI**: Clean layout with a menu bar for less frequently used actions.
25+
* **Global Hotkeys**: Start (`Ctrl+F2`), Stop (`Ctrl+F3`), and Emergency Stop (`ESC`).
26+
27+
---
28+
29+
## Download
30+
31+
Get the latest release directly from the **[GitHub Releases Page](https://github.com/timoinglin/SimpleKeyClicker/releases/latest)**.
32+
33+
*(Look for the `.exe` file for Windows)*
34+
35+
---
36+
37+
## Quick Start
38+
39+
1. Download and run the `.exe` file from the [latest release](https://github.com/timoinglin/SimpleKeyClicker/releases/latest).
40+
2. Click "**Add Row**" to create steps for your sequence.
41+
3. For each row:
42+
* Enter a **Key/Button** or command (see **Help > Show Keys/Actions Info** in the app).
43+
* Use "**Capture**" to easily get coordinates/colors for commands like `moveto`, `click(x,y)`, `waitcolor`.
44+
* Set the **Hold Time** and **Delay**.
45+
4. Use the ****, ****, ****, **X** buttons on each row to organize your sequence.
46+
5. Select the desired **Run Mode**: "Run Indefinitely" or "Run X Times".
47+
6. **(Optional)** Go to **File > Save Configuration**.
48+
7. Click "**Start**" or press `Ctrl+F2`.
49+
8. Click "**Stop**" or press `Ctrl+F3` (or `ESC`).
50+
51+
---
52+
53+
## Building from Source (Optional)
54+
55+
1. Ensure Python 3.7+ is installed.
56+
2. Clone the repository: `git clone https://github.com/timoinglin/SimpleKeyClicker.git`
57+
3. Navigate to the directory: `cd SimpleKeyClicker`
58+
4. Create and activate a virtual environment (recommended):
59+
```bash
60+
python -m venv venv
61+
# On Windows: venv\Scripts\activate
62+
# On macOS/Linux: source venv/bin/activate
63+
```
64+
5. Install dependencies: `pip install -r requirements.txt`
65+
6. Run the application: `python main.py`
66+
67+
---
68+
69+
## Repository
70+
71+
Find the full source code and contribute on **[GitHub](https://github.com/timoinglin/SimpleKeyClicker)**.

docs/logo.png

73.9 KB
Loading

0 commit comments

Comments
 (0)