Skip to content

Commit

Permalink
Update readme to include more links to streamlink over livestreamer
Browse files Browse the repository at this point in the history
  • Loading branch information
laurencee committed May 30, 2017
1 parent d5cbadf commit e7ea04c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
1 change: 1 addition & 0 deletions Livestream.Monitor.sln
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionItems", "{F4253C96-9A1B-46CE-B0AB-C30916E64CAA}"
ProjectSection(SolutionItems) = preProject
GlobalAssemblyInfo.cs = GlobalAssemblyInfo.cs
README.md = README.md
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Livestream.Monitor.Tests", "Livestream.Monitor.Tests\Livestream.Monitor.Tests.csproj", "{9AAF7490-A238-41BB-A0BC-95A5EF84FF0F}"
Expand Down
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Livestream Monitor
A windows GUI for [livestreamer](http://docs.livestreamer.io/install.html#windows-binaries) written in .NET
A windows GUI for [streamlink](https://streamlink.github.io/) / [livestreamer](http://docs.livestreamer.io/install.html#windows-binaries) written in .NET

[Latest Release](https://github.com/laurencee/Livestream.Monitor/releases/latest)

Expand All @@ -10,32 +10,32 @@ The UI layout was influenced by [Skadi](https://github.com/s1mpl3x/skadi) which
## Pre-requisites
* [.NET 4.6](https://www.microsoft.com/en-us/download/details.aspx?id=48130) installed
* [streamlink](https://github.com/streamlink/streamlink) or [livestreamer](http://docs.livestreamer.io/install.html#windows-binaries) installed and configured
* Chrome browser installed (app runs fine without chrome but chrome is required for chat to function)

## Usage
1. Run Livestream.Monitor.exe
2. Import Channels you have already followed using your twitch/hitbox username (no authentication required)
2. Import Channels you have already followed using your stream site username (not all stream sites supported)
3. Add other channels manually
4. Double click on live channels to open the stream or click on the quality button while having a stream row selected

## General Features
* Add your favourite livestreams to be monitored from twitch/youtube/hitbox
* Open twitch/youtube/hitbox chat for the selected stream (requires chrome)
* Ability to choose quality of stream (before opening the stream)
* Add your favourite livestreams to be monitored from twitch, youtube, mixer or smashcast
* Custom command line option for launching twitch/youtube/hitbox chat for the selected stream (presets include Chrome/Firefox/Edge)
* Stream quality selection options
* Toast notifications for streams coming online
* Toast notifications for popular streams (so you never miss a special event)
* Filter your channel list to find and manage streams quickly
* Change your colour theme using the theme button in settings


TIP: You can configure what is considered a "popular stream" in the settings menu (cog icon on right of titlebar)

## Twitch/hitbox features
## Twitch/smashcast features
* Import your already followed streams for live monitoring
* Search for top streams and filter top streams by game (add for monitoring with 1 click)
* Search for VODS by streamer and launch vods through livestreamer (you can also just paste any valid vod url and launch that instead)
* Search for VODS by streamer (you can also just paste any valid vod url and launch that instead)

## Suggested livestreamer configuration
1. Edit your livestreamer [configuration file](http://docs.livestreamer.io/cli.html#configuration-file) (%APPDATA%\livestreamer\livestreamerrc) and uncomment your preferred video player
## Suggested streamlink/livestreamer configuration
1. Edit your streamlink [configuration file](https://streamlink.github.io/cli.html#configuration-file) and set your preferred video player
2. Change the number of threads when streaming HLS/HDS to 4
```
# Number of threads to use when streaming HLS streams
Expand All @@ -49,9 +49,10 @@ hds-segment-threads=4
I didn't like the large amount of memory used by java/web based GUIs for livestreamer and there were some features I wanted that the others didn't provide.

### FAQ
**Q. How do I add YouTube streams?** <br />
A. You need to provide the username/channel name. You can find this by clicking on a users channel link to get to their profile page. <br />
**Q. How do I add YouTube streams?**
A. You need to provide the username/channel name. You can find this by clicking on a users channel link to get to their profile page.
(The URL looks like this: https://www.youtube.com/user/{username})

**Q. Why do some youtube stream chats show an error page when launched from Livestream Monitor?** <br />
A. Some YouTube streams have chat disabled (you can see this by visiting the stream page in your browser). Currently I don't know how to find out if chat is disabled/enabled through the YouTube API, I don't believe there is a built in way through the API right now... hopefully it's something google can add in the future.
**Q. Why do some youtube stream chats show an error page when launched from Livestream Monitor?**
A. Some YouTube streams have chat disabled (you can see this by visiting the stream page in your browser).
I don't believe the Youtube API provides that information right now... hopefully it's something google can add in the future.

0 comments on commit e7ea04c

Please sign in to comment.