Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notmyself/bivrost
Bivrost is a asp.net core application that offers several overlay endpoints, hosts a Twitch.tv bot and bridges the two together to display chat events in OBS while streaming.
https://github.com/notmyself/bivrost
asp-net-core docker now twitch twitch-bot vuejs
Last synced: about 12 hours ago
JSON representation
Bivrost is a asp.net core application that offers several overlay endpoints, hosts a Twitch.tv bot and bridges the two together to display chat events in OBS while streaming.
- Host: GitHub
- URL: https://github.com/notmyself/bivrost
- Owner: NotMyself
- License: mit
- Created: 2019-05-03T20:29:20.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T17:12:52.000Z (over 1 year ago)
- Last Synced: 2024-04-14T15:11:15.155Z (7 months ago)
- Topics: asp-net-core, docker, now, twitch, twitch-bot, vuejs
- Language: C#
- Homepage: https://iamnotmyself.com
- Size: 3.19 MB
- Stars: 24
- Watchers: 3
- Forks: 6
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bivrost
"In Norse mythology, Bivrost is a burning rainbow bridge that reaches between Midguard and Asgard, the realm of the gods." - [WikiPedia](https://en.wikipedia.org/wiki/Bifr%C3%B6st)
---
## About
Bivrost is a asp.net core application that offers several overlay endpoints, hosts a Twitch.tv bot and bridges the two together to display chat events in OBS while streaming.
## Getting Started
### Running Locally
As long as you have the development dependencies installed, the application can be run on your bare metal machine.
1. Clone the repository: `git clone https://github.com/NotMyself/bivrost.git`.
1. Change directory into the cloned repository `cd bivrost`.
1. Run script `scripts/local-init`.
1. Run the command `dotnet user-secrets set BIVROST_TWITCH_BOT_USER_NAME {bot-user-name}`.
1. Run the command `dotnet user-secrets set BIVROST_TWITCH_BOT_ACCESS_TOKEN {bot-access-token}`.
1. Run the command `dotnet user-secrets set BIVROST_TWITCH_BOT_CHANNEL {twitch-channel}`.
1. Run the command `dotnet user-secrets set BIVROST_TWITCH_CLIENT_ID {twitch-client-id}`.
1. Run the command `dotnet user-secrets set BIVROST_TWITCH_CLIENT_SECRET {twitch-client-secret}`.
- **Note:** You must supply valid values for the **BIVROST_** environment variables, see [this](#obtaining-twitch-access-tokens) for instructions on how to obtain these values.
1. Run script `scripts/local-start`.
### Running in Docker
The application can easily be executed locally with no development dependencies using [Docker](https://www.docker.com/).
1. Clone the repository: `git clone https://github.com/NotMyself/bivrost.git`.
2. Change directory into the cloned repository `cd bivrost`.
3. Run script `scripts/image-create`.
4. Run script `scripts/image-start`.
### Obtaining Twitch Access Tokens
Bivrost uses several bits of information to connect to stream chat.
In most cases, you can use your Twitch username for both the bot username and channel. This will make the bot appear as you in chat.
If you would like to have a seperate bot username from your own, you will need to create that account on Twitch and use it to generate your access token.
You will need to generate an OAuth authorization token with several specific scopes applied to it.
1. Navigate to [Twitch Token Generator](https://twitchtokengenerator.com).
2. Select the **Custom Scope Token** option in the popup dialog.
3. Ensure the following scopes are enabled:
1. `user_read`
2. `user_blocks_edit`
3. **TODO:** Figure out the exact scopes needed, for now select all.
4. Click the **Generate Token!** button.
5. You will be redirected Twitch, authenticate if needed.
6. Click the **Authorize** button to grant Twitch Token Generator concent to access your account with the listed scopes.
7. Verify you are not a robot.
8. Click the **Copy** button next to **Access Token**.
Bivrost also makes call directly to the Twitch APIs. This requires to you to register the application to get client crendentials.
1. Navigate to your [Twitch Developer Console](https://dev.twitch.tv/console).
1. Click the **Register Your Application** button.
1. Add **Bivrost** to the **Name** field.
1. Add **http://example.com** to the **OAuth Redirect URL** field.
- **Note:** Bivrost does not currently use oAuth based authentication, so this value is not used.
1. Select **Application Integration** from the **Category** dropdown.
1. Click the **Create** button.
| Env Var | Note |
|---|---|
| BIVROST_TWITCH_BOT_USER_NAME | Twitch Account Username for Bot |
| BIVROST_TWITCH_BOT_ACCESS_TOKEN | OAuth Access Token for Twitch Account |
| BIVROST_TWITCH_BOT_CHANNEL | Twitch Chat Channel for Bot to join and listen. |
| BIVROST_TWITCH_CLIENT_ID | Twitch Application Client Id |
| BIVROST_TWITCH_CLIENT_SECRET| Twitch Application Secret |
### Screen Shots
#### Bivrost On Join Message
When the bot is successfully configured, it will announce it's arrival in chat like this:
#### Bivrost On Message Overlay
### External Dependencies
#### .NET Core
#### Node 8
### Docker
### Platform Dependencies
- [ASP.NET Core](https://www.asp.net/mvc)
- [Vue.js](https://vuejs.org/)
### Features
- [Chat Bot](docs/mockups/chat-bot/readme.md)
### Architecture
- [Logging](docs/logging.md)