Armour v4.0

.version

@@ -1,4 +1,5 @@
-version 3.5.1
-revision 2020020500
-filecount 80
-token 3e8SSB4hURVHDWI2zwDIWujU9FiR9gVVFSyLkyTFYt8EbEbtHW6Y2TkkHo1_wyHtHQE5r0T90AC33QCA11
+version 4.0
+revision 2024030101
+comment Update revision summary available @ https://armour.bot/changelog/#2024030100
+filecount 112
+token QndPhmUgWPWVXARAf6LQNtgev4ZC4uDOR1O6AnC833VI4FrYe94yVSPdaKM_ElsjnoaxzzVC0AC33QCA11

INSTALL.md

@@ -1,43 +1,60 @@
-# Install Guide
+# Armour Setup
+Author: Empus [empus@undernet.org](mailto:empus@undernet.org])
+Last Updated: 2022-12-06
 
-## **Prerequisites:** 
->- \>=TCL 8.6
->- sqlite3
->- TCL packages: sqlite3, tcllib
+## Prerequisites
+The below are required to run Armour:
+* eggdrop 1.8.4 (min)
+* sqlite3
+* TCL 8.6 (min)
+* tcllib
+
+
+## Eggdrop 
+
+### Eggdrop Configuration
 
-## **Eggdrop**
 See **bot.conf.sample** for a template for the **eggdrop.conf** itself
 This eggdrop configuration doesn't need to be used, but it will get you going fast on a new/dedicated bot for Armour
 
-Once the new bot is online using the bot.conf.sample template, do:
->`/msg <bot> createuser`
+Ensure the `./db` directory is created in the eggdrop dir (eggdrop dbs will save here)
+
+Once the new bot is online using the eggdrop sample template template, create your eggdrop account:
+>```/msg <bot> createuser```
+
+
+## Armour
+
+### Armour Configuration
+
+Edit the Armour configuration file as required. Crucially, this will define your default channels and sqlite3 DB path, but there are many more configuration options worth considering.  
 
-## **Armour**
-Edit the Armour configuration file as required. Crucially, this will define your sqlite3 DB path
 Take note to set the md5 method for password security.  This will likely be md5sum for Linux machines, or md5 for others.
 
-Now uncomment the last line in the eggdrop file and rehash the bot to load Armour
-Note that the Armour TCL itself does not get loaded directly.  **Load the Armour \*.conf file** and it will load the TCL for you.
-Loading this will create the DB and the necessary tables.
+Now uncomment the last line in the eggdrop configuration file and rehash the bot to load Armour.
+
+Note that the Armour TCL itself does not get loaded directly.  Load the Armour conf file and it will load the TCL for you and also create the database.
+
+
+### Armour Setup
+
+Once this is done, you can create your new Armour user which then provisions global and default channel access using the below command.  Use <user> to represent the name of your desired bot username, and <account> to represent your network username for autologin, if the network uses user accounts.  The below command only works once, when the user database is empty:
+
+>```/msg <bot> inituser <user> [account]```
 
-## **DB Insert**
-Once the script is loaded, insert yourself into the sqlite3 db as defined in Armour conf file:
+The bot will then generate a random password (sent via /notice) that you can use to login:
 
->`sqlite3 /path/to/armour-db.db`
+>```/msg <bot> login <user> <password>```
 
->`INSERT INTO users (user,xuser,level,pass) VALUES('YOUR-USER','YOUR-X-ACCOUNT',500,'foo');`
+Then a new password can be set:
 
->`.quit`
+>```/msg <bot> newpass <newpassword>```
 
-If autologin is setup and you are authed to X, the bot will soon automatically log you in.  If not, cycle the channel.
-Once logged into the bot (it will send you a /notice), do: 
->`/msg <bot> newpass <pass>`
+If the IRC network supports network user accounts (such as Undernet), the bot will now automatically authenticate you when you join channels.
 
-## **Support**
 And, you're done!
 
-Questions or problems? Ask in **\#Armour** on Undernet, or post to [GitHub Issues](https://github.com/empus/armour/issues)
 
-- Empus [empus@undernet.org](empus@undernet.org)
+### Troubleshooting
+Questions or problems? Ask in #Armour on Undernet, or post @ https://github.com/empus/armour/issues
 
-  26-01-2022

README.md

@@ -1,16 +1,13 @@
 ----------------------------------------------------------------------------------------------------------------
 
  ![Armour](./armour.png)
- Anti abuse and channel management script for eggdrop bots on the Undernet IRC Network
+
+Abuse and channel management script for eggdrop bots on the Undernet IRC Network
 
 https://armour.bot
 
 ----------------------------------------------------------------------------------------------------------------
 
-# Warning
-
-This is an out-of-date legacy branch.  For the current version of Armour, please us [v4.0 beta](https://github.com/empus/armour/tree/4_0_beta)
-
 # Installation
 
 Detailed install instructions and script documentation is found @ [https://armour.bot](https://armour.bot)

UPDATING.md

@@ -1,5 +1,5 @@
 ----------------------------------------------------------------------------------------------------------------------------------------
- armour.tcl v3.5.1 - 2020.02.05
+ armour.tcl v4.0.0 - 2022-12-11
 ----------------------------------------------------------------------------------------------------------------------------------------
 
  ![Armour](./armour.png)