tuxbot-bot/README.rst

Installing Tuxbot

It is preferable to install the bot on a dedicated user. If you don't know how to do it, please refer to this guide

Installing the pre-requirements

• The pre-requirements are:
  • Python 3.7 or greater
  • Pip
  • Git

Operating systems

Arch Linux

$ sudo pacman -Syu python python-pip python-virtualenv git

Continue to create the venv.

---

Debian

$ sudo apt update
$ sudo apt -y install python3 python3-dev python3-pip python3-venv git

Continue to create the venv.

---

Windows

not for now and not for the future

Creating the Virtual Environment

To set up the virtual environment and install the bot, simply run this two commands:

$ make
$ make install

Now, switch your environment to the virtual one by run this single command: source ~/tuxvenv/bin/activate

Configuration

It's time to set up your first instance, to do this, you can simply execute this command:

tuxbot-setup [your instance name]

After following the instructions, you can run your instance by executing this command:

tuxbot [your instance name]

Update

To update the whole bot after a git pull, just execute

$ make update