mirror of
https://git.sr.ht/~ashkeel/strimertul
synced 2024-09-18 01:50:50 +00:00
Make README more friendly
This commit is contained in:
parent
63d791e3fe
commit
27a7ede45e
1 changed files with 22 additions and 9 deletions
31
README.md
31
README.md
|
@ -1,21 +1,34 @@
|
||||||
# Strimertül
|
# 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
|
- Simple way to build stream overlays with minimal code
|
||||||
- and it has pub/sub!
|
- Loyalty points system with redeems and community goals
|
||||||
- Static file server for said overlays
|
- Twitch chat integration with custom commands
|
||||||
- Loyalty system that tracks viewers and allows them to redeem rewards and contribute to community goals
|
- Support for Twitch alerts and channel point redeems<sup>1</sup>
|
||||||
- Twitch IRC bot to tie everything together
|
|
||||||
- Backend integration ([stulbe](https://github.com/strimertul/stulbe))
|
|
||||||
|
|
||||||
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
|
## Getting started
|
||||||
|
|
||||||
Download the latest build from here: [github.com/strimertul/strimertul/releases/latest](https://github.com/strimertul/strimertul/releases/latest)
|
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
|
## Building
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue