From f5c3c955658c967f1b9085b76a805acf7da60a4d Mon Sep 17 00:00:00 2001 From: ComputerTech312 Date: Tue, 20 Feb 2024 09:46:15 +0100 Subject: [PATCH] Updated README.md --- README.md | 47 ++++++++++++++++++++++------------------------- 1 file changed, 22 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e136d44..c880c6f 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,33 @@ # IRC Bot -This is an IRC bot written in Python. It connects to an IRC server, authenticates using SASL if desired, and responds to various commands. It is also able to join and save channels that it is invited to. +This is an IRC bot written in Python. It connects to an IRC server, authenticates using SASL if desired, and responds to various commands. -## Requirements +## Installation. +1. Clone the repository: +```bash +git clone https://github.com/ComputerTech312/EliteBot.git +``` -- Python 3 -- A configuration file `config.json` containing the following variables: - - `BSERVER`: the IRC server to connect to - - `BPORT`: the port to use for the connection (can be preceded with a `+` to specify a secure connection) - - `BNICK`: the desired bot nickname - - `BIDENT`: the bot's ident - - `BNAME`: the bot's real name - - `UseSASL`: a boolean indicating whether or not to use SASL authentication - - `SANICK`: the bot's SASL account name (if using SASL) - - `SAPASS`: the bot's SASL password (if using SASL) - -## Usage +2. CD into the directory: +```bash +cd EliteBot +``` -To run the bot, simply execute the script with `python3 elitebot.py config.json`. The bot will connect to the specified server and authenticate if necessary. It will then listen for commands and respond accordingly. +3. Create a virtual envirionment. +```bash +python3 -m venv elitebot +``` -## Commands +4. Activate the virtual environment: +```bash +source elitebot/bin/activate +``` -The following commands are recognized by the bot: +5. Install the required packages. +```bash +pip install -r requirements.txt +``` -- `&moo`: makes the bot moo. -- `&join`: makes the bot join the specified channel. -- `&part`: makes the bot part the current channel if a channel is not specified. -- `&quit`: makes the bot quit. - -## Saving Channels - -The bot is able to save a list of channels that it should automatically join upon connecting to the server. ## Contributing