|
|
@@ -1,7 +1,7 @@
|
|
|
# OwnchatBot
|
|
|
|
|
|
|
|
|
-A chatbot for Owncast, enabling viewers to earn points which can be used to purchase stream rewards, and enabling streamers to use Kofi integration to monetize their stream.
|
|
|
+A chatbot for Owncast, enabling viewers to earn points which can be redeemed stream rewards, and enabling streamers to monetize their streams using Kofi integration.
|
|
|
|
|
|
## Table of Contents
|
|
|
- [Features](#features)
|
|
|
@@ -12,18 +12,20 @@ A chatbot for Owncast, enabling viewers to earn points which can be used to purc
|
|
|
- [Final Configuration](#final-configuration)
|
|
|
- [Kofi Integration](#kofi-integration)
|
|
|
- [Overlays](#overlays)
|
|
|
+- [Support](#support)
|
|
|
+- [Contributing](#contributing)
|
|
|
- [License](#license)
|
|
|
- [Attribution](#attribution)
|
|
|
|
|
|
## Features
|
|
|
-* The standard chat redeems most of us are familiar with. Viewer spends points for the redeem, streamer does/says a thing.
|
|
|
+* The standard chat points/rewards system most of us are familiar with. Viewer redeems their points for a reward, streamer does/says a thing.
|
|
|
* Voting. The streamer can create votes, and viewers can vote for them.
|
|
|
* The current vote tally can be set up as a browser source, to display on-screen.
|
|
|
-* Special redeems that will run commands for things like triggering webhooks and running scripts.
|
|
|
+* Special rewardss that will run commands for things like triggering webhooks and running scripts.
|
|
|
* Goals that viewers can collectively contribute points to for rewards.
|
|
|
* Goal progress can be set up as a browser source in your streaming software, to display on-screen.
|
|
|
* Milestones can be set up within goals, for little rewards along the way.
|
|
|
-* Cool down timers for redeems and specials.
|
|
|
+* Cool down timers for rewards and specials.
|
|
|
* Automated announcements at regular intervals.
|
|
|
* Web based viewer panel for viewing the reward queue, and points and reward information.
|
|
|
* Web based management panel.
|
|
|
@@ -176,6 +178,15 @@ Goals ```http://localhost:8081/goals```
|
|
|
* Recommended height: 210
|
|
|
* In OBS, check "Refresh browser source when scene becomes active"
|
|
|
|
|
|
+## Support
|
|
|
+For support (a bug, feature request/tweak, question or comment), you can contact DeadTOm via the following methods:
|
|
|
+* [Mastodon](https://dice.camp/@deadtom)
|
|
|
+* Email: deadtom@deadtom.me
|
|
|
+* XMPP: deadtom@deadtom.me
|
|
|
+
|
|
|
+## Contributing
|
|
|
+If you are thrilled to death with OwnchatBot, and want to throw a bit of monetary love DeadTOm's way, you can do so via [Kofi](https://ko-fi.com/deadtom).
|
|
|
+If you'd like to contribute code, contact DeadTOm about setting up an account on his Gogs instance.
|
|
|
|
|
|
## License
|
|
|
OwnchatBot © 2025 by [DeadTOm](https://www.deadtom.me) is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/).
|
|
|
@@ -187,4 +198,4 @@ At the time of this writing, it is released under a [Creative Commons CC-BY 3](h
|
|
|
|
|
|
The basic layout of the user and management panels was copied from the [tab bar tutorial on w3schools.com](https://www.w3schools.com/howto/howto_js_tabs.asp).
|
|
|
|
|
|
-The food that keeps me alive during all-weekend coding sessions is provided by [Wonder](https://mas.to/@wonderwmn).
|
|
|
+The food that keeps me alive during all-weekend coding sessions is provided by [Wonderwmn](https://mas.to/@wonderwmn).
|
