storm
/
stormbot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Module docs for making it easier to write modules.

This commit is contained in:
Storm Dragon 2016-09-03 11:31:18 -04:00
parent 5edc5453fe
commit 26ce77c5df
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/README.md Normal file
View File

@ -0,0 +1,4 @@
When creating modules, remember to source the functions file so all the info it contains will be available.
[ -f functions.sh ] && source functions.sh
Modules are given two parameters, $1 is the nick of the person who called the module, and $2 is the channel. You need at least $2 when sending a message to a channel, like the following:
msg "$2" the rest of your message (quotes are optional, but be careful to escape things if you don't use quotes.)