Wolf

https://games-on-whales.github.io/wolf/stable/
Admin
Wolf is an open source streaming server for Moonlight that enables multiple remote clients to share...
Tokens:25,420
Snippets:265
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Temporary Container

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Start the temporary container to populate the nvidia-driver-vol volume.

```bash
sudo podman start musing_pascal
```

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

### Install Wolf system dependencies

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Installs the required system-level development libraries for building Wolf.

```bash
apt-get install -y --no-install-recommends \
    curl \
    ca-certificates \
    ninja-build \
    cmake \
    pkg-config \
    ccache \
    git \
    clang \
    libboost-thread-dev libboost-locale-dev libboost-filesystem-dev libboost-log-dev libboost-stacktrace-dev libboost-container-dev \
    libwayland-dev libwayland-server0 libinput-dev libxkbcommon-dev libgbm-dev \
    libcurl4-openssl-dev \
    libssl-dev \
    libevdev-dev \
    libpulse-dev \
    libunwind-dev \
    libudev-dev \
    libdrm-dev \
    libpci-dev
```

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

### Build and install gst-wayland-display

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Compiles and installs the gst-wayland-display component using cargo-c.

```bash
git clone https://github.com/games-on-whales/gst-wayland-display
cd gst-wayland-display
cargo install cargo-c
mkdir $HOME/gst-wayland-display
cargo cinstall --prefix=$HOME/gst-wayland-display
```

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

### Run Wolf

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Commands to make the script executable and start the Wolf server.

```bash
chmod +x runwolf.sh
./runwolf.sh
INFO  | Reading config file from: config.toml
WARN  | Unable to open config file: config.toml, creating one using defaults
INFO  | x509 certificates not present, generating...
INFO  | HTTP server listening on port: 47989
INFO  | HTTPS server listening on port: 47984
```

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

### Configure Systemd Install Section

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Snippet for the Install section of a systemd service file.

```bash
[Install]
WantedBy=multi-user.target
```

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

### Enable NVIDIA Persistence

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Start the nvidia-persistenced service to ensure required device files are created on CoreOS.

```bash
sudo systemctl enable --now nvidia-persistenced.service
```

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

### Build and install Gstreamer

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Clones the Gstreamer repository and builds it with specific configuration flags to ensure compatibility.

```bash
git clone -b 1.24.6 --depth=1 https://gitlab.freedesktop.org/gstreamer/gstreamer.git
cd gstreamer
# Setup a place where we'll put the libraries
mkdir -p $HOME/gstreamer/include -p $HOME/gstreamer/usr/local/include
meson setup --prefix=$HOME/gstreamer \
	--buildtype=release \
	--strip \
	-Dgst-full-libraries=app,video \
	-Dorc=disabled \
	-Dgpl=enabled  \
	-Dbase=enabled \
	-Dgood=enabled  \
	-Dugly=enabled \
	-Drs=disabled \
	-Dtls=disabled \
	-Dgst-examples=disabled \
	-Dlibav=disabled \
	-Dtests=disabled \
	-Dexamples=disabled \
	-Ddoc=disabled \
	-Dpython=disabled \
	-Drtsp_server=disabled \
	-Dqt5=disabled \
	-Dbad=enabled \
	-Dgst-plugins-good:soup=disabled \
	-Dgst-plugins-good:ximagesrc=enabled \
	-Dgst-plugins-good:pulse=enabled \
	-Dgst-plugins-bad:x265=enabled  \
	-Dgst-plugins-bad:qsv=enabled \
	-Dgst-plugins-bad:aom=enabled \
	-Dgst-plugin-bad:nvcodec=enabled  \
	-Dvaapi=enabled \
	-Dgstreamer-vaapi:x11=disabled \
	build
meson compile -C build
meson install -C build
```

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

### Install Gstreamer build dependencies

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Installs the necessary system packages required to compile Gstreamer from source.

```bash
apt install -y build-essential ninja-build gcc meson cmake ccache bison equivs \
	ca-certificates git libllvm15 \
	flex libx265-dev libopus-dev nasm libzxing-dev libzbar-dev libdrm-dev libva-dev \
	libmfx-dev libvpl-dev libmfx-tools libunwind8 libcap2-bin \
	libx11-dev libxfixes-dev libxdamage-dev libwayland-dev libpulse-dev libglib2.0-dev \
	libopenjp2-7-dev liblcms2-dev libcairo2-dev libcairo-gobject2 libwebp7 librsvg2-dev libaom-dev \
	libharfbuzz-dev libpango1.0-dev
```

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

### Start Nginx Proxy Container

Source: https://games-on-whales.github.io/wolf/stable/dev/api.html

Run an Nginx container with the necessary volume mounts to proxy the Wolf API socket.

```bash
docker run --name wolf-proxy \
           --network=host \
           -v /var/run/wolf/wolf.sock:/var/run/wolf/wolf.sock:rw \
           -v ./wolf.conf:/etc/nginx/conf.d/wolf.conf:ro \
           nginx
```

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

### List Graphics Cards

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Identify the correct render node for multi-GPU setups.

```bash
ls -l /sys/class/drm/renderD*/device/driver

lrwxrwxrwx. 1 root root 0 Oct 29 19:44 /sys/class/drm/renderD128/device/driver -> ../../../bus/pci/drivers/i915
lrwxrwxrwx. 1 root root 0 Oct 29 19:44 /sys/class/drm/renderD129/device/driver -> ../../../../bus/pci/drivers/nvidia
```

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

### Intel GPU firmware configuration commands

Source: https://games-on-whales.github.io/wolf/stable/user/troubleshooting.html

Commands to install firmware and configure GRUB to resolve Intel QSV encoder errors.

```bash
sudo apt install --reinstall linux-firmware
```

```bash
GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.force_probe=* i915.enable_guc=2"
```

```bash
sudo update-initramfs –u
```

```bash
sudo update-grub
```

```bash
dmesg | grep guc
```

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

### Run Steam container on Wayland host

Source: https://games-on-whales.github.io/wolf/stable/apps/index.html

Example command to test a Steam container locally on a Wayland-enabled host without Wolf.

```shell
  docker run --name=steam --rm -it \
  --device=/dev/dri/renderD128 \
  --device=/dev/dri/card0 \
  --ipc=host \
  --cap-add=ALL \
  --security-opt seccomp=unconfined \
  -e XDG_RUNTIME_DIR=/tmp \
  -v ${XDG_RUNTIME_DIR}/${WAYLAND_DISPLAY}:/tmp/${WAYLAND_DISPLAY}:rw \
  -e XDG_SESSION_TYPE=wayland \
  -e WAYLAND_DISPLAY=${WAYLAND_DISPLAY} \
  -e RUN_SWAY=true \
  -v /tmp/SteamGOWData:/home/retro/ \
  ghcr.io/games-on-whales/steam:edge
```

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

### Vulkan Error Log Example

Source: https://games-on-whales.github.io/wolf/stable/user/troubleshooting.html

Example of log output indicating a failure to initialize Vulkan, often related to video driver issues.

```text
vulkan: physical device 10de:1c03 compute queue doesn't support presenting on our surface, using graphics queue
vulkan: selecting physical device 'NVIDIA GeForce GTX 1060 6GB': queue family 0
vulkan: physical device supports DRM format modifiers
vulkan: vkCreateDevice failed (VkResult: -7)
Failed to initialize Vulkan
```

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

### Verify Nvidia Container Toolkit

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Check the installed version of the Nvidia container toolkit.

```bash
sudo nvidia-container-cli -V
cli-version: 1.16.0
lib-version: 1.16.0
build date: 2024-07-15T13:41+00:00
```

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

### Define an application in TOML

Source: https://games-on-whales.github.io/wolf/stable/user/configuration.html

Example configuration for a single application profile including runner, video, and audio pipeline overrides.

```toml
[[profiles.apps]]
title = "Test ball" __**(1)**
start_virtual_compositor = false __**(2)**
app_state_folder = "some/folder" __**(3)**
icon_png_path = "ball.png" __**(4)**

[profiles.apps.runner] __**(5)**
type = "process"
run_cmd = "sh -c \"while :; do echo 'running...'; sleep 10; done\""

[profiles.apps.video] __**(6)**
source = """
videotestsrc pattern=ball flip=true is-live=true !
video/x-raw, framerate={fps}/1
\
"""

[profiles.apps.audio] __**(7)**
source = "audiotestsrc wave=ticks is-live=true"
```

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

### Configure gst-wayland-display environment variables

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Sets environment variables to point to the gst-wayland-display installation directory.

```bash
GSTWAYLANDDISPLAY_FOLDER="$HOME/gst-wayland-display"
export LIBRARY_PATH="$LIBRARY_PATH:$GSTWAYLANDDISPLAY_FOLDER/lib/"
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$GSTWAYLANDDISPLAY_FOLDER/lib/"
export LDFLAGS="$LDFLAGS -L$GSTWAYLANDDISPLAY_FOLDER/lib"
export CFLAGS="$CFLAGS -I$GSTWAYLANDDISPLAY_FOLDER/include -fPIC"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$GSTWAYLANDDISPLAY_FOLDER/lib/pkgconfig/"
```

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

### Pegasus Application Configuration

Source: https://games-on-whales.github.io/wolf/stable/apps/pegasus.html

A complete example of the Pegasus application configuration block for the config.toml file.

```toml
[[apps]]
title = "Pegasus"
start_virtual_compositor = true

[apps.runner]
type = "docker"
name = "WolfEmulators"
image = "ghcr.io/games-on-whales/pegasus:edge"
mounts = [
    "/mnt/PATH_TO_ROMS_IN_YOUR_HOST/:/ROMs/:rw" # <-- EDIT HERE
]
env = [
"RUN_SWAY=1",
"GOW_REQUIRED_DEVICES=/dev/input/event* /dev/dri/* /dev/nvidia*",
]
devices = []
ports = []
base_create_json = """
{
  "HostConfig": {
    "Binds": [],
    "IpcMode": "host",
    "CapAdd": ["NET_RAW", "MKNOD", "NET_ADMIN", "SYS_ADMIN", "SYS_NICE"],
    "Privileged": false,
    "DeviceCgroupRules": ["c 13:* rmw"]
  }
}
"""
```

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

### Example udev event for joypad

Source: https://games-on-whales.github.io/wolf/stable/dev/fake-udev.html

This represents the structure of a udev event generated when a device is added to the system.

```text
UDEV  [3588.199301] add      /devices/pci0000:00/0000:00:01.3/0000:02:00.0/usb1/1-1/1-1:1.3/0003:054C:0CE6.0007/input/input20/js0 (input)
ACTION=add
SUBSYSTEM=input
DEVNAME=/dev/input/js0
ID_BUS=usb
ID_MODEL=Wireless_Controller
ID_SERIAL=Sony_Interactive_Entertainment_Wireless_Controller
ID_VENDOR=Sony_Interactive_Entertainment
ID_VENDOR_ENC=Sony\x20Interactive\x20Entertainment
ID_VENDOR_ID=054c
ID_REVISION=0100
ID_TYPE=hid
ID_USB_VENDOR_ID=054c
ID_USB_REVISION=0100
ID_USB_TYPE=hid
ID_USB_DRIVER=usbhid
MAJOR=13
MINOR=0
```

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

### GET /api/v1/apps

Source: https://games-on-whales.github.io/wolf/stable/dev/api.html

Retrieves a list of all available Moonlight apps from the Wolf server.

```APIDOC
## GET /api/v1/apps

### Description
Retrieves a list of all Moonlight apps configured on the server.

### Method
GET

### Endpoint
/api/v1/apps

### Headers
- **accept** (string) - Required - Should be set to 'application/json'
```

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

### H.264 Binary Stream Example

Source: https://games-on-whales.github.io/wolf/stable/protocols/rtp-video.html

A complete H.264 stream composed of 3 NAL units. Saving these hex values into a file with a .264 extension allows for viewing the encoded image.

```hex
0x0000 | 00 00 00 01 67 64 00 0A AC 72 84 44 26 84 00 00
0x0010 | 03 00 04 00 00 03 00 CA 3C 48 96 11 80 00 00 00
0x0020 | 01 68 E8 43 8F 13 21 30 00 00 01 65 88 81 00 05
0x0030 | 4E 7F 87 DF 61 A5 8B 95 EE A4 E9 38 B7 6A 30 6A
0x0040 | 71 B9 55 60 0B 76 2E B5 0E E4 80 59 27 B8 67 A9
0x0050 | 63 37 5E 82 20 55 FB E4 6A E9 37 35 72 E2 22 91
0x0060 | 9E 4D FF 60 86 CE 7E 42 B7 95 CE 2A E1 26 BE 87
0x0070 | 73 84 26 BA 16 36 F4 E6 9F 17 DA D8 64 75 54 B1
0x0080 | F3 45 0C 0B 3C 74 B3 9D BC EB 53 73 87 C3 0E 62
0x0090 | 47 48 62 CA 59 EB 86 3F 3A FA 86 B5 BF A8 6D 06
0x00A0 | 16 50 82 C4 CE 62 9E 4E E6 4C C7 30 3E DE A1 0B
0x00B0 | D8 83 0B B6 B8 28 BC A9 EB 77 43 FC 7A 17 94 85
0x00C0 | 21 CA 37 6B 30 95 B5 46 77 30 60 B7 12 D6 8C C5
0x00D0 | 54 85 29 D8 69 A9 6F 12 4E 71 DF E3 E2 B1 6B 6B
0x00E0 | BF 9F FB 2E 57 30 A9 69 76 C4 46 A2 DF FA 91 D9
0x00F0 | 50 74 55 1D 49 04 5A 1C D6 86 68 7C B6 61 48 6C
0x0100 | 96 E6 12 4C 27 AD BA C7 51 99 8E D0 F0 ED 8E F6
0x0110 | 65 79 79 A6 12 A1 95 DB C8 AE E3 B6 35 E6 8D BC
0x0120 | 48 A3 7F AF 4A 28 8A 53 E2 7E 68 08 9F 67 77 98
0x0130 | 52 DB 50 84 D6 5E 25 E1 4A 99 58 34 C7 11 D6 43
0x0140 | FF C4 FD 9A 44 16 D1 B2 FB 02 DB A1 89 69 34 C2
0x0150 | 32 55 98 F9 9B B2 31 3F 49 59 0C 06 8C DB A5 B2
0x0160 | 9D 7E 12 2F D0 87 94 44 E4 0A 76 EF 99 2D 91 18
0x0170 | 39 50 3B 29 3B F5 2C 97 73 48 91 83 B0 A6 F3 4B
0x0180 | 70 2F 1C 8F 3B 78 23 C6 AA 86 46 43 1D D7 2A 23
0x0190 | 5E 2C D9 48 0A F5 F5 2C D1 FB 3F F0 4B 78 37 E9
0x01A0 | 45 DD 72 CF 80 35 C3 95 07 F3 D9 06 E5 4A 58 76
0x01B0 | 03 6C 81 20 62 45 65 44 73 BC FE C1 9F 31 E5 DB
0x01C0 | 89 5C 6B 79 D8 68 90 D7 26 A8 A1 88 86 81 DC 9A
0x01D0 | 4F 40 A5 23 C7 DE BE 6F 76 AB 79 16 51 21 67 83
0x01E0 | 2E F3 D6 27 1A 42 C2 94 D1 5D 6C DB 4A 7A E2 CB
0x01F0 | 0B B0 68 0B BE 19 59 00 50 FC C0 BD 9D F5 F5 F8
0x0200 | A8 17 19 D6 B3 E9 74 BA 50 E5 2C 45 7B F9 93 EA
0x0210 | 5A F9 A9 30 B1 6F 5B 36 24 1E 8D 55 57 F4 CC 67
0x0220 | B2 65 6A A9 36 26 D0 06 B8 E2 E3 73 8B D1 C0 1C
0x0230 | 52 15 CA B5 AC 60 3E 36 42 F1 2C BD 99 77 AB A8
0x0240 | A9 A4 8E 9C 8B 84 DE 73 F0 91 29 97 AE DB AF D6
0x0250 | F8 5E 9B 86 B3 B3 03 B3 AC 75 6F A6 11 69 2F 3D
0x0260 | 3A CE FA 53 86 60 95 6C BB C5 4E F3
```

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

### Initialize NVIDIA Devices

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Load NVIDIA kernel modules if the required device files are missing.

```bash
sudo nvidia-container-cli --load-kmods info
```

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

### RTSP Response Message Example

Source: https://games-on-whales.github.io/wolf/stable/protocols/rtsp.html

Example of a standard RTSP response message structure including status code and payload.

```text
RTSP/1.0 200 OK __**(1)**
CSeq: 1 __**(2)**

a=fmtp:97 surround-params=21101 __**(3)**
```

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

### Initialize NVIDIA device nodes

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Script to probe NVIDIA drivers and create device nodes for GPUs and UVM.

```bash
/sbin/modprobe nvidia
if [ "$?" -eq 0 ]; then
  # Count the number of NVIDIA controllers found.
  NVDEVS=`lspci | grep -i NVIDIA`
  N3D=`echo "$NVDEVS" | grep "3D controller" | wc -l`
  NVGA=`echo "$NVDEVS" | grep "VGA compatible controller" | wc -l`
  N=`expr $N3D + $NVGA - 1`
  for i in `seq 0 $N`; do
    mknod -m 666 /dev/nvidia$i c 195 $i
  done
  mknod -m 666 /dev/nvidiactl c 195 255
else
  exit 1
fi

/sbin/modprobe nvidia-uvm
if [ "$?" -eq 0 ]; then
  # Find out the major device number used by the nvidia-uvm driver
  D=`grep nvidia-uvm /proc/devices | awk '{print $1}'`
  mknod -m 666 /dev/nvidia-uvm c $D 0
  mknod -m 666 /dev/nvidia-uvm-tools c $D 0
else
  exit 1
fi
```

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

### RTSP Request Message Example

Source: https://games-on-whales.github.io/wolf/stable/protocols/rtsp.html

Example of a standard RTSP request message structure including command, options, and payload.

```text
OPTIONS rtsp://192.168.1.100:48010 RTSP/1.0 __**(1)**
CSeq:  1 __**(2)**
X-GS-ClientVersion: 14 __**(3)**
__**(4)**
a=fmtp:97 surround-params=21101 __**(5)**
```

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

### Enable window compositors

Source: https://games-on-whales.github.io/wolf/stable/user/configuration.html

Configure the app runner to use either Sway or Gamescope via environment variables.

```toml
[apps.runner]
env = [
    "RUN_SWAY=1",
    # ...
]
```

```toml
[apps.runner]
env = [
    "RUN_GAMESCOPE=1",
    # ...
]
```

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

### GET /api/v1/openapi-schema

Source: https://games-on-whales.github.io/wolf/stable/dev/api.html

Retrieves the OpenAPI specification for the Wolf API.

```APIDOC
## GET /api/v1/openapi-schema

### Description
Returns the OpenAPI 3.1.0 specification document for the Wolf API.

### Method
GET

### Endpoint
/api/v1/openapi-schema
```

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

### Configure NVIDIA udev rules

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Add these rules to the host to create necessary NVIDIA device files in /dev/.

```udev
KERNEL=="nvidia", RUN+="/bin/bash -c '/usr/bin/nvidia-smi -L && /bin/chmod 0666 /dev/nvidia*'"
KERNEL=="nvidia_uvm", RUN+="/bin/bash -c '/usr/bin/nvidia-modprobe -c0 -u && /bin/chmod 0666 /dev/nvidia-uvm*'"
```

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

### Build NVIDIA driver image

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Create a container image containing the necessary NVIDIA driver files.

```bash
sudo curl https://raw.githubusercontent.com/games-on-whales/gow/master/images/nvidia-driver/Dockerfile | sudo podman build -t gow/nvidia-driver:latest -f - --build-arg NV_VERSION=$(cat /sys/module/nvidia/version) .
```

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

### Set Multi-GPU render node

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Environment variable configuration for multi-GPU setups.

```yaml
environment:
    - WOLF_RENDER_NODE=/dev/dri/renderD12X
```

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

### Verify Gstreamer nvcodec plugin

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Checks if the nvcodec plugin is correctly installed and functional.

```bash
GST_DEBUG=4 gst-inspect-1.0 nvcodec
```

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

### Configure GRUB for Nvidia

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Persistent configuration for enabling nvidia-drm modeset via GRUB.

```bash
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia-drm.modeset=1"
```

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

### Run Wolf with Intel/AMD

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Standard deployment for Intel/AMD hardware using Docker CLI or Compose.

```bash
docker run \
    --name wolf \
    --network=host \
    -v /etc/wolf:/etc/wolf:rw \
    -v /var/run/docker.sock:/var/run/docker.sock:rw \
    --device /dev/dri/ \
    --device /dev/uinput \
    --device /dev/uhid \
    -v /dev/:/dev/:rw \
    -v /run/udev:/run/udev:rw \
    --device-cgroup-rule "c 13:* rmw" \
    ghcr.io/games-on-whales/wolf:stable
```

```yaml
version: "3"
services:
  wolf:
    image: ghcr.io/games-on-whales/wolf:stable
    volumes:
      - /etc/wolf/:/etc/wolf
      - /var/run/docker.sock:/var/run/docker.sock:rw
      - /dev/:/dev/:rw
      - /run/udev:/run/udev:rw
    device_cgroup_rules:
      - 'c 13:* rmw'
    devices:
      - /dev/dri
      - /dev/uinput
      - /dev/uhid
    network_mode: host
    restart: unless-stopped
```

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

### Configure NVIDIA kernel modules

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Commands to create a configuration file for automatic kernel module loading at boot.

```bash
nano /etc/modules-load.d/nvidia.conf
```

```text
nvidia
nvidia_uvm
```

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

### Run Wolf via Docker CLI

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Execute the Wolf container with the necessary device mappings and volume mounts.

```bash
docker run \
    --name wolf \
    --network=host \
    -e NVIDIA_DRIVER_VOLUME_NAME=nvidia-driver-vol \
    -v nvidia-driver-vol:/usr/nvidia:rw \
    -v /etc/wolf:/etc/wolf:rw \
    -v /var/run/docker.sock:/var/run/docker.sock:rw \
    --device /dev/nvidia-uvm \
    --device /dev/nvidia-uvm-tools \
    --device /dev/dri/ \
    --device /dev/nvidia-caps/nvidia-cap1 \
    --device /dev/nvidia-caps/nvidia-cap2 \
    --device /dev/nvidiactl \
    --device /dev/nvidia0 \
    --device /dev/nvidia-modeset \
    --device /dev/uinput \
    --device /dev/uhid \
    -v /dev/:/dev/:rw \
    -v /run/udev:/run/udev:rw \
    --device-cgroup-rule "c 13:* rmw" \
    ghcr.io/games-on-whales/wolf:stable
```

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

### Compile Wolf with CMake and Ninja

Source: https://games-on-whales.github.io/wolf/stable/dev/manual_build.html

Configures the build directory and compiles the project using Ninja.

```bash
cmake -Bbuild -DCMAKE_C_FLAGS="$CFLAGS" -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 -DCMAKE_CXX_EXTENSIONS=OFF -G Ninja
ninja -C build
```

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

### Build Nvidia Driver Image

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Build a local image containing necessary Nvidia driver files.

```bash
curl https://raw.githubusercontent.com/games-on-whales/gow/master/images/nvidia-driver/Dockerfile | docker build -t gow/nvidia-driver:latest -f - --build-arg NV_VERSION=$(cat /sys/module/nvidia/version) .
```

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

### Run Wolf in Docker

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Execute the Wolf container with host networking and GPU device access.

```bash
docker run \
    --name wolf \
    --network=host \
    -v /etc/wolf:/etc/wolf:rw \
    -v /var/run/docker.sock:/var/run/docker.sock:rw \
    --device /dev/dri/ \
    ghcr.io/games-on-whales/wolf:stable
```

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

### Create Custom Sway Keyboard Configuration

Source: https://games-on-whales.github.io/wolf/stable/user/configuration.html

Define multiple keyboard layouts and enable NumLock by creating a custom configuration file for the Sway compositor.

```text
input type:keyboard {
    xkb_layout "fr,us"
    xkb_numlock "enable"
}
```

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

### Network Performance Test Output

Source: https://games-on-whales.github.io/wolf/stable/user/troubleshooting.html

Example output from a network test showing periodic packet loss and bitrate drops consistent with background scanning interference.

```text
Connecting to host <your wolf server>, port 5201
Reverse mode, remote host <your wolf server> is sending
[  5] local <your local client ip> port 53385 connected to <your wolf server> port 5201
[ ID] Interval           Transfer     Bitrate         Jitter    Lost/Total Datagrams

...
[  5]   2.00-3.00   sec  11.9 MBytes   100 Mbits/sec  0.188 ms  0/8626 (0%)
[  5]   3.00-4.00   sec  11.9 MBytes   100 Mbits/sec  0.122 ms  0/8637 (0%)
[  5]   4.00-5.00   sec  11.9 MBytes  99.9 Mbits/sec  0.135 ms  0/8620 (0%)
[  5]   5.00-6.00   sec  11.9 MBytes  99.9 Mbits/sec  0.183 ms  0/8628 (0%)
[  5]   6.00-7.00   sec  11.9 MBytes   100 Mbits/sec  0.180 ms  0/8642 (0%)
[  5]   7.00-8.00   sec  5.70 MBytes  47.8 Mbits/sec  0.143 ms  3676/7805 (47%)
[  5]   8.00-9.00   sec  5.31 MBytes  44.5 Mbits/sec  0.125 ms  4952/8798 (56%)
[  5]   9.00-10.00  sec  5.20 MBytes  43.7 Mbits/sec  0.344 ms  5456/9224 (59%)
[  5]  10.00-11.00  sec  4.49 MBytes  37.7 Mbits/sec  0.150 ms  5459/8712 (63%)
[  5]  11.00-12.00  sec  4.84 MBytes  40.5 Mbits/sec  0.146 ms  3858/7362 (52%)
[  5]  12.00-13.00  sec  6.78 MBytes  57.0 Mbits/sec  0.149 ms  4984/9896 (50%)
[  5]  13.00-14.00  sec  11.9 MBytes   100 Mbits/sec  0.154 ms  0/8645 (0%)
[  5]  14.00-15.00  sec  11.9 MBytes  99.9 Mbits/sec  0.150 ms  0/8625 (0%)
[  5]  15.00-16.00  sec  11.9 MBytes   100 Mbits/sec  0.152 ms  0/8640 (0%)
[  5]  16.00-17.00  sec  11.9 MBytes  99.9 Mbits/sec  0.153 ms  0/8620 (0%)
[  5]  17.00-18.00  sec  11.9 MBytes   100 Mbits/sec  0.144 ms  0/8638 (0%)
[  5]  18.00-19.00  sec  11.9 MBytes   100 Mbits/sec  0.171 ms  0/8630 (0%)
[  5]  19.00-20.00  sec  11.9 MBytes   100 Mbits/sec  0.138 ms  0/8632 (0%)
...
# followed by a similar dropout 300 seconds later
...
 254.00-255.00 sec  11.9 MBytes   100 Mbits/sec  0.152 ms  0/8633 (0%)
[  5] 255.00-256.00 sec  11.9 MBytes   100 Mbits/sec  0.169 ms  0/8635 (0%)
[  5] 256.00-257.00 sec  11.9 MBytes   100 Mbits/sec  0.140 ms  0/8638 (0%)
[  5] 257.00-258.00 sec  11.9 MBytes  99.9 Mbits/sec  0.161 ms  0/8624 (0%)
[  5] 258.00-259.00 sec  11.9 MBytes   100 Mbits/sec  0.191 ms  0/8627 (0%)
[  5] 259.00-260.00 sec  11.9 MBytes   100 Mbits/sec  0.148 ms  0/8639 (0%)
[  5] 260.00-261.00 sec  11.9 MBytes  99.8 Mbits/sec  0.198 ms  0/8614 (0%)
[  5] 261.00-262.00 sec  11.9 MBytes  99.8 Mbits/sec  0.207 ms  0/8616 (0%)
[  5] 262.00-263.00 sec  11.9 MBytes   100 Mbits/sec  0.261 ms  0/8647 (0%)
[  5] 263.00-264.00 sec  11.9 MBytes   100 Mbits/sec  0.160 ms  0/8653 (0%)
[  5] 264.00-265.00 sec  11.9 MBytes   100 Mbits/sec  0.153 ms  0/8635 (0%)
[  5] 265.00-266.00 sec  11.9 MBytes   100 Mbits/sec  0.162 ms  0/8635 (0%)
[  5] 266.00-267.00 sec  11.9 MBytes   100 Mbits/sec  0.144 ms  0/8625 (0%)
[  5] 267.00-268.00 sec  11.9 MBytes   100 Mbits/sec  0.159 ms  0/8643 (0%)
[  5] 268.00-269.00 sec  11.9 MBytes   100 Mbits/sec  0.159 ms  0/8627 (0%)
[  5] 269.00-270.00 sec  8.48 MBytes  71.1 Mbits/sec  0.170 ms  2468/8608 (29%)
[  5] 270.00-271.00 sec  4.69 MBytes  39.3 Mbits/sec  0.119 ms  5235/8629 (61%)
[  5] 271.00-272.00 sec  4.64 MBytes  38.9 Mbits/sec  0.147 ms  4038/7401 (55%)
[  5] 272.00-273.00 sec  5.29 MBytes  44.4 Mbits/sec  0.125 ms  5441/9272 (59%)
[  5] 273.00-274.00 sec  5.30 MBytes  44.5 Mbits/sec  0.120 ms  5368/9205 (58%)
[  5] 274.00-275.00 sec  5.88 MBytes  49.3 Mbits/sec  0.112 ms  4369/8630 (51%)
[  5] 275.00-276.00 sec  5.27 MBytes  44.2 Mbits/sec  0.156 ms  4185/8003 (52%)
[  5] 276.00-277.00 sec  11.3 MBytes  94.7 Mbits/sec  0.127 ms  1146/9310 (12%)
[  5] 277.00-278.00 sec  11.9 MBytes  99.9 Mbits/sec  0.139 ms  0/8624 (0%)
[  5] 278.00-279.00 sec  11.9 MBytes   100 Mbits/sec  0.197 ms  0/8643 (0%)
[  5] 279.00-280.00 sec  11.9 MBytes   100 Mbits/sec  0.162 ms  0/8634 (0%)
...
```

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

### Desktop Streaming Pipeline

Source: https://games-on-whales.github.io/wolf/stable/user/gstreamer.html

Configuration for capturing the desktop screen using TOML format.

```toml
[[apps]]
title = "Desktop"
[apps.video]
source = "avfvideosrc capture-screen-cursor=true capture-screen=true"
```

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

### Run Wolf with Nvidia

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Deployment configuration for Nvidia hardware requiring specific driver capabilities and GPU access.

```bash
docker run \
    --name wolf \
    --network=host \
    -v /etc/wolf:/etc/wolf:rw \
    -v /var/run/docker.sock:/var/run/docker.sock:rw \
    -e NVIDIA_DRIVER_CAPABILITIES=all \
    -e NVIDIA_VISIBLE_DEVICES=all \
    --gpus=all \
    --device /dev/dri/ \
    --device /dev/uinput \
    --device /dev/uhid \
    -v /dev/:/dev/:rw \
    -v /run/udev:/run/udev:rw \
    --device-cgroup-rule "c 13:* rmw" \
    ghcr.io/games-on-whales/wolf:stable
```

```yaml
version: "3"
services:
  wolf:
    image: ghcr.io/games-on-whales/wolf:stable
    environment:
      - NVIDIA_DRIVER_CAPABILITIES=all
      - NVIDIA_VISIBLE_DEVICES=all
    volumes:
      - /etc/wolf/:/etc/wolf
      - /var/run/docker.sock:/var/run/docker.sock:rw
      - /dev/:/dev/:rw
      - /run/udev:/run/udev:rw
    device_cgroup_rules:
      - 'c 13:* rmw'
    devices:
      - /dev/dri
      - /dev/uinput
      - /dev/uhid
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: all
              capabilities: [gpu]
    network_mode: host
    restart: unless-stopped
```

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

### Create NVIDIA driver volume

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Mount the driver image and create a persistent volume for the service.

```bash
sudo podman create --rm --mount source=nvidia-driver-vol,destination=/usr/nvidia gow/nvidia-driver:latest sh
```

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

### Build base and base-app images

Source: https://games-on-whales.github.io/wolf/stable/apps/index.html

Commands to build the hierarchical base images required for custom app development.

```shell
docker build -t gow/base images/base .
docker build -t gow/base-app --build-arg BASE_IMAGE=gow/base images/base-app .
```

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

### Load uhid module on boot

Source: https://games-on-whales.github.io/wolf/stable/user/troubleshooting.html

Ensures the uhid module is available by adding it to the system modules configuration.

```bash
echo 'uhid' | sudo tee /etc/modules-load.d/uhid.conf
```

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

### Populate Nvidia Driver Volume

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Create a container to populate the Nvidia driver volume.

```bash
docker create --rm --mount source=nvidia-driver-vol,destination=/usr/nvidia gow/nvidia-driver:latest sh
```

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

### Gstreamer CLI Utilities

Source: https://games-on-whales.github.io/wolf/stable/user/gstreamer.html

Common command-line tools for inspecting plugins, analyzing media files, and testing pipelines.

```bash
gst-inspect-1.0
```

```bash
gst-discoverer-1.0 -v https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4
```

```bash
gst-launch-1.0 videotestsrc ! autovideosink
```

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

### Configure HostConfig Bind Mount

Source: https://games-on-whales.github.io/wolf/stable/apps/pegasus.html

Add this snippet to the HostConfig section of your configuration to map host directories to the container.

```toml
"Binds": [
    "/path/to/roms:/ROMs"
]
```

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

### Mount Custom Configuration in Container

Source: https://games-on-whales.github.io/wolf/stable/user/configuration.html

Map the custom configuration file into the container's Sway directory to ensure the settings are applied.

```toml
mounts = [
    "${HOST_APPS_STATE_FOLDER}/cfg/90-custom.conf:/etc/sway/config.d/90-custom.conf",
]
```

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

### List Nvidia Driver Volumes

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Verify the existence of the Nvidia driver volume.

```bash
docker volume ls | grep nvidia-driver
```

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

### Configure udev rules for Wolf

Source: https://games-on-whales.github.io/wolf/stable/user/quickstart.html

Add these rules to your system to enable joypad support and DualSense emulation.

```udev
# Allows Wolf to acces /dev/uinput (only needed for joypad support)
KERNEL=="uinput", SUBSYSTEM=="misc", MODE="0660", GROUP="input", OPTIONS+="static_node=uinput", TAG+="uaccess"

# Allows Wolf to access /dev/uhid (only needed for DualSense emulation)
KERNEL=="uhid", GROUP="input", MODE="0660", TAG+="uaccess"

# Joypads
KERNEL=="hidraw*",   ATTRS{name}=="Wolf PS5 (virtual) pad", GROUP="root", MODE="0660", ENV{ID_SEAT}="seat9"
SUBSYSTEMS=="input", ATTRS{name}=="Wolf X-Box One (virtual) pad", GROUP="root", MODE="0660", ENV{ID_SEAT}="seat9"
SUBSYSTEMS=="input", ATTRS{name}=="Wolf PS5 (virtual) pad", GROUP="root", MODE="0660", ENV{ID_SEAT}="seat9"
SUBSYSTEMS=="input", ATTRS{name}=="Wolf gamepad (virtual) motion sensors", GROUP="root", MODE="0660", ENV{ID_SEAT}="seat9"
SUBSYSTEMS=="input", ATTRS{name}=="Wolf Nintendo (virtual) pad", GROUP="root", MODE="0660", ENV{ID_SEAT}="seat9"
```

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

### Configure Keyboard Layout via Environment Variables

Source: https://games-on-whales.github.io/wolf/stable/user/configuration.html

Set the default keyboard layout and variant by adding environment variables to the [apps.runner] section of the configuration.

```toml
[apps.runner]
env = [
    # ...
    "XKB_DEFAULT_LAYOUT=fr",
    "XKB_DEFAULT_VARIANT=azerty",
]
```

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

### Switch Keyboard Layout via Console

Source: https://games-on-whales.github.io/wolf/stable/user/configuration.html

Execute this command in the Moonlight console to cycle to the next configured keyboard layout.

```bash
swaymsg input type:keyboard xkb_switch_layout next
```

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

### Build a custom application image

Source: https://games-on-whales.github.io/wolf/stable/apps/index.html

Command to build a modified Docker image locally with a custom tag.

```shell
docker build -t gow/es-de:custom --build-arg BASE_APP_IMAGE=ghcr.io/games-on-whales/base-app:edge images/es-de .
```

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

### Intel MFX_ERR_UNSUPPORTED encoder error log

Source: https://games-on-whales.github.io/wolf/stable/user/troubleshooting.html

Log output showing a failure in the Intel QSV encoder initialization.

```text
0:01:31.983118812     1 0x7f1d50000b70 ERROR             qsvencoder gstqsvencoder.cpp:1098:gst_qsv_encoder_init_encode_session:<qsvh265enc3> MFXVideoENCODE::Query failed -3 (MFX_ERR_UNSUPPORTED)
0:01:31.983243805     1 0x7f1d50000b70 WARN            videoencoder gstvideoencoder.c:771:gst_video_encoder_setcaps:<qsvh265enc3> rejected caps video/x-raw(memory:VAMemory), width=(int)1280, height=(int)720, framerate=(fraction)60/1, format=(string)NV12, chroma-site=(string)mpeg2, colorimetry=(string)bt601
```

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

### Verify Network Stutter with iperf3

Source: https://games-on-whales.github.io/wolf/stable/user/troubleshooting.html

Run these commands to test for periodic network drops. The server command should be executed on the host machine, and the client command on the laptop.

```bash
iperf3 -s
```

```bash
iperf3 -c <your wolf server> -t 690 -u -R -b 80M
```

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

### Directly launch a Steam game

Source: https://games-on-whales.github.io/wolf/stable/apps/steam.html

Configure a custom app entry in the Wolf configuration to launch a specific Steam game using its App ID.

```toml
[[apps]]
title = "Elden Ring"
start_virtual_compositor = true

[apps.runner]
env = [
  "PROTON_LOG=1",
  "RUN_SWAY=true",
  "GOW_REQUIRED_DEVICES=/dev/input/* /dev/dri/* /dev/nvidia*",
  "STEAM_STARTUP_FLAGS=steam://rungameid/1245620"
]
# COPY EVERYTHING ELSE ...
```

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

### Clone the GOW repository

Source: https://games-on-whales.github.io/wolf/stable/apps/index.html

Initial step to obtain the source code for application images.

```shell
git clone https://github.com/games-on-whales/gow.git
```

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

### Configure Prism Launcher in config.toml

Source: https://games-on-whales.github.io/wolf/stable/apps/prismlauncher.html

Add this entry to your config.toml file to define the Prism Launcher application runner and its Docker container settings.

```toml
[[apps]]
title = "Prismlauncher"
start_virtual_compositor = true

[apps.runner]
type = "docker"
name = "Prismlauncher"
image = "ghcr.io/games-on-whales/prismlauncher:edge"
mounts = []
env = [
  "RUN_SWAY=1",
  "GOW_REQUIRED_DEVICES=/dev/input/event* /dev/dri/* /dev/nvidia* /var/lutris/",
]
devices = []
ports = []
base_create_json = """
{
  "HostConfig": {
    "IpcMode": "host",
    "CapAdd": ["NET_RAW", "MKNOD", "NET_ADMIN", "SYS_ADMIN", "SYS_NICE"],
    "Privileged": false,
    "DeviceCgroupRules": ["c 13:* rmw", "c 244:* rmw"]
  }
}
\"""
```
Tokens:
Raw