logo

scripts

Unnamed repository; edit this file 'description' to name the repository.
commit: b7354b816eb802a386db174e3948cf35b61de740
parent: aee153461d244830001696ba544c26a01578aab4
Author: lanodan <haelwenn.monnier@gmail.com>
Date:   Mon, 30 Jun 2014 12:57:46 +0200

Add a README

Diffstat:

IRCBot/README.md | 20++++++++++++++++++++
1 file changed, 20 insertions(+), 0 deletions(-)

diff --git a/IRCBot/README.md b/IRCBot/README.md @@ -0,0 +1,20 @@ +A simple IRCBot for only one channel. +It works on all IRC servers. + +#Commands +syntax: [optional] <required> +``!hi [text]`` Welcome users. (the bot doesn't welcome users automatically yet) +``!say <text>`` say some text +``!action <text>`` do some actions(same as the /me) +``!source`` Give a link to the sourcode +``!stop in the name of sey`` Stop the bot with a nice reference to SYRSA + +#Configuration +nick nickname +passwd= password +server= Server IP/address (e.g ``server=irc.freenode.net``) +port= Server Port (note: Most of the time it's ``port=6667``) +channel= Channel, you can put only one channel for now +quitMessage= The message when the bot quits the server +welcomeMessage= The message when the bot arrives in the channel +source= The sourcecode of the bot (e.g ``source=My sourcecode is under CC-BY-SA and available at the following address: https://github.com/lanodan/scripts/tree/master/IRCBot``