Go to file
Romain J c1e253689d update(setup): improve setup UI 2020-08-26 17:15:38 +02:00
.github feat(doc): add github issue template 2020-05-24 01:18:05 +02:00
.idea feat(i18n): finish i18n class, todo: persist data in DB 2020-06-11 01:06:30 +02:00
tuxbot update(setup): improve setup UI 2020-08-26 17:15:38 +02:00
.gitignore fix(gitignore): add workspace.xml to gitignore 2020-06-05 00:31:15 +02:00
LICENSE.md 'cause developper is doing SHIT 2020-06-08 00:49:41 +02:00
Makefile feat(i18n): finish i18n class, todo: persist data in DB 2020-06-11 01:06:30 +02:00
README.md update(setup): improve setup UI 2020-08-26 17:15:38 +02:00
setup.cfg update(setup): improve setup UI 2020-08-26 17:15:38 +02:00
setup.py update(setup): improve setup UI 2020-08-26 17:15:38 +02:00

README.md

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

todo