Skip to content

vaylvn/vaylbot-documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 

Repository files navigation

Vayl

Vayl is a Twitch and Discord bot designed to automate interactions and moderation for a streaming environment.

Core Features

Twitch Integration

  • Chat Management:
    • Moderates chat for link posting, excessive capitalization, and inappropriate phrases using customizable rules and thresholds.
  • Commands:
    • Supports custom commands, built-in commands like !uptime, !followage, and interactive features like quotes and sound effects.
  • Event Handling:
    • Responds to Twitch events like subscriptions, raids, follows, hype trains, and ad breaks.
  • Alerts System:
    • Manages a queue of alerts for various events and executes corresponding actions or responses.

Text-to-Speech (TTS)

  • Integrates multiple TTS providers (e.g., Cepstral, IBM Watson, StreamElements).
  • Allows dynamic selection of voice packs and customization of TTS behavior.

Moderation

  • Handles inappropriate content using link whitelists/blacklists, caps thresholds, and banned phrases.
  • Issues warnings or timeouts to offenders.

Event-based Actions

  • Supports dynamic responses to Twitch events such as raids, subscriptions, and hype train progressions, configurable via YAML files.
  • Executes customizable actions for specific conditions (e.g., "User reaches a sub streak of 3 months").

Customizability

  • Configuration-driven via YAML files for actions, commands, phrases, and events.
  • Flexible cooldowns for users and commands.

Stream Information Management

  • Retrieves and updates stream title, game, and other metadata.

Quote System

  • Adds, retrieves, and lists quotes from a YAML-based data store.

Sound Effects

  • Plays sound effects triggered by specific commands, with support for cooldowns and access restrictions.

Documentation

Getting Started? Here's a quick guide to get you set up!

Explore detailed guides for each aspect of the bot:

  • Actions: Learn how to define and trigger custom actions.
  • Conditional Actions: Set up condition-based logic for advanced automation.
  • Events: Automate responses to stream events like subs and follows.
  • TTS: Configure text-to-speech features and customize voice packs.
  • PhraseCheck: Configure PhraseCheck to respond to messages in chat.
  • Default Commands: Learn about the default commands included with Vayl.
  • Custom Commands: Configure custom commands to be used during your stream.
  • SFX Commands: Configure SFX commands to add more user interation.
  • Discord Webhooks: Learn how to integrate both Twitch and Discord.
  • Redeems: Learn how to add automations from channel point redeems.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published