https://github.com/pajbot/pajbot

Twitch moderation bot
https://github.com/pajbot/pajbot

bot hacktoberfest python python3 twitch

Last synced: 3 months ago
JSON representation

Twitch moderation bot

• Host: GitHub
• URL: https://github.com/pajbot/pajbot
• Owner: pajbot
• License: mit
• Created: 2015-06-15T14:43:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T09:51:48.000Z (3 months ago)
• Last Synced: 2024-07-31T11:04:17.578Z (3 months ago)
• Topics: bot, hacktoberfest, python, python3, twitch
• Language: Python
• Homepage: https://pajbot.com/
• Size: 6.47 MB
• Stars: 286
• Watchers: 12
• Forks: 99
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-twitch-dev - pajbot/pajbot - Twitch moderation bot. (Libraries / Python)

README

        
# pajbot ![Python 4HEad](https://github.com/pajbot/pajbot/workflows/Python%204HEad/badge.svg)

pajbot is a twitch chat bot created by [pajlada](http://twitch.tv/pajlada).  

[Website](https://pajbot.com)

Note: pajbot is in **maintenance mode**.

This means we focus on keeping the project alive by not allowing major overhauls of any pajbot system or any major features.

Fixing bugs, updating dependencies and ensuring that code interacting with external APIs still function will be our main goal.

Feature requests will not be accepted unless someone is willing to own the feature, and even then some features that change too much of the architecture won't be allowed.

Current minimal supported Python version is **3.9**.

## Python versioning

We use [pyenv](https://github.com/pyenv/pyenv) to manage Python versions. Get familiar with this tool.  

Quick install of pyenv on Linux systems: `curl https://pyenv.run | bash`

If you don't want to use pyenv's version of Python in any of our scripts, set the `SKIP_PYENV` environment variable to `1`.

## Quick install

1. Install library requirements by typing `./scripts/venvinstall.sh` in the root folder

2. Copy `./configs/example.ini` to `./config.ini` and change the relevant lines in the file.

3. Run the bot! `./main.py`

## Detailed install

You can find a detailed installation guide for **pajbot** in the [`install-docs` directory](./install-docs) of this repository.

## Run-time options

Some values can be set to apply to your bot without modifying the config file, these are mostly for out-of-bot things.  

They are configured using environment variables. The following options are available:

- `PB1_LOG_HIDE_TIMESTAMPS`  

   If this option is set to `1`, all log entries will be printed without a timestamp prefix.