Giter Club home page Giter Club logo

reboodt's Introduction

reboodt is a python 3+ 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
github: 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 can be passed as an argument ..
    • eg. .qr .last, which would generate a 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 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 user is, or was, listening to
.fmu user info on a 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"

reboodt's People

Contributors

sentriz avatar

Stargazers

Li Bo (Evan) avatar  avatar  avatar tehface avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.