Update for release v1.9.1

CMakeLists.txt

@@ -38,7 +38,7 @@ tri_option(CHIAKI_USE_SYSTEM_CURL "Use system-provided curl instead of submodule
 
 set(CHIAKI_VERSION_MAJOR 1)
 set(CHIAKI_VERSION_MINOR 9)
-set(CHIAKI_VERSION_PATCH 0)
+set(CHIAKI_VERSION_PATCH 1)
 set(CHIAKI_VERSION ${CHIAKI_VERSION_MAJOR}.${CHIAKI_VERSION_MINOR}.${CHIAKI_VERSION_PATCH})
 
 set(CPACK_PACKAGE_NAME "chiaki-ng")

docs/diy/buildit.md

@@ -91,7 +91,7 @@
 1. Install the necessary [flatpak runtime](https://docs.flatpak.org/en/latest/basic-concepts.html#runtimes){target="_blank" rel="noopener"}, associated [sdk](https://docs.flatpak.org/en/latest/building-introduction.html#software-development-kits-sdks){target="_blank" rel="noopener"}, and base app.
 
     ```bash
-    flatpak install -y flathub org.kde.Platform//6.7 flathub org.kde.Sdk//6.7
+    flatpak install -y flathub org.kde.Platform//6.8 flathub org.kde.Sdk//6.8
     ```
 
 2. Create a directory for your build files and switch into it
@@ -114,19 +114,7 @@
         curl -LO https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/0001-Vulkan-Don-t-try-to-reuse-old-swapchain.patch
         ```
 
-    2. 0001-lavc-vaapi_h264-Fixup-invalid-references.patch
-
-        ```
-        curl -LO https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/0001-lavc-vaapi_h264-Fixup-invalid-references.patch
-        ```
-
-    3. 0001-lavc-vaapi_hevc-Fixup-invalid-references.patch
-
-        ```
-        curl -LO https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/0001-lavc-vaapi_hevc-Fixup-invalid-references.patch
-        ```
-
-    4. 0001-vulkan-ignore-frames-without-hw-context.patch
+    2. 0001-vulkan-ignore-frames-without-hw-context.patch
 
         ```
         curl -LO https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/0001-vulkan-ignore-frames-without-hw-context.patch

docs/diy/steamdeckdev.md

@@ -8,10 +8,10 @@ This is for contributors that want to make/test updates to the codebase without
 
 ## Setup Environment
 
-1. Install flatpak and/or build a new one with any added dependencies following [Building the Flatpak Yourself](buildit.md){target="_blank" rel="noopener"}
+1. Install flatpak with debug extension and/or build a new one with any added dependencies following [Building the Flatpak Yourself](buildit.md){target="_blank" rel="noopener"}
 
     ``` bash
-    flatpak install --user -y https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref
+    flatpak install --include-debug -y https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref
     ```
 
     !!! Info "Creating local flatpak builds"
@@ -42,22 +42,16 @@ This is for contributors that want to make/test updates to the codebase without
 3. Install the SDK
 
     ``` bash
-    flatpak install org.kde.Sdk//6.7
+    flatpak install org.kde.Sdk//6.8
     ```
 
 4. Install the `Debug` extensions for the SDK
 
     ``` bash
-    flatpak install org.kde.Sdk.Debug//6.7
+    flatpak install org.kde.Sdk.Debug//6.8
     ```
 
-5. Install the `Debug` extension for the application build for debugging
-
-    ``` bash
-    flatpak install io.github.streetpea.Chiaki4deck.Debug
-    ```
-
-6. Clone the project onto your Steam Deck with:
+5. Clone the project onto your Steam Deck with:
 
     === "HTTPS"
 

docs/setup/controlling.md

@@ -319,3 +319,75 @@ In order to enable DualSense haptics on MacOS please do the following:
     ![Select Quadrophonic audio](images/configure_quadrophonic.png)
 
 7. Play your favorite PS5 game with haptic feedback on Mac via `chiaki-ng`!
+
+## Using a non-PlayStation controller with chiaki-ng
+
+### Controller Mapping
+
+#### Change Controller Mapping
+
+You can re-map all necessary PlayStation buttons to your controller using the controller mapper built-in to `chiaki-ng`
+
+1. Go to Settings->Controllers and select `Change Controller Mapping`
+
+    ![Change Controller Mapping](images/ChangeControllerMapping.png)
+
+2. Click on any button on the controller you want to change the mapping for
+
+3. Change the buttons as you see fit on the controller mapping page (i.e., change touchpad to Share button on the Xbox Series X Controller)
+
+    ![Controller Mapping Changes](images/ControllerMappingMenu.png)
+
+4. Update Controller Mapping using the `Options` button on the controller
+
+#### Reset Controller Mapping
+
+You can reset a controller mapping for a controller back to default at any time
+
+1. Go to Settings->Controllers and select `Reset Controller Mapping`
+
+2. Click on any button on the controller you want to reset the mapping for
+
+### Dpad Touch Emulation
+
+Non-PlayStation controllers such as Xbox and Nintendo controllers don't have a touchpad. To use touchpad functionality in games, chiaki-ng provides dpad touch emulation. It is enabled by default in Settings->Controllers and can be disabled at any time. The `Dpad Touch Increment` controls how far away the next touch on the dpad will be when holding down a direction on the dpad. Changing this will make you "move across the touchpad" (in the currently pressed dpad direction) farther or nearer to your current position
+
+![Dpad Touch Emulation](images/DpadTouchEmulation.png)
+
+!!! Question "How does Dpad Touch Emulation work"
+
+    Pushing one of the dpad buttons will register a touch in the quadrant of that button:
+
+    - Dpad Left: All the way to the left and halfway up the touchpad
+
+    - Dpad Right: All the way to the right and halfway up the touchpad
+
+    - Dpad Up: In the middle of the touchpad horizontally and at the top of the touchpad
+
+    - Dpad Down: In the middle of the touchpad horizontally and at the bottom of the touchpad
+
+    How to perform some common touchpad functions with the dpad:
+
+    - For a touchpad left click:
+
+        You want to press the touchpad click button you have mapped for your controller (such as the Share key) and dpad left
+
+    - For a touchpad right click:
+
+        You want to press the touchpad click button you have mapped for your controller (such as the Share key) and dpad right
+
+    - For a swipe from left to right:
+
+        First touch dpad left and then hold dpad right for a second or so. This will start you at the left side of the touchpad and move you across the touchpad in the right direction.
+
+    - For a swipe from right to left:
+
+        First touch dpad right and then hold dpad left for a second or so. This will start you at the right side of the touchpad and move you across the touchpad in the left direction.
+
+    - For a swipe from up to down:
+
+        First touch dpad up and then hold dpad down for a second or so. This will start you at the top of the touchpad and move you across the touchpad in the down direction.
+
+    - For a swipe from down to up:
+
+        First touch dpad down and then hold dpad up for a second or so. This will start you at the bottom of the touchpad and move you across the touchpad in the up direction.

docs/setup/installation.md

@@ -1,33 +1,45 @@
 # Installing `chiaki-ng`
 
-!!! Tip "Copying from and Pasting into Konsole Windows"
+=== "Linux Flatpak"
 
-    You can copy from and paste into `konsole` windows with ++ctrl+shift+c++ (copy) and ++ctrl+shift+v++ (paste) instead of the normal ++ctrl+c++ (copy) and ++ctrl+v++ (paste) shortcuts. In fact, ++ctrl+c++ is a shortcut to terminate the current process in the `konsole`. Additionally, you can still right-click and select copy or paste as per normal.
+    !!! Tip "Copying from and Pasting into Konsole Windows"
 
-=== "Using the Discover Store (Recommended)"
+        You can copy from and paste into `konsole` windows with ++ctrl+shift+c++ (copy) and ++ctrl+shift+v++ (paste) instead of the normal ++ctrl+c++ (copy) and ++ctrl+v++ (paste) shortcuts. In fact, ++ctrl+c++ is a shortcut to terminate the current process in the `konsole`. Additionally, you can still right-click and select copy or paste as per normal.
 
-    1. Open the Discover store
+    === "Using the Discover Store (Recommended)"
 
-        ![Open Discover](images/OpenDiscover.png)
+        1. Open the Discover store
 
-    2. Search for `chiaki-ng` in the search bar
+            ![Open Discover](images/OpenDiscover.png)
 
-        ![Install chiaki-ng](images/InstallChiaki4deck.png)
+        2. Search for `chiaki-ng` in the search bar
 
-    3. Click Install
+            ![Install chiaki-ng](images/InstallChiaking.png)
 
-=== "Using the `konsole` (If for some reason it doesn't show up on the Discover store)"
+        3. Click Install
 
-    1. Run the following command in the `konsole`
+    === "Using the `konsole` (If for some reason it doesn't show up on the Discover store)"
 
-        ```
-        flatpak install -y io.github.streetpea.Chiaki4deck
-        ```
+        1. Run the following command in the `konsole`
+
+            ```
+            flatpak install -y io.github.streetpea.Chiaki4deck
+            ```
+
+    !!! Note "About `chiaki-ng`"
 
-!!! Note "About `chiaki-ng`"
+        The above instructions are for the official `chiaki-ng` flatpak on Flathub.
+        
+        However, you can also build the flatpak yourself (recommended for users who want to add their own source code changes on top of the ones I've made) by following the instructions in [Building the flatpak yourself](../diy/buildit.md){target="_blank" rel="noopener"}.
 
-    This is a flatpak I created for `chiaki-ng` from [updated](../updates/done.md){target="_blank" rel="noopener"} Chiaki source code is available on Flathub. This is the recommended install as it is the most straightforward.
-
-    However, you can also build the flatpak yourself (recommended for users who want to add their own source code changes on top of the ones I've made) by following the instructions in [Building the flatpak yourself](../diy/buildit.md){target="_blank" rel="noopener"}.
+=== "MacOS via Brew"
+
+    1. Install with the following command in the terminal
+
+        ```
+        brew install --cask streetpea/streetpea/chiaki-ng
+        ```
 
+=== "MacOS/Windows/Linux Appimage Package"
 
+    1. Download the appopriate package from the [releases page](https://github.com/streetpea/chiaki-ng/releases){target="_blank" rel="noopener"} on GitHub (for Mac there are separate packages for the Intel (`-amd64`) and Apple (`-arm64`) based Macs)

docs/setup/remoteconnection.md

@@ -31,11 +31,11 @@ The remote connection via PSN uses PSN servers as an initial go-between to excha
 
     ![Go to Settings](images/GoToSettings.png)
 
-2. Go to the PSN tab and then click `Login to PSN`
+2. Go to the `Config` tab and then click `Login to PSN`
 
     ![PSN credentials](images/ClickLoginToPsn.png)
 
-3. Login to psn on the provided page
+3. Login to psn on the provided page if one appears. Otherwise, paste your clipboard contents in a web browser and bang enter to bring up the login to psn page.
 
     ???- Tip "Tips for those having trouble logging into to PSN"
 
@@ -98,7 +98,7 @@ Forward the ports for your console on your router following [this port forwardin
 
     | Port | Connection Type |
     | ---- | --------------- |
-    | 9295 | TCP             |
+    | 9295 | UDP/TCP         |
     | 9296 | UDP             |
     | 9297 | UDP             |
     | 9302 | UDP             |
@@ -108,7 +108,7 @@ Forward the ports for your console on your router following [this port forwardin
     | Port | Connection Type |
     | ---- | --------------- |
     | 987  | UDP             |
-    | 9295 | TCP             |
+    | 9295 | UDP/TCP         |
     | 9296 | UDP             |
     | 9297 | UDP             |
 

docs/updates/releases.md

@@ -41,26 +41,64 @@ To migrate to the flathub repo do the following:
 
 In order to update your already installed `chiaki-ng` to the newest version, either:
 
-- Check for updates in `Discover` and update there
+=== "Linux Flatpak"
 
-    **OR**
+    - Check for updates in `Discover` and update there
 
-- Update via the `konsole` with:
+        **OR**
 
-    === "chiaki-ng Installed Via Discover Store"
+    - Update via the `konsole` with:
 
-        ``` bash
-        flatpak update -y io.github.streetpea.Chiaki4deck
-        ```
+        === "chiaki-ng Installed Via Discover Store"
+
+            ``` bash
+            flatpak update -y io.github.streetpea.Chiaki4deck
+            ```
+
+        === "chiaki-ng Legacy Install Via Konsole"
+
+            ``` bash
+            flatpak update --user -y re.chiaki.Chiaki4deck
+            ```
 
-    === "chiaki-ng Legacy Install Via Konsole"
+=== "MacOS Brew"
+
+    - Update via the terminal with:
 
         ``` bash
-        flatpak update --user -y re.chiaki.Chiaki4deck
+        brew install --cask streetpea/streetpea/chiaki-ng
         ```
 
+=== "Windows/MacOS/Linux Appimage"
+
+     Download the appopriate package from the [releases page](https://github.com/streetpea/chiaki-ng/releases){target="_blank" rel="noopener"} on GitHub (for Mac there are separate packages for the Intel (`-amd64`) and Apple (`-arm64`) based Macs)
+
 ## Releases (Newest First)
 
+### 1.9.1
+
+Small patch update:
+
+- Adds dpad touch emulation to use the dpad for touchscreen touches and swipes [see dpad touch emulation](../setup/controlling.md#dpad-touch-emulation){target="_blank" rel="noopener"}
+- Add --exit-app-on-stream-exit option to exit `chiaki-ng` immediately after closing a streaming session
+- Fix registration issues related to broadcast settings by automatically detecting when broadcast should be used
+- Reset motion controls when necessary to prevent jumping to position when using motion controls to aim in games that activate motion controls via a trigger press such as Resident Evil 4 Remake
+- Fix bug where upnp discovery could take too long, causing the remote connection via PSN to fail
+- Notify users of the possibility of remote connection via PSN as many users aren't aware of this option still
+- Add mapping for Share button on Xbox Series and Xbox One Controllers
+- Display current profile name with colon after application name as Application Display Name
+- Update controller mappings to be portable across all platforms (Linux, Mac/OS, and Windows)
+- Add controller name for controller mapping for controllers that don't have a name configured in the mapping itself
+- Allow entering controller mapping and reset mapping using the back button
+- Make log dialogs, registered consoles, and hidden consoles scrollable with a controller
+- Increase STUN timeouts to 5 seconds + add timeouts for curl of 10 seconds
+- Make key mapping dialog navigable with controller
+- Disable zero-copy for hw cards that don't support it
+- Increase wait time for DualSense haptics of DualSense edge to come online to 15 seconds
+- Add homebrew cask for `chiaki-ng` for MacOS
+- Fix an error causing a crash when random stun allocation was used for remote connection via PSN
+- Fix a memory leak in remote connection via PSN
+
 ### 1.9.0
 
 Brings ability to set controller mappings for chiaki-ng