No description
Find a file
2020-06-08 00:41:06 +02:00
.github feat(doc): add github issue template 2020-05-24 01:18:05 +02:00
.idea update(doc|readme|installing): change installing steps 2020-06-07 18:29:55 +02:00
tuxbot fix(doc): fix broken link in readme 2020-06-07 18:45:50 +02:00
.gitignore fix(gitignore): add workspace.xml to gitignore 2020-06-05 00:31:15 +02:00
LICENSE.md update(license): change to a more friendly license 2020-06-08 00:41:06 +02:00
Makefile update(doc|readme|installing): change installing steps 2020-06-07 18:29:55 +02:00
README.md fix(doc): fix broken link in readme 2020-06-07 18:45:50 +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 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

go to hell

Creating the Virtual Environnement

To set up the virtual environnement 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

todo