ameliabot/README.adoc

28 lines
804 B
Plaintext
Raw Normal View History

2022-04-24 04:56:28 +03:00
:url-owncast: https://owncast.online
:url-hatbot: https://github.com/hatniX/hatbot
:url-hatnix: https://hatnix.net
2022-04-19 08:33:38 +03:00
2022-04-24 04:56:28 +03:00
= ameliabot
A chatbot for owncast, inspiration from {url-hatbot}[hatbot] by {url-hatnix}[hatniX].
2022-04-19 13:27:39 +03:00
2022-04-24 04:56:28 +03:00
Code attributions can be found in `ATTRIBUTION.adoc`
2022-04-19 13:27:39 +03:00
2022-04-24 04:56:28 +03:00
== Requirements
* {url-owncast}[Owncast] server
2022-04-19 13:27:39 +03:00
* Python 3
* Flask
2022-04-24 04:56:28 +03:00
== Setup
2022-04-19 13:27:39 +03:00
2022-04-24 04:56:28 +03:00
* Install Flask (`pip --user install Flask`)
2022-04-19 13:27:39 +03:00
* 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
* Copy `config-example.json` to `config.json` and fill out the information required
Ameliabot can be run by executing `start.sh` or:
```
FLASK_APP=bot.py python3 -m flask run
```
Please use a proper uWSGI proxy if the bot is not on the same machine as owncast.