chiaki-ng
Releases¶
Moving to FlatHub¶
Legacy Repo Deprecation
chiaki-ng
is now on flathub. If you previously installed chiaki-ng
via the konsole the flatpak has changed to io.github.streetpea.chiaki-ng
. The old repo is now deprecated in favor of using Flathub since Flathub is added by default to the Steam Deck and the hosting is at no cost to the project (unlike the initial repo). While the software will still be accessible from the old repo, it is encouraged for users to switch over.
To migrate to the flathub repo do the following:
-
Move chiaki-ng's configuration files to their new location
mv ~/.var/app/re.chiaki.Chiaki4deck ~/.var/app/io.github.streetpea.Chiaki4deck
-
Update automatic launcher script to use
io.github.streetpea.Chiaki4deck
sed -i 's/re.chiaki.Chiaki4deck/io.github.streetpea.Chiaki4deck/g' ~/.var/app/io.github.streetpea.Chiaki4deck/config/Chiaki/Chiaki-launcher.sh
-
Uninstall the existing legacy
chiaki-ng
flatpakflatpak uninstall -y re.chiaki.Chiaki4deck
-
Install chiaki-ng from flathub using Discover store app or
flatpak install -y --user flathub io.github.streetpea.Chiaki4deck
-
Change properties of non-steam game to point to:
/home/deck/.var/app/io.github.streetpea.Chiaki4deck/config/Chiaki/Chiaki-launcher.sh
Updating chiaki-ng
¶
In order to update your already installed chiaki-ng
to the newest version, either:
-
Check for updates in
Discover
and update thereOR
-
Update via the
konsole
with:flatpak update -y io.github.streetpea.Chiaki4deck
flatpak update --user -y re.chiaki.Chiaki4deck
-
Update via the terminal with:
brew install --cask streetpea/streetpea/chiaki-ng
Download the appropriate package from the releases page on GitHub (for Mac there are separate packages for the Intel (-amd64
) and Apple (-arm64
) based Macs)
Releases (Newest First)¶
1.9.3¶
Small patch update:
- add Linux arm64 appimage
- fix bug that can cause chiaki-ng to fail to start after new PlayStation firmware update if user has a login pin and in some other edge cases
1.9.2¶
Small patch update:
- HDR support for MacOS and Windows
- Add Windows installer
- Increase stability of motion controls
- Add native webview for obtaining PSN tokens, making it possible to obtain the token easily in Steam OS game mode
- Add ability to set custom window resolution
- Fix import/export dialogs to work with appimage and Steam OS game mode
- enable switching between dpad mode and dpad touch emulation mode with any chosen combo up to 4 keys set in settings
- expand motion control reset to work with more games beyond the Resident Evil 4 demo
- Fix issue where session wouldn't close if canceled after waking the console but before connecting
- Fix issue where session may fail to connect if it receives invalid frames initially
- Show settings maximized at start instead of 720p
1.9.1¶
Small patch update:
- Adds dpad touch emulation to use the dpad for touchscreen touches and swipes see dpad touch emulation
- 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
-
adds Controllers section to chiaki-ng settings which allows you to configure the mapping for your controller (especially nice for mapping Xbox and Switch controllers to PlayStation inputs)
Controllers mapped via Steam
Controllers mapped via Steam should be mapped directly in the Steam UI gamepad configurator as opposed to this menu. If you try to map a controller that is mapped via Steam in this menu it will give you a notification that it should be mapped via Steam.
-
adds Custom renderer option which allows you to configure your renderer options very granularly with the options at https://libplacebo.org/options/
- add defaults to all settings so users are aware of the defaults/which settings they've changed
- add different haptic rumble intensity settings for users to configure if the default is not to their liking
- for manual connection show 1 pane with all relevant information instead of 2 panes when console is discovered + allow user to choose between registered consoles (regardless of whether or not they are currently discovered) + make PS5 default console type
- disable double click by default and allow re-enabling via the Video section of the Settings
- fix crash when user has more than 1 PS5 registered with PSN
- fix crash that could happen when a user uses the wake from sleep feature
- fix corrupt stream that could occur after several hours of streaming
- fix launching from a path with non-ascii characters on Windows
- fix decimal points turning into scientific notation numbers in QSliders
- properly terminate ipv6 discovery service
- ping all network interfaces on Linux and MacOS allowing discovery of previously undiscoverable consoles
1.8.1¶
Small patch update
- enable haptic feedback for DualSense on MacOS (see enabling haptic feedback for DualSense on MacOS)
- fix issue where sleeping your client device on Linux would cause chiaki-ng to crash
- give user link to use in a browser when using psn login in game mode on Steam Deck
- creating Steam shortcut improvements (i.e., add a timestamp to the backup file so multiple can be saved and not allowing creating another shortcut while currently creating one)
- scale the official Steam icons for chiaki-ng used in the create a Steam shortcut button to the appropriate sizes to fix pause will scrolling through Steam menu with chiaki-ng added as a non-steam game in Steam big-picture mode
- changes MacOS icons to give them the "MacOS" style (i.e., rounded edges, etc.)
1.8.0¶
Name change to chiaki-ng
- changes name and artwork for chiaki-ng
- changes current profile when using --profile option
1.7.4¶
Small patch update
- adds notification when psn creds expire
- use ipv4 for hostnames as ps5/4 don't support using IPv6 for remote play
- allow entering pin using enter key as alternative to selecting ok
1.7.3¶
Adds ability to create/delete and switch between different profiles (i.e., different users)
- Switch, create and delete profiles via Settings (Gear icon)->Config->Manage Profiles. You can also make a shortcut launching from a specific profile with the --profile=profile_name option where profile_name is the given profile's name
- Fix issue where discovery doesn't work in certain setups on Windows
- Fix issue where autoconnect doesn't work with manually added connection on Windows
1.7.2¶
Provides unique remote and local Stream Settings for each console (PS4/PS5)
- Separate Local and Remote and PS4/PS5 settings so you can set appropriate settings for each type of connection
- Enable more network types to work with remote connection via PSN (Note: some can only be made to work a % of the time due to limitations with remote play imposed by Sony)
- Export/import option for settings to transfer across devices/platforms
- Adds
auto
hw decoder option which is now the default. It chooses the best decoder for your platform from the available decoders - Make chiaki-ng ipv6 compatible (ipv6 not yet supported by remote play on the console [i.e., in Sony's PlayStation firmware] so can't be used yet)
1.7.1¶
Improves + adds PS4 support to remote connection via PSN
- remote connection via PSN now supports PS4 consoles
- remote connection via PSN now supports more network types
1.7.0¶
Enables remote connection via PSN
- Remote connection via PSN now available without the need for port forwarding (see remote connection docs for more details) on how to setup and use.
- Allow zooming out from resolution for users targeting a resolution beyond their screen resolution (i.e., 1080p on Steam Deck)
- Enable don't fragment for MacOS Big Sur and later for more accurate MTU readings during Senkusha
- Create a fallback session id when session id isn't received instead of erroring out
- Workaround patch for vulkan ffmpeg hw decoder bug affecting Nvidia 30 series graphics card users
- Add additional option for obtaining the PSN AccountId via logging in with your psn username and password (in addition to the public lookup)
1.6.6¶
Lowers required mtu from 1435 to 576
- Enable using mtu as low as 576
- Enable gyro on Steam Deck automatically (can now set gyro to none in Steam Settings and still use native gyro)
- Adjust haptic rumble to work better with rumble motors
- Add variable zoom (accessible via Stream Menu)
- Enable mic support on MacOS (now on all platforms)
- Fix issues with address when registering manual consoles
- Update steam shortcut creation to cover additional edge cases
- Add option to reset key mappings to default in Settings
- Add Steam shortcut option to Windows build
1.6.5¶
Graduate DualSense features from experimental status
- Provides quiet haptic rumble for Steam Deck (default) in addition to optional noisy haptics
- Adds haptic rumble for MacOS
- Allow escape key to be selected for key mappings in Settings
- Add option to start the stream with the mic unmuted
- Add Steam Shortcut now also available on Windows
1.6.4¶
Enables creating steam shortcut with default controller profile from menu
- Adds create Steam Shortcut option for Linux and Mac
- Allow setting console pin for console in settings
- Add window type option in settings (fullscreen, stretch, zoom)
- Fix issue causing extra blank ip manual console added when registering non-manual console
- Add option to adjust when Wifi connection symbol appears based on % of dropped packets in 200ms interval
1.6.3¶
Small patch release
- Trade-off minor image artifacts for smoother stream
- Fix race condition causing remote play on console has crashed
- Fix issue where dropped packets results in losing mic connection
- Correctly set render preset
- Set Dualsense microphone and LED to match microphone mute status
- Add PS5 Rumble for controllers other than DualSense and Steam Deck (which have native haptics support)
- Enable game mode in MacOS
- Fix congestion control stop on Windows and log Auto audio output when chosen
- Add alternate option of using flipscreen.games to query PSN Login
- Correctly replace old reference frames and update bitstream parsing
1.6.2¶
Small patch release
- Fixes framepacing regression introduced in 1.6.0
- Dualsense haptics now work again on Linux
- Corrects stretch and zoom when using stream command
- Stop stream freezing on close on Windows
- Stop stream crashing on close on Windows
- Report corrupted frames earlier resulting in less frames dropped when a corrupted frame occurs
- Fix mac arm build not opening and reporting as damaged due to not being signed (was also backported to 1.6.1)
1.6.1¶
Small patch release
- Fixes console registration
- Fixes fullscreen double-click and F11 shortcuts
- Don't close main window when closing stream session on MacOS
- Adds option to sleep PlayStation when sleeping Steam Deck
1.6.0¶
Touch friendly and controller navigable GUI
- New touch-friendly and controller navigable GUI
- MacOS support and Windows libplacebo renderer support
- Resume connection from sleep mode on Steam Deck
- Ability to login to PlayStation for account ID via GUI
- Fix Senkusha, lowering time for console connection and properly setting MTU
- Audio Switch to SDL including fixing audio lag building over session
- New Logo
- Qt6 support
1.5.1¶
Small patch release
- Workaround for gamescope bug (in Steam Deck Preview channel) causing HDR surface swapchain creation to hang.
1.5.0¶
HDR support
- Adds HDR support for chiaki-ng perfect with the Steam Deck OLED (see the configuration section for more details).
- New libplacebo vulkan renderer with better picture quality due to post-processing techniques like debanding (now the default renderer)
- Adds option to use controller by positional layout instead of button labels (particularly for Nintendo-style controllers)
- Adds launcher script for appimage
- Adds vulkan video decoding for video cards that support it (Steam Deck doesn't)
- Implements basic FEC error concealment to improve streaming experience (white flashses / green blocking)
1.4.1¶
Small patch release
- Adds multiplier to accelerometer values to match acceleration values of lighter DualSense/DualShock 4 controller. Fixes issue in some games where the acceleration value wasn't high enough when moving/shaking the Steam Deck to trigger the in-game action.
1.4.0¶
Mic support
- Adds mic support to chiaki-ng
- Noise suppression and echo cancelling for mic configurable in the chiaki-ng menu
Why doesn't my bluetooth headset mic show up as an available microphone on Steam Deck?
The Steam Deck does not currently support microphones over bluetooth by default so you will need to either use a hardwired headset or the Steam Deck microphone unless you change your Steam Deck settings to enable bluetooth headset support (it is currently experimental and turned off by default due to a noticeable drop in audio quality). Thus, it's advised to use either a hardwired headset or the internal microphone. If you really want to use a bluetooth headset and can live with the drop in audio quality see How to enable bluetooth headset modes on Steam Deck.
Update Actions for Existing Users¶
-
[Optional] Switch to the new default control layout
chiaki4deck+ mic
which adds toggle mic mute toL4
. Alternatively, you can manually add toggle mic mute to a button of your choice by mapping Ctrl+M to that button.
1.3.4¶
Small patch release
- Adds lowpass filter for haptics and tweaks haptic response => reduced noise while using Steam Deck haptics
- Automatic connection option for GUI
- Update automation script to work for PS4 remote connection
1.3.3¶
Small cosmetic release
- Update icons and display name to
chiaki-ng
1.3.2¶
Small patch release
- disable Steam Deck haptics when external controllers connected
- add vertical orientation option for motion controls
- let analog trigger actions work w/out PlayStation features enabled
- merge update to RGB mapping with HW accelerated graphics from jonibim
1.3.1¶
Small patch release
- Added scrollbar to settings since bottom of page was cut off on Steam Deck
- Fixed gyro mapping regression (causing drift in some games [i.e., Dreams])
- Updated HIDAPI (dependency) to 0.13.1 due to critical bug in release 0.13.0
Install update following updating chiaki-ng
.
1.3.0¶
- Native gyro support for Steam Deck
- Haptics support for DualSense (via USB) and Steam Deck [experimental]
- Adaptive triggers with DualSense (via USB or Bluetooth)
- Automation script tweaks (allow using hostname and specifying external IP / hostname in addition to local one)
- Documentation Updates (new DIY sections on building docs + development builds on Steam Deck + document various 1.3.0 features and changes for new and existing users)
- Bug fixes (audio bug causing crash in base Chiaki fixed, mismatch between cli and automation script leading and lagging space handling fixed, etc.)
Update Actions for Existing Users¶
-
[Optional] Enable the experimental PlayStation 5 features (enables PlayStation 5 haptics for Steam Deck and DualSense [via USB] and adaptive triggers for DualSense [via USB or bluetooth]).
-
Check the box shown in the image below in the GUI.
-
[If you are using a DualSense] Turn off Steam Input for the DualSense following the "Turning off Steam Input" tab in this section.
-
-
[Optional] Add an external IP/hostname to the automation by revisiting (running back through) the Automation section. Doing this will make the automation use your external address if you aren't connected to your home wireless network.
Note
This is for those that have gone through the process to make a connection outside of their local network to get an external IP/hostname to use.
1.2.0¶
chiaki-ng
's 2nd update since initial release.
What You Need to Do to Update¶
-
Updating your controller config to the new default (
chiaki-ng+
) and/or updating your custom controller layouts to take advantage of native touchscreen / trackpad controls. See the Controller Options section for details.-
Using the Default Controller Profile (Recommended Starting Point):
Open the
chiaki-ng
Controller Options section, browsing theCOMMUNITY LAYOUTS
tab for thechiaki4deck+
config, downloading it, and setting it as your new layout.[Approximate Time Estimate: 1 minute]
-
Creating a Custom Controller Profile (Great for tinkering, especially for updating the default profile to meet your needs exactly):
Make a custom controller profile using the Creating Your Own Controller Profile section, taking special note of the Special Button Mappings and Using Steam Deck Controller Touchscreen in Your Custom Controller Profile
[Approximate Time Estimate: 10-20 minutes depending on your experience with Steam Deck Controller Layouts]
-
-
[OPTIONAL] If you have a PlayStation Login Passcode and want entering it to be automated, please revisit (run back through) the Automation section (don't need to revisit any of the other sections). This is really quick if you use the "Automated Instructions (Recommended)" Tab. [Approximate Time Estimate: 5 minutes]
Success
Once your script is updated, since it will be in the same location as before, the Game Mode and controller setup will automatically carry over to this updated automation script. Thus, after revisiting the Automation section, you can immediately go back to using
chiaki-ng
.
What you Get by Updating¶
-
Full mapping for the PlayStation touchpad to the Steam Deck's touchscreen and trackpad (you can use either or switch between them if you so choose). See the touchscreen and trackpad mapping subsections of the Controller Options section for details.
General Touchscreen and Mouse Support
This update adds general touchscreen and mouse support for the PlayStation touchpad. Thus, it's applicable beyond the Steam Deck. With regard to
chiaki-ng
, the Steam Deck is the focus / inspiration for the update. -
Updated RGB color mapping used in OpenGL widget to be more color accurate thanks to Egoistically's Chiaki fork. See Updated RGB Mapping for details and a before and after comparison in Ghost of Tsushima.
-
Automatic Login Passcode Entry (For Users with a Login Passcode)
If you have to enter a login passcode each time you turn on your PlayStation console and login, you can now enter it into the automation to login from your personal Steam Deck without the hassle of bringing up the virtual keyboard with
Steam
++X and entering it in each time.
1.1.0¶
chiaki-ng
's 1st update since initial release.
What You Need to Do to Update¶
-
Revisiting (running back through) the Automation section (don't need to revisit any of the other sections). This is really quick if you use the "Automated Instructions (Recommended)" Tab.
Success
Once your script is updated, since it will be in the same location as before, the Game Mode and controller setup will automatically carry over to this updated automation script. Thus, after revisiting the Automation section, you can immediately go back to using
chiaki-ng
. -
[If desired] Visit the Using a DualSense and/or DualShock4 Controller with
chiaki-ng
to see how to setup native touchpad and gyro controls when playingchiaki-ng
with the DualShock4 and DualSense controllers.
What you Get by Updating¶
-
PlayStation controller native touchpad + gyro controller support enabled for the flatpak with setup instructions in Using a DualSense and/or DualShock4 Controller with
chiaki-ng
. This is great for when your using a TV or monitor with your Steam Deck. -
Enhanced automated launch
Specifically, I upgraded the discovery cli command to work properly and updated the automation script (and accompanying generator script) to to take advantage of this command instead of ping to handle some cases that failed intermittently before.
Now, the automation works for edge cases such as:
-
user is remote playing from outside their home wireless network (given they've already done the networking setup for that)
-
console is in the process of going to sleep or coming online when remote play session launched
-
console is currently downloading a large game
-
user doesn't have ping enabled on his/her wireless network
-
1.0.0¶
chiaki-ng's
initial release including the following notable updates:
-
3 view modes for non-standard screen sizes
-
Quit function Ctrl+Q
-
Enabled Automated Launch