Go to file
2020-11-11 01:29:53 +01:00
.github update(main): improve launch UI 2020-08-28 01:06:57 +02:00
.idea feat(commands|Utils): add info command 2020-11-09 01:18:55 +01:00
tuxbot fix(commands|Utils>source): stupid of me, the +3 was 'cause of a diff in local and github 2020-11-11 01:29:53 +01:00
.deepsource.toml fix(deepsource): remove black from deepsource conf 2020-10-21 00:02:02 +02:00
.gitignore fix(linting): set the not to 10/10 on pylint 2020-10-19 00:20:58 +02:00
.pylintrc fix(commands|Utils>source): stupid of me, the +3 was 'cause of a diff in local and github 2020-11-11 01:29:53 +01:00
dev.requirements.txt feat(database): add models loader in core 2020-11-08 01:07:27 +01:00
LICENSE fix(linting): set the not to 10/10 on pylint 2020-10-19 00:20:58 +02:00
Makefile feat(database): add models loader in core 2020-11-08 01:07:27 +01:00
README.rst remove(support): drop testing support for python 3.7 2020-11-08 01:09:40 +01:00
setup.cfg feat(commands|Utils): add credits and invite commands 2020-11-11 01:05:36 +01:00
setup.py update(setup): improve setup UI 2020-08-26 17:15:38 +02:00

image0 image1 image2

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