Chiaki NG

https://streetpea.github.io/chiaki-ng/
Admin
Chiaki NG is a free and open-source PlayStation Remote Play client that enables users to stream and...
Tokens:50,521
Snippets:858
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install MkDocs and Plugins

Source: https://streetpea.github.io/chiaki-ng/diy/builddocs

Installs MkDocs and essential plugins for building the documentation. Ensure pip3 is installed first.

```bash
pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-print-site-plugin
```

--------------------------------

### Install Self-Built Chiaki-NG Flatpak

Source: https://streetpea.github.io/chiaki-ng/print_page?q=

Installs Chiaki-NG from the newly added local repository. This command installs the application for the current user.

```bash
flatpak --user install chiaki-ng-diy io.github.streetpea.Chiaki4deck
```

--------------------------------

### Install Flatpak Dependencies

Source: https://streetpea.github.io/chiaki-ng/print_page

Installs the required KDE runtime and SDK for building the Flatpak.

```bash
flatpak install -y flathub org.kde.Platform//6.9 flathub org.kde.Sdk//6.9
```

--------------------------------

### Install custom Flatpak

Source: https://streetpea.github.io/chiaki-ng/diy/buildit

Commands to add the local repository and install the built Flatpak.

```bash
flatpak --user remote-add --gpg-import chiaki-ng-diy.gpg chiaki-ng-diy ~/build-chiaki-ng-flatpak/chiaki-ng-diy
```

```bash
flatpak --user install chiaki-ng-diy io.github.streetpea.Chiaki4deck
```

--------------------------------

### Install Flatpak runtime and SDK

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Installs the necessary Flatpak runtime (org.kde.Platform//6.9) and SDK (org.kde.Sdk//6.9) for building Chiaki-NG.

```bash
flatpak install -y flathub org.kde.Platform//6.9 flathub org.kde.Sdk//6.9

```

--------------------------------

### Install KDE SDK

Source: https://streetpea.github.io/chiaki-ng/diy/steamdeckdev

Installs the KDE Software Development Kit version 6.9 for flatpak development.

```bash
flatpak install --user org.kde.Sdk//6.9

```

--------------------------------

### Install KDE SDK

Source: https://streetpea.github.io/chiaki-ng/print_page

Install the KDE SDK version 6.9, which is required for building the project.

```bash
flatpak install --user org.kde.Sdk//6.9
```

--------------------------------

### Install Chiaki-NG Flatpak with Debug Extension

Source: https://streetpea.github.io/chiaki-ng/print_page

Install the user-specific Flatpak with debug extensions for Chiaki-NG. This is part of the environment setup for development.

```bash
flatpak install --user --include-debug -y https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref
```

--------------------------------

### Install SDK Flatpak

Source: https://streetpea.github.io/chiaki-ng/diy/builddocs

Installs the necessary SDK for Flatpak development. This is a Linux-specific command.

```bash
flatpak install -y --user org.kde.Sdk//6.9
```

--------------------------------

### Install SDK and Debug Extensions

Source: https://streetpea.github.io/chiaki-ng/print_page?q=

Installs the required KDE SDK and its corresponding debug extensions for development.

```bash
flatpak install --user org.kde.Sdk//6.9
```

```bash
flatpak install --user org.kde.Sdk.Debug//6.9
```

--------------------------------

### Install Documentation Build Environment

Source: https://streetpea.github.io/chiaki-ng/print_page

Commands to set up the development environment for building documentation via Flatpak or system-level pip.

```bash
flatpak install -y --user https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref
```

```bash
flatpak install -y --user org.kde.Sdk//6.9
```

```bash
flatpak run --devel --command=bash io.github.streetpea.Chiaki4deck-devel
```

```bash
pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-print-site-plugin
```

--------------------------------

### Install chiaki-ng from Flathub

Source: https://streetpea.github.io/chiaki-ng/updates/releases

Installs the chiaki-ng Flatpak from the Flathub repository. This can be done via the Discover store or the command line.

```bash
flatpak install -y --user flathub io.github.streetpea.Chiaki4deck
```

--------------------------------

### Install Development Flatpak

Source: https://streetpea.github.io/chiaki-ng/print_page?q=

Installs the development version of the Flatpak application.

```bash
flatpak install --user --include-debug -y https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpak.Chiaki4deck-devel.flatpakref
```

--------------------------------

### Example Output of gen-launcher.sh Script

Source: https://streetpea.github.io/chiaki-ng/setup/automation

This is an example of the interactive prompts and user selections when running the gen-launcher script to set up automated connections.

```bash
bash <(curl -sLo- https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/gen-launcher.sh)

1) PlayStation 4
2) PlayStation 5
Please select the number corresponding to your Playstation Console: 2
Option 2: PlayStation 5 was chosen


HOME ADDRESS
-------------
1) IP
2) hostname
NOTICE: Use 1 unless you created a hostname (FQDN) for your PlayStation
Please select the number corresponding to your address type: 1
Option 1: IP was chosen

Enter your PlayStation IP (should be xxx.xxx.xxx.xxx like 192.168.1.16):
192.168.1.16

Do you have a separate address (DNS or IP) to access this console away from home? (y/n):
y
Enter your home SSID [hit enter for default: StreetPea-5G]: 


AWAY ADDRESS
-------------
1) IP
2) hostname
NOTICE: Use 1 unless you created a hostname (FQDN) for your PlayStation
Please select the number corresponding to your address type: 2
Option 2: hostname was chosen

```

--------------------------------

### Chiaki-NG Launcher Script Example

Source: https://streetpea.github.io/chiaki-ng/setup/automation

An example bash script for launching Chiaki-NG, including network detection, status checks, and error handling for remote play connections.

```bash
#!/usr/bin/env bash

connect_error_loc()
{
    echo "Error: Couldn't connect to your PlayStation console from your local address!" >&2
    echo "Error: Please check that your Steam Deck and PlayStation are on the same network" >&2
    echo "Error: ...and that you have the right PlayStation IP address or hostname!" >&2
    exit 1
}

connect_error_ext()
{
    echo "Error: Couldn't connect to your PlayStation console from your external address!" >&2
    echo "Error: Please check that you have forwarded the necessary ports on your router" >&2
    echo "Error: ...and that you have the right external PlayStation IP address or hostname!" >&2
    exit 1
}

wakeup_error()
{
    echo "Error: Couldn't wake up PlayStation console from sleep!" >&2
    echo "Error: Please make sure you are using a PlayStation 5." >&2
    echo "Error: If not, change the wakeup call to use the number of your PlayStation console" >&2
    exit 2
}

timeout_error()
{
    echo "Error: PlayStation console didn't become ready in 35 seconds!" >&2
    echo "Error: Please change 35 to a higher number in your script if this persists." >&2
    exit 1
}
if [ "$(iwgetid -r)" == "StreetPea-5G" ]
then
    addr="192.168.1.16"
    local=true
else
    addr="foo.bar.com"
    local=false
fi
SECONDS=0
# Wait for console to be in sleep/rest mode or on (otherwise console isn't available)
ps_status="$(flatpak run io.github.streetpea.Chiaki4deck discover -h ${addr} 2>/dev/null)"
while ! echo "${ps_status}" | grep -q 'ready\|standby'
do
    if [ ${SECONDS} -gt 35 ]
    then
        if [ "${local}" = true ]
        then
            connect_error_loc
        else
            connect_error_ext
        fi
    fi
    sleep 1
    ps_status="$(flatpak run io.github.streetpea.Chiaki4deck discover -h ${addr} 2>/dev/null)"
done

# Wake up console from sleep/rest mode if not already awake
if ! echo "${ps_status}" | grep -q ready
then
    flatpak run io.github.streetpea.Chiaki4deck wakeup -5 -h ${addr} -r '2ebf539d' 2>/dev/null
fi

# Wait for PlayStation to report ready status, exit script on error if it never happens.
while ! echo "${ps_status}" | grep -q ready
do
    if [ ${SECONDS} -gt 35 ]
    then
        if echo "${ps_status}" | grep -q standby
        then
            wakeup_error
        else
            timeout_error
        fi
    fi
    sleep 1
    ps_status="$(flatpak run io.github.streetpea.Chiaki4deck discover -h ${addr} 2>/dev/null)"
done

```

--------------------------------

### Install Devel Flatpak

Source: https://streetpea.github.io/chiaki-ng/diy/builddocs

Installs the development Flatpak for chiaki-ng. This is a Linux-specific command.

```bash
flatpak install -y --user https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref
```

--------------------------------

### Example Output of Launcher Generator

Source: https://streetpea.github.io/chiaki-ng/print_page?q=

A sample interaction session showing the prompts and inputs required by the gen-launcher script.

```text
bash <(curl -sLo- https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/gen-launcher.sh)

1) PlayStation 4
2) PlayStation 5
Please select the number corresponding to your Playstation Console: 2
Option 2: PlayStation 5 was chosen




HOME ADDRESS
-------------
1) IP
2) hostname
NOTICE: Use 1 unless you created a hostname (FQDN) for your PlayStation
Please select the number corresponding to your address type: 1
Option 1: IP was chosen

Enter your PlayStation IP (should be xxx.xxx.xxx.xxx like 192.168.1.16):
192.168.1.16

Do you have a separate address (DNS or IP) to access this console away from home? (y/n):
y
Enter your home SSID [hit enter for default: StreetPea-5G]: 



AWAY ADDRESS
-------------
1) IP
2) hostname
NOTICE: Use 1 unless you created a hostname (FQDN) for your PlayStation
Please select the number corresponding to your address type: 2
Option 2: hostname was chosen
```

--------------------------------

### Install chiaki-ng via Flatpak

Source: https://streetpea.github.io/chiaki-ng/setup/installation

Use this command in the terminal to install the official Flatpak version from Flathub.

```bash
flatpak install -y io.github.streetpea.Chiaki4deck
```

--------------------------------

### Install dependencies by distribution

Source: https://streetpea.github.io/chiaki-ng/diy/buildit

Commands to install required packages for building Flatpaks on various Linux distributions.

```bash
sudo apt update && sudo apt install -y gnupg curl flatpak flatpak-builder
```

```bash
sudo yum update && sudo yum install -y gnupg curl flatpak flatpak-builder
```

```bash
sudo pacman -Syy && sudo pacman -S gnupg curl flatpak flatpak-builder
```

--------------------------------

### Install flatpak-builder on Steam OS

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Installs the flatpak-builder package after setting up the pacman keyring on Steam OS.

```bash
sudo pacman -Syy && sudo pacman -S flatpak-builder

```

--------------------------------

### Install chiaki-ng via Flatpak

Source: https://streetpea.github.io/chiaki-ng/setup/installation?q=

Use this command to install the official chiaki-ng flatpak from Flathub. This is the recommended method for most users.

```bash
flatpak install -y io.github.streetpea.Chiaki4deck

```

--------------------------------

### Install self-built Flatpak

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Installs the self-built Chiaki-NG Flatpak from the newly added local remote repository ('chiaki-ng-diy') for the current user.

```bash
flatpak --user install chiaki-ng-diy io.github.streetpea.Chiaki4deck

```

--------------------------------

### Install Flatpak Dependencies on Ubuntu/Debian

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Installs gpg, curl, flatpak, and flatpak-builder using apt for Ubuntu/Debian-based systems.

```bash
sudo apt update && sudo apt install -y gnupg curl flatpak flatpak-builder

```

--------------------------------

### List Consoles with Chiaki-NG

Source: https://streetpea.github.io/chiaki-ng/setup/automation

Use this command to get the nickname of your console, which is required for further setup.

```bash
flatpak run io.github.streetpea.Chiaki4deck list
```

--------------------------------

### Prepare build environment

Source: https://streetpea.github.io/chiaki-ng/diy/buildit

Commands to install the necessary Flatpak runtime and SDK, create a build directory, and download the manifest and patch files.

```bash
flatpak install -y flathub org.kde.Platform//6.9 flathub org.kde.Sdk//6.9
```

```bash
mkdir -p ~/build-chiaki-ng-flatpak && cd ~/build-chiaki-ng-flatpak
```

```bash
curl -Lo chiaki-ng.yaml https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/chiaki4deck.yaml
```

```bash
curl -LO https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/0001-vulkan-ignore-frames-without-hw-context.patch
```

--------------------------------

### Create build directory and switch into it

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Creates a directory named 'build-chiaki-ng-flatpak' in the home directory and changes the current directory to it.

```bash
mkdir -p ~/build-chiaki-ng-flatpak && cd ~/build-chiaki-ng-flatpak

```

--------------------------------

### Prepare Build Directory

Source: https://streetpea.github.io/chiaki-ng/print_page

Creates and enters the directory for build files.

```bash
mkdir -p ~/build-chiaki-ng-flatpak && cd ~/build-chiaki-ng-flatpak
```

--------------------------------

### Update chiaki-ng via terminal

Source: https://streetpea.github.io/chiaki-ng/print_page

Commands to update chiaki-ng installations based on the installation method.

```bash
flatpak update -y io.github.streetpea.Chiaki4deck
```

```bash
flatpak update --user -y re.chiaki.Chiaki4deck
```

```bash
brew install --cask streetpea/streetpea/chiaki-ng
```

--------------------------------

### Install KDE SDK Debug Extensions

Source: https://streetpea.github.io/chiaki-ng/print_page

Install the debug extensions for the KDE SDK version 6.9.

```bash
flatpak install --user org.kde.Sdk.Debug//6.9
```

--------------------------------

### Serve Documentation Locally

Source: https://streetpea.github.io/chiaki-ng/diy/builddocs

Serves the chiaki-ng documentation locally using MkDocs. This command should be run from the root of the cloned repository.

```bash
mkdocs serve
```

--------------------------------

### Install Development Flatpak

Source: https://streetpea.github.io/chiaki-ng/diy/steamdeckdev

Installs the user-specific development version of the chiaki-ng flatpak, including debug extensions.

```bash
flatpak install --user --include-debug -y https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref

```

--------------------------------

### Enter Flatpak Development Environment

Source: https://streetpea.github.io/chiaki-ng/print_page

Launch a bash shell inside the development Flatpak container with the source code mounted.

```bash
flatpak run --command=bash --devel io.github.streetpea.Chiaki4deck-devel
```

--------------------------------

### Enter Development Flatpak Environment

Source: https://streetpea.github.io/chiaki-ng/diy/steamdeckdev

Enters the development version of the flatpak with the chiaki-ng source code mounted.

```bash
flatpak run --command=bash --devel io.github.streetpea.Chiaki4deck-devel

```

--------------------------------

### Install SDK Debug Extensions

Source: https://streetpea.github.io/chiaki-ng/diy/steamdeckdev

Installs the debug extensions for the KDE Software Development Kit version 6.9.

```bash
flatpak install --user org.kde.Sdk.Debug//6.9

```

--------------------------------

### Launch Chiaki-ng via Command Line

Source: https://streetpea.github.io/chiaki-ng/setup/automation

Executes the Chiaki-ng application with specific stream parameters.

```bash
flatpak run io.github.streetpea.Chiaki4deck --passcode --zoom stream 'PS5-012' ${addr}
```

```bash
flatpak run io.github.streetpea.Chiaki4deck --passcode 1111 --zoom stream 'PS5-012' 192.168.1.16
```

--------------------------------

### Install Flatpak Dependencies on RHEL/CentOS

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Installs gpg, curl, flatpak, and flatpak-builder using yum for RHEL/CentOS-based systems.

```bash
sudo yum update && sudo yum install -y gnupg curl flatpak flatpak-builder

```

--------------------------------

### Configure Steam OS for building

Source: https://streetpea.github.io/chiaki-ng/diy/buildit

Commands to prepare a Steam OS environment for building, including disabling read-only mode and initializing the keyring.

```bash
sudo steamos-readonly disable
```

```bash
sudo pacman-key --init
```

```bash
sudo pacman-key --populate archlinux
```

```bash
sudo pacman-key --populate holo
```

```bash
sudo pacman -Syy && sudo pacman -S flatpak-builder
```

```bash
sudo steamos-readonly enable
```

--------------------------------

### Install chiaki-ng via Homebrew

Source: https://streetpea.github.io/chiaki-ng/setup/installation

Use this command to install the application on macOS using the Homebrew package manager.

```bash
brew install --cask streetpea/streetpea/chiaki-ng
```

--------------------------------

### Install Flatpak Builder on RHEL/CentOS

Source: https://streetpea.github.io/chiaki-ng/print_page

Installs required packages such as gnupg, curl, flatpak, and flatpak-builder on RHEL or CentOS systems.

```bash
sudo yum update && sudo yum install -y gnupg curl flatpak flatpak-builder
```

--------------------------------

### Build and sign Flatpak

Source: https://streetpea.github.io/chiaki-ng/diy/buildit?q=

Builds the Chiaki-NG Flatpak using 'flatpak-builder', specifying the repository, cleaning the build directory, and signing the build with the 'chiaki-ng-diy' GPG key.

```bash
flatpak-builder --repo=chiaki-ng-diy --force-clean build chiaki-ng.yaml --gpg-sign chiaki-ng-diy

```

--------------------------------

### Run chiaki (Release Build)

Source: https://streetpea.github.io/chiaki-ng/diy/steamdeckdev

Executes the chiaki application from the Release build directory.

```bash
./gui/chiaki

```
Tokens:
Raw