From 3ae3e3b206f42edece58df100c3ead776bcfa983 Mon Sep 17 00:00:00 2001 From: Steve Date: Fri, 21 May 2021 13:55:04 -0400 Subject: [PATCH] readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c863507 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# simpbot +A small matrix bot that checks the holodex API to see when defined VTuber's are streaming and embeds their stream into every Matrix room it's in. + +Mostly just a toy for widget testing purposes, and to have something to convert to an appservice + +Not the most productive use of my time. + +## Usage +Copy config.yaml.sample to config.yaml, give it a username and password for an account on your Matrix server. +Define some VTuber's to ~~simp for~~ keep track of. The "msg" parameter defines what message is sent when a stream starts for that Vtuber. + +Run the bot. It will automatically add and remove streams as they start and finish,