WIP fixup READMEs

GuardChan/README.md

@@ -1,8 +1,11 @@
+GuideChan
+=========
+
 Guardchan is an eggdrop script which will kick (and optionally ban) anyone who joins a channel who isn’t in the bot’s userfile. If it’s not opped then it’ll /msg a configurable nick to warn them.
 
 To use this script:
 
-* Download it (link below)
+* Download it
 * Put the file .TCL file in your eggdrop’s scripts directory
 * Edit the script to set your nick as the owner, and to choose if you want bans or not.
 * Get the bot to load it by adding this towards the end of your config: `source scripts/guardchan.tcl`

HostClean/README.md

@@ -1,11 +1,17 @@
 HostClean
----------
+=========
 
 HostClean helps tidy up old entries in your bot for users hostmasks.
 
-First, run log files (e.g. from your client) through parse.py - expects lines to have something matching "joins (user@hostname)" (or quits). Outputs user@host entries, one per line, for the TCL script. Run it many times and concatenate the output, then use sort and uniq to sanitise.
+First, run log files (e.g. from your client) through `parse.py` - expects lines to have something matching "`joins (user@hostname)`" (or `quits`). Outputs user@host entries, one per line, for the TCL script. Run it many times and concatenate the output, then use sort and uniq to sanitise.
+
+Something like this:
+
+```bash
+$( for f in "#channel.*.log"; do python parse.py "$f"; done ) | sort | uniq > hosts.txt
+```
 
 Then load the TCL script into your bot, and run `.hostload <path to file you made above>`, and then do `.hostclean <handle>` for each user.
 
-The script outputs a bunch of .-host lines, which you should double check, and then you can copy/paste them back into the partyline.
+The script outputs a bunch of `.-host` lines on the partyline, which you should double check, and then you can copy/paste them back into the partyline to execute them.
 

ProxyCheck/README.md

@@ -1,3 +1,13 @@
+proxycheck
+==========
+
 proxycheck performs RBL lookups on people joining your channel and bans people who are listed. Per-channel toggle, configurable ban duration, configurable RBL usage.
 
-Configuration instructions are contained in the script.
+To use the script:
+
+* Download it
+* Put the TCL file in your eggdrop scripts directory
+* Add `source scripts/proxycheck.tcl` to the end of your eggdrop config
+* If you want to change the list of RBLs the script checks or how long users are banned for, edit it (it's clearly commented)
+* Rehash the bot
+* Enable on channels with `.chanset #channel +proxycheck`

QuoteEngine/README.md

@@ -1,11 +1,16 @@
-**Hello!**
+QuoteEngine
+===========
 
+A quote database for Eggdrop bots.
+
+Prerequisites
+-------------
 
-Steps you need to do (or packages you should have) before downloading the script:
 1. Install all necessary packages for eggdrop to make use of mysql (also packages which you need to have are included).
-   <br>
-   For example for ubuntu 18.04 these would be the packages: tcl, tcl-dev, tcllib, tcl-tls, zlibc, zlib1g, tcl-trf, mysqltcl
-2. Install mysql-server and phpmyadmin (phpmyadmin is not really needed, but it helps to manage databases).
+
+   For example for ubuntu 18.04 these would be the packages `tcl, tcl-dev, tcllib, tcl-tls, zlibc, zlib1g, tcl-trf, mysqltcl`
+
+2. Install `mysql-server`. You may also want to install `phpmyadmin` and phpmyadmin (phpmyadmin is not really needed, but it helps to manage databases).
    <br>
    For example for ubuntu 18.04 these would be the packages: mysql-server, mysql-client, phpmyadmin
       <br>

README.md

@@ -1,11 +1,12 @@
 eggdrop-scripts
 ===============
 
-A collection of eggdrop scripts
+A collection of eggdrop scripts.
 
 * GuardChan: kickban people who aren't known to the bot
+* HostClean: helper tool for cleaning up old hostmasks
 * ProxyCheck: look up people joining against DNSBL and kickban on match
 * QuoteEngine: a quotes database with web access
-* TopicEngine: a topic management script (superceeded by TopicEngine2)
+* TopicEngine: a topic management script (superseded by TopicEngine2)
 * TriviaEngine: a trivia bot
 * noiphost: require reverse DNS for people joining the channel

TopicEngine/README.md

@@ -1,8 +1,11 @@
+TopicEngine
+===========
+
 The TopicEngine script allows advanced topic control in your IRC channel(s). It can be used to allow non-ops to change the topic, as well as offering useful ways for people who could otherwise change the topic directly to modify it.
 
-Consult the settings script for configuration instructions.
+Consult the settings script for configuration instructions. The script loads `TopicEngineSettings.tcl` and then tries `TopicEngineSettings_BOTNICK.tcl` too, so you can put bot-specific customisations in that file if you want.
 
-This script works fine, but can be quirky for features like prefix and postfix. I’m going to fix it, sometime :)
+This script works fine, but can be quirky for features like prefix and postfix.
 
 Full help is available online in the script (`/msg BOTNICK topic help`), but here’s an overview:
 

TriviaEngine/README.md

@@ -1,4 +1,6 @@
+TriviaEngine
+============
+
 A trivia script for eggdrop.
 
 This script is unsupported; please read the source to divine how to set it up and use it (because, to be honest, that's what I'd have to do now ;)
-

noIPhost/README.md

@@ -1,4 +1,12 @@
-This script automatically bans people joining a channel with non-resolving hosts. Per-channel toggle.
+noIPhost
+========
 
-Instructions are in the script.
+This script automatically bans people joining a channel with non-resolving hosts. Per-channel toggle. Bans last a day by default. (To adjust, edit the script.)
 
+To use this script:
+
+* Download it
+* Put the TCL file in your eggdrop's `scripts` directory
+* Add `source scripts/noiphost.tcl` to your eggdrop config file
+* Rehash the bot
+* Enable it on desired channels with `.chanset #channel +noiphosts`