From cb266f531057b58c653479c300359a02b81a876b Mon Sep 17 00:00:00 2001 From: raylu Date: Wed, 27 Oct 2010 01:20:23 -0400 Subject: [PATCH] Document new commands --- README.md | 62 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 43 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 059d01c..c134337 100644 --- a/README.md +++ b/README.md @@ -18,36 +18,60 @@ rbot.conf and auth.conf will be copied. Configure those and then run the bot: ./rbot -### Commands - -All commands are prefixed with the trigger configured in rbot.conf. - -- `tr text`: detect the language of text -- `tr en|ja en|es text`: translate text into Japanese and Spanish -- `flags raylu`: get's raylu's flags -- `flags`: get's the flags of the user executing the command -- `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 -- `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. -- `say text`: says text to the channel - -Commands that don't require access behave the same when sent to a channel the bot is in and when whispered to the bot. 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. - ### Flags -Access is configured in auth.conf and 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. +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 +- `h`: halfop|hop dehalfop|dehop kick ban unban kb (hop and dehop can only be used on yourself and you cannot kick or kb people with o or h) - `t`: topic appendtopic - `s`: say In addition, a user must have at least one flag to use `flags` (so users without access can't spam the bot). +### Commands + +All commands are prefixed with the trigger configured in rbot.conf. + +Access related commands: +- `flags raylu`: get's raylu's flags +- `flags`: get's your flags +- `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 +- `say text`: says text to the channel + +Op commands +- `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 +- `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 +- `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. + +Google API commands: +- `tr text`: detect the language of text +- `tr en|ja en|es text`: translate text into Japanese and Spanish +- `calc 2-1 usd in yen`: convert 1 USD to Japanese yen + +Commands that don't require access behave the same when sent to a channel the bot is in and when whispered to the bot. + +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. + +The bot will accept invites from the owner to any channel. + ### Miscellaneous 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.