Skip to content
This repository was archived by the owner on Sep 27, 2023. It is now read-only.

Commit b320b53

Browse files
committed
Adding a LICENSE and README
Signed-off-by: Jesse Millar <[email protected]>
1 parent 9956dd7 commit b320b53

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Jesse Millar
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Screm Bot 3000
2+
3+
[![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)
4+
5+
## Overview
6+
7+
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!
8+
9+
## Usage
10+
11+
1. Create a `config.toml` file as outlined in the ["Config File" section](#config-file) below
12+
1. Put any sound effects you want to use in `./sounds` inside a directory with a name something like `./sounds/e-epic`
13+
- 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)
14+
1. Launch `screm.exe` by double clicking on it
15+
1. Trigger a sound effect with your configured keyboard shortcuts!
16+
17+
## Config File
18+
19+
`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.
20+
21+
- `twitch_username` (required): The username for your Twitch account/channel. Screm Bot 3000 can't read your channel's chat messages without this
22+
- `twitch_secret`: The OAUTH token needed for Screm Bot 3000 to post messages to your Twitch chat
23+
24+
## FAQ
25+
26+
### Does this work on any operating systems besides Windows?
27+
28+
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.

0 commit comments

Comments
 (0)