2010-10-14 00:09:56 +00:00
rbot
2009-12-17 21:12:37 +00:00
======================
2010-10-14 00:09:56 +00:00
### Getting started
2010-10-16 23:14:41 +00:00
Assuming you have go set up (http://golang.org/),
2010-10-14 00:09:56 +00:00
2010-10-16 23:14:41 +00:00
git clone git://github.com/raylu/rbot.git
cd rbot
2011-01-24 22:32:58 +00:00
git submodule init
git submodule update
2011-01-24 03:58:26 +00:00
make -C client install
2011-01-24 22:32:58 +00:00
make -C goconfig install
2009-12-17 21:12:37 +00:00
make
2010-10-14 00:09:56 +00:00
2010-10-16 23:14:41 +00:00
rbot.conf and auth.conf will be copied. Configure those and then run the bot:
2010-10-14 00:09:56 +00:00
./rbot
2009-12-17 21:12:37 +00:00
2010-10-27 05:20:23 +00:00
### Flags
Access is configured in auth.conf, is per-channel, based on ident and host; nick is ignored. The owner is configured per server and other access is configured per channel. Owners can use any commands.
The following is a description of the commands enabled by each flag:
- `a` : add remove
- `o` : op halfop deop dehalfop kick|k ban|b unban|u kb
2010-10-27 05:49:57 +00:00
- `h` : halfop|hop dehalfop|dehop kick|k ban|b unban|u kb (hop and dehop can only be used on yourself and you cannot kick or kb people with o or h)
- `v` : voice, devoice
2010-10-27 05:20:23 +00:00
- `t` : topic appendtopic
- `s` : say
2010-11-03 21:17:46 +00:00
In addition, a user must have at least one flag to use `flags` and `list` (so users without access can't spam the bot).
2010-10-27 05:20:23 +00:00
2010-10-19 03:44:16 +00:00
### Commands
All commands are prefixed with the trigger configured in rbot.conf.
2010-10-27 05:20:23 +00:00
Access related commands:
2010-10-27 05:22:34 +00:00
2010-10-19 03:51:42 +00:00
- `flags raylu` : get's raylu's flags
2010-10-27 05:20:23 +00:00
- `flags` : get's your flags
2010-10-20 21:34:47 +00:00
- `add raylu t` : gives raylu the t flag
- `remove raylu t` : removes the t flag from raylu
- `remove raylu` : removes all of raylu's flags
2010-11-03 21:17:46 +00:00
- `list` : lists all users and their access
2010-11-05 23:19:15 +00:00
- `list raylu` : searches the access list for raylu
2010-10-27 05:20:23 +00:00
2010-11-05 23:28:32 +00:00
Admin commands:
2010-11-09 03:27:33 +00:00
2010-11-05 23:28:32 +00:00
- `nick john` : changes the bot's nick to john
- `say text` : says text to the channel
2010-10-27 05:22:34 +00:00
Op commands:
2010-10-27 05:20:23 +00:00
- `halfop|hop` : halfop yourself
- `halfop|hop raylu john` : halfop raylu and john
- `op` : op yourself
- `op raylu john` : op raylu and john
- `deop` : deop yourself
- `deop raylu john` : deop raylu and john
- `dehalfop` : dehalfop yourself
- `dehalfop|dehop raylu john` : dehalfop raylu and john
2010-10-27 05:49:57 +00:00
- `voice` : voice yourself
- `voice raylu john` : voice raylu and john
- `devoice` : devoice yourself
- `devoice raylu john` : devoice raylu and john
2010-10-27 05:20:23 +00:00
- `kick|k raylu` : kick raylu
- `ban|b raylu john!*@*` : ban raylu by hostname and john by nick
- `unban|u raylu john!*@*` : unban raylu by hostname and john by nick
- `kb raylu` : kick raylu, then ban him by hostname
2010-10-19 03:51:42 +00:00
- `topic text` : sets the topic and basetopic to text
- `topic` : gets the current basetopic
- `appendtopic text` : if the topic does not starts with basetopic, sets the basetopic to the current topic. Makes the topic basetopic+text.
2010-11-04 01:15:27 +00:00
- `part` : leaves the channel
2010-10-19 03:44:16 +00:00
2010-10-27 05:20:23 +00:00
Google API commands:
2010-10-27 05:22:34 +00:00
2010-10-27 05:20:23 +00:00
- `tr text` : detect the language of text
- `tr en|ja en|es text` : translate text into Japanese and Spanish
2010-12-09 08:22:24 +00:00
- `roman text` : translate text into romaji (see rbot.conf.example)
2010-11-04 01:15:27 +00:00
- `calc 1 usd in yen` : convert 1 USD to Japanese yen
2010-10-19 03:44:16 +00:00
2010-10-27 05:20:23 +00:00
Commands that don't require access behave the same when sent to a channel the bot is in and when whispered to the bot.
2010-10-19 03:44:16 +00:00
2010-10-27 05:20:23 +00:00
Commands that require access are listed above as if they were sent to a channel. When sent as a whisper, the first argument must be a channel name.
2010-10-19 03:44:16 +00:00
2010-11-04 01:15:27 +00:00
The bot will accept invites from the owner to any channel and only the owner can use `part` .
2010-10-19 03:44:16 +00:00
### Miscellaneous
2009-12-17 21:12:37 +00:00
2010-10-14 00:09:56 +00:00
This project was forked from jessta/goirc which is in turn forked from fluffle/goirc. Both of those projects are focused on developing the goirc framework whereas this is focused on developing a bot.
