You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,21 @@
1
1
# Stream Starting countdown timer
2
2
Allows you to show an accurate countdown at the start of stream, and fire events at specified times.
3
3
Events can be VNyan websockets, MixItUp commands or external executables
4
+
* 100% Free and Open Source
5
+
* No ads, no premium version, no subscription, no monetization of any sort
6
+
* Lightweight portable executable
7
+
* No registry settings, just config.json files in the exe directory
4
8
5
9
## Quick Start
6
-
1. Add a window capture in OBS capturing this application, put this on your "Stream Starting" scene
7
-
2. Add a crop filter to remove the top toolbar and the bottom status bar
8
-
3. Add a Chroma key filter to greenscreen the clock
9
-
4. Click the Clock Font button and set your desired font and size
10
-
5. Close the application
11
-
6. Run StreamStartingTimer.exe -m 5 for a five minute countdown
10
+
1. Requires [.net 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). This should already be installed on most modern versions of Windows
11
+
2. Download the .zip file from the [latest release](https://github.com/LumKitty/StreamStartingTimer/releases) and extract to wherever you keep your streamer tools
12
+
3. Run StreamStartingTimer.exe
13
+
4. Add a window capture in OBS capturing this application, put this on your "Stream Starting" scene
14
+
5. Add a crop filter to remove the top toolbar and the bottom status bar
15
+
6. Add a Chroma key filter to greenscreen the clock
16
+
7. Click the Clock Font button and set your desired font and size
17
+
8. Close the application
18
+
9. Run StreamStartingTimer.exe -m 5 for a five minute countdown
12
19
13
20
## Usage
14
21
This application is designed to be started from the commandline or launched from a Stream Deck. Commandline options:
@@ -22,6 +29,12 @@ While the timer is running, you can used the +30s and +1m buttons to add time to
22
29
23
30
If the application was started with ```-m```, ```-s``` or ```-p``` it will automatically close once the timer expired. If it is manually started it will remain open.
2. Add the Advanced launcher to a button on your stream deck
35
+
3. Click "Choose File" and point to StreamStartingTimer.exe
36
+
4. Add commandline arguments as described above
37
+
25
38
## Configuration
26
39
The clock font can be customised to match your overall aesthetic. Click the "Clock Font" text to choose your font, change the colour by entering a hex code immediately to right of the font button.
27
40
If your clock colour is green, change the Background colour to a different colour hex code and adjust your OBS chroma key filter to match
@@ -50,6 +63,11 @@ Will be run exactly as if you'd typed it at a command prompt (e.g. powershell.ex
50
63
## Testing
51
64
Running the application without commandline parameters will open it in setup/test mode. Immediately to the right of the +1m button you can set a time, in seconds for the timer to start at. The application will not quit when the timer expires
52
65
66
+
## StatusBar indicators
67
+
When the application starts, the indicators in the bottom left corner will be yellow and we will attempt to connect to VNyan and MixItUp
68
+
When they turn green we have successfully connected
69
+
If they turn red, connection has timed out, but we will keep retrying. This is a visual indicator to actually start your streaming software! :D
0 commit comments