Skip to content

Commit 054a4c2

Browse files
committed
Update Readme
1 parent c820db1 commit 054a4c2

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
This is a tool built in React and Electron to help you clip VODs of tournaments automatically! It's a work in progress, so please be patient and expect some bugs ><. If you run into any issues or have any suggestions, please make an issue [here](https://github.com/willie-yao/tournament-vod-clipper/issues) so I can fix it ASAP!
44

55
## Main Features
6+
67
- Automatically clips Twitch VODs of matches from a start.gg bracket
78
- Clips and downloads matches in parallel
8-
- Upload VODs to YouTube automatically
9+
- Generates thumbnails for each match
10+
- Upload VODs to YouTube automatically (on hold until YouTube approval)
911

1012
## Requirements
1113

@@ -14,19 +16,22 @@ Windows: This tool is Windows-only for the time being. Releases for Mac and Linu
1416
## How to Use
1517

1618
### Pre-requesites
19+
1720
This tool clips VODs automatically by retrieving timestamps of when matches are started and reported on Start.GG. In order for your VODs to be clipped accurately, you need to do the following:
1821

19-
1. Assign a station number to the stream setup. Please refer to the Start.GG documentation [here](https://help.start.gg/en/articles/1465692-adding-streams-and-creating-stations#:~:text=Adding%20a%20Stream%20to%20a%20Station). **IMPORTANT:** Assigning a stream station is not enough. You must assign the stream to a station number, then assign the match to the number, not the station!
22+
1. Assign stream sets to a stream setup. Please refer to the Start.GG documentation [here](https://help.start.gg/en/articles/1465692-adding-streams-and-creating-stations).
2023
2. Start the stream match exactly when you want the VOD for that match to start. Likewise, report the match exactly when you want the VOD to end. If this is done incorrectly, your VOD will start/end at the wrong times.
21-
3. Report characters for the match if you want the characters to show up on the video title.
24+
3. Report characters for the match if you want the characters to show up on the video title and thumbnails.
2225

2326
### Download
27+
2428
- Download the latest release from the releases page:
2529
- https://github.com/willie-yao/tournament-vod-clipper/releases
2630
- Extract the zip file to a folder of your choice
2731
- Run the `tournament-vod-clipper.exe` file
2832

2933
### Retrieving streamed sets
34+
3035
- First, you need to generate a Start.GG authentication token. You can do so by following the instructions here:
3136
- https://developer.start.gg/docs/authentication/
3237
- Once you have your token, paste it into the `Start.GG API Key` field in the tool
@@ -38,13 +43,15 @@ This tool clips VODs automatically by retrieving timestamps of when matches are
3843
- Finally, click the `Retrieve Sets` button. This will take you to a new page.
3944

4045
### Downloading sets
46+
4147
- You should be able to see a list of sets that were played on stream! Select the ones that you want to download by clicking on each set.
4248
- To select all or deselect all, toggle the `Select All` button.
49+
- To edit timestamps, click on the edit icon next to the set. This will open a modal where you can edit the title, start time, and end time.
4350
- When you have selected all the matches, click the `Download VODs` button. Your VODs will be saved to the `/downloadedVODs` folder.
4451

4552
### Uploading VODs to YouTube
53+
4654
- Once the VODs are downloaded, you can navigate to the upload page by clicking the `Upload` button.
4755
- You will need to login to your YouTube account. Click the `Login` button and follow the instructions.
4856
- Next, select the tournament you want to upload VODs from using the `VOD Folder` box.
4957
- Finally, click the `Upload` button. You should see the VODs being processed on your YouTube account!
50-

0 commit comments

Comments
 (0)