Skip to content

Commit 43cc473

Browse files
committed
docs: config details
1 parent 6e7a5ba commit 43cc473

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,55 @@ It provides:
7676
└── README.md
7777
```
7878

79+
## Configuration Details (config.json)
80+
81+
The config.json file lets you customize paths, intervals, email, and GUI settings — no code changes needed.
82+
83+
#### Default Config
84+
85+
```{
86+
"paths": {
87+
"data_dir": "data",
88+
"keys_file": "data/key_log.txt",
89+
"system_file": "data/systeminfo.txt",
90+
"clipboard_file": "data/clipboard.txt",
91+
"screenshot_dir": "data/screenshots"
92+
},
93+
"intervals_seconds": {
94+
"screenshot_interval": 900,
95+
"email_interval": 900,
96+
"clipboard_interval": 30
97+
},
98+
"screenshots": { "keep_latest": 10 },
99+
"email": {
100+
"smtp_host": "smtp.gmail.com",
101+
"smtp_port": 587,
102+
"from_env": true
103+
},
104+
"gui": { "icon": "cracking.ico", "image": "cracking.png", "window_title": "Key Logger 5155" },
105+
"safety": { "require_confirm": true }
106+
}
107+
```
108+
109+
#### Parameter Summary -
110+
111+
112+
| Section | Key | Default | Description |
113+
| :-------------------- | :-------------------- | :------------------- | :--------------------------------- |
114+
| **paths** | `data_dir` | `data` | Directory for storing logs. |
115+
| | `keys_file` | `data/key_log.txt` | Keystroke log file. |
116+
| | `clipboard_file` | `data/clipboard.txt` | Clipboard data file. |
117+
| | `screenshot_dir` | `data/screenshots` | Folder for screenshots. |
118+
| **intervals_seconds** | `screenshot_interval` | `900` | Take screenshot every 15 mins. |
119+
| | `email_interval` | `900` | Send logs via email every 15 mins. |
120+
| | `clipboard_interval` | `30` | Capture clipboard every 30s. |
121+
| **screenshots** | `keep_latest` | `10` | Keep only latest screenshots. |
122+
| **email** | `smtp_host` | `smtp.gmail.com` | Mail server for sending logs. |
123+
| | `from_env` | `true` | Load credentials from`.env`. |
124+
| **gui** | `window_title` | `Key Logger 5155` | GUI window title. |
125+
126+
#### - Modify these values to change log intervals, file paths, or email setup without touching the source code.
127+
79128
## Tech Stack
80129

81130
* **Python 3.9+**

0 commit comments

Comments
 (0)