Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viral32111/twitchbot
My Twitch integration & chat bot.
https://github.com/viral32111/twitchbot
bot chat integration oauth twitch
Last synced: 19 days ago
JSON representation
My Twitch integration & chat bot.
- Host: GitHub
- URL: https://github.com/viral32111/twitchbot
- Owner: viral32111
- License: agpl-3.0
- Created: 2022-05-31T19:27:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T22:45:26.000Z (4 months ago)
- Last Synced: 2024-11-05T11:43:50.241Z (2 months ago)
- Topics: bot, chat, integration, oauth, twitch
- Language: C#
- Homepage: https://dev.twitch.tv/docs/irc
- Size: 334 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# Twitch Bot
[](https://github.com/viral32111/TwitchBot/actions/workflows/ci.yml)
[](https://github.com/viral32111/TwitchBot/actions/workflows/codeql.yml)
This is my Twitch integration and chat bot, made for [Rawreltv](https://www.twitch.tv/rawreltv).
## 📥 Usage
The recommended way to run this bot is by using the [Docker image](https://github.com/users/viral32111/packages/container/package/twitchbot). This image is automatically updated every time a commit is pushed.
For example, this command will run the bot in a Docker container using a custom configuration file in the current directory:
```
docker run \
--name twitch-bot \
--mount type=volume,source=twitch-bot,target=/var/lib/twitch-bot \
--mount type=bind,source=$PWD/config.json,target=/etc/twitch-bot.json \
ghcr.io/viral32111/twitchbot:latest
```
### ⚙️ Configuration
The configuration file is where you should specify Twitch application credentials, channel names, etc.
The default configuration file will be created at the default path, or at the path given as the first command-line argument to the program.
The default path for the configuration file for each operating system is:
* Windows: `%CD%/twitch-bot.json`
* Linux: `$PWD/twitch-bot.json`
### Persistent Data
The bot will create data over time that must be retained across reboots.
The location of this directory can be changed in the configuration file. The default for each operating system is:
* Windows: `%LOCALAPPDATA%/TwitchBot`
* Linux: `/var/lib/twitch-bot`
### Cached Data
The bot will create temporary data over time that is reused across reboots, but can safely be destroyed when closed.
The location of this directory can be changed in the configuration file. The default for each operating system is:
* Windows: `%TEMP%/TwitchBot`
* Linux: `/var/cache/twitch-bot`
### 🏗️ Development
When running during development, it is preferred to keep secrets in the [.NET user secrets store](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets).
These secrets can be set using the `dotnet user-secrets set` command. The following secrets are required:
* `AppClientSecret` should be your Twitch application's client secret.
## ⚖️ License
Copyright (C) 2022-2023 [viral32111](https://viral32111.com).
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see https://www.gnu.org/licenses.