|
|
@@ -10,6 +10,7 @@ A chatbot for Owncast, where viewers earn points which can be redeemed for strea
|
|
|
- [Installation](#installation)
|
|
|
- [Running OwnchatBot](#running-ownchatbot)
|
|
|
- [Final Configuration](#final-configuration)
|
|
|
+* [Rewards Queue](#rewards-queue)
|
|
|
- [Kofi Integration](#kofi-integration)
|
|
|
- [Overlays](#overlays)
|
|
|
- [Support](#support)
|
|
|
@@ -76,9 +77,8 @@ A chatbot for Owncast, where viewers earn points which can be redeemed for strea
|
|
|
```bash
|
|
|
bash install.sh
|
|
|
```
|
|
|
-4. The last lines of install.sh's output tell you how to proceed to the management panel, where you can set up Owncast integraion, and other odds and ends.
|
|
|
|
|
|
-More detailed instructions for running OwnchatBot are covered below.
|
|
|
+4. The install script provides the URL for your OwnchatBot management panel. Bookmark it.
|
|
|
|
|
|
## Upgrading
|
|
|
*Make a backup of your OwnchatBot/instance folder.*
|
|
|
@@ -110,13 +110,13 @@ env/bin/python -m gunicorn --error-logfile ownchatbot.log -b 0.0.0.0:8081 -w 1 '
|
|
|
```
|
|
|
|
|
|
## Final configuration
|
|
|
-Once OwnchatBot is running, you can start setting up your rewards and other options via the Management Panel. When you finish running install.sh, it gives you a URL for your management panel. It will look something like this, with a proper, pregenerated auth code attached to it.
|
|
|
+Once OwnchatBot is running, you can start setting up your rewards and other options via the Management Panel at the URL provided by the install script. Authentication is handled using your Owncast server as an IndieAuth server. Your login credentials are the same credentials you use to log into your Owncast Admin page.
|
|
|
|
|
|
-http://localhost:8081/mgmt?auth=yourMGMT_AUTHcode
|
|
|
+The first thing you'll want to visit is the settings page. Each option is explained in detail. Then you'll need to get it talking to your Owncast instance, and Kofi if you'll be using it, both covered below.
|
|
|
|
|
|
-Once you're in the OwnchatBot management panel, bookmark it.
|
|
|
+### Rewards Queue
|
|
|
|
|
|
-The first thing you'll want to visit is the settings page. Each option is explained in detail. Then you'll need to get it talking to your Owncast instance, and Kofi if you'll be using it, both covered below.
|
|
|
+Also provided by the install script. The queue will refresh every 30 seconds to keep you up to date on your viewers' redeemed rewards. You can mark them as fulfilled as you go, or refund points when necessary.
|
|
|
|
|
|
### Owncast chat connection
|
|
|
OwnchatBot accesses Owncast chat room information via a webhook. You'll need to point Owncast at that webhook for things to function.
|
