siina/ameliabot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Converted from markdown to adoc

Browse source
This commit is contained in:
Siina Mashek 2022-04-24 04:56:28 +03:00
parent e1ff594f79
commit 7f01289ca0
3 changed files with 24 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
ATTRIBUTION.adoc Normal file
View file

@ -0,0 +1,14 @@
:url-colargulog: https://github.com/davidohana/colargulog
:url-apache: https://www.apache.org/licenses/LICENSE-2.0.txt
:url-unlicense: https://unlicense.org/
:url-hatbot: https://github.com/hatniX/hatbot
:url-hatnix: https://hatnix.net
= Code Attribution
== ameliabot.logger
`ameliabot.logger` is based on {url-colargulog}[colargulog] by David Ohana under the {url-apache}[Apache-2.0 License]. Changed for `flake8` compliance.
== ameliabot.owncast
`ameliabot.owncast` originally started as {url-hatbot}[hatbot] by {url-hatnix}[hatniX], licensed under the {url-unlicense}[Unlicense], which this project also uses.

13
ATTRIBUTION.md
View file

@ -1,13 +0,0 @@
# Code Attribution
## ameliabot.logger
`ameliabot.logger` is based on [colargulog]() by David Ohana under the [Apache-2.0 License](). Changed for `flake8` compliance.
## ameliabot.owncast
`ameliabot.owncast` originally started as [hatbot]() by hatniX, licensed under the [Unlicense](), which this project also uses.
[colargulog]:https://github.com/davidohana/colargulog
[Apache-2.0 License]:https://www.apache.org/licenses/LICENSE-2.0.txt
[Unlicense]:https://unlicense.org/

22
README.md → README.adoc
View file

@ -1,18 +1,20 @@
# ameliabot
:url-owncast: https://owncast.online
:url-hatbot: https://github.com/hatniX/hatbot
:url-hatnix: https://hatnix.net
A chatbot for owncast, inspiration from [hatbot][] by [hatniX][].
= ameliabot
A chatbot for owncast, inspiration from {url-hatbot}[hatbot] by {url-hatnix}[hatniX].
Code attributions can be found in `ATTRIBUTIONS.md`
Code attributions can be found in `ATTRIBUTION.adoc`
## Requirements
* [Owncast][] server
== Requirements
* {url-owncast}[Owncast] server
* Python 3
* Flask
## Setup
== Setup
* Install Flask and (optionally for the quote system) psycopg2
* `pip --user install Flask`
* Install Flask (`pip --user install Flask`)
* 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
@ -23,7 +25,3 @@ 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.
[Owncast]:https://owncast.online
[hatbot]:https://github.com/hatniX/hatbot
[hatniX]:https://hatnix.net