Skip to content

Commit

Permalink
Update readme for recording documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nirgoren committed Dec 12, 2021
1 parent 2402df1 commit 27f4f94
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ Hoykeys can be suppressed by toggling `Suppress Hotkeys` in the GUI window.
* *X* - Tap *X* and release the next frame
* [*X*] - Hold *X*
* ]*X*[ - Release *X*
* Note - For directions, if you want to switch from held direction to another held direction,
there's no need to release in between.
(For example, if you want to go from down to forward, just do
* Note - For directions, if you want to switch directly from held direction to another held direction,
do not release the held direction in between.
For example, if you want to go from down to forward, just do
`[2] W10 [6]`
instead of
`[2] W10 ]2[+[6]`)
`[2] W10 ]2[+[6]`
* **The above does not hold if the directions are mapped to keyboard keys (experimental)
* *+* - Add input to the same frame
#### Example:
Expand Down Expand Up @@ -115,7 +115,7 @@ endloop
## Config files:

You can define symbols, reassign symbols to other buttons, and set up macros in a JSON config file (see configs\gg.json for an example).
The first line of a playbacks file should always be the path (absolute or relative) to the config file to be used.
The first line of a playback file should always be the path (absolute or relative) to the config file to be used.

#### Reserved symbols:

Expand Down Expand Up @@ -216,6 +216,10 @@ The first line of a playbacks file should always be the path (absolute or relati
* 'enter'
</details>

## Recording:
The program can listen to controller inputs and generate Eddienput playbacks files. A controller has to be connected as the program starts to enable this feature.

Recording is initiated by pressing F10 on the keyboard. Once stopped by pressing the select button on the controller, the recorded inputs will be written into a playbacks file. The loaded recording configuration json file determines the symbols each button will be translated to, which should match the symbols defined in the configuration file for the generated playbacks file. If the loaded recording configuration file does not define a mapping between a button and a symbol, that button is ignored. See `rec_configs/rec.json` or `rec_configs/rec_bb.json` for examples.
## Others:

### Playing sounds
Expand Down
33 changes: 33 additions & 0 deletions src/rec_gg.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"config": "configs/gg.json",
"Symbols": {
"X": "P",
"A": "K",
"Y": "S",
"B": "H",
"START": "start",
"BACK": "select",
"RIGHT_SHOULDER": "D",
"RIGHT_TRIGGER": "T"
},
"P1_directions": {
"DPAD_UP": "8",
"DPAD_DOWN": "2",
"DPAD_LEFT": "4",
"DPAD_RIGHT": "6",
"DPAD_DOWN_LEFT": "1",
"DPAD_DOWN_RIGHT": "3",
"DPAD_UP_LEFT": "7",
"DPAD_UP_RIGHT": "9"
},
"P2_directions": {
"DPAD_UP": "8",
"DPAD_DOWN": "2",
"DPAD_LEFT": "6",
"DPAD_RIGHT": "4",
"DPAD_DOWN_LEFT": "3",
"DPAD_DOWN_RIGHT": "1",
"DPAD_UP_LEFT": "9",
"DPAD_UP_RIGHT": "7"
}
}

0 comments on commit 27f4f94

Please sign in to comment.