Skip to content

Commit

Permalink
Merge branch 'main' of github.com:electrorayer/electrobot
Browse files Browse the repository at this point in the history
  • Loading branch information
rayer456 committed Sep 10, 2023
2 parents 2f96fe1 + 05e0fa1 commit 2685923
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# electrobot

Twitch chat bot that manages predictions via chat commands and starts predictions based on Livesplit. Now with hotkey support.
Twitch bot that manages predictions via chat commands and starts predictions automatically based on Livesplit. Now with hotkey support.

# Prerequisites

Expand Down Expand Up @@ -71,9 +71,9 @@ The yellow stars indicate which category is active and which splits have predict
When you first successfully run `electrobot.py` a bindings file will be created in `config/bindings.json` with some default hotkeys to perform below actions.
- Close a prediction
- Cancel a prediction
- Select an outcome <1-10> *by default only the first four outcomes are made into a hotkey. You can go all the way up to 10 by just copy pasting the objects in the file.
- Close a prediction with CTRL + 5
- Cancel a prediction with CTRL + 6
- Select an outcome <1-10> with CTRL + <1-4> *by default only the first four outcomes are made into a hotkey. You can go all the way up to 10 by just copy pasting the objects in the bindings file.
- You can change the actual keys you press by editing the `hotkey` field. [List of available keys](https://github.com/btsdev/global_hotkeys#list-of-the-available-keys)
Expand Down Expand Up @@ -107,9 +107,9 @@ If all was configured correctly you should see this:
**Chat commands:**
The broadcaster and moderators can use these commands.
The broadcaster and moderators can use these commands:
- Start predictions with `pred start <name>`
- `name` must correspond to the `name` field of a prediction in `predictions.json`
- `<name>` must correspond to the `Name` field of a prediction
- Lock predictions with `pred lock` or wait until the timer runs out
- Resolve predictions with `pred outcome <1-10>`
- Cancel predictions with `pred cancel`
Expand All @@ -124,4 +124,4 @@ Only the broadcaster can use [hotkeys](#hotkeys)
- ![](/assets/pred_outcome.png)
- ![](/assets/pred_cancel.png)
- ![](/assets/livesplit.gif)
- ![](/assets/livesplit.gif)

0 comments on commit 2685923

Please sign in to comment.