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
No description
60 commits 2 branches 59 tags 4.2 MiB
TypeScript 64.9%
Go 31.6%
NSIS 1.9%
JavaScript 1.2%
Dockerfile 0.3%
Find a file
Ash Keel 3cf570542b
Add getting started
2021-09-19 00:06:54 +02:00
.github/workflows Add release CI 2021-09-18 22:28:34 +02:00
database Tring to hotfix logger but nothing is working 2021-05-16 18:10:51 +02:00
frontend Add callable functions to custom commands 2021-09-18 22:06:22 +02:00
modules Add callable functions to custom commands 2021-09-18 22:06:22 +02:00
.gitignore Add release CI 2021-09-18 22:28:34 +02:00
commands.go First public commit \o/ 2021-05-02 14:29:43 +02:00
go.mod Add callable functions to custom commands 2021-09-18 22:06:22 +02:00
go.sum Add callable functions to custom commands 2021-09-18 22:06:22 +02:00
LICENSE First public commit \o/ 2021-05-02 14:29:43 +02:00
LICENSING.md First public commit \o/ 2021-05-02 14:29:43 +02:00
main.go Add callable functions to custom commands 2021-09-18 22:06:22 +02:00
README.md Add getting started 2021-09-19 00:06:54 +02:00
static-ex.go First public commit \o/ 2021-05-02 14:29:43 +02:00

README.md

Strimertül

Smol broadcasting suite, includes:

  • Extremely simple/fast disk-backed KV over websocket (Kilovolt) for interacting with web-based overlays
    • oh 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
    • WIP betting system
  • Twitch IRC bot to tie everything together
  • WIP own 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). For ISC exceptions, see LICENSING.md.