initial commit

1 files changed, 25 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..f1ca229
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+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,
+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).
+
+dependencies: chicken 5, "irc" egg, "srfi-18" egg.
+
+the default "config.scm" is very very specific to my 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).
+
+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
+irc-admins config option:
+  -  `!!set-verbose` enables relaying all log output to irc (config option
+     "verbose-log-relay?")
+  -  `!!unset-verbose` disables it
+  -  `!!/<command>` sends a command to the minecraft server (e.g. !!/stop)