gobot

command module
v0.0.0-...-d16ae5f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2015 License: GPL-2.0 Imports: 15 Imported by: 0

README

GoBot

Gitter Build Status

Description

GoBot is my first stab at an IRC bot written in Go. The goal is for it to become less of a "dumb bot" and more of an semi-clever assistant.

Installation

Important: Requires Go>=1.3

    $ go get github.com/darthlukan/gobot

Or:

    $ mkdir -p $GOPATH/src/github.com/darthlukan
    $ cd $GOPATH/src/github.com/darthlukan
    $ git clone git@github.com:darthlukan/gobot.git
    $ cd gobot

Usage

Edit the config.json file located in $GOPATH/src/github.com/darthlukan/gobot to your preferences.

After those variables have been edited, you can run:

    $ go install .    # Note the '.'
    $ gobot

in-channel interaction

For now, the available commands are fairly limited, here's what's available:

  • !search or !ddg: Execute a search via DuckDuckGo
    !search Los Angeles
    !ddg New York

!bangs support has also been included, so you can get results from Google as well as many other sources:

    !search !google weather in Los Angeles
    !search !archwiki i3
    !ddg !godoc cakeday
  • !cakeday: Find the Reddit cakeday for a user
    !cakeday darthlukan
  • !VERB: Echo the VERB and add a random quip.
    !slap SomeUser really hard
    >> *$botNick slaps SomeUser really hard, FOR SCIENCE!

Logging

Gobot can now Log Channels.

Set the "LogDir" in config.json

NOTE: the Directory Must be Writable by the user executing the bot.

TODO

    1. Add commands that actually do something useful
    1. DuckDuckGo Search
    1. Logging
    1. Tests would be nice >.>

License

GPLv2, see LICENSE file.

Documentation

Overview

GoBot

An IRC bot written in Go.

Copyright (C) 2014 Brian C. Tomlinson

Contact: brian.tomlinson@linux.com

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL