From 26ce77c5df1257be86cbb1d52f75567bb718a998 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Sat, 3 Sep 2016 11:31:18 -0400 Subject: [PATCH] Module docs for making it easier to write modules. --- modules/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 modules/README.md diff --git a/modules/README.md b/modules/README.md new file mode 100644 index 0000000..a709398 --- /dev/null +++ b/modules/README.md @@ -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.)