hamcha
/
strimertul
mirror of https://git.sr.ht/~ashkeel/strimertul
1
0
Fork 0
Code Actions
78 Commits 2 Branches 59 Tags 4.2 MiB
TypeScript 64.9%
Go 31.6%
NSIS 1.9%
JavaScript 1.2%
Dockerfile 0.3%
Go to file
Ash Keel c4990bde6c
Remove ISC restriction (file doesn't exist anymore) 		2021-11-15 17:29:58 +01:00
.github/workflows Add release CI 2021-09-18 22:28:34 +02:00
database Fix linting issues (Thanks GoLand!) 2021-10-28 11:01:52 +02:00
frontend Update KV to v5, add some debug methods 2021-11-15 13:33:40 +01:00
modules Add RPC for writing to chat 2021-11-12 23:23:30 +01:00
.gitignore Fix linting issues (Thanks GoLand!) 2021-10-28 11:01:52 +02:00
LICENSE First public commit \o/ 2021-05-02 14:29:43 +02:00
LICENSING.md Remove ISC restriction (file doesn't exist anymore) 2021-11-15 17:29:58 +01:00
README.md Remove ISC restriction (file doesn't exist anymore) 2021-11-15 17:29:58 +01:00
commands.go Fix linting issues (Thanks GoLand!) 2021-10-28 11:01:52 +02:00
go.mod Update KV to v5, add some debug methods 2021-11-15 13:33:40 +01:00
go.sum Update KV to v5, add some debug methods 2021-11-15 13:33:40 +01:00
main.go Update KV to v5, add some debug methods 2021-11-15 13:33:40 +01:00
static-ex.go Fix linting issues (Thanks GoLand!) 2021-10-28 11:01:52 +02:00

README.md

Strimertül

Small broadcasting suite, includes:

  • Extremely simple/fast disk-backed KV over websocket (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)

Platform support is limited to Twitch only for the time being (sorry!)

Getting started

Download the latest build from here: 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!

Building

You need to build the frontend first!

cd frontend
npm i
npm run build

Once that's done, just build the app like any other Go project

go build

License

Kilovolt's code is based on Gorilla Websocket's server example, licensed under BSD-2-Clause

The entire project is licensed under AGPL-3.0-only (see LICENSE).