mjfwebb / twitch-bot

Twitch Chat bot with overlays, custom commands, TTS, sounds, rewards, API integrations and more!

Hello!

• 🔭 I’m currently working at Neo4j on the GraphQL team
• 👯 I’m looking to collaborate on GraphQL security analysis tools!

twitch-bot's Issues

Fetch stream status on bot start

Currently, the stream status state ("online" or "offline") is only set when the Twitch API sends the WebSocket event, but we may be restarting the bot several times during the same stream.

Let's also request the state when the bot starts up using https://api.twitch.tv/helix/streams https://dev.twitch.tv/docs/api/reference/#get-streams

!category command

Synchronous promise wrapper

For example, it is used twice in this same callback to avoid issues with async/await

twitch-bot/server/src/handlers/botCommands.ts

Lines 131 to 148 in f6ded48

	callback: (connection) => {
	new Promise<void>(() => {
	void (async () => {
	const lutfiskId = await getUserIdByName('lutf1sk');
	if (lutfiskId !== '') {
	sendChatMessage(connection, 'Get banned fool');
	setTimeout(() => {
	new Promise<void>(() => {
	void (async () => {
	await unbanUser(lutfiskId);
	})();
	}).catch((e) => console.log(e));
	}, 10000);
	await banUser(lutfiskId);
	}
	})();
	}).catch((e) => console.log(e));
	},

Welcome command should work after first time setting it

On !commands filter out commands that not everyone can use

Filter out any command that has a mustBeUser property

Welcome message (opt-in)

With https://dev.twitch.tv/docs/irc/capabilities/ the membership capability, we can receive messages when a user enters or leaves the chat channel, so we could send them a welcome message.

Personally, I think I would prefer this to be opt-in only from a user's perspective because it's quite anti-lurk.

Combined with this is a need to keep a memory of user choices, so some sort of database is required.

Depends on #24

Reaction to subscriber

Periodic chat messages

Sound queue

There is a queue for commands, but not for sounds. Currently, that means if two separate sound commands are used then the last one will play, even if the former was in the process of being played.

Add !uptime command

Examples:

When the stream is online:

!uptime
The stream has been live for 1 hour, 5 minutes, 20 seconds

When the stream is offline:

!uptime
The stream is offline

!followage command

With no param: Informs the user how long it has been since they followed the stream

Example:

!followage
It has been 27 days, 2 hours, 8 seconds since you started following

With param (username): Informs how long it has been since the provided user followed the stream

Example:

!followage John
It has been 18 days, 18 hours, 9 seconds since John started following

Add !issues command

List the current todo issues from the GitHub API

Potentially with a search string

Make !commands output in alphabetical order

Reaction to raid

Moderation API endpoints

Twitch will be deprecating many chat commands through IRC.

https://discuss.dev.twitch.tv/t/deprecation-of-chat-commands-through-irc/40486

Only the /ban and /unban currently, by the lutf1sk chat command:

twitch-bot/server/src/handlers/botCommands.ts

Lines 118 to 130 in 7109bfa

	command: ['lutf1sk', 'lutfisk'],
	id: 'lutf1sk',
	mustBeUser: 'lutf1sk',
	hidden: true,
	callback: (connection) => {
	sendChatMessage(connection, 'Get banned fool');
	setTimeout(() => {
	sendChatMessage(connection, '/unban lutf1sk');
	}, 10000);
	sendChatMessage(connection, '/ban lutf1sk');
	},
	cooldown: 30 * MINUTE_MS,
	},

Add !remindme command

!remindme <timeframe> <thing>

Example:

!remindme 2d Dentist appointment!

Database for storing persistent data

Since I already use it in so many other projects, I will probably leverage mongoDB and mongoose.

Get list of chatters

https://dev.twitch.tv/docs/api/reference#get-chatters

Update stream title

https://dev.twitch.tv/docs/api/reference/#modify-channel-information

Make Discord optional in code

Currently, the Discord webhook is required in code by default and requires a manual change to remove it.

Let's just make this optional from the beginning.

Type Challenge: Event type based on Subscription "type" property

In this example taken from Twitch docs, we see a channel.subscription.end event. The subscription object contains the type property "channel.subscription.end":

{
    "subscription": {
        "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
        "type": "channel.subscription.end",
        "version": "1",
        "status": "enabled",
        "cost": 0,
        "condition": {
           "broadcaster_user_id": "1337"
        },
         "transport": {
            "method": "webhook",
            "callback": "https://example.com/webhooks/callback"
        },
        "created_at": "2019-11-16T10:11:12.634234626Z"
    },
    "event": {
        "user_id": "1234",
        "user_login": "cool_user",
        "user_name": "Cool_User",
        "broadcaster_user_id": "1337",
        "broadcaster_user_login": "cooler_user",
        "broadcaster_user_name": "Cooler_User",
        "tier": "1000",
        "is_gift": false
    }
}

We should be able to therefore infer that the event object is of a certain structure. How do we do this in Typescript?

We don't want to use the as keyword in Typescript for this!

Reference: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types

!viewers command

!command command

Shows details about a command:

• Who can use it
• What cooldown it has
• Aliases
• What it does
• What arguments it takes

Update stream tags

https://dev.twitch.tv/docs/api/reference/#modify-channel-information

React to gifted subs

!song command

Probably want to make it work with lastfm, or Spotify directly

Check if channel is live before sending periodic messages

Add credits screen

Should be a separate webpage /credits where it shows all active chatters, new followers, new subscribers, and raiding channels

Add !filter command

change the filter of your camera based on this command for a certain time. add a big cooldown to it
!filter [name: string]
!filterlist - sends the list of available filters

!addissue command should create issues directly through GitHub API

Instead of simply opening a webpage to the new issue form

https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#create-an-issue

Text to speech (TTS) with several voices

Some work has been done on this where there are several voices present in the constants file.

Reaction to first ever message

Command aliases

Add stream alerts overlay

make cool effects with alerts on stream. for example some party particles when there is a raid

Keep record of how many times a command is used

Multiple message wrapper for maximum message length cases

When we suspect the output of a command (i.e. !commands) is going to be longer than the maximum message allowed by Twitch, we should split up the output and send it over several messages.

!settask and !task command

Depends on #24

Only allow a single punctuation mark at the end of command descriptions

Add chat box

Reaction to new follows

Improve parseParameters

twitch-bot/server/src/parsers/parseParameters.ts

Lines 13 to 17 in 8c04ec0

	} else {
	command.botCommand = commandParts.slice(0, paramsIdx);
	command.botCommandParams = commandParts.slice(paramsIdx).trim();
	// TODO: remove extra spaces in parameters string
	}

Currently, it doesn't really handle multiple parameters in a nice way. It could be nicer to return this as an array of strings, or even as a separate property in addition to the existing botCommandParams.

Potential proposal:

Return both botCommandParams and a new botCommandParamsList which is pre-split by space.

Add playing sounds to database commands

Currently we can't play sounds from commands that are made with the !addcommand command. If this is added then a lot of the custom commands saved to the repo could be removed.

Add !songrequest command

    add a song request with channel points, it will submit it to a queue Spotify will play

Originally posted by @JumpyLionnn in #15 (comment)

Add squats redeem

Exclude known bots from user database

!randomissue command

Should return a random issue's title from GitHub

Example:

!randomissue
Here's a random issue: ${issueTitle}

Reaction to bits donation

!roll command

Roll a die basically. Should accept parameters min max with default of min = 1 and max = 6

Reaction to first message of stream (per user)

Add Spotify auth flow

Use the scope user-read-currently-playing while following the guide https://developer.spotify.com/documentation/general/guides/authorization/code-flow/