Skip to content

Bacon-Fixation/Twitch-Mod-Bot

Repository files navigation

image image

Twitch-Mod-Bot (Working Title)

Work In Progress

A personal Auto Mod Bot for Twitch to help combat inappropriate username harassment, and Follow Bot advertisements from the chat. it is designed to moderate only one channel locally as part of your stream kit

System Dependencies

Installing Bot

  • Install Node.js LTS
  • Install Mod-Bot dependencies either by running the Mod-Bot Install.bat file
    OR
    by opening Command Prompt and running npm install in the ./Twitch-Mod-Bot/ folder

Starting Bot

  • Either by running the Mod-Bot Start.bat file
    OR
    by opening Command Prompt and running npm run dev in the ./Twitch-Mod-Bot/ folder
  • Open the Dashboard by going to "http://localhost:8000/" in a private browser tab. (Incognito Mode)
  • If needed follow the steps in the Dashboard to create/setup Mod-Bot

Features

Currently list of available features

  • Dashboard Controls
  • Ban inappropriate usernames from chat with keyword
  • Keywords accounts for L33t3d names (Example a Keyword of "bacon" will also trigger on leeted names like "b4c0n_F!x4xt!0n")
  • Remove Follow Bot Ads from chat automatically
  • Track Stream events like subs, raiders, gifters, bits, etc... per stream (long term Stream Metrics not available yet)
  • Mod-Bot can be controlled by other Mods with Text Commands ^commands or locally with a web browser (Dashboard)
  • Expandable Command Framework (Command Template)
  • Both Twitch TMI IRC (Twitch Chat) and Twitch API Support
  • Error Logging: all errors are save to a log file in ./Twitch-Mod-Bot/logs/ (only keeps the last 14 logs)

Commands

Command Description Example
^ban Ban a user from the channel ^ban @bacon_fixation
^unban Unban a user from channel ^unban @bacon_fixation
^ban-term Add a Keyword to Auto Ban Users ^ban-term bacon
^unban-term Remove a Keyword from Word Bank ^unban-term bacon
^help Shows the current Command List or Command Details ^help or ^help ban

To Do

being a work in progress, here is whats planned

  • Make the Account Age and Follow Age Limits adjustable
  • Make Keywords for the Follow Bot triggers customizable
  • Switch to using Prisma instead of quick.db (Database Optimizations)
  • Add Command Cooldown (prevent command spamming)
  • Stream to Stream Metrics (help track growth)
  • Auto Welcome and/or Shout-out specific users with personalized messages
  • Notify the Chat when a Streamer you would like to support goes live while you are streaming (advertise a fellow streamer)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages