Skip to content

Commit d5192d9

Browse files
authored
More descriptive appExclusions section on README (#1706)
1 parent 4cd799d commit d5192d9

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
88
### Added
99
- new icon styles preference for tray (showing time to break or visual progress to break)
1010
- Autostart functionality in Flatpaks
11+
- updated appExclusions section on README to include description for Windows and substring matching
1112

1213
### Fixed
1314
- snap package not starting on Wayland

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,7 @@ By editing `appExclusions` in preferences file, you can automatically control wh
366366

367367
If you want Stretchly to be paused when specific apps are running, you could have this value (breaks are paused when Skype or Atom are running):
368368

369+
Linux
369370
```
370371
"appExclusions": [
371372
{
@@ -379,8 +380,23 @@ If you want Stretchly to be paused when specific apps are running, you could hav
379380
]
380381
```
381382

383+
Windows
384+
```
385+
"appExclusions": [
386+
{
387+
"rule": "pause",
388+
"active": true,
389+
"commands": [
390+
"librewolf.exe",
391+
"masseffectlauncher.exe"
392+
]
393+
}
394+
]
395+
```
396+
382397
If you want Stretchly to be running when specific apps are as well, you could have this value (breaks are paused when Skype or Atom are not running):
383398

399+
Linux
384400
```
385401
"appExclusions": [
386402
{
@@ -394,7 +410,23 @@ If you want Stretchly to be running when specific apps are as well, you could ha
394410
]
395411
```
396412

397-
You can specify multiple values, (as `appExclusions` is array) and Stretchly will take the first one that is marked as `"active": true`. Multiple `commands` can be specified as well. Commands should be case sensitive, but seems like this is not consistent across platforms. Therefore, sometimes, going all lowercase might be needed (this was noticed on Windows).
413+
Windows
414+
```
415+
"appExclusions": [
416+
{
417+
"rule": "resume",
418+
"active": true,
419+
"commands": [
420+
"librewolf.exe",
421+
"masseffectlauncher.exe"
422+
]
423+
}
424+
]
425+
```
426+
427+
You can specify multiple values, (as `appExclusions` is array) and Stretchly will take the first one that is marked as `"active": true`. Multiple `commands` can be specified as well. Commands should be case sensitive, but seems like this is not consistent across platforms. Therefore, sometimes, going all lowercase might be needed (this was noticed on Windows). Commands can also be substrings, meaning a rule containing "exe" will trigger when there's any running processes that contains "exe" in its name or cmd properties.
428+
429+
For Windows, note that paths not specified. This is because on Windows, the API we're using only checks the names of processes being run, which in the vast majority of cases is "process_name.exe". If you try to specify paths, it will not work.
398430

399431
You can also specify `appExclusionsCheckInterval` in milliseconds: lower number means more often checks, but also higher CPU usage. Default value is `1000` which is 1 second.
400432

@@ -611,6 +643,7 @@ You can help to translate Stretchly on [Weblate](https://hosted.weblate.org/enga
611643
- Lorenzo García Rivera, @lorenzogrv, [lorenzogrv.tech](https://lorenzogrv.tech)
612644
- Aleh, [@alehpa](https://github.com/alehpa)
613645
- Philip Wintersteiner, [@Wikiwix](https://github.com/wikiwix)
646+
- Steven Cai, [@stevencaiOR](https://github.com/stevencaiOR)
614647

615648
Also see Github's list of [contributors](https://github.com/hovancik/stretchly/graphs/contributors).
616649

0 commit comments

Comments
 (0)