Skip to content

Commit 70c4907

Browse files
committed
Add readme
1 parent b073df9 commit 70c4907

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# TitleScraper
2+
3+
TitleScraper is a simple program to catch \[parts of\] a title of an open window, and outputs it to a file on your desktop.
4+
5+
![](https://voxelfox.co.uk/static/images/titlescraper/main.png)
6+
7+
## Use Cases
8+
9+
This system is useful for those who stream with Spotify or another program playing music, and want its song title output onto your stream. By selecting the file you're outputting to as a source in your OBS settings, you can have a constantly updating song tracker on your screen.
10+
11+
## Usage
12+
13+
**Window match regex** is the string/regex to search for in each open window's executable name. For example, the regex `firefox` would match any `firefox.exe` window.
14+
15+
**Title match regex** is the string/regex to search for in each of the matching window's titles. If you used the regex `(.+) - (.+)`, then any titles from `firefox.exe` windows with a hyphen and two spaces in them would be matched.
16+
17+
**File output regex** is the ouptut string to be put into the given file. If your output regex was `\1` then the first group before the hyphen would be matched.
18+
19+
**File output location** is the location where the file output is written.

0 commit comments

Comments
 (0)