matrixai/README.md
0xMRTT 70d77306cc
All checks were successful
black-action / runner / black formatter (push) Successful in -1m14s
doc: add psflt
2023-06-08 23:06:49 +02:00

34 lines
1.0 KiB
Markdown

# MatrixAI Bot
![]( https://healthchecks.projectsegfau.lt/badge/1de0ebc9-6c86-48b5-9992-7b44bcc4b483/4fokvU0o.svg )
A Matrix Bot for chatting with AI and generating pictures
## Usage
1. Invite `@ai:projectsegfau.lt` to your room
2. Chat with AI by doing `!ask Who are you ?`
3. Generate a picture by doing `!img A cat style=REALISTIC`
4. Do `!help` for getting more help
## Setup
``` shell
git clone https://git.projectsegfau.lt/0xMRTT/matrixai.git && cd matrixai
pip install -r requirements.txt
cp run.sh.example run.sh
mkdir -p ~/.local/share/systemd/user/
cp matrixai.service ~/.local/share/systemd/user/
```
And after
- Customize `run.sh` with your settings
- Fix the path to `run.sh` in the service file (`~/.local/share/systemd/user/matrixai.service`)
## Thanks
- [Baichat-py](https://bavarder.codeberg.page/code/baichat)
- [Project Segfault](https://psf.lt)
- [Simple Matrix Bot](https://simple-matrix-bot-lib.readthedocs.io/en/latest/examples.html)
- [Discord AI](https://github.com/mishalhossin/Discord-AI-Chatbot/tree/main)