Skip to content

Commit 7bd7424

Browse files
committed
Add windows readme.
1 parent 3078088 commit 7bd7424

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

README_WINDOWS.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Mouse Damper for Windows
2+
3+
Windows-native implementation of Mouse Damper.
4+
5+
## System Requirements
6+
7+
- Windows 7 or newer (32-bit or 64-bit)
8+
- No external dependencies required
9+
10+
## Building from Source
11+
12+
### Prerequisites
13+
14+
1. MSYS2 - Download from https://www.msys2.org/
15+
2. Install MSYS2 and open **MSYS2 MINGW64** terminal
16+
3. Install build tools:
17+
```bash
18+
pacman -Syu
19+
pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-meson mingw-w64-x86_64-ninja
20+
```
21+
22+
### Build Steps
23+
24+
```bash
25+
cd /d/dev/mouse-damper
26+
meson setup build
27+
ninja -C build
28+
```
29+
30+
### Build Output
31+
32+
Three executables are created in `build/src/`:
33+
- `mousedamper.exe` (~290KB) - Main daemon
34+
- `mousedamper-launch.exe` (~293KB) - Launcher with configuration support
35+
- `mousedamper-config.exe` (~308KB) - GUI configuration tool
36+
37+
## Installation
38+
39+
### Option 1: NSIS Installer (Recommended)
40+
41+
If you have NSIS installed (https://nsis.sourceforge.io/):
42+
43+
```bash
44+
makensis installer.nsi
45+
```
46+
47+
This creates `mousedamper-setup.exe` which:
48+
- Installs to `C:\Program Files\MouseDamper\`
49+
- Creates Start Menu shortcuts
50+
- Registers in Programs and Features
51+
- Creates uninstaller
52+
53+
### Option 2: Manual Installation
54+
55+
1. **Create installation directory:**
56+
```
57+
C:\Program Files\MouseDamper\
58+
```
59+
60+
2. **Copy executables:**
61+
```
62+
build\src\mousedamper.exe → C:\Program Files\MouseDamper\
63+
build\src\mousedamper-launch.exe → C:\Program Files\MouseDamper\
64+
build\src\mousedamper-config.exe → C:\Program Files\MouseDamper\
65+
```
66+
67+
3. **Create Start Menu shortcut (optional):**
68+
- Right-click on `mousedamper-config.exe`
69+
- Send to → Desktop (create shortcut)
70+
- Move shortcut to: `%APPDATA%\Microsoft\Windows\Start Menu\Programs\`
71+
72+
Settings are stored in: `%APPDATA%\mousedamper\config.ini`
73+
74+
Example:
75+
```ini
76+
[MouseDamper]
77+
Enabled=1
78+
DeltaThreshold=100
79+
OverrideDoubleClickTime=0
80+
DoubleClickTimeOverride=400
81+
```
82+
83+
### If installed with NSIS installer:
84+
1. Use "Uninstall Mouse Damper" from Start Menu, or
85+
2. Use Programs and Features in Control Panel
86+
87+
### If installed manually:
88+
1. Stop the daemon: `taskkill /F /IM mousedamper.exe`
89+
2. Remove autostart (if enabled):
90+
- Open Registry Editor (regedit)
91+
- Navigate to: `HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run`
92+
- Delete value: `MouseDamper`
93+
3. Delete installation directory: `C:\Program Files\MouseDamper\`
94+
4. Delete configuration (optional): `%APPDATA%\mousedamper\`
95+
96+
## License
97+
98+
GPL-3.0 - See COPYING file for details
99+
100+
Copyright 2020 Michael Webster <miketwebster@gmail.com>

0 commit comments

Comments
 (0)