|
|
@@ -106,6 +106,7 @@ Run:
|
|
|
|
|
|
## Running OwnchatBot
|
|
|
*Port 8081 used here as an example. Change it to whatever port you'd like your bot to listen on.*
|
|
|
+
|
|
|
Run OwnchatBot:
|
|
|
```bash
|
|
|
env/bin/python -m gunicorn -b 0.0.0.0:8081 -w 1 'ownchatbot:create_app()'
|
|
|
@@ -120,7 +121,8 @@ env/bin/python -m gunicorn --error-logfile ownchatbot.log -b 0.0.0.0:8081 -w 1 '
|
|
|
**A caveat here:** Some features are managed by a module called apscheduler. I chose this for its simplicity, however, it doesn't play well when trying to run the app with more than one worker. The "-w 1" option in the gunicorn command specifies just one worker. If you run it with more, it will multiply the jobs that apscheduler manages. For example, "-w 4" will start four workers, and every job apscheduler performs will get run four times. OCB will continue to function fine, but you'll see fun things like announcements getting repeated four times, and viewers getting awarded four times your configured points awards. OCB isn't yet so huge that it really needs more than one worker, but at some point I might try to move away from apscheduler.
|
|
|
|
|
|
## Final configuration
|
|
|
-Once OwnchatBot is running, you can start setting up your rewards and other options ```/mgmt```.
|
|
|
+Once OwnchatBot is running, you can start setting up your rewards and other options at ```/mgmt```.
|
|
|
+
|
|
|
Authentication is handled using your Owncast server as an IndieAuth server, so your login credentials are the same credentials you use to log into your Owncast Admin page.
|
|
|
|
|
|
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.
|
|
|
@@ -286,7 +288,7 @@ All command and rewards are preceeded with a prefix configured in the management
|
|
|
* GiveButter monthly subscription support.
|
|
|
* Streak tracker, to track how many consecutive streams a viewer has watched, and reward accordingly.
|
|
|
* Get emojis in OwnchatBot panels working correctly, because Wonderwmn insists on it.
|
|
|
-* Option to only allow authenticated users, or Kofi subscribers to redeem certain rewards.
|
|
|
+* Option to only allow authenticated users or Kofi subscribers to redeem certain rewards.
|
|
|
* !Timer - Set a timer that will sound an audible alarm. A command only available to the streamer or mods.
|
|
|
* A "watch" function that watches chat for certain words or phrases, and responds with preset messages.
|
|
|
|
