aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README15
1 files changed, 10 insertions, 5 deletions
diff --git a/README b/README
index f1ca229..2c1e6f6 100644
--- a/README
+++ b/README
@@ -1,23 +1,28 @@
this is a very scrappy thrown-together chicken scheme script, which runs a
-minecraft server as a subprocess and simultaneously connects to an irc channel,
+minecraft server as a subprocess and simultaneously connects to an IRC channel,
and then relays chat messages between the two (and also join/part messages, and
-ctcp actions (/me), and it also allows specified users to send commands from
-irc).
+CTCP ACTIONs (/me), and it also allows specified users to send commands from
+IRC).
dependencies: chicken 5, "irc" egg, "srfi-18" egg.
-the default "config.scm" is very very specific to my personal use-case, but it
+the default "config.scm" is very very specific to our personal use-case, but it
should be relatively easy to adapt it for your own situation. in particular,
you'll want to change the irc-admins, irc-conn and irc-channel, and unless
you're running an old version of minecraft, you'll also need to customise the
log parsing regexes, since the log format has changed in later versions (the
current one is tested on vanilla 1.6.4).
+messages are relayed into IRC using roleplay commands (NPC and NPCA). so, make
+sure the bot has permission to use these, maybe you need to set +E on the
+channel, etc. (or you could edit the code to not use those commands, or to use
+IRCv3's RELAYMSG, etc.)
+
also, because we're running this on an old server - it uses the "say" command
instead of "tellraw" because tellraw didn't exist yet. you may want to edit the
script itself ("wrapper.scm") to use tellraw to produce nicer messages?
-the irc bot accepts a small set of admin commands from the user(s) listed in
+the IRC bot accepts a small set of admin commands from the user(s) listed in
irc-admins config option:
- `!!set-verbose` enables relaying all log output to irc (config option
"verbose-log-relay?")