tsugumi

やれやれだぜ

Installing

$ go get -u github.com/vulski/tsugumi/...

Getting Started

$ mkdir ~/.tsugumi && cp $GOPATH/src/github.com/vulski/tsugumi/config.json ~/.tsugumi/config.json

Edit the default config.json to your liking

{
  "nick": "tsugumi",
  "ssl": false,
  "sasl": false,
  "username": "tsugumi",
  "password": "",
  "host": "chat.freenode.net:6667",
  "commandoperator": "!",
  "channels": [
    "#tsugumi"
  ],
  "daddies": [],
  "plugins": [],
  "debug": false,
  "instances": "1"
}

Run !

tsugumi -rebuild

The -rebuild flag will rebuild/build any plugins, if you set any.

Default Commands

Some default commands out of the box (assuming ! is our commandoperator)

• !nick {NICK} - Change the bot's nick name.
• !join {CHANNEL} - Tell the bot to join a channel.
• !part {CHANNEL} - Tell the bot to part a channel.
• !topic {TOPIC} - Set the topic for the current channel.
• !tell {NICK} {MESSAGE} - Tell a user a message when they type in the current channel.

Installing plugins

Installing and updating plugins are fairly simple, simple clone the plugin you want into the ~/.tsugumi/plugins directory and add the plugin's directory name to "plugins" variable in your config.

For example,

$ git clone https://github.com/vulski/title_plugin.git ~/.tsugumi/plugins/title

Add to your config.json plugins

  "plugins": [
    "title",
  ]

Then run tsugumi with the -rebuild flag.

$ tsugumi -rebuild