Skip to content

Commit b9cd549

Browse files
authored
RecordKeyboardController.md (#245)
1 parent 96dcb13 commit b9cd549

File tree

2 files changed

+65
-9
lines changed

2 files changed

+65
-9
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Record Keyboard Controller
2+
3+
## Program Description
4+
5+
Record actions with the keyboard controller, then play it back. The action recordings are saved in a `.json` file.
6+
7+
For developers: you can also convert this `.json` file into a `.txt` file that contains the C++ code.
8+
9+
## Instructions
10+
11+
### Record mode
12+
- Press "Start Program".
13+
- Then click the screen to activate the keyboard controller.
14+
- Perform your actions with the keyboard.
15+
- Press "Stop Program" when you are done.
16+
- The actions will be saved to a .json file. The name of this file will be as per the text box next to "File name".
17+
18+
### Replay mode
19+
- Ensure the name of the .json file with your saved actions is in "File name" text box.
20+
- Press "Start Program".
21+
- The program will replay the actions as listed in the .json file.
22+
23+
### [For Developers] Convert json to code
24+
- Ensure the name of the .json file with your saved actions is in "File name" text box.
25+
- Press "Start Program".
26+
- The program will output a .txt file with the C++ code that can perform the actions listed in the .json file. The .txt file will be in the same folder as the .json file.
27+
28+
29+
## Options
30+
31+
### Mode
32+
Choose one of three modes.
33+
- Record: Record the keyboard actions
34+
- Replay: Replay the keyboard actions that have been recorded
35+
- [For Developers] Convert json to code: Convert the actions saved to the .json file to C++ code, saved as a .txt file.
36+
37+
### File name
38+
Name of the JSON file to read from, or to write to.
39+
40+
### [For Developers] Automatically generate C++ code
41+
After recording, a text file with the C++ code will automatically be generated. The .txt file will be in the same folder as the .json file.
42+
43+
## Credits
44+
45+
- **Author:** jw
46+
47+
48+
49+
<hr>
50+
51+
**Discord Server:**
52+
53+
[<img src="https://canary.discordapp.com/api/guilds/695809740428673034/widget.png?style=banner2">](https://discord.gg/cQ4gWxN)
54+
55+

Wiki/Programs/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,16 @@ Read more about [Controller Performance Categories](/Wiki/ControllerList.md#cont
2828

2929
| **Program** | **Feedback** | **Controllers** |
3030
| --- | --- | --- |
31-
| [Framework Settings](NintendoSwitch/FrameworkSettings.md) | --- | --- |
32-
| [Virtual Console](NintendoSwitch/VirtualConsole.md) | --- | All |
33-
| [Switch Viewer](NintendoSwitch/SwitchViewer.md) | --- | All |
34-
| [TurboA](NintendoSwitch/TurboA.md) | | All |
35-
| [Turbo Button](NintendoSwitch/TurboButton.md) | | All |
36-
| [Turbo Macro](NintendoSwitch/TurboMacro.md) | | All |
37-
| [Prevent Sleep](NintendoSwitch/PreventSleep.md) | | All |
38-
| [Friend Code Adder](NintendoSwitch/FriendCodeAdder.md) | | All (Degraded: sbb2) |
39-
| [Friend Delete](NintendoSwitch/FriendDelete.md) | | All |
31+
| [Framework Settings](NintendoSwitch/FrameworkSettings.md) | --- | --- |
32+
| [Virtual Console](NintendoSwitch/VirtualConsole.md) | --- | All |
33+
| [Switch Viewer](NintendoSwitch/SwitchViewer.md) | --- | All |
34+
| [TurboA](NintendoSwitch/TurboA.md) | | All |
35+
| [Turbo Button](NintendoSwitch/TurboButton.md) | | All |
36+
| [Turbo Macro](NintendoSwitch/TurboMacro.md) | | All |
37+
| [Prevent Sleep](NintendoSwitch/PreventSleep.md) | | All |
38+
| [Friend Code Adder](NintendoSwitch/FriendCodeAdder.md) | | All (Degraded: sbb2) |
39+
| [Friend Delete](NintendoSwitch/FriendDelete.md) | | All |
40+
| [Record Keyboard Controller](NintendoSwitch/RecordKeyboardController.md) | | All |
4041

4142
## Pokémon Home
4243

0 commit comments

Comments
 (0)