From 745175210c4823ec452b6c95c44a370176b3caab Mon Sep 17 00:00:00 2001 From: Bel LaPointe Date: Fri, 24 Mar 2023 14:01:44 -0600 Subject: [PATCH] mv README#host to host.d --- README.md | 78 ----------------------------------------------- host.d/README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+), 78 deletions(-) create mode 100644 host.d/README.md diff --git a/README.md b/README.md index 1204afa..d7f3eaa 100644 --- a/README.md +++ b/README.md @@ -20,81 +20,3 @@ Think Dug's Twitch Chat Plays * 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 - -> 10 buttons per player -> `go doc key Undef | grep Key | grep -v Undef | wc -l` total (54) - -The server cannot be a client because math. Maybe a VM on the client as a server would work tho. - -```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 -``` - -#### `mayhem-party` - -##### Configs - -Create some number of remap files at `/tmp/mayhem-party.d/*` -with keys for EVERY client config button like the following -with at least 1 effectively not mapped/empty - -```yaml -A: A -B: B -C: C -``` - -run `cd /tmp/mayhem-party.d; ln -s ./the-unmapped-file ./live` - -##### Binary - -```bash -DEBUG=1 -INPUT_KEYBOARD=true -INPUT_REFRESH_ON_SIGUSR=true -INPUT_REMAP_FILE=/tmp/mayhem-party.d/live -MAIN_INTERVAL_DURATION=5ms -OUTPUT_KEYBOARD=true -``` - -#### Game Playing - -Foreground - -#### `stt` - -TODO pipe stt detecting relevant strings -> change the `/tmp/mayhem-party.d/live` link -> `SIGUSR1` to `mayhem-party` diff --git a/host.d/README.md b/host.d/README.md new file mode 100644 index 0000000..71f3f11 --- /dev/null +++ b/host.d/README.md @@ -0,0 +1,79 @@ +# 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 + +> 10 buttons per player +> `go doc key Undef | grep Key | grep -v Undef | wc -l` total (54) + +The server cannot be a client because math. Maybe a VM on the client as a server would work tho. + +```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 +``` + +## `mayhem-party` + +### Configs + +Create some number of remap files at `/tmp/mayhem-party.d/*` +with keys for EVERY client config button like the following +with at least 1 effectively not mapped/empty + +```yaml +A: A +B: B +C: C +``` + +run `cd /tmp/mayhem-party.d; ln -s ./the-unmapped-file ./live` + +### Binary + +```bash +DEBUG=1 +INPUT_KEYBOARD=true +INPUT_REFRESH_ON_SIGUSR=true +INPUT_REMAP_FILE=/tmp/mayhem-party.d/live +MAIN_INTERVAL_DURATION=5ms +OUTPUT_KEYBOARD=true +``` + +## Game Playing + +Foreground + +## `stt` + +TODO pipe stt detecting relevant strings -> change the `/tmp/mayhem-party.d/live` link -> `SIGUSR1` to `mayhem-party` +