Simple owncast bot
Go to file
Siina Mashek 8b4885af76 Fixed command parsing; fixed help command; updated start.sh for the port i use 2023-10-24 11:50:42 +03:00
core Fixed command parsing; fixed help command; updated start.sh for the port i use 2023-10-24 11:50:42 +03:00
plugins General updates to remove fedi and become flake compliant 2023-10-24 11:06:59 +03:00
.gitignore Migrated config and commands to ConfigParser 2022-04-24 04:47:08 +03:00
ATTRIBUTION.adoc Restructured to use primitive plugin system. 2022-04-27 11:24:45 +03:00
LICENSE Initial commit 2022-04-19 07:33:38 +02:00
Pipfile General updates to remove fedi and become flake compliant 2023-10-24 11:06:59 +03:00
Pipfile.lock General updates to remove fedi and become flake compliant 2023-10-24 11:06:59 +03:00
README.adoc Moving to pipenv, adding initial fedi goodies 2022-11-29 19:53:11 +02:00
bot.py forgot to remove fedi import 2023-10-24 11:12:29 +03:00
commands.ini Fixed command parsing; fixed help command; updated start.sh for the port i use 2023-10-24 11:50:42 +03:00
config.example.ini Moving to pipenv, adding initial fedi goodies 2022-11-29 19:53:11 +02:00
start.sh Fixed command parsing; fixed help command; updated start.sh for the port i use 2023-10-24 11:50:42 +03:00

= AMELIABOT

:url-owncast: https://owncast.online
:url-hatbot: https://codeberg.org/hatniX/hatbot
:url-hatnix: https://hatnix.net

= ameliabot

A chatbot for owncast, inspiration from {url-hatbot}[hatbot] by {url-hatnix}[hatniX].

Code attributions can be found in `ATTRIBUTION.adoc`

== Requirements
* {url-owncast}[Owncast] server
* Python 3
* Flask

== Setup


* Install dependencies with `pipenv install`
* Create an Owncast webhook url pointing to your bot's location
** http://localhost:5000/webhook/owncast if bot and owncast are on the same machine
* Run ameliabot the first time to generate a minimal configuration file
** Or copy `config.example.ini` to `config.ini` and fill out the information required

Ameliabot can be run by executing `start.sh` or:
```
FLASK_APP=bot.py pipenv run python3 -m flask run
```

Please use a proper uWSGI proxy if the bot is not on the same machine as owncast.