ubottu/README.md
2024-07-19 06:04:26 +00:00

1.2 KiB

Ubottu Matrix Helper Bot

The bot is a plugin for Maubot. Please see their documentation for setup and development. See USAGE.md for supported commands. There is a Django web component that provides the API for most of the bot's features.

Building

Clone the Repository

To clone the repository, use the following command:

git clone https://git.buechner.me/nbuechner/ubottu.git

Navigate to the Directory

Change your current working directory to the cloned repository:

cd ubottu

Create a Python Virtual Environment

Create a virtual environment for the project:

python3 -m venv .venv

Activate the Virtual Environment

Activate the created virtual environment:

source .venv/bin/activate

Install Dependencies

Install the required dependencies from requirements.txt:

pip install -r requirements.txt

Build the module

mbc build

This produces a .mbp file you can upload via the Maubot admin interface.