https://github.com/sentriz/reboodt

a python 3+ IRC bot
https://github.com/sentriz/reboodt

cli irc irc-bot python

Last synced: 3 days ago
JSON representation

a python 3+ IRC bot

• Host: GitHub
• URL: https://github.com/sentriz/reboodt
• Owner: sentriz
• Created: 2015-02-19T20:22:19.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-01-07T21:27:22.000Z (almost 5 years ago)
• Last Synced: 2024-12-11T22:05:22.714Z (22 days ago)
• Topics: cli, irc, irc-bot, python
• Language: Python
• Homepage:
• Size: 330 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**reboodt** is a python *3+* [IRC bot](http://en.wikipedia.org/wiki/IRC_bot) that supports multiple servers, channels, and commands.  

It also supports a **plugin** system to easily add your *own* commands and variables. 

###### note: this software has only been tested on Python 3.4.0, please report any issues you may have on earlier Python 3 versions

home: [sentriz.github.io/reboodt](http://sentriz.github.io/reboodt)  

github: [github.com/sentriz/reboodt](https://github.com/sentriz/reboodt)

Installation

-----------

move `config.sample.yml` to `config.yml` and modify.  

move `api_keys.sample.yml` to `api_keys.yml` and (optionally) modify.  

    

Usage

-----------

    python reboodt.py [--verbose] [--debug]

    python reboodt.py (--help | --version)

    

note: running in `--verbose` mode is recommended for first run

    

Options

-----------

    -d, --debug    debug bot (show raw IRC messages, ect.)

    -v, --verbose  be verbose (show channel messages, commands, plugin loading, ect.)

    -h, --help     show full help

    -V, --version  show reboodt version

Commands

-----------

- commands start with `.` followed by the command name ..

  - eg. `.calc` ..

- after the command - a string or [variable](#variables) can be passed as an argument ..

  - eg. `.qr .last`, which would generate a [QR code](http://en.wikipedia.org/wiki/QR_code) of the last message said in the channel ..

- the arguments don't have to be just a string or just a variable either, they can be mixed up ..

  - eg. `.say the current time is .time on the server` ..

- to create a command/variable (plugin)..

  - make a copy of `files/template.txt` for dir `plugins/` ..

  - rename to `your_plugin.py` ..

  - modify ..

below is a table of plugins that have already been created  

note: `[]` denotes optional arguments

command..   | takes argument(s).. | and returns..

------------|---------------------|--------------

**.8**      | `question`          | a positive, negative, or neutral [magic 8 ball](http://en.wikipedia.org/wiki/Magic_8-Ball) reply

**.calc**   | `expression`        | an evaluation of a mathematical `expression` (eg `.calc 1 + 2` returns `3`)

**.define** | `word`              | a definition of a `word`

**.fmnp**   | `user`              | what a [last.fm](http://last.fm/) `user` is, or was, listening to 

**.fmu**    | `user`              | info on a [last.fm](http://last.fm/) `user`

**.google** | `query`             | top 4 Google results when searching for a `query`

**.help**   | `[command]`         | help for a `command` if provided. otherwise, a list commands

**.insult** | `[user]`            | a shakespearean insult, optionally aimed at a `user`

**.join**   | `#channel`          | 

**.py**     | `expression`        | a python `expression` evaluated (eg. `.py len([1, 2])` returns `2`)

**.qr**     | `string`            | a qr code of your `string`

**.quit**   | `[message]`         | 

**.reload** |                     | nothing; command reloads all plugins in the `plugin/` directory

**.say**    | `string`            | `string`, useful if `string` has a `.variable`

Variables

-----------

variable   | is replaced with..

-----------|-------------------

**.last**  | the `last` message that was said in the channel

**.time**  | "yyyy/mm/dd hh:mm:ss"