Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sigma-cw committed Feb 21, 2023
1 parent 4c0e2f7 commit 60922fb
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**A *mostly* standalone app to serve widgets for your YouTube livestreams**

![App](https://i.imgur.com/aqiPMew.png)

## Features

Sigmanuts offers a very flexible experience. The trade-off between having an extra app to run during live stream and having a positive chat experience is worth it!
Expand All @@ -14,7 +16,7 @@ Sigmanuts offers a very flexible experience. The trade-off between having an ext
- Can run as many different widgets as you want
- Only update chat link once and have it refresh for every overlay in OBS

## Links
## Links (WIP)

- Website
- Twitter
Expand All @@ -24,25 +26,27 @@ Sigmanuts offers a very flexible experience. The trade-off between having an ext
There are multiple ways you can run this app.
### Recommended
Windows 11
- .NET Core 3.1 SDK (Download from here)
- .NET Core 3.1 SDK (Download from [here](https://download.visualstudio.microsoft.com/download/pr/b70ad520-0e60-43f5-aee2-d3965094a40d/667c122b3736dcbfa1beff08092dbfc3/dotnet-sdk-3.1.426-win-x64.exe))

Windows 10
- .NET Core 3.1 SDK (Download from here)
- WebView2 Runtime (Download from here)
- .NET Core 3.1 SDK (Download from [here](https://download.visualstudio.microsoft.com/download/pr/b70ad520-0e60-43f5-aee2-d3965094a40d/667c122b3736dcbfa1beff08092dbfc3/dotnet-sdk-3.1.426-win-x64.exe))
- WebView2 Runtime (Download from [here](https://go.microsoft.com/fwlink/p/?LinkId=2124703))

### Standalone
Windows 11
- No requirements

Windows 10
- WebView2 Runtime (Download from here)
- WebView2 Runtime (Download from [here](https://go.microsoft.com/fwlink/p/?LinkId=2124703))

## Installation

To install, download the required packages and then run the app, no installation required.

## How does it work?

Actually, very simple! You launch the app, log in to YouTube, put in a link to your stream, and the app automatically grabs your chat and waits for any messages, superchats, member notifications, etc. When one appears, the app extracts all the useful information from it, and packs it all into a JSON object that a developer can then use to restyle the chat in any way they want.

## Is it against YouTube ToS?

Short answer: Technically, *kind of* yes. But also... *maybe*.
Expand All @@ -56,3 +60,7 @@ Regardless of what you read here, you should decide for yourself whether you wan
## Documentation

## Changelog

02/20/2023 - BETAv0.5
- Initial beta release

0 comments on commit 60922fb

Please sign in to comment.