https://github.com/aptmac/smash-bot

IRC Sm4sh Bot for RH YYZ
https://github.com/aptmac/smash-bot

Last synced: about 2 months ago
JSON representation

IRC Sm4sh Bot for RH YYZ

• Host: GitHub
• URL: https://github.com/aptmac/smash-bot
• Owner: aptmac
• Created: 2018-03-16T01:00:36.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-15T17:30:41.000Z (over 6 years ago)
• Last Synced: 2024-10-12T15:50:52.361Z (3 months ago)
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Smash Bot

## How to Use

### Dependencies

Installing Pychallonge:

`pip install iso8601 --user` &&

`pip install -e git+http://github.com/russ-/pychallonge#egg=pychallonge --user`

### Setup

Configure the IRC channel information at the top of the `smashbot.py` file to set the bot's name and specify which channel it should join. 

### Running 

Run `python smashbot.py` to start the bot, and if configured correctly, it should join the channel specified.

## Commands

`!help`: whispers the user with a description of bot functionality

`!all `: broadcasts a message and tags every member of the channel

`!bracket`: prints the URL of the current challonge bracket

`!hitbox  `: prints the URL to view the move in the struz smash 4 move viewer app

`!matches`: prints the currently open matches

## Contributing

This is a hacky bot, and isn't meant to be high quality. As a result, spaghetti code is encouraged! That means no tests, no segregation of code into other files (long live the monolith), regex is king, and it's a feature - not a bug. 

## Kudos

Based on the examples and instructions provided by: https://linuxacademy.com/blog/geek/creating-an-irc-bot-with-python3/

Thank you to russ- for the pychallonge package that makes life much easier: https://github.com/russ-/pychallonge

Thank you to struz for making the smash 4 move viewer: https://struz.github.io/smash-move-viewer/#/v1