autoexecbot / autoexecbot Goto Github PK

2.0 1.0 0.0 0 B

Public AutoexecBot documentation and issues tracking

autoexecbot's Introduction

AutoexecBot

This repository is the public facing support repository for AutoexecBot that's designed to contain the documentation for AutoexecBot and to act as the front-facing repository for users to report issues and give feedback on the bot.

Current version is 0.17.0.

Roadmap

See the roadmap for more details about the future of AutoexecBot and what work remains to be done.

Documentation

See the documentation for more help.

autoexecbot's People

Contributors

Stargazers

Watchers

autoexecbot's Issues

Add ability to reset a team's points

Overlay integrations

Add endpoint to validate and refresh client OAuth tokens

[Bug] Don't attempt to ban the broadcaster and moderators.

If the broadcaster and moderators have a name that has been banned the bot will attempt to ban them and will short circuit the request pipeline, effectively locking them out from interacting with the bot.

Add bot to channel mutation

Create GraphQL service

Port over issues from Trello

Decided to convert from Trello to a public GitHub repo because in general it has better project management tools. The following tasks need completed:

Bring over all cards as GitHub issues
Create a Projects board to track the progress of various issues
Create several milestones to help track progress of individual epics
Create several labels to help with organizing an prioritizing issues

Add ability to randomly select a team member's name from a team

Add user OAuth token validation and refreshing

Phrase blocking

Add support for channel point commands

Add support for chat commands

Decompose autoexecbot-runtime into several sub-crates and a root workspace.

I'd like to decompose the runtime down into several sub-crates that are composed together and compiled by a root workspace. This will help with compilation times for isolated changes and also help to better organize the code.

Add ability to award points to teams

Add ability to remove the bot from Twitch channels

Add ability to manage teams through website

Add endpoint to retrieve user OAuth tokens

Remove bot from channel mutation

Name filters mutation

Add ability to join a team

Chat filters query

Add endpoint to retrieve client OAuth tokens

Chat polls

Create PubSub service

Team Points

Create a system where users can join teams (including Discord roles) and be awarded points by streamers/mods on their respective teams.

Some ideas for this include:

Ability to award points to a team
Ability to see team points
Ability to see top point earners and their respective team
Ability to reset team points
Ability to randomly select a point earning team member's name from a team
Ability to generate reports of team points and their respective members

Simple name and phrase blocking syntax

Plan is to add a simple syntax for name and syntax blocking.

The syntax will be as follows

* will be a wildcard that matches zero or more of any character
+ will be a wildcard that matches one or more of any character
? will be a wild card that matches zero or one of any character
[i] will match either i or l
% is a repeat operator that matches the following character one or more times
r# will be a prefix that allows the usage of regular expressions for matching

Examples include (not a comprehensive list)

byte - This will match any name or chat message that contains byte
http?://*.twitch.tv - This will match any link on Twitch
you?suck - This will match any name or phrase that contains "you" and "suck" separated by zero or one characters
r#.* - This will match any name or phrase that matches the provided regex
*byte - This will match any name or phrases that matches *byte
%f - This will match the character f one or more times

This syntax will be case-insensitive.

Add ability to view a team's point leaderboards

Document built-in commands

Create authentication and authorization workflow for the bot's API that uses Twitch OAuth as the sign-in mechanism.

Add ability to create teams

Add ability for users to login via Twitch

Add SIGTERM support to more gracefully shut the bot down when containers are terminated

Add endpoint to store user OAuth tokens

Add ability to add the bot to Twitch channels

Add support for timer commands

Metrics gathering

I would like to improve the story around what metrics get gathered by the bot so that I can keep an eye on how the bot is performing over time.

Rainbow roulette

Add ability to view the cumulative points of each team

Create Twitch OAuth token service

Switch to using Twitch user id as the primary identifier, in favor of login name

This will allow the bot to more effectively handle users changing their names.

Discord/Twitch account linking

Once Discord is support, create a way to let users link their Twitch accounts with their Discord accounts so that any cross-service integrations will work for that user.

Add endpoint to subscribe to topics

Plugin framework based on WebAssembly

The wasmer project looks promising for developing a plugin framework for the bot. This would allow for sandboxed plugins to be developed in any language that can be compiled to WebAssembly. This would give third party developers the opportunity to extend the bot.

If possible, a lot of the bot's current core functionality could be offloaded to plugin modules that could come with a default deployment of the bot, but easily reconfigured or removed by users of the bot.

Add error handling for poorly formatted filters.

If a filter is poorly formatted, it causes the regex parser to fail and the bot logs the error and silently fails, but the state is not transactional, so the state doesn't roll back on error (but fortunately is not persisted), effectively blocking the bot from having new filters added until it is restarted.