https://github.com/digiduncan/zeatbot

It's a bot for Zeat. It's zeatbot.
https://github.com/digiduncan/zeatbot

bot irc python twitch

Last synced: about 1 month ago
JSON representation

It's a bot for Zeat. It's zeatbot.

• Host: GitHub
• URL: https://github.com/digiduncan/zeatbot
• Owner: DigiDuncan
• Created: 2020-10-28T11:25:35.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-16T20:53:03.000Z (about 4 years ago)
• Last Synced: 2024-10-22T23:44:08.207Z (2 months ago)
• Topics: bot, irc, python, twitch
• Language: Python
• Homepage:
• Size: 45.9 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# zeatbot

It's a bot for [zeat](http://www.twitch.tv/zeat). It's zeatbot.

## How to Use

Make sure you have [Python 3](https://www.python.org/downloads/) installed. Make sure you installed `pip` with it.

To start run the bot once. It will place a default settings file in the App Directory (On Windows, this is `%LocalAppData%\DigiDuncan\zeatbot`, on Linux it's (usually?) `~/.local/share/zeatbot`.)

Place a file called `authtoken.txt` in the App Directory. This file should only contain a Twitch authtoken, and should look something like this:

```

0123456789abcdefghijABCDEFGHIJ

```

Place another file in the same location called `client_id.txt`. This file should contain your Client ID, and should look something like this.

```

0123456789abcdefghijABCDEFGHIJ

```

## Features

* Customizable prefix (defaults to `!`)

* A weather command (`!weather `)

* A say command (`!say `)

* Timed messages every X minutes

* Custom text responses (`!add  ` and `!remove `)

### Custom text responses

Custom text responses are loaded from the file `commands.ini` in the App Directory. They are formatted like so:

```ini

[commands]  # This is important!

test = "Boy howdy is this a test!"

test2 = "Hey %n, this is a test!"

test3 = "Wow, I added this baby myself!"

```

To run them, use the prefix and then the name of the command in chat.

Commands will replace the following strings with certain data:

* **%n**: the command runner's name.

* **%s**: the streamer's name.

* **%t**: the current time (HH:MM)

* **%d**: the current date (YYYY-MM-DD)

You can add new commands from either this file, or using `!add command_name command response wee!` and `!remove command_name` to remove it.

### Timers

Timers run every X minutes, sending a message to chat. X is a number specified in `settings.ini`.

To add timers, open up (or create) `timers.txt` in the App Directory. Each new line is a seperate message to send!