erikstmartin / erikbotdev

Twitch bot

ErikBotDev

TODO: Add description and usage here later.

Modular support. Pick which modules you like.

Modules

• Hue (lights)
• Elgato (fill lights)
• OBS (scenes)
• Browser Source (use bot as a web endpoint to update a browser source)
• Voice Effects (Through VST in OBS)

Configuration

Many of the commands in this bot interact with OBS through the OBS websocket plugin. By default, this bot requires that it can connect to the websocket in order to even run. If it can't it marks itself as offline and won't respond to any commands.

If you want to force this into "streaming mode"

If you do not have the OBS websocket plugin running, you have two options for forcing the bot to configure itself into streaming mode:

• Pass -s or --streaming-on
• Mark an individual command "offline": true to enable just that command

Sounds

Any sound you reference in the config file (sample) needs to be a WAV file in the media directory.

erikbotdev's Issues

!raid command

Allow viewers to vote on person to be raided

browser-source: Handle disconnects and reconnects better

points: hook into twitch's channel point redemptions

Now that triggers exist, we can also use twitch's channel points to trigger actions in the bot

help: List sounds

sounds: Ability for people to contribute sounds

obs: Add video filters

xrandr: Add command to turn off screens

browser-source: look into chat messages overflowing

browser-source: Give viewers the ability to draw on screen

Record movements on viewer side and replay using canvas on browser side or webrtc?

browser-source: Ensure sound file exists and no path traversal strings exist.

obsws: Contribute upstream. Allow for silencing of log messages.

points: Explore the idea of global rewards.

Where money earned anywhere can be spent anywhere. Instead of current rewards system where participation elsewhere earns you local rewards, but not global rewards.

help: Print descriptions of commands

browser-source: Chat should only play our channel, not all channels joined

actions: Execute action

An action that allows arbitrary commands to be executed on the host

Doublecheck websocket reconnect logic.

Restarting bot seems to break our websocket connect. Retry logic should exist, doesn't appear to function properly

sound: Remove hardcoding for media location

browser-source: Don't allow sounds to be played concurrently

points: ensure that !props allows for both user and @user

points: Cross-channel points

Support the bot joining multiple channels and receiving points.

points: Explore the idea of a global currency.

Where money earned anywhere can be spent anywhere. Instead of current rewards system where participation elsewhere earns you local rewards, but not global rewards.

browser-source: Cleanup chat logic

Use svelte, style and place the chat appropriately. Use color data provided as part of the user.

browser-source: animate objects on the page

Use separate name for bot

Ensure we also filter out messages from the bot in our browser-source.

sound: allow for sound to have any extension

Maybe create a mapping between sound name and filename or search for sound in a specific order of extensions?

browser-source: fix word wrapping in chat

maintenance: Comments & Godoc

Time to start adding comments and godoc info

hue: Ability to control individual groups of lights

Currently we only have the ability to control the room as a whole, but we should be able to control individual groups of lights, possibly individual lights.

browser-source: Media object can't be played if user doesn't interact with DOM?!

Uncaught (in promise) DOMException: play() failed because the user didn't interact with the document first

maintenance: Documentation

README and user documentation for people who want to use the bot.

websocket: Send commands over websocket

This will open the doors to being able to disable/enable commands without updating the config and restarting. It can also be used to disable commands for specific people, etc.

feature: convert user cache to an LRU cache

github.com/hashicorp/golang-lru

actions: vim/nvim controlling actions

obs: Get VST plugins working on linux so that voice commands work again

feature: Triggers & Alerts

Implement alerts so that browser source reacts to Follow, Raid, Host, Cheering, etc.

This could also be generic logic in the config that allows users to specify actions when a particular trigger happens.

points: Channel Points

We still need to implement the following:

• Consuming points to run commands
• Allow users to give each other points
• Allow bot owner to give unlimited number of points

browser-source: Cleanup frontend

Start using Svelte.

browser-source: Fetch and handle emotes

https://dev.twitch.tv/docs/v5/reference/chat/#get-all-chat-emoticons

browser-source: Show badges in chat

https://badges.twitch.tv/v1/badges/global/display

browser-source: Filter users

The config should support the ability to filter out users from chat. Either because they are a bot or a known spammer. This could also support mod/vip/broadcaster only?

bot::Say default channel to bot's main channel

modules: Add new module to control KeyLights

https://github.com/endocrimes/keylight-go

maintenance: Unit Testing

We need to start on unit testing

Ensure bot is only running once

Bot cannot open the database multiple times. We need a lock file or something so that only one instance of the bot can exist.

This may also require using a websocket or something for the cmd-line to work.

The other option would be to use sqlite or some other RDBMS for out bot.

i3: create module to control window placement, etc.

config: Remove dependency on environment variables

• Remove all logic that depends on environment variables for config.

Remove hardcoded shutdown logic and use trigger instead

config: Implement web frontend to configure bot

The configuration JSON file will only get increasingly larger and harder to wrap our head around. It would be nice to have a frontend to edit the configuration.

auth: Retrieve UserAccessToken by providing authentication URL for individual user from ClientSecrets

https://github.com/nicklaw5/helix/blob/master/docs/authentication_docs.md

config: Only initialize enabled modules

We don't want errors for users not connecting OBS or Hue, etc if they don't want to use those modules.

• Ensure modules don't register themselves if not enabled.