hamcha/strimertul
1
0
Fork 0
mirror of https://git.sr.ht/~ashkeel/strimertul synced 2024-09-18 01:50:50 +00:00
Code Activity Actions

Make README more friendly

Browse source
This commit is contained in:
Ash Keel 2021-11-20 12:36:56 +01:00
parent 63d791e3fe
commit 27a7ede45e
No known key found for this signature in database
GPG key ID: BAD8D93E7314ED3E
1 changed files with 22 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,21 +1,34 @@
# Strimertül
Small broadcasting suite, includes:
Small broadcasting suite for Twitch, includes:
- Extremely simple/fast disk-backed KV over websocket ([Kilovolt](https://github.com/strimertul/kilovolt)) for interacting with web-based overlays
- and it has pub/sub!
- Static file server for said overlays
- Loyalty system that tracks viewers and allows them to redeem rewards and contribute to community goals
- Twitch IRC bot to tie everything together
- Backend integration ([stulbe](https://github.com/strimertul/stulbe))
- Simple way to build stream overlays with minimal code
- Loyalty points system with redeems and community goals
- Twitch chat integration with custom commands
- Support for Twitch alerts and channel point redeems<sup>1</sup>
Platform support is limited to Twitch only for the time being (sorry!)
<sub>1. Requires external tool hosted somewhere</sub>
**Note:** some technical/coding experience is currently required to be able to use this effectively, see the technical overview below for more information.
## Getting started
Download the latest build from here: [github.com/strimertul/strimertul/releases/latest](https://github.com/strimertul/strimertul/releases/latest)
Start strimertul and the Web UI will appear when the app is done loading, you can start configuring and using it from there!
Start `strimertul.exe` and as soon as it will load a browser window will open with a Web UI you can use to configure it to your heart's content.
You can also build the project yourself, refer to the Building section below.
## Technical overview
Strimertül is a single executable app that provides the following:
- HTTP server for serving static assets and a websocket API
- Twitch bot for handling chat messages and providing custom commands
- Polling-based loyalty system for rewards and community goals
At strimertul's core is [Kilovolt](https://github.com/strimertul/kilovolt), a pub/sub key-value store accessible via websocket. You can access every functionality of strimertul through the Kilovolt API. Check [this repository](https://github.com/strimertul/kilovolt-clients) for a list of officially supported kilovolt clients (or submit your own). You should be able to easily build a client yourself by just creating a websocket connection and using the [Kilovolt protocol](https://github.com/strimertul/kilovolt/blob/main/PROTOCOL.md).
Check out the [project's wiki](https://github.com/strimertul/strimertul/wiki) for more information on how to use the API to interact with strimertul.
## Building