Merge pull request #2 from TheGreatRambler/dev

Add docs

README.md

@@ -1,6 +1,8 @@
 # NX TAS UI
 A PC frontend for the Nintendo Switch homebrew [Nx-TAS](https://github.com/hamhub7/nx-TAS).
 
+# [RELEASES HERE](https://github.com/TheGreatRambler/NX-TAS-UI/releases)
+
 ## Why this?
 You have probably heard of the [TASBOT Nintendo Switch setup](https://www.youtube.com/watch?v=VXRL7dUVT-M), [Switch Fightstick](https://github.com/shinyquagsire23/Switch-Fightstick) or even the macros of [JoyCon Droid](https://play.google.com/store/apps/details?id=com.rdapps.gamepad&hl=en_US). This program was created to address the shortcomings of these other, similar, projects.
 
@@ -10,18 +12,118 @@ In the spirit of TASBot, it is generally considered more prestigious to display
 
 Having access to the entire system via CFW introduces a lot of freedoms, so this project intends to place this functionality into a standard PC application, much like Bizhawk or other TAS creators. This power allows you to tas with the freedom of an emulator even though this is not an emulator. Yuzu can't TAS yet, to any dissenters out there :)
 
-This editor most closely resembles the [FCEUX TAS Editor](http://www.fceux.com/web/help/taseditor/).
+This editor is intended to most closely resemble the [FCEUX TAS Editor](http://www.fceux.com/web/help/taseditor/).
 
 ## How To Use:
 * Create a project, load a project, or load a recent project with the dialog at start.
-![Load Project](screenshots/loadproject.png)
+
+<div align=”center”><img src="screenshots/loadproject.png"></div> 
+
 * Select the IP address of your switch in order to take advantage of Switch homebrew for TASing. This menu appears at start and in `File/Set Switch IP`. (**THIS FEATURE IS CURRENTLY UNSUPPORTED**)
-![Select Switch IP](screenshots/selectip.png)
+
+<div align=”center”><img src="screenshots/selectip.png"></div>
+
 * Select a frame in the *Piano Roll* to begin editing frames. Add frames with `Ctrl + Plus`, create and remove savestate blocks with the buttons on the top, and create and select players. All the familiar commands are here, right click to see them all. Included are `Paste Place`, which only adds buttons if they are not present, and `Paste Insert`, which inserts the frame below the selected one. `Undo` and `Redo` support are planned.
-![Piano Roll](screenshots/pianoroll.png)
+
+<div align=”center”><img src="screenshots/pianoroll.png"></div>
+
+* To allow for seamless usage, button inputs support both keyboards and gamepads. The keyboard bindings are as follows:
+```json
+"buttons": {
+	"A": {
+		"viewName": "A Button",
+		"triggerKeybind": "A"
+	},
+	"B": {
+		"viewName": "B Button",
+		"triggerKeybind": "B"
+	},
+	"X": {
+		"viewName": "X Button",
+		"triggerKeybind": "X"
+	},
+	"Y": {
+		"viewName": "Y Button",
+		"triggerKeybind": "Y"
+	},
+	"L": {
+		"viewName": "L Button",
+		"triggerKeybind": "T"
+	},
+	"R": {
+		"viewName": "R Button",
+		"triggerKeybind": "R"
+	},
+	"ZL": {
+		"viewName": "ZL Trigger",
+		"triggerKeybind": "O"
+	},
+	"ZR": {
+		"viewName": "ZR Trigger",
+		"triggerKeybind": "P"
+	},
+	"SL": {
+		"viewName": "SL Trigger",
+		"triggerKeybind": "Q"
+	},
+	"SR": {
+		"viewName": "SR Trigger",
+		"triggerKeybind": "E"
+	},
+	"DUP": {
+		"viewName": "Up on Dpad",
+		"triggerKeybind": "I"
+	},
+	"DDOWN": {
+		"viewName": "Down on Dpad",
+		"triggerKeybind": "K"
+	},
+	"DLEFT": {
+		"viewName": "Left on Dpad",
+		"triggerKeybind": "J"
+	},
+	"DRIGHT": {
+		"viewName": "Right on Dpad",
+		"triggerKeybind": "L"
+	},
+	"PLUS": {
+		"viewName": "Plus Button",
+		"triggerKeybind": "="
+	},
+	"MINUS": {
+		"viewName": "Minus Button",
+		"triggerKeybind": "-"
+	},
+	"HOME": {
+		"viewName": "Home Button",
+		"triggerKeybind": "H"
+	},
+	"CAPT": {
+		"viewName": "Capture Button",
+		"triggerKeybind": "G"
+	},
+	"LS": {
+		"viewName": "Left Stick Press",
+		"triggerKeybind": "N"
+	},
+	"RS": {
+		"viewName": "Right Stick Press",
+		"triggerKeybind": "U"
+	}
+}
+```
+To change these values, refer to the corresponding entry in `mainSettings.json`. Each character need to be typed with it's lowercase equivalent to register. As of now, gamepad support is restricted to a wired pro controller on Windows 10. No drivers are needed. Select the gamepad in `File/List Joysticks` and you're good to go. Note, joystick inputs are not registered until you press the lock button underneath either the right or left joysticks.
+
+<div align=”center”><img src="screenshots/buttonandjoysticks.png"></div>
+
+NX TAS UI also has a video view, in order to use a video from youtube/twitter/twitch/etc to compare against your TAS. All that is needed is YouTube DL, which can be installed with a simple `sudo -H pip install --upgrade youtube-dl`. To use, simply enter the URL of your video and press enter. A few seconds later, select your format and wait for it to download. Now, when selecting frames in the *Piano Roll*, the viewer will automatically adjust the selected frame of the video. The video is saved to your filesystem so you can easily load the video again later. To use this feature, press `File/List Recent Comparison Videos`.
+
+<div align=”center”><img src="screenshots/videocomparisonviewerwithlist.png"></div>
+<div align=”center”><img src="screenshots/videocomparisonviewer.png"></div>
 
 ## Thanks
 - [Hamhub7](https://github.com/hamhub7): The creator of Nx-TAS
 - [MonsterDruide1](https://github.com/MonsterDruide1): Providing many valuable insights into the behavior of hardware-based TAS setups
 - [AtlasNX](https://twitter.com/atlasnx?lang=en): For their help during development
-- 黯然的饭#8969 on discord: Providing the ever-elusive answer to the problem of obtaining the framebuffer
+- Members of the wxWidgets forums: For being incredibly useful for every question
+- [Shakkar23](https://github.com/shakkar23): For being a chad, obviously

pc_application/buildRelease.sh

@@ -6,7 +6,8 @@ rm nxtaspc.zip
 mkdir release/bin
 cp bin/* release/bin
 cp mainSettings.json release
-cp -r share release/share
+# https://unix.stackexchange.com/a/314823
+find share -name '*.png' -o -name '*.jpg' | xargs cp --parents -t release
 
 strip -s release/bin/nxtas.exe
 

pc_application/source/ui/bottomUI.hpp

@@ -175,7 +175,7 @@ class BottomUI {
 	BottomUI(wxFrame* parentFrame, rapidjson::Document* settings, std::shared_ptr<ButtonData> buttons, wxBoxSizer* theGrid, DataProcessing* input);
 
 	void addJoystickMenu(wxMenu* parent) {
-		parent->AppendSubMenu(joystickSubMenu, "&List Joysticks");
+		parent->AppendSubMenu(joystickSubMenu, "&List Joysticks\tCtrl+G");
 	}
 
 	// Just a random large number, apparently can't be larger than 76