No description
Find a file
2020-06-07 17:41:34 +02:00
.github feat(doc): add github issue template 2020-05-24 01:18:05 +02:00
.idea fix(gitignore): add workspace.xml to gitignore 2020-06-05 00:31:15 +02:00
tuxbot feat(style): add black 2020-06-07 17:41:34 +02:00
.gitignore fix(gitignore): add workspace.xml to gitignore 2020-06-05 00:31:15 +02:00
Makefile feat(style): add black 2020-06-07 17:41:34 +02:00
README.md feat(style): add black 2020-06-07 17:41:34 +02:00
setup.cfg feat(style): add black 2020-06-07 17:41:34 +02:00
setup.py feat(doc): add readme file 2020-06-03 01:10:47 +02:00

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 by creating virtual env.


Debian

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

Continue by creating virtual env.


Windows

go to hell

Creating a virtual env

Make sure you have the virtualenv package installed before following the next steps.

Create the virtual environment by executing the following command:

python3 -m venv ~/tuxvenv

And activate it with this command:

source ~/tuxvenv/bin/activate

Installing Tuxbot

Now, you can finish the installation by executing this single command:

pip install .

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

todo