Welcome to vexbot’s documentation!

Installation

You will need an active DBus user session bus. Depending on your distro, you might already have one (Arch linux, for example).

For Ubuntu:

$ apt-get install dbus-user-session python3-gi python3-dev python3-pip build-essential

For everyone:

$ python3 -m venv <DIR>
$ source <DIR>/bin/activate
$ ln -s /usr/lib/python3/dist-packages/gi <DIR>/lib/python3.5/site-packages/
$ pip install vexbot[process_manager]

Make sure your virtual environment is activated. Then run:

$ vexbot_generate_certificates
$ vexbot_generate_unit_file
$ systemctl --user daemon-reload

Your bot is ready to run!

Running

$ systemctl --user start vexbot

Or

$ vexbot_robot

Please note that vexbot has a client/server architecture. The above commands will launch the server. To launch the command line client:

$ vexbot

Exit the command line client by typing !exit or using ctl+D.

Indices and tables