Skip to content

Commit

Permalink
Update docs for some chiaki-ng links and images
Browse files Browse the repository at this point in the history
  • Loading branch information
streetpea committed Jul 29, 2024
1 parent 20aa533 commit cb979c5
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 18 deletions.
Binary file modified docs/setup/images/FinishedBackgroundLogo.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/setup/images/FinishedChiaki4DeckProperties.png
Binary file not shown.
Binary file added docs/setup/images/Finishedchiaki-ngProperties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/setup/steaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@

!!! Tip "If You're missing `Chiaki-launcher.sh`, You Skipped the Automation Section"

`Chiaki-launcher.sh` is a script to launch Chiaki without the main gui, resulting in a much better experience on the Steam Deck ([click for details](../updates/done.md#enabled-automated-launch){target="_blank" rel="noopener"}) and makes it [easier to use the 3 games modes](../updates/done.md#3-view-modes-for-non-standard-screen-sizes){target="_blank" rel="noopener"}. If `Chiaki-launcher.sh` is missing, you almost certainly skipped the automation section. Don't worry, the fix is easy! :relaxed: Please complete the [Automation section](automation.md){target="_blank" rel="noopener"} now and come back here afterward. It should take you ~ 5 minutes. Luckily, :four_leaf_clover: there is a helper script that does most of the work for you! You simply answer a few questions I walk you through.
`Chiaki-launcher.sh` is a script to launch Chiaki without the main gui, resulting in a much better experience on the Steam Deck ([click for details](../updates/done.md#enabled-automated-launch-and-auto-connect){target="_blank" rel="noopener"}) and makes it [easier to use the 3 games modes](../updates/done.md#3-view-modes-for-non-standard-screen-sizes){target="_blank" rel="noopener"}. If `Chiaki-launcher.sh` is missing, you almost certainly skipped the automation section. Don't worry, the fix is easy! :relaxed: Please complete the [Automation section](automation.md){target="_blank" rel="noopener"} now and come back here afterward. It should take you ~ 5 minutes. Luckily, :four_leaf_clover: there is a helper script that does most of the work for you! You simply answer a few questions I walk you through.

1. Choose `File type: All Files` at the bottom of the screen

Expand Down Expand Up @@ -92,7 +92,7 @@

1. Acquire pictures to use for the game library in Steam

1. Get the images I used [here](https://raw.githubusercontent.com/streetpea/chiaki4deck/main/assets/chiaki-ngImages.tar.xz){target="_blank" rel="noopener"} for `chiaki-ng` on my Steam Deck.
1. Get the official `chiaki-ng` images [here](https://raw.githubusercontent.com/streetpea/chiaki4deck/main/assets/chiaki-ngImages.tar.xz){target="_blank" rel="noopener"}.

2. Extract the package to a folder of your choice (such as your `Documents` folder).
Expand Down Expand Up @@ -122,7 +122,7 @@

???+ example "Finished chiaki-ng Properties"

![Finished chiaki-ng Properties](images/FinishedChiaki4DeckProperties.png)
![Finished chiaki-ng Properties](images/Finishedchiaki-ngProperties.png)

5. Go to your `Library` in Steam and select `chiaki-ng` from the left-hand list or one of the `Library` categories to go to `chiaki-ng`'s game page.

Expand Down
26 changes: 11 additions & 15 deletions docs/updates/done.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

## Remote Connection Via PSN

Enabled remote connection via PSN so users can use this instead of port forwarding on their routers as an option.
Enabled remote connection via PSN so users can use this instead of port forwarding on their routers as an option.[^1]

## Touch Friendly and Controller Navigable GUI

QML based user interface that is better suited for handheld computers such as the Steam Deck and more user-friendly in general.
QML based user interface that is better suited for handheld computers such as the Steam Deck and more user-friendly in general.[^1]

## HDR for Steam Deck OLED in game mode

You can now use [HDR with your Steam Deck OLED](../setup/configuration.md#hdr-high-dynamic-range) thanks to [Johannes Baiter](https://github.com/jbaiter){target="_blank" rel="noopener"} and [David Rosca](https://github.com/nowrep){target="_blank" rel="noopener"} as well as many patient testers. In order to enable this, you must have:
You can now use [HDR with your Steam Deck OLED](../setup/configuration.md#hdr-high-dynamic-range) thanks to [Johannes Baiter](https://github.com/jbaiter){target="_blank" rel="noopener"} and [David Rosca](https://github.com/nowrep){target="_blank" rel="noopener"} as well as many patient testers. In order to enable this, you must have:[^1]

1. An HDR-capable streaming device such as the Steam Deck OLED or an OLED monitor attached to an LCD Steam Deck(non-HDR device will still work but use [tonemapping](https://mixinglight.com/color-grading-tutorials/whats-tone-mapping/){target="_blank" rel="noopener"} instead of outputting HDR)

Expand All @@ -21,31 +21,31 @@ You can now use [HDR with your Steam Deck OLED](../setup/configuration.md#hdr-hi

## Enabled Touchpad for Steam Deck Touchscreen and/or Trackpads

Added Touchpad support for touchscreens (use outer edges of touchscreen for touchpad click) as well as mouse input (enables trackpads to be fully supported with gestures on touch and touchpad click on click). For an example mapping these in a Steam Deck controller profile, see [Default `chiaki4deck` Layout Touchscreen Mapping](../setup/controlling.md#default-chiaki4deck-layout-touchscreen-mapping){target="_blank" rel="noopener"} and [Default `chiaki4deck` Layout Trackpad Mapping](../setup/controlling.md#default-chiaki4deck-layout-trackpad-mapping){target="_blank" rel="noopener"} respectively. Downloading the updated `chiaki4deck+` controller layout will have these mappings set for your convenience.
Added Touchpad support for touchscreens (use outer edges of touchscreen for touchpad click) as well as mouse input (enables trackpads to be fully supported with gestures on touch and touchpad click on click). For an example mapping these in a Steam Deck controller profile, see [Default `chiaki4deck` Layout Touchscreen Mapping](../setup/controlling.md#default-chiaki-ng-layout-touchscreen-mapping){target="_blank" rel="noopener"} and [Default `chiaki4deck` Layout Trackpad Mapping](../setup/controlling.md#default-chiaki-ng-layout-trackpad-mapping){target="_blank" rel="noopener"} respectively. Downloading the updated `chiaki4deck+` controller layout will have these mappings set for your convenience.[^1]

## Enabled Gyro for Steam Deck

Added gyro support for Steam Deck via a native interface since SDL2 doesn't support Steam Deck gyro due to Steam's virtual gamepads not providing gyro.
Added gyro support for Steam Deck via a native interface since SDL2 doesn't support Steam Deck gyro due to Steam's virtual gamepads not providing gyro.[^1]

## Enabled Mic Support

You can now attach a microphone and use it to chat online or use in games. There is also noise suppression and echo cancelling for the mic you can configure in the chiaki4deck settings.
You can now attach a microphone and use it to chat online or use in games. There is also noise suppression and echo cancelling for the mic you can configure in the chiaki4deck settings.[^1]

## Added Steam Shortcut Creation Button

Added ability to create a Steam shortcut with the name of your choice and Chiaki4deck artwork and the Steam Deck controller profile from the main menu. This makes setup even easier on Steam Deck.
Added ability to create a Steam shortcut with the name of your choice and Chiaki4deck artwork and the Steam Deck controller profile from the main menu. This makes setup even easier on Steam Deck.[^1]

## Enabled Haptics for Steam Deck and DualSense controller + adaptive Triggers for DualSense

Haptics enabled for PlayStation 5 thanks to [Johannes Baiter](https://github.com/jbaiter){target="_blank" rel="noopener"}. You can use a USB connected DualSense for haptics and adaptive triggers or a bluetooth connected DualSense for just adaptive triggers. To use these features for the DualSense in game mode, please disable Steam Input for the DualSense controller following the "Turning off Steam Input" tab in [this section](../setup/controlling.md#enabling-chiaki4deck-to-work-with-dualsense-dualshock-4){target="_blank" rel="noopener"}.[^2].
Haptics enabled for PlayStation 5 thanks to [Johannes Baiter](https://github.com/jbaiter){target="_blank" rel="noopener"}. You can use a USB connected DualSense for haptics and adaptive triggers or a bluetooth connected DualSense for just adaptive triggers. To use these features for the DualSense in game mode, please disable Steam Input for the DualSense controller following the "Turning off Steam Input" tab in [this section](../setup/controlling.md#enabling-chiaki-ng-to-work-with-dualsense-dualshock-4){target="_blank" rel="noopener"}.[^2].

I have also added the capability to play the haptics via the Steam Deck controller using the native interface I added.

You can also use rumble haptics for controllers without integrated haptics or the Steam Deck if the noise of its haptics bothers you.

## Updated RGB Mapping

RGB mapping update thanks to [Egoistically](https://github.com/Egoistically){target="_blank" rel="noopener"} via a [Chiaki fork](https://github.com/Egoistically/chiaki){target="_blank" rel="noopener"} which is of course copy-left under the [GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html){target="_blank" rel="noopener"} as are all of the other `chiaki4deck` changes. I added the patches to `chiaki4deck` and it results in a more accurate picture. Joni Bimbashi updated the initial mapping to work with HW acceleration. Below is a **BEFORE** and **AFTER** from Ghost of Tsushima.
RGB mapping update thanks to [Egoistically](https://github.com/Egoistically){target="_blank" rel="noopener"} via a [Chiaki fork](https://github.com/Egoistically/chiaki){target="_blank" rel="noopener"} which is of course copy-left under the [GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html){target="_blank" rel="noopener"} as are all of the other `chiaki4deck` changes. I added the patches to `chiaki4deck` and it results in a more accurate picture. Joni Bimbashi updated the initial mapping to work with HW acceleration. Below is a **BEFORE** and **AFTER** from Ghost of Tsushima.[^1]

!!! example "BEFORE"

Expand All @@ -59,10 +59,6 @@ RGB mapping update thanks to [Egoistically](https://github.com/Egoistically){tar

It's great to have these options for Steam Deck's non-standard 1280x800 resolution.[^3]

???- Info "Using These Options Without the Automation [Not Recommended] (click me to open)"

If for some strange reason you want to launch `chiaki4deck` via the GUI instead of the automation (not recommended due to the items noted [here](#enabled-automated-launch)), it launches by default in a window matching the aspect ratio of the stream (i.e., 16:9). This means that the stream output exactly matches the stream window. In this scenario, there is nothing to stretch or zoom the stream output to because the stream output already perfectly matches with the stream window. If you want to stretch or zoom, you would need to first either:

1. Adjust the window to a bigger or smaller size with your mouse in `Desktop Mode` (perhaps you want to use `chiaki4deck` as half of your screen in Desktop mode)

**OR**
Expand Down Expand Up @@ -111,11 +107,11 @@ Cleanly quits Chiaki, respecting the user's configuration option of either askin

## Enabled Automated Launch and Auto-connect

This skips the need to visit the configuration screen each time. Use auto-connect if you have one console to choose from and this will work out of the box. Otherwise, you can create an automation script to do this for you. I have added a helper script to generate a `Chiaki-launcher.sh` script as well as provided complete instructions in the [Automation section](../setup/automation.md){target="_blank" rel="noopener"}.
This skips the need to visit the configuration screen each time. Use auto-connect if you have one console to choose from and this will work out of the box. Otherwise, you can create an automation script to do this for you. I have added a helper script to generate a `Chiaki-launcher.sh` script as well as provided complete instructions in the [Automation section](../setup/automation.md){target="_blank" rel="noopener"}.[^1]

## Enabled Touchpad and Gyro Controls with DualSense/DualShock 4 Controller for Flatpak

This makes it as easy as possible for Steam Deck users to use touchpad and gyro support with their DualSense or DualShock 4 controller. See [Using a DualSense and/or DualShock4 Controller with `chiaki4deck`](../setup/controlling.md#using-a-dualsense-andor-dualshock4-controller-with-chiaki4deck){target="_blank" rel="noopener"} to set it up for yourself.[^3]
This makes it as easy as possible for Steam Deck users to use touchpad and gyro support with their DualSense or DualShock 4 controller. See [Using a DualSense and/or DualShock4 Controller with `chiaki-ng`](../setup/controlling.md#using-a-dualsense-andor-dualshock4-controller-with-chiaki-ng){target="_blank" rel="noopener"} to set it up for yourself.[^3]
The DualSense/DualShock 4 touchpad and gyro controls work with the binary version of Chiaki but don't work with the official flatpak version. Luckily for you, they now work with the `chiaki4deck` flatpak! :smile:

[^1]: merged upstream, but not yet released in official flatpak
Expand Down

0 comments on commit cb979c5

Please sign in to comment.