From b320b535d50daea5a5e228eadbf1637abe6b026c Mon Sep 17 00:00:00 2001 From: Jesse Millar Date: Sun, 5 Jul 2020 15:18:30 -0500 Subject: [PATCH] Adding a LICENSE and README Signed-off-by: Jesse Millar --- LICENSE | 21 +++++++++++++++++++++ README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b95d784 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Jesse Millar + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1451ac2 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Screm Bot 3000 + +[![Man Hours](https://img.shields.io/endpoint?url=https%3A%2F%2Fmh.jessemillar.com%2Fhours%3Frepo%3Dhttps%3A%2F%2Fgithub.com%2Fjessemillar%2Fscrem.git)](https://jessemillar.com/r/man-hours) + +## Overview + +I like playing comedic sound effects while streaming videogames but couldn't find a sound board program that let me configure my sound effects and keyboard shortcuts with Git version control while also randomizing the sound effects that were played (it's more fun if I'm surprised by the sound effect as well as my viewers). Thus, Screm Bot 3000 was born! + +## Usage + +1. Create a `config.toml` file as outlined in the ["Config File" section](#config-file) below +1. Put any sound effects you want to use in `./sounds` inside a directory with a name something like `./sounds/e-epic` + - The first letter of the directory name (e.g. `e` in the example above) is the keyboard button used to play a random sound file from that directory (`Alt + e` in this case) +1. Launch `screm.exe` by double clicking on it +1. Trigger a sound effect with your configured keyboard shortcuts! + +## Config File + +`config.toml` should be in the same directory as the `screm.exe` binary. There are a few properties that can go in your `config.toml` file. Properties listed below are optional unless otherwise noted. See `sample-config.toml` for an example with fake configuration values. + +- `twitch_username` (required): The username for your Twitch account/channel. Screm Bot 3000 can't read your channel's chat messages without this +- `twitch_secret`: The OAUTH token needed for Screm Bot 3000 to post messages to your Twitch chat + +## FAQ + +### Does this work on any operating systems besides Windows? + +No. Not at the moment at least. The library I'm using for capturing global keyboard shortcuts is Windows-specific and my use case only involves Windows.