Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 1.73 KB

README.md

File metadata and controls

30 lines (25 loc) · 1.73 KB

Billy1Buttsbot

Have you ever felt like your Twitch chat was missing something? Butts, specifically? Well, now you can add a bot that will buttify your chat! This is a simple Twitch bot for Billy1Kirby but you can use it for your own channel as well. It will buttify random messages in chat, and you can configure the chance of a message being buttified.

Installation

  1. Clone or download contents of the repository. Downloading requires you to extract the contents of the zip file every time you want to update the bot, so cloning is recommended
  2. Install python 3.11 or later from here
  3. Open a command prompt or terminal in the directory where you downloaded the bot code
  4. Run python -m pip install poetry to install poetry
  5. Run poetry install to install dependencies
  6. Edit the top contents of pyproject.toml to adjust the [tool.billy1buttsbot] section to your liking, but it should work out of the box

Usage

  1. Run poetry run python -m main to start the bot. Especially in the beginning, it helps to run the bot in debug level logging, using --verbose. It will ask you for your Twitch username and OAuth token, which you can get from here, choose "Connect", authorize access and copy the OAuth token.
  2. If you want to run the bot in the background, you can use poetry run python -m main & on Linux or start poetry run python -m main on Windows
  3. If you want to stop the bot, you can use Ctrl-C on either Linux or Windows

Features

  • Buttification of random messages
  • Configuration of buttification chance
  • Skip first message for any user
  • Skip messages from the bot itself
  • Skip messages from any user listed in pyproject.toml