Skip to content

Overview#

Armour is a script designed to run on eggdrop bots. It is expected that users are already familiar with eggdrop bots when loading Armour.

Install Script#

Armour can be installed via an interactive script, simplifying the setup. This is the recommended approach for initial installation.

The script can be used to:

  • Download and install all prerequisite packages
  • Download, install, and configure eggdrop
  • Download and configure Armour
  • Add new bots to an existing Armour installation
  • Load Armour on an already configured eggdrop
  • Deploy new bots non-interactively from an input deployment file
  • Start eggdrop

Paste the below command into your shell to begin the interactive installation:

bash -c "$(curl -fsSL https://armour.bot/install.sh)"
Info

To use this install script, bash and curl must be installed on the machine.

The script source code can be viewed here

Install Demo

Once Armour is installed, the install.sh script is available on the local machine in the ./armour directory and kept up-to-date with the update command.

Proceed to the Configuration section for information about initialisation and usage.

Adding Bots#

The install.sh script can also be used to add new bots to existing installations:

empus@armour:~$ ./install.sh -h

Armour Installer
Usage: ./install.sh [options]
    -i              Install Armour (and optionally, eggdrop)
    -a              Add a new bot to existing Armour install
    -l              Load Armour on an existing eggdrop with Armour already configured
    -f <file>       Deploy an additional Armour bot non-interactively from a deployment file
    -h, --help      Display this message

empus@armour:~$
Deployment Files

Rather than interactive deployment of additional bots using -a, deployment files can be used with minimal configuration options.

Sample deployment files for different networks are in the ./deploy directory. For example, to deploy a bot for the Undernet network, edit ./deploy/undernet.ini and use:

./install.sh -f deploy/undernet.ini

Manual Installation#

For detailed manual setup instructions, please navigate through to Manual Installation

Advanced Users

Advanced Users#

The below is a high-level overview of the steps required:

  1. Install and run eggdrop bot, creating yourself as owner
  2. Install prerequisites on machine (git tcl tcllib tcltls sqlite3 sqlite-tcl)
  3. Install Armour 4.0 (from Github) to the ./armour directory inside the eggdrop installation directory
  4. Rename armour.conf to your own botname (further supporting multiple bots per install), editing configuration to suit
  5. Add the below to the end of your eggdrop config file (using your Armour conf name):

    source ./armour/mybot.conf
    

    Console Debug

    It is recommended that you watch the partyline with Debug Levels enabled, to ensure the script loads successfully or capture errors if it does not.

    To enable debug logging, enable the desired log levels (1-5). Useful logging without being too excessive, is up to log level 3:

    .console +1
    .console +2
    .console +3
    

  6. Rehash bot

  7. On IRC, create your initial Armour user (from empty database):

    /msg <botnick> inituser <user> [account]
    /msg <botnick> login <user> <password>
    /msg <botnick> newpass <newpassword>
    
    Information

    The inituser command only works when the Armour user database is empty.

    The user is your desired username in the Armour bot. It can be the same as your eggdrop handle.

    Use account to represent your network account (e.g., X username on Undernet). This will be used for autologin.

    Running the inituser command will generate generate a random password that can then be changed. This password can be used when autologin is unavailable, otherwise is not typically required in future.

    /msg <botnick> inituser <user>
    /msg <botnick> login <user> <password>
    /msg <botnick> newpass <newpassword>
    
    Information

    The inituser command only works when the Armour user database is empty.

    The user is your desired username in the Armour bot. It can be the same as your eggdrop handle.

    Running the command will generate generate a random password that can then be changed.