Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alcadesign/autostreamer-bot
Send an ffmpeg test pattern stream to a Twitch channel controlled by chat commands.
https://github.com/alcadesign/autostreamer-bot
Last synced: 4 months ago
JSON representation
Send an ffmpeg test pattern stream to a Twitch channel controlled by chat commands.
- Host: GitHub
- URL: https://github.com/alcadesign/autostreamer-bot
- Owner: AlcaDesign
- License: isc
- Created: 2019-05-30T15:16:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T04:31:36.000Z (about 2 years ago)
- Last Synced: 2024-05-02T04:36:07.566Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Autostreamer-Bot
Send an ffmpeg test pattern stream to a Twitch channel controlled by chat
commands.
## Install
Install Node.js and ffmpeg on the system and set up the `.env` file from the
`.env.example` file.
```bash
$ git clone [email protected]:alcadesign/autostreamer-bot.git
$ cd autostreamer-bot
$ npm install
```
### Environment variables
- **`INGEST_REGION`** - The region of the preferred ingest server. The default
is "`live-sfo`". See the [Twitch Ingests][ingests] page for a list of
possible regions.
- **`STREAM_KEY`** - A Twitch stream key to authenticate with.
- **`TWITCH_OWNER_ID`** - The user ID of the owner/controller account.
- **`TWITCH_BOT_USER`** - The username of the bot account.
- **`TWITCH_BOT_TOKEN`** - The token of the bot account. Needs the required
scopes for sending messages to chat.
- **`TWITCH_BOT_CHANNEL`** - The name of the channel to listen to in chat.
## Running
The basic way to run it is just using Node:
```bash
$ node index.js
```
This bot could be set up using any daemon like `service`, `systemctl`, or Node-
based daemons like `pm2` or `forever`.
## Commands
| Command | Arguments | Description
| --- | --- | --- |
| `!startstream` | | Start streaming. |
| `!stopstream` | | Stop streaming. |
## Credits
Inspiration from ["park-stream"][park-stream] by [freaktechnik][freaktechnik].
# Todo
- Ensure required environment variables are available.
- Catch possible `tmi.js` errors from `client.say` or if the credentials don't
pass logging in.
- Allow anonymous (and/or silent) chat integration.
- Better permission system.
- Ensure ffmpeg is installed.
- Ensure the stream _actually_ starts and stops.
- Investigate `child_process` errors.
- Expand upon README.
- Think of more Todo's.
[ingests]: https://stream.twitch.tv/ingests/
[park-stream]: https://github.com/freaktechnik/park-stream
[freaktechnik]: https://github.com/freaktechnik