aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Phillips <david@sighup.nz>2017-09-26 23:07:27 +1300
committerDavid Phillips <david@sighup.nz>2017-09-26 23:07:27 +1300
commit20e56480ab73629afa1486542f01b0de9b95df94 (patch)
tree2e8694f974135b3e14ebe04378cb659dc8165ccc
parent8c9677c6224130f2ea138274b46814a27e7e70e8 (diff)
downloadidalius-20e56480ab73629afa1486542f01b0de9b95df94.tar.xz
Add commands to README
-rw-r--r--README.md72
-rw-r--r--TODO1
2 files changed, 72 insertions, 1 deletions
diff --git a/README.md b/README.md
index f6e3b63..81dbeb2 100644
--- a/README.md
+++ b/README.md
@@ -20,3 +20,75 @@ this IRC log:
<somebot> 🎷 🎷 🐍 🎷 🎺 🎺
Simple eh.
+
+## Admin commands
+
+idalius also supports some basic administration commands. These should be sent
+in a private message to the bot by someone with a hostmask configured to be an
+administrator's hostmask.
+
+At the moment these commands comprise:
+
+### Nick change
+
+ nick fooeybot
+
+Attempt to change the bot's IRC nick name to fooeybot.
+
+### Part/leave from channels
+
+ part #channel
+ part #channel some part message
+ part #channel #anotherone
+ part #channel #anotherone witty part message here
+
+Leave/part from one or more channels, giving an optional part message. This
+part message will be used for the parts sent to each channel specified.
+
+### Join channels
+
+ join #channel
+ join #channel #someotherchannel #omganotherchannel #holymoly
+
+Join one or more channels
+
+### Say something to a channel or person
+
+ say nick I'm here for you, Jack
+ say #channel Hey hi hello howdy
+
+Tell a person or a channel something, perferably something useful. Useful for
+puppeting if you are not on a channel, or you could talk to yourself through
+an idalius bot if you get lonely. Additionally, it might be useful for your
+idalius to contact services like nickserv, memoserv, chanserv etc.
+
+### Perform a CTCP action to a channel or person
+
+ action nick slaps you with a fish
+ action #channel stares down everyone in the room
+
+Not really useful apart from having a laugh in a channel. Really not sure why
+I added this except for a lame gag or two. Worth it.
+
+### Kick someone from a channel
+
+ kick #channel badPerson
+ kick #channel badPerson You've been very naughty!
+
+Kicks badPerson from #channel, and optionally takes your specified kick reason
+to relay with the kick. If you do not specify a kick reason, then idalius will
+use a default message "Requested by <yourNameHere!>".
+
+### Reconnect
+
+ reconnect
+ reconnect witty message
+
+Code isn't bug-free, and idalius is far from it. If you manage to break your
+idalius beyond repair, you might want to look at asking it remotely to
+disconnect from the IRC server and connect back to it again to start from a
+clean slate.
+
+Your idalius will ask the IRC server to use a witty quit message if you
+specify one, otherwise it will fall back on the default quit message specified
+in the config file (quit_msg)
diff --git a/TODO b/TODO
index 0fbb5bc..a986fc8 100644
--- a/TODO
+++ b/TODO
@@ -4,7 +4,6 @@
provides this"
* auto-rejoin delay
* auto-rejoin selectivity (on some channels not on others)
-* add admin commands to README.md
* add more admin commands for e.g.
+ adding stuff on the fly
+ reloading modules, or changing channel blacklists/whitelists