diff --git a/README.md b/README.md index ad62da9..611901c 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,44 @@ Think Dug's Twitch Chat Plays * output * to keyboard * to stderr + +## Hosting a Mayhem Party + +#### Requirements + +1. [`rusty-pipe`](https://gogs.inhome.blapointe.com/bel/rusty-pipe) +1. [`mayhem-party`](https://gogs.inhome.blapointe.com/bel/mayhem-party) +1. [`stt`](https://gogs.inhome.blapointe.com/bel/stt) + +### Clients + +#### Distribute `rusty-pipe` + +Each client needs 1 executable and 1 env file with a unique set of buttons + +```bash +INPUT_NAME=gui +OUTPUT_UDP_HOST=ip +OUTPUT_UDP_PORT=port +INPUT_GUI_BUTTON_A=X +INPUT_GUI_BUTTON_B=X +INPUT_GUI_BUTTON_DOWN=X +INPUT_GUI_BUTTON_L=X +INPUT_GUI_BUTTON_LEFT=X +INPUT_GUI_BUTTON_R=X +INPUT_GUI_BUTTON_RIGHT=X +INPUT_GUI_BUTTON_UP=X +INPUT_GUI_BUTTON_X=X +INPUT_GUI_BUTTON_Y=X +``` + +### Server + +#### `rusty-pipe` + +```bash +INPUT_NAME=udp +INPUT_UDP_PORT=port_i +``` + +#### `mayhem-party` diff --git a/todo.yaml b/todo.yaml index 9620d36..cdf673e 100755 --- a/todo.yaml +++ b/todo.yaml @@ -1,4 +1,5 @@ -todo: [] +todo: +- case-sensitive scheduled: [] done: - todo: sticky keyboard input mode for enable/disable explicitly