build(deps): add renovate.json

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.clang-format

@@ -7,7 +7,7 @@
 BasedOnStyle: LLVM
 AccessModifierOffset: -2
 AlignAfterOpenBracket: DontAlign
-AlignConsecutiveAssignments: Consecutive
+AlignConsecutiveAssignments: false
 AlignOperands: Align
 AllowAllArgumentsOnNextLine: false
 AllowAllConstructorInitializersOnNextLine: false
@@ -18,8 +18,9 @@ AllowShortFunctionsOnASingleLine: All
 AllowShortIfStatementsOnASingleLine: WithoutElse
 AllowShortLambdasOnASingleLine: All
 AllowShortLoopsOnASingleLine: true
-AlwaysBreakAfterReturnType: None
-AlwaysBreakTemplateDeclarations: Yes
+AlignTrailingComments: false
+AlwaysBreakAfterReturnType: All
+AlwaysBreakTemplateDeclarations: MultiLine
 BreakBeforeBraces: Custom
 BraceWrapping:
   AfterCaseLabel: false
@@ -37,32 +38,32 @@ BraceWrapping:
   SplitEmptyRecord: true
 BreakBeforeBinaryOperators: None
 BreakBeforeTernaryOperators: false
-BreakConstructorInitializers: BeforeColon
-BreakInheritanceList: BeforeColon
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
 ColumnLimit: 0
 CompactNamespaces: false
 ContinuationIndentWidth: 2
-IndentCaseLabels: false
-IndentPPDirectives: None
+IndentCaseLabels: true
+IndentPPDirectives: BeforeHash
 IndentWidth: 2
-KeepEmptyLinesAtTheStartOfBlocks: true
-MaxEmptyLinesToKeep: 2
-NamespaceIndentation: None
-ObjCSpaceAfterProperty: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCSpaceAfterProperty: true
 ObjCSpaceBeforeProtocolList: true
 PointerAlignment: Right
-ReflowComments: false
-SpaceAfterCStyleCast: false
+ReflowComments: true
+SpaceAfterCStyleCast: true
 SpaceAfterLogicalNot: false
-SpaceAfterTemplateKeyword: false
+SpaceAfterTemplateKeyword: true
 SpaceBeforeAssignmentOperators: true
 SpaceBeforeCpp11BracedList: true
-SpaceBeforeCtorInitializerColon: true
-SpaceBeforeInheritanceColon: true
-SpaceBeforeParens: Never
+SpaceBeforeCtorInitializerColon: false
+SpaceBeforeInheritanceColon: false
+SpaceBeforeParens: ControlStatements
 SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyParentheses: false
-SpacesBeforeTrailingComments: 1
+SpacesBeforeTrailingComments: 2
 SpacesInAngles: Never
 SpacesInCStyleCastParentheses: false
 SpacesInContainerLiterals: false

.codeql-prebuild-cpp.sh

@@ -0,0 +1,55 @@
+# install dependencies for C++ analysis
+
+sudo apt-get update -y
+sudo apt-get install -y \
+  build-essential \
+  gcc-10 \
+  g++-10 \
+  libayatana-appindicator3-dev \
+  libavdevice-dev \
+  libboost-filesystem-dev \
+  libboost-locale-dev \
+  libboost-log-dev \
+  libboost-program-options-dev \
+  libcap-dev \
+  libcurl4-openssl-dev \
+  libdrm-dev \
+  libevdev-dev \
+  libmfx-dev \
+  libnotify-dev \
+  libnuma-dev \
+  libopus-dev \
+  libpulse-dev \
+  libssl-dev \
+  libva-dev \
+  libvdpau-dev \
+  libwayland-dev \
+  libx11-dev \
+  libxcb-shm0-dev \
+  libxcb-xfixes0-dev \
+  libxcb1-dev \
+  libxfixes-dev \
+  libxrandr-dev \
+  libxtst-dev \
+  wget
+
+# clean apt cache
+sudo apt-get clean
+sudo rm -rf /var/lib/apt/lists/*
+
+# Update gcc alias
+# https://stackoverflow.com/a/70653945/11214013
+sudo update-alternatives --install \
+  /usr/bin/gcc gcc /usr/bin/gcc-10 100 \
+  --slave /usr/bin/g++ g++ /usr/bin/g++-10 \
+  --slave /usr/bin/gcov gcov /usr/bin/gcov-10 \
+  --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-10 \
+  --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-10
+
+# Install CUDA
+sudo wget \
+  https://developer.download.nvidia.com/compute/cuda/11.8.0/local_installers/cuda_11.8.0_520.61.05_linux.run \
+  --progress=bar:force:noscroll -q --show-progress -O /root/cuda.run
+sudo chmod a+x /root/cuda.run
+sudo /root/cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm
+sudo rm /root/cuda.run

.docker_platforms

@@ -1 +0,0 @@
-linux/amd64

.dockerignore

@@ -1,12 +1,12 @@
-# ignore git files
-.git*
-
 # ignore hidden files
 .*
 
+# do not ignore .git, needed for versioning
+!/.git
+
 # ignore repo directories and files
 docs/
-packaging/
+gh-pages-template/
 scripts/
 tools/
 crowdin.yml
@@ -14,3 +14,6 @@ crowdin.yml
 # ignore dev directories
 build/
 venv/
+
+# ignore artifacts
+artifacts/

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -22,6 +22,13 @@ body:
       options:
         - label: I have read the documentation
           required: true
+  - type: checkboxes
+    attributes:
+      label: Is your issue present in the nightly release?
+      description: Please test the [nightly](https://github.com/LizardByte/Sunshine/releases/tag/nightly-dev) release
+      options:
+        - label: This issue is present in the nightly release
+          required: true
   - type: textarea
     id: description
     attributes:
@@ -50,6 +57,8 @@ body:
         - macOS
         - Windows
         - other, n/a
+    validations:
+      required: true
   - type: input
     id: os-version
     attributes:
@@ -66,11 +75,13 @@ body:
         - 64 bit
         - arm
         - other, n/a
+    validations:
+      required: true
   - type: input
     id: version
     attributes:
       label: Sunshine commit or version
-      placeholder: eg. 0.14.0
+      placeholder: eg. 0.18.0
     validations:
       required: true
   - type: dropdown
@@ -80,17 +91,28 @@ body:
       description: The package you installed
       options:
         - Linux - AppImage
+        - Linux - AUR (Third Party)
         - Linux - deb
+        - Linux - Docker
         - Linux - flatpak
+        - Linux - nixpkgs (Third Party)
+        - Linux - PKGBUILD
+        - Linux - pkg.tar.zst
         - Linux - rpm
+        - Linux - solus (Third Party)
         - macOS - dmg
         - macOS - Portfile
-        - macOS - pkg
+        - Windows - Chocolatey (Third Party)
         - Windows - installer
         - Windows - portable
+        - Windows - Scoop (Third Party)
+        - Windows - Winget (Third Party)
         - other (not listed)
         - other (self built)
         - other (fork of this repo)
+        - n/a
+    validations:
+      required: true
   - type: dropdown
     id: graphics_type
     attributes:
@@ -101,6 +123,9 @@ body:
         - Intel
         - Nvidia
         - none (software encoding)
+        - n/a
+    validations:
+      required: true
   - type: input
     id: graphics_model
     attributes:
@@ -125,6 +150,24 @@ body:
       placeholder: e.g. PipeWire/KVM/X11/KMS
     validations:
       required: false
+  - type: textarea
+    id: config
+    attributes:
+      label: Config
+      description: |
+        Please copy and paste your config (`sunshine.conf`) file.
+      render: Shell
+    validations:
+      required: true
+  - type: textarea
+    id: apps
+    attributes:
+      label: Apps
+      description: |
+        If this is an issue with launching a game or app, please copy and paste your `apps.json` file.
+      render: json
+    validations:
+      required: false
   - type: textarea
     id: logs
     attributes:
@@ -132,9 +175,6 @@ body:
       description: |
         Please copy and paste any relevant log output. This will be automatically formatted into code,
         so no need for backticks.
-      render: Shell
-  - type: markdown
-    attributes:
-      value: |
-        Make sure to close your issue when it's solved! If you found the solution yourself please comment
-        so that others benefit from it.
+      render: shell
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -9,5 +9,5 @@ contact_links:
     url: https://app.lizardbyte.dev/support
     about: Official LizardByte support
   - name: Feature request
-    url: https://app.lizardbyte.dev/feedback
-    about: Share your suggestions or ideas to help us improve
+    url: https://ideas.moonlight-stream.org
+    about: Share your suggestions or ideas to help Moonlight and Sunshine improve

.github/dependabot.yml

@@ -9,30 +9,40 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
-      time: "00:00"
-    target-branch: "nightly"
+      time: "08:00"
     open-pull-requests-limit: 10
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"
-      time: "00:00"
-    target-branch: "nightly"
+      time: "08:30"
     open-pull-requests-limit: 10
 
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "daily"
-      time: "00:00"
-    target-branch: "nightly"
+      time: "09:00"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "09:30"
     open-pull-requests-limit: 10
 
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
       interval: "daily"
-      time: "00:00"
-    target-branch: "nightly"
+      time: "10:00"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "10:30"
     open-pull-requests-limit: 10

.github/pr_release_template.md

@@ -17,8 +17,12 @@ This PR was created automatically.
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Dependency update (updates to dependencies)
 - [ ] Documentation update (changes to documentation)
-- [ ] Repository update (changes to repository files)
+- [ ] Repository update (changes to repository files, e.g. `.github/...`)
+
+## Branch Updates
+- [x] I want maintainers to keep my branch updated
 
 ## Changelog Summary
 <!--- Summarize all the changes in a bulleted list. --->

.github/workflows/CI.yml

@@ -9,6 +9,10 @@ on:
     branches: [master, nightly]
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   github_env:
     name: GitHub Env Debug
@@ -27,7 +31,7 @@ jobs:
     steps:
       - name: Checkout
         if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Verify Changelog
         id: verify_changelog
@@ -42,6 +46,7 @@ jobs:
       last_version: ${{ steps.verify_changelog.outputs.latest_release_tag_name }}
       release_body: ${{ steps.verify_changelog.outputs.changelog_parser_description }}
 
+  # todo - remove this job once versioning is fully automated by cmake
   check_versions:
     name: Check Versions
     runs-on: ubuntu-latest
@@ -50,7 +55,7 @@ jobs:
     # base_ref for pull request check, ref for push
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Check CMakeLists.txt Version
         run: |
@@ -143,109 +148,6 @@ jobs:
     outputs:
       matrix: ${{ steps.flatpak_matrix.outputs.matrix }}
 
-  build_linux_aur:
-    name: Linux AUR
-    runs-on: ubuntu-latest
-    needs: setup_release
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Dependencies Linux AUR
-        run: |
-          sudo apt-get update -y
-          sudo apt-get install -y \
-            cmake
-
-      - name: Configure PKGBUILD files
-        run: |
-          # variables for manifest
-          echo "aur_publish=false" >> $GITHUB_ENV
-          aur_pkg=sunshine-dev
-          sub_version=""
-          conflicts="'sunshine'"
-          provides="'sunshine'"
-
-          branch=${GITHUB_HEAD_REF}
-
-          # check the branch variable
-          if [ -z "$branch" ]
-          then
-            echo "This is a PUSH event"
-            commit=${{ github.sha }}
-            clone_url=${{ github.event.repository.clone_url }}
-
-            if [[ ${{ github.ref == 'refs/heads/master' }} ]]; then
-              aur_pkg=sunshine
-              conflicts=""
-              provides=""
-
-              echo "aur_publish=true" >> $GITHUB_ENV
-            elif [[ ${{ github.ref == 'refs/heads/nightly' }} ]]; then
-              sub_version=".r${commit}"
-
-              echo "aur_publish=true" >> $GITHUB_ENV
-            fi
-          else
-            echo "This is a PR event"
-            commit=${{ github.event.pull_request.head.sha }}
-            clone_url=${{ github.event.pull_request.head.repo.clone_url }}
-
-            sub_version=".r${commit}"
-          fi
-          echo "Commit: ${commit}"
-          echo "Clone URL: ${clone_url}"
-
-          echo "aur_pkg=${aur_pkg}" >> $GITHUB_ENV
-
-          mkdir -p artifacts
-          mkdir -p build
-
-          cd build
-          cmake -DSUNSHINE_CONFIGURE_AUR=ON \
-            -DSUNSHINE_AUR_PKG=${aur_pkg} \
-            -DSUNSHINE_SUB_VERSION=${sub_version} \
-            -DSUNSHINE_AUR_CONFLICTS=${conflicts} \
-            -DSUNSHINE_AUR_PROVIDES=${provides} \
-            -DGITHUB_CLONE_URL=${clone_url} \
-            -DGITHUB_COMMIT=${commit} \
-            -DSUNSHINE_CONFIGURE_ONLY=ON \
-            ..
-          cd ..
-
-          mv ./build/PKGBUILD ./artifacts/
-
-      - name: Validate package
-        uses: hapakaien/archlinux-package-action@v2.2.0
-        with:
-          path: artifacts
-          flags: '--syncdeps --noconfirm'
-          namcap: true
-          srcinfo: true
-          aur: true  # workaround mirror problem
-
-      - name: Upload Artifacts
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v3
-        with:
-          name: sunshine-linux-aur
-          path: artifacts/
-
-      - name: Publish AUR package
-        if: ${{ env.aur_publish == 'true' }}
-        uses: KSXGitHub/github-actions-deploy-aur@v2.5.0
-        with:
-          pkgname: ${{ env.aur_pkg }}
-          pkgbuild: ./artifacts/PKGBUILD
-          assets: |
-            ./artifacts/*
-          commit_username: ${{ secrets.AUR_USERNAME }}
-          commit_email: ${{ secrets.AUR_EMAIL }}
-          ssh_private_key: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
-          commit_message: Automatic update from GitHub ${{ github.repository }} per ${{ github.ref }}
-          allow_empty_commits: false
-
   build_linux_flatpak:
     name: Linux Flatpak
     runs-on: ubuntu-22.04
@@ -255,22 +157,43 @@ jobs:
       matrix: ${{fromJson(needs.setup_flatpak_matrix.outputs.matrix)}}
 
     steps:
+      - name: Maximize build space
+        uses: easimon/maximize-build-space@v8
+        with:
+          root-reserve-mb: 10240
+          remove-dotnet: 'true'
+          remove-android: 'true'
+          remove-haskell: 'true'
+          remove-codeql: 'true'
+          remove-docker-images: 'false'
+
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Checkout Flathub Shared Modules
+        uses: actions/checkout@v4
+        with:
+          repository: flathub/shared-modules
+          path: build/shared-modules
 
       - name: Setup Dependencies Linux Flatpak
         run: |
+          PLATFORM_VERSION=22.08
+
           sudo apt-get update -y
           sudo apt-get install -y \
             cmake \
-            qemu-user-static \
-            flatpak
-          sudo su $(whoami) -c 'flatpak --user remote-add --if-not-exists flathub \
-            https://flathub.org/repo/flathub.flatpakrepo'
-          sudo su $(whoami) -c 'flatpak --user install -y flathub \
+            flatpak \
+            qemu-user-static
+          sudo su $(whoami) -c "flatpak --user remote-add --if-not-exists flathub \
+            https://flathub.org/repo/flathub.flatpakrepo"
+          sudo su $(whoami) -c "flatpak --user install -y flathub \
             org.flatpak.Builder \
-            org.freedesktop.Platform/${{ matrix.arch }}/21.08 \
-            org.freedesktop.Sdk/${{ matrix.arch }}/21.08'
+            org.freedesktop.Platform/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            org.freedesktop.Sdk/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            org.freedesktop.Sdk.Extension.node18/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            org.freedesktop.Sdk.Extension.vala/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            "
 
       - name: Cache Flatpak build
         uses: actions/cache@v3
@@ -348,46 +271,93 @@ jobs:
           prerelease: ${{ needs.setup_release.outputs.pre_release }}
 
   build_linux:
-    name: Linux
-    runs-on: ubuntu-20.04
+    name: Linux ${{ matrix.type }}
+    runs-on: ubuntu-${{ matrix.dist }}
     needs: [check_changelog, setup_release]
     strategy:
       fail-fast: false  # false to test all, true to fail entire job if any fail
       matrix:
         include:  # package these differently
-          - type: cpack
-            EXTRA_ARGS: ''
-          - type: appimage
-            EXTRA_ARGS: '-DSUNSHINE_CONFIGURE_APPIMAGE=ON'
+          - type: AppImage
+            EXTRA_ARGS: '-DSUNSHINE_BUILD_APPIMAGE=ON'
+            dist: 20.04
 
     steps:
+      - name: Maximize build space
+        uses: easimon/maximize-build-space@v8
+        with:
+          root-reserve-mb: 20480
+          remove-dotnet: 'true'
+          remove-android: 'true'
+          remove-haskell: 'true'
+          remove-codeql: 'true'
+          remove-docker-images: 'false'
+
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
       - name: Setup Dependencies Linux
         run: |
-          sudo add-apt-repository ppa:savoury1/ffmpeg4 -y
-          # sudo add-apt-repository ppa:savoury1/boost-defaults-1.71 -y
           sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
 
-          sudo apt-get update -y
+          if [[ ${{ matrix.dist }} == "18.04" ]]; then
+            # Ubuntu 18.04 packages
+            sudo add-apt-repository ppa:savoury1/boost-defaults-1.71 -y
+
+            sudo apt-get update -y
+            sudo apt-get install -y \
+              libboost-filesystem1.71-dev \
+              libboost-locale1.71-dev \
+              libboost-log1.71-dev \
+              libboost-regex1.71-dev \
+              libboost-program-options1.71-dev
+
+            # Install cmake
+            wget https://cmake.org/files/v3.22/cmake-3.22.2-linux-x86_64.sh
+            chmod +x cmake-3.22.2-linux-x86_64.sh
+            mkdir /opt/cmake
+            ./cmake-3.22.2-linux-x86_64.sh --prefix=/opt/cmake --skip-license
+            ln --force --symbolic /opt/cmake/bin/cmake /usr/local/bin/cmake
+            cmake --version
+
+            # install newer tar from focal... appimagelint fails on 18.04 without this
+            echo "original tar version"
+            tar --version
+            wget -O tar.deb http://security.ubuntu.com/ubuntu/pool/main/t/tar/tar_1.30+dfsg-7ubuntu0.20.04.2_amd64.deb
+            sudo apt-get -y install -f ./tar.deb
+            echo "new tar version"
+            tar --version
+          else
+            # Ubuntu 20.04+ packages
+            sudo apt-get update -y
+            sudo apt-get install -y \
+              cmake \
+              libboost-filesystem-dev \
+              libboost-locale-dev \
+              libboost-log-dev \
+              libboost-program-options-dev
+          fi
+
           sudo apt-get install -y \
             build-essential \
-            cmake \
             gcc-10 \
             g++-10 \
+            libayatana-appindicator3-dev \
             libavdevice-dev \
-            libboost-filesystem-dev \
-            libboost-log-dev \
-            libboost-thread-dev \
             libcap-dev \
+            libcurl4-openssl-dev \
             libdrm-dev \
             libevdev-dev \
-            libpulse-dev \
+            libmfx-dev \
+            libnotify-dev \
+            libnuma-dev \
             libopus-dev \
+            libpulse-dev \
             libssl-dev \
+            libva-dev \
+            libvdpau-dev \
             libwayland-dev \
             libx11-dev \
             libxcb-shm0-dev \
@@ -397,46 +367,39 @@ jobs:
             libxrandr-dev \
             libxtst-dev \
             wget
-          # # Ubuntu 20.04+ packages
-          # libboost-filesystem-dev
-          # libboost-log-dev
-          # libboost-thread-dev
-
-          # # Ubuntu 18.04 packages
-          # libboost-filesystem1.71-dev \
-          # libboost-log1.71-dev \
-          # libboost-regex1.71-dev \
-          # libboost-thread1.71-dev \
 
           # clean apt cache
           sudo apt-get clean
           sudo rm -rf /var/lib/apt/lists/*
 
           # Update gcc alias
+          # https://stackoverflow.com/a/70653945/11214013
           sudo update-alternatives --install \
-            /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10
+            /usr/bin/gcc gcc /usr/bin/gcc-10 100 \
+            --slave /usr/bin/g++ g++ /usr/bin/g++-10 \
+            --slave /usr/bin/gcov gcov /usr/bin/gcov-10 \
+            --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-10 \
+            --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-10
 
-          # Install CuDA
+          # Install CUDA
           sudo wget \
-            https://developer.download.nvidia.com/compute/cuda/11.4.2/local_installers/cuda_11.4.2_470.57.02_linux.run \
+            https://developer.download.nvidia.com/compute/cuda/11.8.0/local_installers/cuda_11.8.0_520.61.05_linux.run \
             --progress=bar:force:noscroll -q --show-progress -O /root/cuda.run
           sudo chmod a+x /root/cuda.run
           sudo /root/cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm
           sudo rm /root/cuda.run
 
-          # # Install cmake (necessary for 18.04)
-          # wget https://cmake.org/files/v3.22/cmake-3.22.2-linux-x86_64.sh
-          # chmod +x cmake-3.22.2-linux-x86_64.sh
-          # mkdir /opt/cmake
-          # ./cmake-3.22.2-linux-x86_64.sh --prefix=/opt/cmake --skip-license
-          # ln --force --symbolic /opt/cmake/bin/cmake /usr/local/bin/cmake
-          # cmake --version
-
       - name: Build Linux
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }}
+          COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
         run: |
           mkdir -p build
           mkdir -p artifacts
 
+          npm install
+
           cd build
           cmake -DCMAKE_BUILD_TYPE=Release \
             -DCMAKE_INSTALL_PREFIX=/usr \
@@ -451,25 +414,26 @@ jobs:
           make -j ${nproc}
 
       - name: Package Linux - CPACK
+        # todo - this is no longer used
         if: ${{ matrix.type == 'cpack' }}
         working-directory: build
         run: |
-          # package
           cpack -G DEB
-          cpack -G RPM
+          mv ./cpack_artifacts/Sunshine.deb ../artifacts/sunshine-${{ matrix.dist }}.deb
 
-          # move
-          mv ./cpack_artifacts/Sunshine.deb ../artifacts/sunshine.deb
-          mv ./cpack_artifacts/Sunshine.rpm ../artifacts/sunshine.rpm
+          if [[ ${{ matrix.dist }} == "20.04" ]]; then
+            cpack -G RPM
+            mv ./cpack_artifacts/Sunshine.rpm ../artifacts/sunshine.rpm
+          fi
 
       - name: Set AppImage Version
-        if: ${{ matrix.type == 'appimage' && ( needs.check_changelog.outputs.next_version_bare != needs.check_changelog.outputs.last_version ) }}  # yamllint disable-line rule:line-length
+        if: ${{ matrix.type == 'AppImage' && ( needs.check_changelog.outputs.next_version_bare != needs.check_changelog.outputs.last_version ) }}  # yamllint disable-line rule:line-length
         run: |
           version=${{ needs.check_changelog.outputs.next_version_bare }}
           echo "VERSION=${version}" >> $GITHUB_ENV
 
       - name: Package Linux - AppImage
-        if: ${{ matrix.type == 'appimage' }}
+        if: ${{ matrix.type == 'AppImage' }}
         working-directory: build
         run: |
           # install sunshine to the DESTDIR
@@ -488,14 +452,18 @@ jobs:
           wget https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage
           chmod +x linuxdeploy-x86_64.AppImage
 
+          # https://github.com/linuxdeploy/linuxdeploy-plugin-gtk
+          sudo apt-get install libgtk-3-dev librsvg2-dev -y
+          wget https://raw.githubusercontent.com/linuxdeploy/linuxdeploy-plugin-gtk/master/linuxdeploy-plugin-gtk.sh
+          chmod +x linuxdeploy-plugin-gtk.sh
+          export DEPLOY_GTK_VERSION=3
+
           ./linuxdeploy-x86_64.AppImage \
             --appdir ./AppDir \
+            --plugin gtk \
             --executable ./sunshine \
             --icon-file "../$ICON_FILE" \
             --desktop-file "./$DESKTOP_FILE" \
-            --library /usr/lib/x86_64-linux-gnu/libpango-1.0.so.0 \
-            --library /usr/lib/x86_64-linux-gnu/libpangocairo-1.0.so.0 \
-            --library /usr/lib/x86_64-linux-gnu/libpangoft2-1.0.so.0 \
             --output appimage
 
           # move
@@ -505,7 +473,7 @@ jobs:
           chmod +x ../artifacts/sunshine.AppImage
 
       - name: Verify AppImage
-        if: ${{ matrix.type == 'appimage' }}
+        if: ${{ matrix.type == 'AppImage' }}
         run: |
           wget https://github.com/TheAssassin/appimagelint/releases/download/continuous/appimagelint-x86_64.AppImage
           chmod +x appimagelint-x86_64.AppImage
@@ -517,7 +485,7 @@ jobs:
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3
         with:
-          name: sunshine-linux-${{ matrix.type }}
+          name: sunshine-linux-${{ matrix.type }}-${{ matrix.dist }}
           path: artifacts/
 
       - name: Create/Update GitHub Release
@@ -537,24 +505,30 @@ jobs:
   build_mac:
     name: MacOS
     runs-on: macos-11
-    needs: setup_release
+    needs: [check_changelog, setup_release]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
       - name: Setup Dependencies MacOS
         run: |
           # install dependencies using homebrew
-          brew install boost cmake ffmpeg opus
+          brew install boost cmake curl node opus pkg-config
 
           # fix openssl header not found
           ln -sf /usr/local/opt/openssl/include/openssl /usr/local/include/openssl
 
       - name: Build MacOS
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }}
+          COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
         run: |
+          npm install
+
           mkdir build
           cd build
           cmake -DCMAKE_BUILD_TYPE=Release \
@@ -571,13 +545,10 @@ jobs:
 
           # package
           cpack -G DragNDrop
-          mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-macos-experimental-dragndrop.dmg
+          mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine.dmg
 
-          cpack -G Bundle
-          mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-macos-experimental-bundle.dmg
-
-          cpack -G ZIP
-          mv ./cpack_artifacts/Sunshine.zip ../artifacts/sunshine-macos-experimental-archive.zip
+          # cpack -G Bundle
+          # mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-bundle.dmg
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3
@@ -585,48 +556,38 @@ jobs:
           name: sunshine-macos
           path: artifacts/
 
-      # this step can be removed after packages are fixed
-      - name: Delete experimental packages
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
-        working-directory: artifacts
-        run: |
-          rm -f ./sunshine-macos-experimental-dragndrop.dmg
-          rm -f ./sunshine-macos-experimental-bundle.dmg
-          rm -f ./sunshine-macos-experimental-archive.zip
-
-#      #  no artifacts to release currently
-#      - name: Create/Update GitHub Release
-#        if: ${{ needs.setup_release.outputs.create_release == 'true' }}
-#        uses: ncipollo/release-action@v1
-#        with:
-#          name: ${{ needs.setup_release.outputs.release_name }}
-#          tag: ${{ needs.setup_release.outputs.release_tag }}
-#          commit: ${{ needs.setup_release.outputs.release_commit }}
-#          artifacts: "*artifacts/*"
-#          token: ${{ secrets.GH_BOT_TOKEN }}
-#          allowUpdates: true
-#          body: ${{ needs.setup_release.outputs.release_body }}
-#          discussionCategory: announcements
-#          prerelease: ${{ needs.setup_release.outputs.pre_release }}
+      - name: Create/Update GitHub Release
+        if: ${{ needs.setup_release.outputs.create_release == 'true' }}
+        uses: ncipollo/release-action@v1
+        with:
+          name: ${{ needs.setup_release.outputs.release_name }}
+          tag: ${{ needs.setup_release.outputs.release_tag }}
+          commit: ${{ needs.setup_release.outputs.release_commit }}
+          artifacts: "*artifacts/*"
+          token: ${{ secrets.GH_BOT_TOKEN }}
+          allowUpdates: true
+          body: ${{ needs.setup_release.outputs.release_body }}
+          discussionCategory: announcements
+          prerelease: ${{ needs.setup_release.outputs.pre_release }}
 
   build_mac_port:
     name: Macports
-    needs: setup_release
+    needs: [check_changelog, setup_release]
     runs-on: macos-11
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Checkout ports
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: macports/macports-ports
           fetch-depth: 64
           path: ports
 
       - name: Checkout mpbb
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: macports/mpbb
           path: mpbb
@@ -657,7 +618,8 @@ jobs:
 
           mkdir build
           cd build
-          cmake -DGITHUB_COMMIT=${commit} \
+          cmake \
+            -DGITHUB_COMMIT=${commit} \
             -DGITHUB_CLONE_URL=${clone_url} \
             -DSUNSHINE_CONFIGURE_PORTFILE=ON \
             -DSUNSHINE_CONFIGURE_ONLY=ON \
@@ -685,123 +647,33 @@ jobs:
           echo "/opt/local/bin" >> $GITHUB_PATH
           echo "/opt/local/sbin" >> $GITHUB_PATH
 
-      - name: Determine list of subports
-        id: subportlist
+      - name: Run port lint
         run: |
-          set -eu
-          port=Sunshine
-          subportlist=""
+          port -q lint "Sunshine"
 
-          echo "Listing subports for Sunshine"
-          new_subports=$(mpbb \
-            --work-dir /tmp/mpbb \
-            list-subports \
-            --archive-site= \
-            --archive-site-private= \
-            --include-deps=no \
-            "$port" \
-            | tr '\n' ' ')
-          for subport in $new_subports; do
-            echo "$subport"
-            subportlist="$subportlist $subport"
-          done
-          echo "subportlist=${subportlist}" >> $GITHUB_OUTPUT
-
-      - name: Run port lint for all subports
-        run: |
-          set -eu
-          fail=0
-          for subport in $subportlist; do
-            echo "::group::${subport}"
-            path=$(port file "$subport")
-            messagetype="warning"
-            if ! messages=$(port -q lint "$subport" 2>&1); then
-              messagetype="error"
-              fail=1
-            fi
-            if [ -n "$messages" ]; then
-              echo "$messages"
-              # See https://github.com/actions/toolkit/issues/193#issuecomment-605394935
-              encoded_messages="port lint ${subport}:%0A"
-              encoded_messages+="$(echo "${messages}" | sed -E 's/$/%0A/g' | tr -d '\n')"
-              echo "::${messagetype} file=${path#${PWD}/ports/},line=1,col=1::${encoded_messages}"
-            fi
-            echo "::endgroup::"
-          done
-          exit "$fail"
+      - name: Build port
         env:
           subportlist: ${{ steps.subportlist.outputs.subportlist }}
-
-      - name: Build subports
         run: |
-          set -eu
-          fail=0
-          for subport in $subportlist; do
-            workdir="/tmp/mpbb/$subport"
-            mkdir -p "$workdir/logs"
-            touch "$workdir/logs/dependencies-progress.txt"
-            echo "::group::Cleaning up between ports"
-            sudo mpbb --work-dir "$workdir" cleanup
-            echo "::endgroup::"
-            echo "::group::Installing dependencies for ${subport}"
-            sudo mpbb \
-              --work-dir "$workdir" \
-              install-dependencies \
-              "$subport" >"$workdir/logs/install-dependencies.log" 2>&1 &
-            deps_pid=$!
-            tail -f "$workdir/logs/dependencies-progress.txt" 2>/dev/null &
-            tail_pid=$!
-            set +e
-            wait "$deps_pid"
-            deps_exit=$?
-            set -e
-            kill "$tail_pid" || true
-            if [ "$deps_exit" -ne 0 ]; then
-              echo "::endgroup::"
-              echo "::error::Failed to install dependencies for ${subport}"
-              fail=1
-              continue
-            fi
-            echo "::endgroup::"
-            echo "::group::Installing ${subport}"
-            set +e
-            sudo mpbb \
-              --work-dir "$workdir" \
-              install-port \
-              --source \
-              "$subport"
-            install_exit=$?
-            set -e
-            if [ "$install_exit" -ne 0 ]; then
-              echo "::endgroup::"
-              echo "::error::Failed to install ${subport}"
-              fail=1
-              continue
-            fi
-            echo "::endgroup::"
-          done
-          exit "$fail"
-        env:
-          subportlist: ${{ steps.subportlist.outputs.subportlist }}
+          subport="Sunshine"
 
-      - name: Package
-        run: |
-          # create packages
-          sudo port pkg sunshine
-          sudo port dmg sunshine
+          workdir="/tmp/mpbb/$subport"
+          mkdir -p "$workdir/logs"
 
-          work=$(port work sunshine)
-          echo "Sunshine port work directory: ${work}"
+          echo "::group::Installing dependencies"
+          sudo mpbb \
+            --work-dir "$workdir" \
+            install-dependencies \
+            "$subport"
+          echo "::endgroup::"
 
-          # move components out of port work directory
-          sudo mv ${work}/Sunshine*component.pkg /tmp/
-
-          # copy artifacts
-          sudo mv ${work}/Sunshine*.pkg ./artifacts/sunshine.pkg
-          sudo mv ${work}/Sunshine*.dmg ./artifacts/sunshine.dmg
-
-          # move components back
-          # sudo mv /tmp/Sunshine*component.pkg ${work}/
+          echo "::group::Installing ${subport}"
+          sudo mpbb \
+            --work-dir "$workdir" \
+            install-port \
+            --source \
+            "$subport"
+          echo "::endgroup::"
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3
@@ -826,11 +698,11 @@ jobs:
   build_win:
     name: Windows
     runs-on: windows-2019
-    needs: setup_release
+    needs: [check_changelog, setup_release]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -846,24 +718,34 @@ jobs:
             mingw-w64-x86_64-binutils
             mingw-w64-x86_64-boost
             mingw-w64-x86_64-cmake
+            mingw-w64-x86_64-curl
+            mingw-w64-x86_64-onevpl
             mingw-w64-x86_64-nsis
             mingw-w64-x86_64-openssl
             mingw-w64-x86_64-opus
             mingw-w64-x86_64-toolchain
-            mingw-w64-x86_64-x265
             nasm
+            wget
             yasm
 
+      - name: Install npm packages
+        run: |
+          npm install
+
       - name: Build Windows
         shell: msys2 {0}
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }}
+          COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
         run: |
           mkdir build
           cd build
-          cmake -DCMAKE_BUILD_TYPE=Release \
+          cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo \
             -DSUNSHINE_ASSETS_DIR=assets \
             -G "MinGW Makefiles" \
             ..
-          mingw32-make -j2
+          mingw32-make -j$(nproc)
 
       - name: Package Windows
         shell: msys2 {0}
@@ -876,8 +758,17 @@ jobs:
           cpack -G ZIP
 
           # move
-          mv ./cpack_artifacts/Sunshine.exe ../artifacts/sunshine-windows.exe
-          mv ./cpack_artifacts/Sunshine.zip ../artifacts/sunshine-windows.zip
+          mv ./cpack_artifacts/Sunshine.exe ../artifacts/sunshine-windows-installer.exe
+          mv ./cpack_artifacts/Sunshine.zip ../artifacts/sunshine-windows-portable.zip
+
+      - name: Package Windows Debug Info
+        working-directory: build
+        run: |
+          # save the original binaries with debug info
+          7z -r `
+            "-xr!CMakeFiles" `
+            "-xr!cpack_artifacts" `
+            a "../artifacts/sunshine-debuginfo-win32.zip" "*.exe"
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3
@@ -901,12 +792,15 @@ jobs:
 
   release-winget:
     name: Release to WinGet
-    needs: build_win
-    if: ${{ needs.setup_release.outputs.create_release == 'true' && github.ref == 'refs/heads/master' }}
-    runs-on: windows-latest  # the required action can only be run on Windows
+    needs: [setup_release, build_win]
+    if: |
+      (github.repository_owner == 'LizardByte' &&
+      needs.setup_release.outputs.create_release == 'true' &&
+      github.ref == 'refs/heads/master')
+    runs-on: ubuntu-latest
     steps:
       - name: Release to WinGet
-        uses: vedantmgoyal2009/winget-releaser@v1
+        uses: vedantmgoyal2009/winget-releaser@v2
         with:
           identifier: LizardByte.Sunshine
           release-tag: ${{ needs.setup_release.outputs.release_tag }}

.github/workflows/auto-create-pr.yml

@@ -3,6 +3,9 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# This workflow  creates a PR automatically when anything is merged/pushed into the `nightly` branch. The PR is created
+# against the `master` (default) branch.
+
 name: Auto create PR
 
 on:
@@ -12,11 +15,12 @@ on:
 
 jobs:
   create_pr:
+    if: startsWith(github.repository, 'LizardByte/')
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Create Pull Request
         uses: repo-sync/pull-request@v2

.github/workflows/automerge.yml

@@ -3,6 +3,8 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# This workflow will, first, automatically approve PRs created by @LizardByte-bot. Then it will automerge relevant PRs.
+
 name: Automerge PR
 
 on:
@@ -11,11 +13,16 @@ on:
       - opened
       - synchronize
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   autoapprove:
-    if: >
+    if: >-
       contains(fromJson('["LizardByte-bot"]'), github.event.pull_request.user.login) &&
-      contains(fromJson('["LizardByte-bot"]'), github.actor)
+      contains(fromJson('["LizardByte-bot"]'), github.actor) &&
+      startsWith(github.repository, 'LizardByte/')
     runs-on: ubuntu-latest
     steps:
       - name: Autoapproving
@@ -36,20 +43,18 @@ jobs:
             })
 
   automerge:
+    if: startsWith(github.repository, 'LizardByte/')
     needs: [autoapprove]
     runs-on: ubuntu-latest
-    concurrency:
-      group: automerge-${{ github.ref }}
-      cancel-in-progress: true
 
     steps:
       - name: Automerging
-        uses: pascalgn/automerge-action@v0.15.5
+        uses: pascalgn/automerge-action@v0.15.6
         env:
           BASE_BRANCHES: nightly
           GITHUB_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
           GITHUB_LOGIN: ${{ secrets.GH_BOT_NAME }}
-          MERGE_LABELS: ""
+          MERGE_LABELS: "!dependencies"
           MERGE_METHOD: "squash"
           MERGE_COMMIT_MESSAGE: "{pullRequest.title} (#{pullRequest.number})"
           MERGE_DELETE_BRANCH: true

.github/workflows/autoupdate.yml

@@ -1,32 +0,0 @@
----
-# This action is centrally managed in https://github.com/<organization>/.github/
-# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
-# the above-mentioned repo.
-
-# This workflow is designed to work with:
-# - automerge workflows
-
-# It uses GitHub Action that auto-updates pull requests branches, when changes are pushed to their destination branch.
-# Auto-updating to the latest destination branch works only in the context of upstream repo and not forks.
-
-name: autoupdate
-
-on:
-  push:
-    branches:
-      - 'nightly'
-
-jobs:
-  autoupdate-for-bot:
-    name: Autoupdate autoapproved PR created in the upstream
-    if: startsWith(github.repository, 'LizardByte/')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Update
-        uses: docker://chinthakagodawita/autoupdate-action:v1
-        env:
-          GITHUB_TOKEN: '${{ secrets.GH_BOT_TOKEN }}'
-          PR_FILTER: "labelled"
-          PR_LABELS: "autoupdate"
-          PR_READY_STATE: "ready_for_review"
-          MERGE_CONFLICT_ACTION: "ignore"

.github/workflows/ci-docker.yml

@@ -3,6 +3,21 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# This workflow is intended to work with all our organization Docker projects. A readme named `DOCKER_README.md`
+# will be used to update the description on Docker hub.
+
+# custom comments in dockerfiles:
+
+# `# platforms: `
+#    Comma separated list of platforms, i.e. `# platforms: linux/386,linux/amd64`. Docker platforms can alternatively
+#    be listed in a file named `.docker_platforms`.
+# `# platforms_pr: `
+#    Comma separated list of platforms to run for PR events, i.e. `# platforms_pr: linux/amd64`. This will take
+#    precedence over the `# platforms: ` directive.
+# `# artifacts: `
+#    `true` to build in two steps, stopping at `artifacts` build stage and extracting the image from there to the
+#    GitHub runner.
+
 name: CI Docker
 
 on:
@@ -13,62 +28,65 @@ on:
     branches: [master, nightly]
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  check_dockerfile:
-    name: Check Dockerfile
+  check_dockerfiles:
+    name: Check Dockerfiles
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Check
-        id: check
+      - name: Find dockerfiles
+        id: find
         run: |
-          if [ -f "./Dockerfile" ]
-          then
-            FOUND=true
-          else
-            FOUND=false
-          fi
+          dockerfiles=$(find . -type f -iname "Dockerfile" -o -iname "*.dockerfile")
 
-          echo "dockerfile=${FOUND}" >> $GITHUB_OUTPUT
+          echo "found dockerfiles: ${dockerfiles}"
+
+          # do not quote to keep this as a single line
+          echo dockerfiles=${dockerfiles} >> $GITHUB_OUTPUT
+
+          MATRIX_COMBINATIONS=""
+          for FILE in ${dockerfiles}; do
+            # extract tag from file name
+            tag=$(echo $FILE | sed -r -z -e 's/(\.\/)*.*\/(Dockerfile)/None/gm')
+            if [[ $tag == "None" ]]; then
+              MATRIX_COMBINATIONS="$MATRIX_COMBINATIONS {\"dockerfile\": \"$FILE\"},"
+            else
+              tag=$(echo $FILE | sed -r -z -e 's/(\.\/)*.*\/(.+)(\.dockerfile)/-\2/gm')
+              MATRIX_COMBINATIONS="$MATRIX_COMBINATIONS {\"dockerfile\": \"$FILE\", \"tag\": \"$tag\"},"
+            fi
+          done
+
+          # removes the last character (i.e. comma)
+          MATRIX_COMBINATIONS=${MATRIX_COMBINATIONS::-1}
+
+          # setup matrix for later jobs
+          matrix=$((
+            echo "{ \"include\": [$MATRIX_COMBINATIONS] }"
+          ) | jq -c .)
+
+          echo $matrix
+          echo $matrix | jq .
+          echo "matrix=$matrix" >> $GITHUB_OUTPUT
 
     outputs:
-      dockerfile: ${{ steps.check.outputs.dockerfile }}
-
-  lint_dockerfile:
-    name: Lint Dockerfile
-    needs: [check_dockerfile]
-    if: ${{ needs.check_dockerfile.outputs.dockerfile == 'true' }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Hadolint
-        id: hadolint
-        uses: hadolint/hadolint-action@v2.1.0
-        with:
-          dockerfile: ./Dockerfile
-          ignore: DL3008,DL3013,DL3016,DL3018,DL3028,DL3059
-          output-file: ./hadolint.log
-          verbose: true
-
-      - name: Log
-        if: failure()
-        run: |
-          echo "Hadolint outcome: ${{ steps.hadolint.outcome }}" >> $GITHUB_STEP_SUMMARY
-          cat "./hadolint.log" >> $GITHUB_STEP_SUMMARY
+      dockerfiles: ${{ steps.find.outputs.dockerfiles }}
+      matrix: ${{ steps.find.outputs.matrix }}
 
   check_changelog:
     name: Check Changelog
-    needs: [check_dockerfile]
-    if: ${{ needs.check_dockerfile.outputs.dockerfile == 'true' }}
+    needs: [check_dockerfiles]
+    if: ${{ needs.check_dockerfiles.outputs.dockerfiles }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Verify Changelog
         id: verify_changelog
@@ -79,34 +97,138 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
     outputs:
       next_version: ${{ steps.verify_changelog.outputs.changelog_parser_version }}
+      next_version_bare: ${{ steps.verify_changelog.outputs.changelog_parser_version_bare }}
+      last_version: ${{ steps.verify_changelog.outputs.latest_release_tag_name }}
+      release_body: ${{ steps.verify_changelog.outputs.changelog_parser_description }}
+
+  setup_release:
+    name: Setup Release
+    needs: check_changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set release details
+        id: release_details
+        env:
+          RELEASE_BODY: ${{ needs.check_changelog.outputs.release_body }}
+        run: |
+          # determine to create a release or not
+          if [[ $GITHUB_EVENT_NAME == "push" ]]; then
+            RELEASE=true
+          else
+            RELEASE=false
+          fi
+
+          # set the release tag
+          COMMIT=${{ github.sha }}
+          if [[ $GITHUB_REF == refs/heads/master ]]; then
+            TAG="${{ needs.check_changelog.outputs.next_version }}"
+            RELEASE_NAME="${{ needs.check_changelog.outputs.next_version }}"
+            RELEASE_BODY="$RELEASE_BODY"
+            PRE_RELEASE="false"
+          elif [[ $GITHUB_REF == refs/heads/nightly ]]; then
+            TAG="nightly-dev"
+            RELEASE_NAME="nightly"
+            RELEASE_BODY="automated nightly release - $(date -u +'%Y-%m-%dT%H:%M:%SZ') - ${COMMIT}"
+            PRE_RELEASE="true"
+          fi
+
+          echo "create_release=${RELEASE}" >> $GITHUB_OUTPUT
+          echo "release_tag=${TAG}" >> $GITHUB_OUTPUT
+          echo "release_commit=${COMMIT}" >> $GITHUB_OUTPUT
+          echo "release_name=${RELEASE_NAME}" >> $GITHUB_OUTPUT
+          echo "pre_release=${PRE_RELEASE}" >> $GITHUB_OUTPUT
+
+          # this is stupid but works for multiline strings
+          echo "RELEASE_BODY<<EOF" >> $GITHUB_ENV
+          echo "$RELEASE_BODY" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+    outputs:
+      create_release: ${{ steps.release_details.outputs.create_release }}
+      release_tag: ${{ steps.release_details.outputs.release_tag }}
+      release_commit: ${{ steps.release_details.outputs.release_commit }}
+      release_name: ${{ steps.release_details.outputs.release_name }}
+      release_body: ${{ env.RELEASE_BODY }}
+      pre_release: ${{ steps.release_details.outputs.pre_release }}
+
+  lint_dockerfile:
+    needs: [check_dockerfiles]
+    if: ${{ needs.check_dockerfiles.outputs.dockerfiles }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.check_dockerfiles.outputs.matrix) }}
+    name: Lint Dockerfile${{ matrix.tag }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Hadolint
+        id: hadolint
+        uses: hadolint/hadolint-action@v3.1.0
+        with:
+          dockerfile: ${{ matrix.dockerfile }}
+          ignore: DL3008,DL3013,DL3016,DL3018,DL3028,DL3059
+          output-file: ./hadolint.log
+          verbose: true
+
+      - name: Log
+        if: failure()
+        run: |
+          echo "Hadolint outcome: ${{ steps.hadolint.outcome }}" >> $GITHUB_STEP_SUMMARY
+          cat "./hadolint.log" >> $GITHUB_STEP_SUMMARY
 
   docker:
-    name: Docker
-    needs: [check_dockerfile, check_changelog]
-    if: ${{ needs.check_dockerfile.outputs.dockerfile == 'true' }}
+    needs: [check_dockerfiles, check_changelog, setup_release]
+    if: ${{ needs.check_dockerfiles.outputs.dockerfiles }}
     runs-on: ubuntu-latest
     permissions:
       packages: write
       contents: write
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.check_dockerfiles.outputs.matrix) }}
+    name: Docker${{ matrix.tag }}
 
     steps:
+      - name: Maximize build space
+        uses: easimon/maximize-build-space@v8
+        with:
+          root-reserve-mb: 30720  # https://github.com/easimon/maximize-build-space#caveats
+          remove-dotnet: 'true'
+          remove-android: 'true'
+          remove-haskell: 'true'
+          remove-codeql: 'true'
+          remove-docker-images: 'true'
+
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
       - name: Prepare
         id: prepare
         env:
-          NEXT_VERSION: ${{ needs.check_changelog.outputs.next_version }}
+          NV: ${{ needs.check_changelog.outputs.next_version }}
         run: |
           # get branch name
           BRANCH=${GITHUB_HEAD_REF}
 
-          if [ -z "$BRANCH" ]
-          then
+          RELEASE=false
+
+          if [ -z "$BRANCH" ]; then
             echo "This is a PUSH event"
             BRANCH=${{ github.ref_name }}
+            COMMIT=${{ github.sha }}
+            CLONE_URL=${{ github.event.repository.clone_url }}
+            if [[ $BRANCH == "master" ]]; then
+              RELEASE=true
+            fi
+          else
+            echo "This is a PULL REQUEST event"
+            COMMIT=${{ github.event.pull_request.head.sha }}
+            CLONE_URL=${{ github.event.pull_request.head.repo.clone_url }}
           fi
 
           # determine to push image to dockerhub and ghcr or not
@@ -119,68 +241,132 @@ jobs:
           # setup the tags
           REPOSITORY=${{ github.repository }}
           BASE_TAG=$(echo $REPOSITORY | tr '[:upper:]' '[:lower:]')
-          COMMIT=${{ github.sha }}
 
-          TAGS="${BASE_TAG}:${COMMIT:0:7},ghcr.io/${BASE_TAG}:${COMMIT:0:7}"
+          TAGS="${BASE_TAG}:${COMMIT:0:7}${{ matrix.tag }},ghcr.io/${BASE_TAG}:${COMMIT:0:7}${{ matrix.tag }}"
 
           if [[ $GITHUB_REF == refs/heads/master ]]; then
-            TAGS="${TAGS},${BASE_TAG}:latest,ghcr.io/${BASE_TAG}:latest"
-            TAGS="${TAGS},${BASE_TAG}:master,ghcr.io/${BASE_TAG}:master"
+            TAGS="${TAGS},${BASE_TAG}:latest${{ matrix.tag }},ghcr.io/${BASE_TAG}:latest${{ matrix.tag }}"
+            TAGS="${TAGS},${BASE_TAG}:master${{ matrix.tag }},ghcr.io/${BASE_TAG}:master${{ matrix.tag }}"
           elif [[ $GITHUB_REF == refs/heads/nightly ]]; then
-            TAGS="${TAGS},${BASE_TAG}:nightly,ghcr.io/${BASE_TAG}:nightly"
+            TAGS="${TAGS},${BASE_TAG}:nightly${{ matrix.tag }},ghcr.io/${BASE_TAG}:nightly${{ matrix.tag }}"
           else
-            TAGS="${TAGS},${BASE_TAG}:test,ghcr.io/${BASE_TAG}:test"
+            TAGS="${TAGS},${BASE_TAG}:test${{ matrix.tag }},ghcr.io/${BASE_TAG}:test${{ matrix.tag }}"
           fi
 
-          if [[ ${NEXT_VERSION} != "" ]]; then
-            TAGS="${TAGS},${BASE_TAG}:${NEXT_VERSION},ghcr.io/${BASE_TAG}:${NEXT_VERSION}"
+          if [[ ${NV} != "" ]]; then
+            TAGS="${TAGS},${BASE_TAG}:${NV}${{ matrix.tag }},ghcr.io/${BASE_TAG}:${NV}${{ matrix.tag }}"
           fi
 
-          # read the platforms from `.docker_platforms`
-          PLATFORMS=$(<.docker_platforms)
+          # parse custom directives out of dockerfile
+          # try to get the platforms from the dockerfile custom directive, i.e. `# platforms: xxx,yyy`
+          # directives for PR event, i.e. not push event
+          if [[ ${PUSH} == "false" ]]; then
+            while read -r line; do
+              if [[ $line == "# platforms_pr: "* && $PLATFORMS == "" ]]; then
+                # echo the line and use `sed` to remove the custom directive
+                PLATFORMS=$(echo -e "$line" | sed 's/# platforms_pr: //')
+              elif [[ $PLATFORMS != "" ]]; then
+                # break while loop once all custom "PR" event directives are found
+                break
+              fi
+            done <"${{ matrix.dockerfile }}"
+          fi
+          # directives for all events... above directives will not be parsed if they were already found
+          while read -r line; do
+            if [[ $line == "# platforms: "* && $PLATFORMS == "" ]]; then
+              # echo the line and use `sed` to remove the custom directive
+              PLATFORMS=$(echo -e "$line" | sed 's/# platforms: //')
+            elif [[ $line == "# artifacts: "* && $ARTIFACTS == "" ]]; then
+              # echo the line and use `sed` to remove the custom directive
+              ARTIFACTS=$(echo -e "$line" | sed 's/# artifacts: //')
+            elif [[ $line == "# no-cache-filters: "* && $NO_CACHE_FILTERS == "" ]]; then
+              # echo the line and use `sed` to remove the custom directive
+              NO_CACHE_FILTERS=$(echo -e "$line" | sed 's/# no-cache-filters: //')
+            elif [[ $PLATFORMS != "" && $ARTIFACTS != "" && $NO_CACHE_FILTERS != "" ]]; then
+              # break while loop once all custom directives are found
+              break
+            fi
+          done <"${{ matrix.dockerfile }}"
+          # if PLATFORMS is blank, fall back to the legacy method of reading from the `.docker_platforms` file
+          if [[ $PLATFORMS == "" ]]; then
+            # read the platforms from `.docker_platforms`
+            PLATFORMS=$(<.docker_platforms)
+          fi
+          # if PLATFORMS is still blank, fall back to `linux/amd64`
+          if [[ $PLATFORMS == "" ]]; then
+            PLATFORMS="linux/amd64"
+          fi
 
           echo "branch=${BRANCH}" >> $GITHUB_OUTPUT
           echo "build_date=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_OUTPUT
           echo "commit=${COMMIT}" >> $GITHUB_OUTPUT
+          echo "clone_url=${CLONE_URL}" >> $GITHUB_OUTPUT
+          echo "release=${RELEASE}" >> $GITHUB_OUTPUT
+          echo "artifacts=${ARTIFACTS}" >> $GITHUB_OUTPUT
+          echo "no_cache_filters=${NO_CACHE_FILTERS}" >> $GITHUB_OUTPUT
           echo "platforms=${PLATFORMS}" >> $GITHUB_OUTPUT
           echo "push=${PUSH}" >> $GITHUB_OUTPUT
           echo "tags=${TAGS}" >> $GITHUB_OUTPUT
 
       - name: Set Up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         id: buildx
 
       - name: Cache Docker Layers
         uses: actions/cache@v3
         with:
           path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          key: Docker-buildx${{ matrix.tag }}-${{ github.sha }}
           restore-keys: |
-            ${{ runner.os }}-buildx-
+            Docker-buildx${{ matrix.tag }}-
 
       - name: Log in to Docker Hub
         if: ${{ steps.prepare.outputs.push == 'true' }}  # PRs do not have access to secrets
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
 
       - name: Log in to the Container registry
         if: ${{ steps.prepare.outputs.push == 'true' }}  # PRs do not have access to secrets
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ secrets.GH_BOT_NAME }}
           password: ${{ secrets.GH_BOT_TOKEN }}
 
-      - name: Build and push
-        uses: docker/build-push-action@v3
+      - name: Build artifacts
+        if: ${{ steps.prepare.outputs.artifacts == 'true' }}
+        id: build_artifacts
+        uses: docker/build-push-action@v5
         with:
           context: ./
-          file: ./Dockerfile
+          file: ${{ matrix.dockerfile }}
+          target: artifacts
+          outputs: type=local,dest=artifacts
+          push: false
+          platforms: ${{ steps.prepare.outputs.platforms }}
+          build-args: |
+            BRANCH=${{ steps.prepare.outputs.branch }}
+            BUILD_DATE=${{ steps.prepare.outputs.build_date }}
+            BUILD_VERSION=${{ needs.check_changelog.outputs.next_version }}
+            COMMIT=${{ steps.prepare.outputs.commit }}
+            CLONE_URL=${{ steps.prepare.outputs.clone_url }}
+            RELEASE=${{ steps.prepare.outputs.release }}
+          tags: ${{ steps.prepare.outputs.tags }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+          no-cache-filters: ${{ steps.prepare.outputs.no_cache_filters }}
+
+      - name: Build and push
+        id: build
+        uses: docker/build-push-action@v5
+        with:
+          context: ./
+          file: ${{ matrix.dockerfile }}
           push: ${{ steps.prepare.outputs.push }}
           platforms: ${{ steps.prepare.outputs.platforms }}
           build-args: |
@@ -188,9 +374,45 @@ jobs:
             BUILD_DATE=${{ steps.prepare.outputs.build_date }}
             BUILD_VERSION=${{ needs.check_changelog.outputs.next_version }}
             COMMIT=${{ steps.prepare.outputs.commit }}
+            CLONE_URL=${{ steps.prepare.outputs.clone_url }}
+            RELEASE=${{ steps.prepare.outputs.release }}
           tags: ${{ steps.prepare.outputs.tags }}
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
+          no-cache-filters: ${{ steps.prepare.outputs.no_cache_filters }}
+
+      - name: Arrange Artifacts
+        if: ${{ steps.prepare.outputs.artifacts == 'true' }}
+        working-directory: artifacts
+        run: |
+          # artifacts will be in sub directories named after the docker target platform, e.g. `linux_amd64`
+          # so move files to the artifacts directory
+          # https://unix.stackexchange.com/a/52816
+          find ./ -type f -exec mv -t ./ -n '{}' +
+
+          # remove provenance file
+          rm -f ./provenance.json
+
+      - name: Upload Artifacts
+        if: ${{ steps.prepare.outputs.artifacts == 'true' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: Docker${{ matrix.tag }}
+          path: artifacts/
+
+      - name: Create/Update GitHub Release
+        if: ${{ needs.setup_release.outputs.create_release == 'true' && steps.prepare.outputs.artifacts == 'true' }}
+        uses: ncipollo/release-action@v1
+        with:
+          name: ${{ needs.setup_release.outputs.release_name }}
+          tag: ${{ needs.setup_release.outputs.release_tag }}
+          commit: ${{ needs.setup_release.outputs.release_commit }}
+          artifacts: "*artifacts/*"
+          token: ${{ secrets.GH_BOT_TOKEN }}
+          allowUpdates: true
+          body: ${{ needs.setup_release.outputs.release_body }}
+          discussionCategory: announcements
+          prerelease: ${{ needs.setup_release.outputs.pre_release }}
 
       - name: Update Docker Hub Description
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}

.github/workflows/ci-qodana.yml

@@ -0,0 +1,292 @@
+---
+# This action is centrally managed in https://github.com/<organization>/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
+# the above-mentioned repo.
+
+name: Qodana
+
+on:
+  pull_request:
+    branches: [master, nightly]
+    types: [opened, synchronize, reopened]
+  push:
+    branches: [master, nightly]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  qodana_initial_check:
+    name: Qodana Initial Check
+    permissions:
+      actions: write  # required to use workflow dispatch on fork PRs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Prepare
+        id: prepare
+        run: |
+          # check the branch variable
+          if [ "${{ github.event_name }}" == "push" ]
+          then
+            echo "This is a PUSH event"
+            # use the branch name
+            destination=${{ github.ref_name }}
+            target=${{ github.ref_name }}
+          else
+            echo "This is a PR event"
+            # use the PR number
+            destination=${{ github.event.pull_request.number }}
+            target=${{ github.event.pull_request.base.ref }}
+          fi
+
+          echo "checkout_repo=$checkout_repo" >> $GITHUB_OUTPUT
+          echo "checkout_ref=$checkout_ref" >> $GITHUB_OUTPUT
+          echo "destination=$destination" >> $GITHUB_OUTPUT
+          echo "target=$target" >> $GITHUB_OUTPUT
+
+          # prepare urls
+          base=https://${{ github.repository_owner }}.github.io
+          report_url=${base}/qodana-reports/${{ github.event.repository.name }}/${destination}
+          echo "report_url=$report_url" >> $GITHUB_OUTPUT
+
+          # build matrix
+          files=$(find . -type f -iname "qodana*.yaml")
+
+          echo "files: ${files}"
+
+          # do not quote to keep this as a single line
+          echo files=${files} >> $GITHUB_OUTPUT
+
+          MATRIX_COMBINATIONS=""
+          REPORTS_MARKDOWN=""
+          for FILE in ${files}; do
+            # extract the language from file name after `qodana-` and before `.yaml`
+              language=$(echo $FILE | sed -r -z -e 's/(\.\/)*.*\/(qodana.yaml)/default/gm')
+            if [[ $language != "default" ]]; then
+              language=$(echo $FILE | sed -r -z -e 's/(\.\/)*.*qodana-(.*).yaml/\2/gm')
+            fi
+            MATRIX_COMBINATIONS="$MATRIX_COMBINATIONS {\"file\": \"$FILE\", \"language\": \"$language\"},"
+            REPORTS_MARKDOWN="$REPORTS_MARKDOWN <br> - [${language}](${report_url}/${language})"
+          done
+
+          # removes the last character (i.e. comma)
+          MATRIX_COMBINATIONS=${MATRIX_COMBINATIONS::-1}
+
+          # setup matrix for later jobs
+          matrix=$((
+            echo "{ \"include\": [$MATRIX_COMBINATIONS] }"
+          ) | jq -c .)
+
+          echo $matrix
+          echo $matrix | jq .
+          echo "matrix=$matrix" >> $GITHUB_OUTPUT
+
+          echo "reports_markdown=$REPORTS_MARKDOWN" >> $GITHUB_OUTPUT
+
+      - name: Setup initial notification inputs
+        id: inputs
+        if: >-
+          startsWith(github.event_name, 'pull_request') &&
+          steps.prepare.outputs.files != ''
+        run: |
+          # workflow logs
+          workflow_url_a=https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }}
+          workflow_url=${workflow_url_a}/actions/runs/${{ github.run_id }}
+
+          # multiline message
+          message=$(cat <<- EOF
+            :warning: **Qodana is checking this PR** :warning:
+            Live results available [here](${workflow_url})
+          EOF
+          )
+
+          # escape json control characters
+          message=$(jq -n --arg message "$message" '$message' | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g')
+
+          secondary_inputs=$(echo '{
+            "issue_message": "'"${message}"'",
+            "issue_message_id": "'"qodana"'",
+            "issue_number": "'"${{ github.event.number }}"'",
+            "issue_repo_owner": "'"${{ github.repository_owner }}"'",
+            "issue_repo_name": "'"${{ github.event.repository.name }}"'"
+          }' | jq -r .)
+
+          #escape json control characters
+          secondary_inputs=$(jq -n --arg secondary_inputs "$secondary_inputs" '$secondary_inputs' \
+            | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g')
+
+          echo $secondary_inputs
+
+          # secondary input as string, not JSON
+          # todo - change dispatch_ref to master instead of nightly
+          primary_inputs=$(echo '{
+            "dispatch_repository": "'"${{ github.repository_owner }}/.github"'",
+            "dispatch_workflow": "'"dispatch-issue-comment.yml"'",
+            "dispatch_ref": "'"nightly"'",
+            "dispatch_inputs": "'"${secondary_inputs}"'"
+          }' | jq -c .)
+
+          echo $primary_inputs
+          echo $primary_inputs | jq .
+          echo "primary_inputs=$primary_inputs" >> $GITHUB_OUTPUT
+
+      - name: Workflow Dispatch
+        if: >-
+          startsWith(github.event_name, 'pull_request') &&
+          steps.prepare.outputs.files != ''
+        uses: benc-uk/workflow-dispatch@v1.2.2
+        continue-on-error: true  # this might error if the workflow is not found, but we still want to run the next job
+        with:
+          ref: ${{ github.base_ref || github.ref_name }}  # base ref for PR and branch name for push
+          workflow: dispatcher.yml
+          inputs: ${{ steps.inputs.outputs.primary_inputs }}
+          token: ${{ github.token }}
+
+    outputs:
+      destination: ${{ steps.prepare.outputs.destination }}
+      target: ${{ steps.prepare.outputs.target }}
+      files: ${{ steps.prepare.outputs.files }}
+      reports_markdown: ${{ steps.prepare.outputs.reports_markdown }}
+      matrix: ${{ steps.prepare.outputs.matrix }}
+
+  qodana:
+    if: ${{ needs.qodana_initial_check.outputs.files != '' }}
+    needs: [qodana_initial_check]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.qodana_initial_check.outputs.matrix) }}
+    name: Qodana-Scan-${{ matrix.language }}
+    continue-on-error: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Get baseline
+        id: baseline
+        run: |
+          # check if destination is not an integer
+          if ! [[ "${{ needs.qodana_initial_check.outputs.destination }}" =~ ^[0-9]+$ ]]
+          then
+            echo "Running for a branch update"
+            echo "baseline_args=" >> $GITHUB_OUTPUT
+          else
+            echo "Running for a PR"
+
+            sarif_file=qodana.sarif.json
+            repo=${{ github.event.repository.name }}
+            target=${{ needs.qodana_initial_check.outputs.target }}
+            language=${{ matrix.language }}
+
+            baseline_file="${repo}/${target}/${language}/results/${sarif_file}"
+            baseline_file_url="https://lizardbyte.github.io/qodana-reports/${baseline_file}"
+
+            # don't fail if file does not exist
+            wget ${baseline_file_url} || true
+
+            # check if file exists
+            if [ -f ${sarif_file} ]
+            then
+              echo "baseline exists"
+              echo "baseline_args=--baseline,${sarif_file}" >> $GITHUB_OUTPUT
+            else
+              echo "baseline does not exist"
+              echo "baseline_args=" >> $GITHUB_OUTPUT
+            fi
+          fi
+
+      - name: Rename Qodana config file
+        id: rename
+        run: |
+          # rename the file
+          if [ "${{ matrix.file }}" != "./qodana.yaml" ]
+          then
+            mv -f ${{ matrix.file }} ./qodana.yaml
+          fi
+
+      - name: Qodana
+        id: qodana
+        continue-on-error: true  # ensure dispatch-qodana job is run
+        uses: JetBrains/qodana-action@v2023.2.6
+        with:
+          additional-cache-hash: ${{ github.ref }}-${{ matrix.language }}
+          artifact-name: qodana-${{ matrix.language }}  # yamllint disable-line rule:line-length
+          args: '--print-problems,${{ steps.baseline.outputs.baseline_args }}'
+          pr-mode: false
+          upload-result: true
+          use-caches: true
+
+      - name: Set output status
+        id: status
+        run: |
+          # check if qodana failed
+          echo "qodana_status=${{ steps.qodana.outcome }}" >> $GITHUB_OUTPUT
+
+    outputs:
+      qodana_status: ${{ steps.status.outputs.qodana_status }}
+
+  dispatch-qodana:
+    # trigger qodana-reports to download artifacts from the matrix runs
+    needs: [qodana_initial_check, qodana]
+    runs-on: ubuntu-latest
+    name: Dispatch Qodana
+    permissions:
+      actions: write  # required to use workflow dispatch on fork PRs
+    if: ${{ needs.qodana_initial_check.outputs.files != '' }}
+    steps:
+      - name: Setup qodana publish inputs
+        id: inputs
+        run: |
+          # get the artifacts
+          artifacts=${{ toJson(steps.artifacts.outputs.result) }}
+          artifacts=$(echo $artifacts | jq -c .)
+
+          # get the target branch
+          target=${{ needs.qodana_initial_check.outputs.target }}
+
+          # get the destination branch
+          destination=${{ needs.qodana_initial_check.outputs.destination }}
+
+          # client payload
+          secondary_inputs=$(echo '{
+            "destination": "'"${destination}"'",
+            "ref": "'"${{ github.ref }}"'",
+            "repo": "'"${{ github.repository }}"'",
+            "repo_name": "'"${{ github.event.repository.name }}"'",
+            "run_id": "'"${{ github.run_id }}"'",
+            "reports_markdown": "'"${{ needs.qodana_initial_check.outputs.reports_markdown }}"'",
+            "status": "'"${{ needs.qodana.outputs.qodana_status }}"'"
+          }' | jq -r .)
+
+          #escape json control characters
+          secondary_inputs=$(jq -n --arg secondary_inputs "$secondary_inputs" '$secondary_inputs' \
+            | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g')
+
+          echo $secondary_inputs
+
+          primary_inputs=$(echo '{
+            "dispatch_repository": "'"${{ github.repository_owner }}/qodana-reports"'",
+            "dispatch_workflow": "'"dispatch-qodana.yml"'",
+            "dispatch_ref": "'"master"'",
+            "dispatch_inputs": "'"$secondary_inputs"'"
+          }' | jq -c .)
+
+          echo $primary_inputs
+          echo $primary_inputs | jq .
+          echo "primary_inputs=$primary_inputs" >> $GITHUB_OUTPUT
+
+      - name: Workflow Dispatch
+        uses: benc-uk/workflow-dispatch@v1.2.2
+        continue-on-error: true  # this might error if the workflow is not found, but we don't want to fail the workflow
+        with:
+          ref: ${{ github.base_ref || github.ref_name }}  # base ref for PR and branch name for push
+          workflow: dispatcher.yml
+          inputs: ${{ steps.inputs.outputs.primary_inputs }}
+          token: ${{ github.token }}

.github/workflows/codeql.yml

@@ -0,0 +1,147 @@
+---
+# This action is centrally managed in https://github.com/<organization>/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
+# the above-mentioned repo.
+
+# This workflow will analyze all supported languages in the repository using CodeQL Analysis.
+
+name: "CodeQL"
+
+on:
+  push:
+    branches: ["master", "nightly"]
+  pull_request:
+    branches: ["master", "nightly"]
+  schedule:
+    - cron: '00 12 * * 0'  # every Sunday at 12:00 UTC
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  languages:
+    name: Get language matrix
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.lang.outputs.result }}
+      continue: ${{ steps.continue.outputs.result }}
+    steps:
+      - name: Get repo languages
+        uses: actions/github-script@v6
+        id: lang
+        with:
+          script: |
+            // CodeQL supports ['cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift']
+            // Use only 'java' to analyze code written in Java, Kotlin or both
+            // Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+            // Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+            const supported_languages = ['cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift']
+
+            const remap_languages = {
+              'c++': 'cpp',
+              'c#': 'csharp',
+              'kotlin': 'java',
+              'typescript': 'javascript',
+            }
+
+            const repo = context.repo
+            const response = await github.rest.repos.listLanguages(repo)
+            let matrix = {
+              "include": []
+            }
+
+            for (let [key, value] of Object.entries(response.data)) {
+              // remap language
+              if (remap_languages[key.toLowerCase()]) {
+                console.log(`Remapping language: ${key} to ${remap_languages[key.toLowerCase()]}`)
+                key = remap_languages[key.toLowerCase()]
+              }
+              if (supported_languages.includes(key.toLowerCase()) &&
+                  !matrix['include'].includes({"language": key.toLowerCase()})) {
+                console.log(`Found supported language: ${key}`)
+                matrix['include'].push({"language": key.toLowerCase()})
+              }
+            }
+
+            // print languages
+            console.log(`matrix: ${JSON.stringify(matrix)}`)
+
+            return matrix
+
+      - name: Continue
+        uses: actions/github-script@v6
+        id: continue
+        with:
+          script: |
+            // if matrix['include'] is an empty list return false, otherwise true
+            const matrix = ${{ steps.lang.outputs.result }}  // this is already json encoded
+
+            if (matrix['include'].length == 0) {
+              return false
+            } else {
+              return true
+            }
+
+  analyze:
+    name: Analyze
+    if: ${{ needs.languages.outputs.continue == 'true' }}
+    needs: [languages]
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.languages.outputs.matrix) }}
+
+    steps:
+      - name: Maximize build space
+        uses: easimon/maximize-build-space@v8
+        with:
+          root-reserve-mb: 20480
+          remove-dotnet: ${{ (matrix.language == 'csharp' && 'false') || 'true' }}
+          remove-android: 'true'
+          remove-haskell: 'true'
+          remove-codeql: 'false'
+          remove-docker-images: 'true'
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # yamllint disable-line rule:line-length
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      # Pre autobuild
+      # create a file named .codeql-prebuild-${{ matrix.language }}.sh in the root of your repository
+      - name: Prebuild
+        run: |
+          # check if .qodeql-prebuild-${{ matrix.language }}.sh exists
+          if [ -f "./.codeql-prebuild-${{ matrix.language }}.sh" ]; then
+            echo "Running .codeql-prebuild-${{ matrix.language }}.sh"
+            ./.codeql-prebuild-${{ matrix.language }}.sh
+          fi
+
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/cpp-clang-format-lint.yml

@@ -1,60 +0,0 @@
----
-# This action is centrally managed in https://github.com/<organization>/.github/
-# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
-# the above-mentioned repo.
-
-name: Clang Format Lint
-
-on:
-  pull_request:
-    branches: [master, nightly]
-    types: [opened, synchronize, reopened]
-
-jobs:
-  check_src:
-    name: Check src
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Check
-        id: check
-        run: |
-          if [ -d "./src" ]
-          then
-            FOUND=true
-          else
-            FOUND=false
-          fi
-
-          echo "src=${FOUND}" >> $GITHUB_OUTPUT
-
-    outputs:
-      src: ${{ steps.check.outputs.src }}
-
-  lint:
-    name: Clang Format Lint
-    needs: [check_src]
-    if: ${{ needs.check_src.outputs.src == 'true' }}
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Clang format lint
-        uses: DoozyX/clang-format-lint-action@v0.14
-        with:
-          source: './src'
-          extensions: 'cpp,h,m,mm'
-          clangFormatVersion: 13
-          style: file
-          inplace: false
-
-      - name: Upload Artifacts
-        if: failure()
-        uses: actions/upload-artifact@v3
-        with:
-          name: clang-format-fixes
-          path: src/

.github/workflows/cpp-lint.yml

@@ -0,0 +1,120 @@
+---
+# This action is centrally managed in https://github.com/<organization>/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
+# the above-mentioned repo.
+
+# Lint c++ source files and cmake files.
+
+name: C++ Lint
+
+on:
+  pull_request:
+    branches: [master, nightly]
+    types: [opened, synchronize, reopened]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  clang-format:
+    name: Clang Format Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Find cpp files
+        id: find_files
+        run: |
+          # find files
+          found_files=$(find . -type f -iname "*.cpp" -o -iname "*.h" -o -iname "*.m" -o -iname "*.mm")
+          ignore_files=$(find . -type f -iname ".clang-format-ignore")
+
+          # Loop through each C++ file
+          for file in $found_files; do
+            for ignore_file in $ignore_files; do
+              ignore_directory=$(dirname "$ignore_file")
+              # if directory of ignore_file is beginning of file
+              if [[ "$file" == "$ignore_directory"* ]]; then
+                echo "ignoring file: ${file}"
+                found_files="${found_files//${file}/}"
+                break 1
+              fi
+            done
+          done
+
+          # remove empty lines
+          found_files=$(echo "$found_files" | sed '/^\s*$/d')
+
+          echo "found cpp files: ${found_files}"
+
+          # do not quote to keep this as a single line
+          echo found_files=${found_files} >> $GITHUB_OUTPUT
+
+      - name: Clang format lint
+        if: ${{ steps.find_files.outputs.found_files }}
+        uses: DoozyX/clang-format-lint-action@v0.16.2
+        with:
+          source: ${{ steps.find_files.outputs.found_files }}
+          extensions: 'cpp,h,m,mm'
+          clangFormatVersion: 16
+          style: file
+          inplace: false
+
+      - name: Upload Artifacts
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: clang-format-fixes
+          path: ${{ steps.find_files.outputs.found_files }}
+
+  cmake-lint:
+    name: CMake Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools cmakelang
+
+      - name: Find cmake files
+        id: find_files
+        run: |
+          # find files
+          found_files=$(find . -type f -iname "CMakeLists.txt" -o -iname "*.cmake")
+          ignore_files=$(find . -type f -iname ".cmake-lint-ignore")
+
+          # Loop through each C++ file
+          for file in $found_files; do
+            for ignore_file in $ignore_files; do
+              ignore_directory=$(dirname "$ignore_file")
+              # if directory of ignore_file is beginning of file
+              if [[ "$file" == "$ignore_directory"* ]]; then
+                echo "ignoring file: ${file}"
+                found_files="${found_files//${file}/}"
+                break 1
+              fi
+            done
+          done
+
+          # remove empty lines
+          found_files=$(echo "$found_files" | sed '/^\s*$/d')
+
+          echo "found cmake files: ${found_files}"
+
+          # do not quote to keep this as a single line
+          echo found_files=${found_files} >> $GITHUB_OUTPUT
+
+      - name: Test with cmake-lint
+        run: |
+          cmake-lint --line-width 120 --tab-size 4 ${{ steps.find_files.outputs.found_files }}

.github/workflows/dispatcher.yml

@@ -0,0 +1,69 @@
+---
+# This action is centrally managed in https://github.com/<organization>/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
+# the above-mentioned repo.
+
+# This action receives a dispatch event and passes it through to another repo. This is a workaround to avoid issues
+# where fork PRs do not have access to secrets.
+
+name: Dispatcher
+
+on:
+  workflow_dispatch:
+    inputs:
+      dispatch_repository:
+        description: 'Repository to dispatch to'
+        required: true
+      dispatch_workflow:
+        description: 'Workflow to dispatch to'
+        required: true
+      dispatch_ref:
+        description: 'Ref/branch to dispatch to'
+        required: true
+      dispatch_inputs:
+        description: 'Inputs to send'
+        required: true
+
+jobs:
+  dispatcher:
+    name: Repository Dispatch
+    runs-on: ubuntu-latest
+    steps:
+      - name: Unescape JSON control characters
+        id: inputs
+        run: |
+          # get the inputs
+          dispatch_inputs=${{ github.event.inputs.dispatch_inputs }}
+          echo "$dispatch_inputs"
+
+          # temporarily replace newlines with a placeholder
+          dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/\\\\n/_!new_line!_/g')
+
+          # remove newline characters
+          dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/\\n//g')
+
+          # replace placeholder with newline
+          dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/_!new_line!_/\\n/g')
+
+          # replace escaped quotes with unescaped quotes
+          dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/\\"//g')
+
+          # debug echo
+          echo "$dispatch_inputs"
+
+          # parse as JSON
+          dispatch_inputs=$(echo "$dispatch_inputs" | jq -c .)
+
+          # debug echo
+          echo "$dispatch_inputs"
+
+          echo "dispatch_inputs=$dispatch_inputs" >> $GITHUB_OUTPUT
+
+      - name: Workflow Dispatch
+        uses: benc-uk/workflow-dispatch@v1.2.2
+        with:
+          repo: ${{ github.event.inputs.dispatch_repository }}
+          ref: ${{ github.event.inputs.dispatch_ref || 'master' }}  # default to master if not specified
+          workflow: ${{ github.event.inputs.dispatch_workflow }}
+          inputs: ${{ steps.inputs.outputs.dispatch_inputs }}
+          token: ${{ secrets.GH_BOT_TOKEN || github.token }}  # fallback to default token if not specified

.github/workflows/issues-stale.yml

@@ -3,19 +3,22 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# Manage stale issues and PRs.
+
 name: Stale Issues / PRs
 
 on:
   schedule:
-    - cron: '00 00 * * *'
+    - cron: '00 10 * * *'
 
 jobs:
   stale:
     name: Check Stale Issues / PRs
+    if: startsWith(github.repository, 'LizardByte/')
     runs-on: ubuntu-latest
     steps:
       - name: Stale
-        uses: actions/stale@v6
+        uses: actions/stale@v8
         with:
           close-issue-message: >
             This issue was closed because it has been stalled for 10 days with no activity.
@@ -28,16 +31,19 @@ jobs:
           exempt-pr-labels: 'dependencies,l10n'
           stale-issue-label: 'stale'
           stale-issue-message: >
-            This issue is stale because it has been open for 90 days with no activity.
-            Comment or remove the stale label, otherwise this will be closed in 10 days.
+            It seems this issue hasn't had any activity in the past 90 days.
+            If it's still something you'd like addressed, please let us know by leaving a comment.
+            Otherwise, to help keep our backlog tidy, we'll be closing this issue in 10 days. Thanks!
           stale-pr-label: 'stale'
           stale-pr-message: >
-            This PR is stale because it has been open for 90 days with no activity.
-            Comment or remove the stale label, otherwise this will be closed in 10 days.
+            It looks like this PR has been idle for 90 days.
+            If it's still something you're working on or would like to pursue,
+            please leave a comment or update your branch.
+            Otherwise, we'll be closing this PR in 10 days to reduce our backlog. Thanks!
           repo-token: ${{ secrets.GH_BOT_TOKEN }}
 
       - name: Invalid Template
-        uses: actions/stale@v6
+        uses: actions/stale@v8
         with:
           close-issue-message: >
             This issue was closed because the the template was not completed after 5 days.
@@ -45,7 +51,6 @@ jobs:
             This PR was closed because the the template was not completed after 5 days.
           days-before-stale: 0
           days-before-close: 5
-          exempt-pr-labels: 'dependencies,l10n'
           only-labels: 'invalid:template-incomplete'
           stale-issue-label: 'invalid:template-incomplete'
           stale-issue-message: >

.github/workflows/issues.yml

@@ -3,6 +3,8 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# Label and un-label actions using `../label-actions.yml`.
+
 name: Issues
 
 on:
@@ -14,9 +16,10 @@ on:
 jobs:
   label:
     name: Label Actions
+    if: startsWith(github.repository, 'LizardByte/')
     runs-on: ubuntu-latest
     steps:
       - name: Label Actions
-        uses: dessant/label-actions@v2
+        uses: dessant/label-actions@v3
         with:
           github-token: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/localize.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Python 3.9
         uses: actions/setup-python@v4  # https://github.com/actions/setup-python
@@ -77,7 +77,7 @@ jobs:
         run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
 
       - name: Create/Update Pull Request
-        uses: peter-evans/create-pull-request@v4
+        uses: peter-evans/create-pull-request@v5
         with:
           add-paths: |
             locale/*.po

.github/workflows/pull-requests.yml

@@ -1,27 +0,0 @@
----
-# This action is centrally managed in https://github.com/<organization>/.github/
-# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
-# the above-mentioned repo.
-
-name: Pull Requests
-
-on:
-  pull_request_target:
-    types: [opened, synchronize, edited, reopened]
-
-jobs:
-  check-pull-request:
-    name: Check Pull Request
-    runs-on: ubuntu-latest
-    steps:
-      - uses: Vankka/pr-target-branch-action@v2
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          target: master
-          exclude: nightly  # Don't prevent going from nightly -> master
-          change-to: nightly
-          comment: |
-            Your PR was set to `master`, PRs should be sent to `nightly`.
-            The base branch of this PR has been automatically changed to `nightly`.
-            Please check that there are no merge conflicts

.github/workflows/python-flake8.yml

@@ -3,6 +3,8 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# Lint python files with flake8.
+
 name: flake8
 
 on:
@@ -10,12 +12,16 @@ on:
     branches: [master, nightly]
     types: [opened, synchronize, reopened]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   flake8:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v4  # https://github.com/actions/setup-python
@@ -24,7 +30,8 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip setuptools flake8
+          # pin flake8 before v6.0.0 due to removal of support for type comments (required for Python 2.7 type hints)
+          python -m pip install --upgrade pip setuptools "flake8<6"
 
       - name: Test with flake8
         run: |

.github/workflows/release-notifier.yml

@@ -3,6 +3,8 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# Send release notification to various platforms.
+
 name: Release Notifications
 
 on:
@@ -12,10 +14,14 @@ on:
 
 jobs:
   discord:
+    if: >-
+      startsWith(github.repository, 'LizardByte/') and
+      not(github.event.release.prerelease) and
+      not(github.event.release.draft)
     runs-on: ubuntu-latest
     steps:
       - name: discord
-        uses: sarisia/actions-status-discord@v1  # https://github.com/sarisia/actions-status-discord
+        uses: sarisia/actions-status-discord@v1
         with:
           webhook: ${{ secrets.DISCORD_RELEASE_WEBHOOK }}
           nodetail: true
@@ -27,10 +33,14 @@ jobs:
           color: 0xFF4500
 
   facebook_group:
+    if: >-
+      startsWith(github.repository, 'LizardByte/') and
+      not(github.event.release.prerelease) and
+      not(github.event.release.draft)
     runs-on: ubuntu-latest
     steps:
       - name: facebook-post-action
-        uses: ReenigneArcher/facebook-post-action@v1  # https://github.com/ReenigneArcher/facebook-post-action
+        uses: ReenigneArcher/facebook-post-action@v1
         with:
           page_id: ${{ secrets.FACEBOOK_GROUP_ID }}
           access_token: ${{ secrets.FACEBOOK_ACCESS_TOKEN }}
@@ -40,10 +50,14 @@ jobs:
           url: ${{ github.event.release.html_url }}
 
   facebook_page:
+    if: >-
+      startsWith(github.repository, 'LizardByte/') and
+      not(github.event.release.prerelease) and
+      not(github.event.release.draft)
     runs-on: ubuntu-latest
     steps:
       - name: facebook-post-action
-        uses: ReenigneArcher/facebook-post-action@v1  # https://github.com/ReenigneArcher/facebook-post-action
+        uses: ReenigneArcher/facebook-post-action@v1
         with:
           page_id: ${{ secrets.FACEBOOK_PAGE_ID }}
           access_token: ${{ secrets.FACEBOOK_ACCESS_TOKEN }}
@@ -53,10 +67,14 @@ jobs:
           url: ${{ github.event.release.html_url }}
 
   reddit:
+    if: >-
+      startsWith(github.repository, 'LizardByte/') and
+      not(github.event.release.prerelease) and
+      not(github.event.release.draft)
     runs-on: ubuntu-latest
     steps:
       - name: reddit
-        uses: bluwy/release-for-reddit-action@v1  # https://github.com/bluwy/release-for-reddit-action
+        uses: bluwy/release-for-reddit-action@v2
         with:
           username: ${{ secrets.REDDIT_USERNAME }}
           password: ${{ secrets.REDDIT_PASSWORD }}
@@ -69,13 +87,17 @@ jobs:
           comment: ${{ github.event.release.body }}
 
   twitter:
+    if: >-
+      startsWith(github.repository, 'LizardByte/') and
+      not(github.event.release.prerelease) and
+      not(github.event.release.draft)
     runs-on: ubuntu-latest
     steps:
       - name: twitter
-        uses: ethomson/send-tweet-action@v1  # https://github.com/ethomson/send-tweet-action
+        uses: nearform-actions/github-action-notify-twitter@v1
         with:
-          consumer-key: ${{ secrets.TWITTER_API_KEY }}
-          consumer-secret: ${{ secrets.TWITTER_API_SECRET }}
-          access-token: ${{ secrets.TWITTER_ACCESS_TOKEN }}
-          access-token-secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
-          status: ${{ github.event.release.html_url }}
+          message: ${{ github.event.release.html_url }}
+          twitter-app-key: ${{ secrets.TWITTER_API_KEY }}
+          twitter-app-secret: ${{ secrets.TWITTER_API_SECRET }}
+          twitter-access-token: ${{ secrets.TWITTER_ACCESS_TOKEN }}
+          twitter-access-token-secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}

.github/workflows/update-pages.yml

@@ -0,0 +1,62 @@
+---
+name: Build GH-Pages
+
+on:
+  pull_request:
+    branches: [master, nightly]
+    types: [opened, synchronize, reopened]
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  update_pages:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Checkout gh-pages
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+          path: gh-pages
+          persist-credentials: false  # otherwise, the token used is the GITHUB_TOKEN, instead of the personal token
+          fetch-depth: 0  # otherwise, will fail to push refs to dest repo
+
+      - name: Prepare gh-pages
+        run: |
+          # empty contents
+          rm -f -r ./gh-pages/*
+
+          # copy template back to pages
+          cp -f -r ./gh-pages-template/. ./gh-pages/
+
+      - name: Upload Artifacts
+        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: gh-pages
+          if-no-files-found: error  # 'warn' or 'ignore' are also available, defaults to `warn`
+          path: |
+            ${{ github.workspace }}/gh-pages
+            !**/*.git
+
+      - name: Deploy to gh-pages
+        if: >-
+          (github.event_name == 'push' && github.ref == 'refs/heads/master') ||
+          (github.event_name == 'workflow_dispatch')
+        uses: actions-js/push@v1.4
+        with:
+          github_token: ${{ secrets.GH_BOT_TOKEN }}
+          author_email: ${{ secrets.GH_BOT_EMAIL }}
+          author_name: ${{ secrets.GH_BOT_NAME }}
+          directory: gh-pages
+          branch: gh-pages
+          force: false
+          message: sync gh-pages to ${{ github.sha }}

.github/workflows/yaml-lint.yml

@@ -3,6 +3,8 @@
 # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
 # the above-mentioned repo.
 
+# Lint yaml files.
+
 name: yaml lint
 
 on:
@@ -10,12 +12,16 @@ on:
     branches: [master, nightly]
     types: [opened, synchronize, reopened]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   yaml-lint:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Find additional files
         id: find-files
@@ -56,6 +62,5 @@ jobs:
           file_or_dir: . ${{ steps.find-files.outputs.found }}
 
       - name: Log
-        if: failure()
         run: |
           cat "${{ steps.yaml-lint.outputs.logfile }}" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -9,15 +9,9 @@ cmake-build*
 .cache
 .idea
 
-# Extra FontAwesome files
-/src_assets/common/assets/web/fonts/fontawesome-free-web/css/*.css
-!/src_assets/common/assets/web/fonts/fontawesome-free-web/css/*min.css
-/src_assets/common/assets/web/fonts/fontawesome-free-web/js/
-/src_assets/common/assets/web/fonts/fontawesome-free-web/less/
-/src_assets/common/assets/web/fonts/fontawesome-free-web/metadata/
-/src_assets/common/assets/web/fonts/fontawesome-free-web/scss/
-/src_assets/common/assets/web/fonts/fontawesome-free-web/sprites/
-/src_assets/common/assets/web/fonts/fontawesome-free-web/svgs/
+# npm
+node_modules/
+package-lock.json
 
 # Translations
 *.mo

.gitmodules

@@ -1,18 +1,68 @@
-[submodule "moonlight-common-c"]
+[submodule "third-party/moonlight-common-c"]
 	path = third-party/moonlight-common-c
 	url = https://github.com/moonlight-stream/moonlight-common-c.git
-[submodule "Simple-Web-Server"]
+	branch = master
+[submodule "third-party/Simple-Web-Server"]
 	path = third-party/Simple-Web-Server
-	url = https://github.com/loki-47-6F-64/Simple-Web-Server.git
-[submodule "ViGEmClient"]
+	url = https://gitlab.com/eidheim/Simple-Web-Server.git
+	branch = master
+[submodule "third-party/ViGEmClient"]
 	path = third-party/ViGEmClient
-	url = https://github.com/ViGEm/ViGEmClient
+	url = https://github.com/nefarius/ViGEmClient
+	branch = master
 [submodule "third-party/miniupnp"]
 	path = third-party/miniupnp
 	url = https://github.com/miniupnp/miniupnp
+	branch = master
 [submodule "third-party/nv-codec-headers"]
 	path = third-party/nv-codec-headers
 	url = https://github.com/FFmpeg/nv-codec-headers
+	branch = sdk/12.0
 [submodule "third-party/TPCircularBuffer"]
 	path = third-party/TPCircularBuffer
 	url = https://github.com/michaeltyson/TPCircularBuffer
+	branch = master
+[submodule "third-party/ffmpeg-windows-x86_64"]
+	path = third-party/ffmpeg-windows-x86_64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-windows-x86_64
+[submodule "third-party/ffmpeg-macos-x86_64"]
+	path = third-party/ffmpeg-macos-x86_64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-macos-x86_64
+[submodule "third-party/ffmpeg-linux-x86_64"]
+	path = third-party/ffmpeg-linux-x86_64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-linux-x86_64
+[submodule "third-party/ffmpeg-linux-aarch64"]
+	path = third-party/ffmpeg-linux-aarch64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-linux-aarch64
+[submodule "third-party/ffmpeg-macos-aarch64"]
+	path = third-party/ffmpeg-macos-aarch64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-macos-aarch64
+[submodule "third-party/nanors"]
+	path = third-party/nanors
+	url = https://github.com/sleepybishop/nanors.git
+	branch = master
+[submodule "third-party/tray"]
+	path = third-party/tray
+	url = https://github.com/LizardByte/tray
+	branch = master
+[submodule "third-party/nvapi-open-source-sdk"]
+	path = third-party/nvapi-open-source-sdk
+	url = https://github.com/LizardByte/nvapi-open-source-sdk
+	branch = sdk
+[submodule "third-party/ffmpeg-linux-powerpc64le"]
+	path = third-party/ffmpeg-linux-powerpc64le
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-linux-powerpc64le
+[submodule "third-party/wayland-protocols"]
+	path = third-party/wayland-protocols
+	url = https://gitlab.freedesktop.org/wayland/wayland-protocols
+	branch = main
+[submodule "third-party/wlr-protocols"]
+	path = third-party/wlr-protocols
+	url = https://gitlab.freedesktop.org/wlroots/wlr-protocols
+	branch = master

.readthedocs.yaml

@@ -8,27 +8,22 @@ version: 2
 
 # Set the version of Python
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.11"
+  apt_packages:
+    - graphviz  # required to build diagrams
+    - libboost-locale-dev  # required for rstcheck in cpp code block
+  jobs:
+    post_build:
+      - find ./third-party -iname "*.rst" -type f -delete  # find and delete rst files in third-party
+      - rstcheck -r .  # lint rst files
+      # - rstfmt --check --diff -w 120 .  # check rst formatting
 
-## apt packages required packages to run cmake on sunshine, note that additional packages are required
-#  apt_packages:
-#    - cmake
-#    - ffmpeg
-#    - libboost-filesystem-dev
-#    - libboost-log-dev
-#    - libboost-thread-dev
-
-## run cmake
-#  jobs:
-#    pre_build:
-#      - cmake .
-
-## Include the submodules, required for cmake
-#  submodules:
-#    include: all
-#    recursive: true
+# submodules required for include statements
+submodules:
+  include: all
+  recursive: true
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -42,4 +37,3 @@ formats: all
 python:
   install:
     - requirements: ./docs/requirements.txt
-  system_packages: true

.rstcheck.cfg

@@ -0,0 +1,10 @@
+# configuration file for rstcheck, an rst linting tool
+# https://rstcheck.readthedocs.io/en/latest/usage/config
+
+[rstcheck]
+ignore_directives =
+    doxygenfile,
+    include,
+    mdinclude,
+    tab,
+    todo,

CHANGELOG.md

@@ -1,17 +1,393 @@
 # Changelog
 
+## [0.21.0] - 2023-10-15
+**Added**
+- (Input) Add support for automatically selecting the emulated controller type based on the physical controller connected to the client
+- (Input/Windows) Add support for Applications (context menu) key
+- (Input/Windows) Implement touchpad, motion sensors, battery state, and LED control for the emulated DualShock 4 controller
+- (Input) Advertise support for new input features to clients
+- (Linux/Debian) Added Debian Bookworm package
+- (Prep-Commands) Expose connection environment variables
+- (Input/Windows) Implement pen and touch support
+- (Capture/Windows) Add standalone NVENC encoder
+- (Capture) Implement AV1 encoding
+- (Network) Implement IPv6 support
+- (Capture/Windows) Add option to disable realtime hags
+- (Graphics/NVIDIA) Add an option to decrease GPU scheduling priority to workaround HAGS video hang
+- (Capture/Linux) Add FFmpeg powerpc64le architecture for self compiling Sunshine
+- (Capture/Windows) Add support for capturing rotated displays
+- (System Tray) Implement streaming event notifications
+- (UI) Add port configuration table
+- (Applications) Added option to automatically treat launcher type apps as detached commands
+- (Input/Gamepad) Allow the Misc button to work as Guide on emulated Xbox 360 controllers
+
+**Changed**
+- (Input) Reduce latency by implementing input batching
+- (Logging) Move input packet debug prints off the control stream thread
+- (Input) Refactor gamepad emulation code to use DS4 extended report format
+- (Graphics/NVIDIA) Modify and restore NVIDIA control panel settings before and after stream, respectively
+- (Graphics/NVIDIA) New config page for NVENC
+- (Graphics/Windows) Refactor DX shaders
+- (Input/Windows) Use our own keycode mapping to avoid installing the US English keyboard layout
+
+**Fixed**
+- (UI) Fix update notifications
+- (Dependencies/Linux) Replace libboost chrono and thread with standard chrono and thread
+- (Input) Increase maximum gamepad limit to 16
+- (Network) Allow use of multiple ENet channels
+- (Network) Consider link-local addresses on LAN
+- (Input) Fixed issue where button may sometimes stick on Windows
+- (Input) Fix "ControllerNumber not allocated" warning when a gamepad is removed
+- (Input) Fix handling of gamepad feedback with multiple clients connected
+- (Input) Fix clamping mouse position to aspect ratio adjusted viewport
+- (Graphics/AMD) Fix crash during startup on some older AMD GPUs
+- (Logging) Fix crash when non-ASCII characters are logged
+- (Prep-Commands) Fix resource exhaustion bug which could occur when many prep commands were used
+- (Subprocesses) Fix race condition when inserting new processes
+- (Logging) Log error if encoder doesn't produce IDR frame on demand
+- (Audio) Improve audio capture logic and logging
+- (Logging) Fix AMF logging to match configured log level
+- (Logging) Log FFmpeg to log file instead of stdout
+- (Capture) Reject codecs that are not supported by display device
+- (Capture) Add fallbacks for unsupported codec settings
+- (Capture) Avoid probing HEVC or AV1 codecs in some cases
+- (Caputre) Remove DwmFlush()
+- (Capture/Windows) Improvements to capture sleeps for better frame stability
+- (Capture/Windows) Adjust capture rate to better match with display
+- (Linux/ArchLinux) Fix package version in PKGBUILD and precompiled package 
+- (UI) Highlight fatal log messages in web ui
+- (Commands) Allow stream if prep command fails
+- (Capture/Linux) Fix KMS grab VRAM capture with libva 2.20
+- (Capture/macOS) Fix video capture backend
+- (Misc/Windows) Don't start the session monitor window when launched in command mode
+- (Linux/AppImage) Use the linuxdeploy GTK plugin to correctly deploy GTK3 dependencies
+- (Input/Windows) Fix reWASD not recognizing emulated DualShock 4 input
+
+**Dependencies**
+- Bump bootstrap from 5.2.3 to 5.3.2
+- Bump third-party/moonlight-common-c from c9426a6 to 7a6d12f
+- Bump gcc-10 in Ubuntu 20.04 docker image
+- Bump furo from 2023.5.20 to 2023.9.10
+- Bump sphinx from 7.0.1 to 7.2.6
+- Bump cmake from 3.26 to 3.27 in Fedora docker images
+- Move third-party/nv-codec-headers from sdk/11.1 branch to sdk/12.0 branch
+- Automatic bump ffmpeg
+- Bump actions/checkout from 3 to 4
+- Bump boost from 1.80 to 1.81 in Macport manifest
+- Bump @fortawesome/fontawesome-free from 6.4.0 to 6.4.2
+
+**Misc**
+- (Docs) Force badges to use svg
+- (Docs) Add Linux SSH example
+- (Docs) Add information about mesa for Linux
+- (CI) Free additional space on Docker, Flatpak, and AppImage builds due to internal changes on GitHub runners
+- (Docs/Logging/UI) Corrected various typos
+- (Docs) Add blurb about Gamescope compatibility
+- (Installer/Windows) Use system proxy to download ViGEmBus
+- (CI) Ignore third-party directory for clang-format
+- (Docs/Linux) Add Plasma-Compatible resolution example
+- (Docs) Add Sunshine website available at https://app.lizardbyte.dev/Sunshine
+- (Build/Windows) Fix audio code build with new MinGW headers
+- (Build/Windows) Fix QoS code build with new MinGW headers
+- (CI/Windows) Prevent winget action from creating an update when running in a fork
+- (CI/Windows) Change winget job to ubuntu-latest runner
+- (CI) Add CodeQL analysis
+- (CI/Docker) Fix ArchLinux image caching issue
+- (Windows) Manifest improvements
+- (CI/macOS) Simplify macport build
+- (Docs) Remove deprecated options from readthedocs config
+- (CI/Docs) Lint rst files
+- (Docs) Update localization information (after consolidating Crowdin projects)
+- (Cmake) Split CMakelists into modules
+- (Docs) Add Linux Headless/SSH Guide
+
+## [0.20.0] - 2023-05-28
+**Breaking**
+- (Windows) The Windows installer version of Sunshine is now always launched by the Sunshine Service. Manually launching Sunshine.exe from Program Files is no longer supported. This was necessary to address security issues caused by non-admin users having access to Sunshine's config data. If you have set up Task Scheduler or other mechanisms to launch Sunshine automatically, remove those from your system before updating.
+- (Windows) The Start Menu shortcut has been redesigned for use with the Sunshine Service. It now launches Sunshine in the background (if not already running) and opens the Web UI, avoiding the persistent Command Prompt window present in prior versions. The Start Menu shortcut is now the recommended method for opening the Web UI and launching Sunshine.
+- (Network/UPnP) If the Moonlight Internet Hosting Tool is installed alongside Sunshine, you must remove it or upgrade to v5.6 or later to prevent conflicts with Sunshine's UPnP support. As a reminder, the Moonlight Internet Hosting Tool is not required to stream over the Internet with Sunshine. Instead, simply enable UPnP in the Sunshine Web UI.
+- (Windows) If Steam is installed, the Steam Streaming Speakers driver will be automatically installed when starting a stream for the first time. This behavior can be disabled in the Audio/Video tab of the Web UI. This Steam driver enables support for surround sound and muting host audio without requiring any manual configuration.
+- (Input) The Back Button Timeout option has been renamed to Guide Button Emulation Timeout and has been disabled by default to ensure long presses on the Back button work by default. The previous behavior can be restored by setting the Guide Button Emulation Timeout to 2000.
+- (Windows) The service name of SunshineSvc has been changed to SunshineService to address a false positive in MalwareBytes. If you have any scripts or other logic on your system that is using the service name, you will need to update that for the new name.
+- (Windows) To support new installer features, install-service.bat no longer sets the service to auto-start by default. Users executing install-service.bat manually on the Sunshine portable build must also execute autostart-service.bat to start Sunshine on boot. However, installing the service manually like this is not recommended. Instead, use the Sunshine installer which handles service installation and configuration automatically.
+- (Linux/Fedora) Fedora 36 builds are removed due to upstream end of support
+
+**Added**
+- (Windows) Added an option to launch apps and prep/undo commands as administrator
+- (Installer/Windows) Added an option to choose whether Sunshine launches on boot. If not configured to launch on boot, use the Start Menu shortcut to start Sunshine when desired.
+- (Input/Windows) Added option to send VK codes instead of scancodes for compatibility with iOS/Android devices using non-English keyboard layouts
+- (UI) The Apply/Restart option is now available in the Web UI for all platforms
+- (Systray) Added a Restart option to the system tray context menu
+- (Video/Windows) Added host latency data to video frames. This requires future updates to Moonlight to display in the on-screen overlay.
+- (Audio) Added support for matching Audio Sink and Virtual Sink values on device names
+- (Client) Added friendly error messages for clients when streaming fails to start
+- (Video/Windows) Added warning log messages when Windows is hiding DRM-protected content from display capture
+- (Interop/Windows) Added warning log messages when GeForce Experience is currently using the same ports as Sunshine
+- (Linux/Fedora) Fedora 38 builds are now available
+
+**Changed**
+- (Video) Encoder selection now happens at each stream start for more reliable GPU detection
+- (Video/Windows) The host display now stays on while clients are actively streaming
+- (Audio) Streaming will no longer fail if audio capture is unavailable
+- (Audio/Windows) Sunshine will automatically switch back to the Virtual Sink if the default audio device is changed while streaming
+- (Audio) Changes to the host audio playback option will now take effect when resuming a session from Moonlight
+- (Audio/Windows) Sunshine will switch to a different default audio device if Steam Streaming Speakers are the default when Sunshine starts. This handles cases where Sunshine terminates unexpectedly without restoring the default audio device.
+- (Apps) The Connection Terminated dialog will no longer appear in Moonlight when the app on the host exits normally
+- (Systray/Windows) Quitting Sunshine via the system tray will now stop the Sunshine Service rather than leaving it running and allowing it to restart Sunshine
+- (UI) The 100.64.0.0/10 CGN IP address range is now treated as a LAN address range
+- (Video) Removed a workaround for some versions of Moonlight prior to mid-2022
+- (UI) The PIN field is now cleared after successfully pairing
+- (UI) User names are now treated as case-insensitive
+- (Linux) Changed udev rule to automatically grant access to virtual input devices
+- (UI) Several item descriptions were adjusted to reflect newer configuration recommendations
+- (UI) Placeholder text opacity has been reduced to improve contrast with non-placeholder text
+- (Video/Windows) Minor capture performance improvements
+
+**Fixed**
+- (Video) VRAM usage while streaming is significantly reduced, particularly with higher display resolutions and HDR
+- (Network/UPnP) UPnP support was rewritten to fix several major issues handling router restarts, IP address changes, and port forwarding expiration
+- (Input) Fixed modifier keys from the software keyboard on Android clients
+- (Audio) Fixed handling of default audio device changes while streaming
+- (Windows) Fixed streaming after Microsoft Remote Desktop or Fast User Switching has been used
+- (Input) Fixed some games not recognizing emulated Guide button presses
+- (Video/Windows) Fixed incorrect gamma when using an Advanced Color SDR display on the host
+- (Installer/Windows) The installer is no longer blurry on High DPI systems
+- (Systray/Windows) Fixed multiple system tray icons appearing if Sunshine exits unexpectedly
+- (Systray/Windows) Fixed the system tray icon not appearing in several situations
+- (Windows) Fixed hang on shutdown/restart if mDNS registration fails
+- (UI) Fixed missing response headers
+- (Stability) Fixed several possible crashes in cases where the client did not successfully connect
+- (Stability) Fixed several memory leaks
+- (Input/Windows) Back/Select input now correctly generates the Share button when emulating DS4 controllers
+- (Audio/Windows) Fixed various bugs in audio-info.exe that led to inaccurate output on some systems
+- (Video/Windows) Fixed incorrect resolution values from dxgi-info.exe on High DPI systems
+- (Video/Linux) Fixed poor quality encoding from H.264 on Intel encoders
+- (Config) Fixed a couple of typos in predefined resolutions
+
+**Dependencies**
+- Bump sphinx-copybutton from 0.5.1 to 0.5.2
+- Bump sphinx from 6.13 to 7.0.1
+- Bump third-party/nv-codec-headers from 2055784 to 2cd175b
+- Bump furo from 2023.3.27 to 2023.5.20
+
+**Misc**
+- (Build/Linux) Add X11 to PLATFORM_LIBARIES when found
+- (Build/macOS) Fix compilation with Clang 14
+- (Docs) Fix nvlax URL
+- (Docs) Add diagrams using graphviz
+- (Docs) Improvements to source code documentation
+- (Build) Unpin docker dependencies
+- (Build/Linux) Honor install prefix for tray icon
+- (Build/Windows) Unstripped binaries are now provided as a debuginfo package to support crash dump debugging
+- (Config) Config directories are now created recursively
+
+## [0.19.1] - 2023-03-30
+**Fixed**
+- (Audio) Fixed no audio issue introduced in v0.19.0
+
+## [0.19.0] - 2023-03-29
+**Breaking**
+- (Linux/Flatpak) Moved Flatpak to org.freedesktop.Platform 22.08 and Cuda 12.0.0
+  This will drop support for Nvidia GPUs with compute capability 3.5
+
+**Added**
+- (Input) Added option to suppress input from gamepads, keyboards, or mice
+- (Input/Linux) Added unicode support for remote pasting (may not work on all DEs)
+- (Input/Linux) Added XTest input fallback
+- (UI) Added version notifications to web UI
+- (Linux/Windows) Add system tray icon
+- (Windows) Added ability to safely elevate commands that fail due to insufficient permissions when running as a service
+- (Config) Added global prep commands, and ability to exclude an app from using global prep commands
+- (Installer/Windows) Automatically install ViGEmBus if selected
+
+**Changed**
+- (Logging) Changed client verified messages to debug to prevent spamming the log
+- (Config) Only save non default config values
+- (Service/Linux) Use xdg-desktop-autostart for systemd service
+- (Linux) Added config option to force capture method
+- (Windows) Execute prep command in context of current user
+- (Linux) Allow disconnected X11 outputs
+
+**Fixed**
+- (Input/Windows) Fix issue where internation keys were not translated correct, and modifier keys appeared stuck
+- (Linux) Fixed startup when /dev/dri didn't exist
+- (UI) Changes software encoding settings to select menu instead of text input
+- (Initialization) Do not terminate upon failure, allowing access to the web UI
+
+**Dependencies**
+- Bump third-party/moonlight-common-c from 07beb0f to c9426a6
+- Bump babel from 2.11.0 to 2.12.1
+- Bump @fortawesome/fontawesome-free from 6.2.1 to 6.4.0
+- Bump third-party/ViGEmClient from 9e842ba to 726404e
+- Bump ffmpeg
+- Bump third-party/miniupnp from 014c9df to e439318
+- Bump furo from 2022.12.7 to 2023.3.27
+- Bump third-party/nanors from 395e5ad to e9e242e
+
+**Misc**
+- (GitHub) Shared feature request board with Moonlight
+- (Docs) Improved application examples
+- (Docs) Added WIP documentation for source code using Doxygen and Breathe
+- (Build) Fix linux clang build errors
+- (Build/Archlinux) Skip irrelevant submodules
+- (Build/Archlinux) Disable download timeout
+- (Build/macOS) Support compiling for earlier releases of macOS
+- (Docs) Add favicon
+- (Docs) Add missing config default values
+- (Build) Fix compiler warnings due to depreciated elements in C++17
+- (Build) Fix libcurl link errors
+- (Clang) Adjusted formatting rules
+
+## [0.18.4] - 2023-02-20
+**Fixed**
+- (Linux/AUR) Drop support of AUR package
+- (Docker) General enhancements to docker images
+
+## [0.18.3] - 2023-02-13
+**Added**
+- (Linux) Added PKGBUILD for Archlinux based distros to releases
+- (Linux) Added precompiled package for Archlinux based distros to releases
+- (Docker) Added archlinux docker image (x86_64 only)
+
+## [0.18.2] - 2023-02-13
+**Fixed**
+- (Video/KMV/Linux) Fixed wayland capture on Nvidia for KMS
+- (Video/Linux) Implement vaSyncBuffer stuf for libva <2.9.0
+- (UI) Fix issue where mime type was not being set for node_modules when using a reverse proxy
+- (UI/macOS) Added missing audio sink config options
+- (Linux) Specify correct Boost dependency versions
+- (Video/AMF) Add missing encoder tunables
+
+## [0.18.1] - 2023-01-31
+**Fixed**
+- (Linux) Fixed missing dependencies for deb and rpm packages
+- (Linux) Use dynamic boost
+
+## [0.18.0] - 2023-01-29
+Attention, this release contains critical security fixes. Please update as soon as possible. Additionally, we are
+encouraging users to change your Sunshine password, especially if you expose the web UI (i.e. port 47790 by default)
+to the internet, or have ever uploaded your logs with verbose output to a public resource.
+
+**Added**
+- (Windows) Add support for Intel QuickSync
+- (Linux) Added aarch64 deb and rpm packages
+- (Windows) Add support for hybrid graphics systems, such as laptops with both integrated and discrete GPUs
+- (Linux) Add support for streaming from Steam Deck Gaming Mode
+- (Windows) Add HDR support, see https://docs.lizardbyte.dev/projects/sunshine/en/latest/about/usage.html#hdr-support
+
+**Fixed**
+- (Network) Refactor code for UPnP port forwarding
+- (Video) Enforce 10 FPS encoding frame rate minimum to improve static image quality
+- (Linux) deb and rpm packages are now specific to destination distro and version
+- (Docs) Add nvidia/nvenc preset migration guide
+- (Network) Performance optimizations
+- (Video/Windows) Fix streaming to multiple clients from hardware encoder
+- (Linux) Fix child process spawning
+- (Security) Fix security vulnerability in implementation of SimpleWebServer
+- (Misc) Rename "Steam BigPicture" to "Steam Big Picture" in default apps.json
+- (Security) Scrub basic authorization header from logs
+- (Linux) The systemd service will now restart in the event of a crash
+- (Video/KMS/Linux) Fixed error: `couldn't import RGB Image: 00003002 and 00003004`
+- (Video/Windows) Fix stream freezing triggered by the resolution changed
+- (Installer/Windows) Fixes silent installation and other miscellaneous improvements
+- (CPU) Significantly improved CPU usage
+
+## [0.17.0] - 2023-01-08
+If you are running Sunshine as a service on Windows, we are strongly urging you to update to v0.17.0 as soon as
+possible. Older Windows versions of Sunshine had a security flaw in which the binary was located in a user-writable
+location which is problematic when running as a service or on a multi-user system. Additionally, when running Sunshine
+as a service, games and applications were launched as SYSTEM. This could lead to issues with save files and other game
+settings. In v0.17.0, games now run under your user account without elevated privileges.
+
+**Breaking**
+- (Apps) Removed automatic desktop entry (Re-add by adding an empty application named "Desktop" with no commands, "desktop.png" can be added as the image.)
+- (Windows) Improved user upgrade experience (Suggest to manually uninstall existing Sunshine version before this upgrade. Do NOT select to remove everything, if prompted. Make a backup of config files before uninstall.)
+- (Windows) Move config files to specific directory (files will be migrated automatically if using Windows installer)
+- (Dependencies) Fix npm path (breaking change for package maintainers)
+
+**Added**
+- (macOS) Added initial support for arm64 on macOS through Macports portfile
+- (Input) Added support for foreign keyboard input
+- (Misc) Logs inside the WebUI and log to file
+- (UI/Windows) Added an Apply button to configuration page when running as a service
+- (Input/Windows) Enable Mouse Keys while streaming for systems with no physical mouse
+
+**Fixed**
+- (Video) Improved capture performance
+- (Audio) Improved audio bitrate and quality handling
+- (Apps/Windows) Fixed PATH environment variable handling
+- (Apps/Windows) Use the proper environment variable for the Program Files (x86) folder
+- (Service/Windows) Fix SunshineSvc hanging if an error occurs during startup
+- (Service/Windows) Spawn Sunshine.exe in a job object, so it is terminated if SunshineSvc.exe dies
+- (Video) windows/vram: fix fringing in NV12 colour conversion
+- (Apps/Windows) Launch games under the correct user account
+- (Video) nvenc, amdvce: rework all user presets/options
+- (Network) Generate certificates with unique serial numbers
+- (Service/Windows) Graceful termination on shutdown, logoff, and service stop
+- (Apps/Windows) Fix launching apps when Sunshine is running as admin
+- (Misc) Remove/fix calls to std::abort()
+- (Misc) Remove prompt to press enter after Sunshine exits
+- (Misc) Make log priority consistent for execution messages
+- (Apps) Applications in Moonlight clients are now updated automatically after editing
+- (Video/Linux) Fix wayland capture on nvidia
+- (Audio) Fix 7.1 surround channel mapping
+- (Video) Fix NVENC profile values not applying
+- (Network) Fix origin_web_ui_allowed binding
+- (Service/Windows) Self terminate/restart service if process hangs for 10 seconds
+- (Input/Windows) Fix Windows masked cursor blending with GPU encoders
+- (Video) Color conversion fixes and BT.2020 support
+
+**Dependencies**
+- Bump ffmpeg from 4.4 to 5.1
+- ffmpeg_patches: add amfenc delay/buffering fix
+- CBS moved to ffmpeg submodules
+- Migrate to upstream Simple-Web-Server submodule
+- Bump third-party/TPCircularBuffer from `bce9170` to `8833b3a`
+- Bump third-party/moonlight-common-c from `8169a31` to `ef9ad52`
+- Bump third-party/miniupnp from `6f848ae` to `207cf44`
+- Bump third-party/ViGEmClient from `f719a1d` to `9e842ba`
+- Bump bootstrap from 5.0.0 to 5.2.3
+- Bump @fortawesome/fontawesome-free from 6.2.0 to 6.2.1
+
+## [0.16.0] - 2022-12-13
+**Added**
+- Add cover finder
+- (Docker) Add arm64 docker image
+- (Flatpak) Add installation helper scripts
+- (Windows) Add support for Unicode input messages
+
+**Fixed**
+- (Linux) Reintroduce Ubuntu 20.04 and 22.04 specific deb packages
+- (Linux) Fixed udev and systemd file locations
+
+**Dependencies**
+- Bump babel from 2.10.3 to 2.11.0
+- Bump sphinx-copybutton from 0.5.0 to 0.5.1
+- Bump KSXGitHub/github-actions-deploy-aur from 2.5.0 to 2.6.0
+- Use npm for web dependencies (breaking change for third-party package maintainers)
+- Update moonlight-common-c
+- Use pre-built ffmpeg from LizardByte/build-deps for all sunshine builds (breaking change for third-party package maintainers)
+- Bump furo from 2022.9.29 to 2022.12.7
+
+**Misc**
+- Misc org level workflow updates
+- Fix misc typos in docs
+- Fix winget release
+
 ## [0.15.0] - 2022-10-30
-### Added
+**Added**
 - (Windows) Add firewall rules scripts
 - (Windows) Automatically add and remove firewall rules at install/uninstall
 - (Windows) Automatically add and remove service at install/uninstall
 - (Docker) Official image added
 - (Linux) Add aarch64 flatpak package
-### Changed
+
+**Changed**
 - (Windows/Linux/MacOS) - Move default config and apps file to assets directory
 - (MacOS) Bump boost to 1.80 for macport builds
 - (Linux) Remove backup and restore of config files
-### Fixed
+
+**Fixed**
 - (Linux) - Create sunshine config directory if it doesn't exist
 - (Linux) Remove portable home and config directories for AppImage
 - (Windows) Include service install and uninstall scripts again
@@ -22,72 +398,79 @@
 - (Linux) Fix CUDA RGBA to NV12 conversion
 
 ## [0.14.1] - 2022-08-09
-### Added
+**Added**
 - (Linux) Flatpak package added
 - (Linux) AUR package automated updates
 - (Windows) Winget package automated updates
-### Changed
+
+**Changed**
 - (General) Moved repo to @LizardByte GitHub org
 - (WebUI) Fixed button spacing on home page
 - (WebUI) Added Discord WidgetBot Crate
-### Fixed
+
+**Fixed**
 - (Linux/Mac) Default config and app files now copied to user home directory
 - (Windows) Default config and app files now copied to working directory
 
 ## [0.14.0] - 2022-06-15
-### Added
+
+**Added**
 - (Documentation) Added Sphinx documentation available at https://sunshinestream.readthedocs.io/en/latest/
 - (Development) Initial support for Localization
 - (Linux) Add rpm package as release asset
-- (MacOS) Add Portfile as release asset
+- (macOS) Add Portfile as release asset
 - (Windows) Add DwmFlush() call  to improve capture
 - (Windows) Add Windows installer
-### Fixed
+
+**Fixed**
 - (AMD) Fixed hwdevice being destroyed before context
 - (Linux) Added missing dependencies to AppImage
 - (Linux) Fixed rumble events causing game to freeze
 - (Linux) Improved Pulse/Pipewire compatibility
 - (Linux) Moved to single deb package
-- (MacOS) Fixed missing TPCircularBuffer submodule
+- (macOS) Fixed missing TPCircularBuffer submodule
 - (Stream) Properly catch exceptions in stream broadcast handlers
 - (Stream/Video) AVPacket fix
 
 ## [0.13.0] - 2022-02-27
-### Added
-- (MacOS) Initial support for MacOS (#40)
+**Added**
+- (macOS) Initial support for macOS (#40)
 
 ## [0.12.0] - 2022-02-13
-### Added
+**Added**
 - New command line argument `--version`
 - Custom png poster support
-### Changed
+
+**Changed**
 - Correct software bitrate calculation
 - Increase vbv-bufsize to 1/10 of requested bitrate
 - Improvements to Web UI
 
 ## [0.11.1] - 2021-10-04
-### Changed
+**Changed**
 - (Linux) Fix search path for config file and assets
 
 ## [0.11.0] - 2021-10-04
-### Added
+**Added**
 - (Linux) Added support for wlroots based compositors on Wayland.
 - (Windows) Added an icon for the executable
-### Changed
+
+**Changed**
 - Fixed a bug causing segfault when connecting multiple controllers.
 - (Linux) Improved NVENC, it now offloads converting images from RGB to NV12
 - (Linux) Fixed a bug causes stuttering
 
 ## [0.10.1] - 2021-08-21
-### Changed
+**Changed**
 - (Linux) Re-enabled KMS
 
 ## [0.10.0] - 2021-08-20
-### Added
+**Added**
 - Added support for Rumble with gamepads.
 - Added support for keyboard shortcuts <--- See the README for details.
 - (Windows) A very basic script has been added in Sunshine-Windows\tools <-- This will start Sunshine at boot with the highest privileges which is needed to display the login prompt.
-### Changed
+
+**Changed**
 - Some cosmetic changes to the WebUI.
 - The first time the WebUI is opened, it will request the creation of a username/password pair from the user.
 - Fixed audio crackling introduced in version 0.8.0
@@ -95,54 +478,58 @@
 - (Windows) Installing from debian package shouldn't overwrite your configuration files anymore. <-- It's recommended that you back up `/etc/sunshine/` before testing this.
 
 ## [0.9.0] - 2021-07-11
-### Added
+**Added**
 - Added audio encryption
 - (Linux) Added basic NVENC support on Linux
 - (Windows) The Windows version can now capture the lock screen and the UAC prompt as long as it's run through `PsExec.exe` https://docs.microsoft.com/en-us/sysinternals/downloads/psexec
-### Changed
+
+**Changed**
 - Sunshine will now accept expired or not-yet-valid certificates, as long as they are signed properly.
 - Fixed compatibility with iOS version of Moonlight
 - Drastically reduced chance of being forced to skip error correction due to video frame size
 - (Linux) sunshine.service will be installed automatically.
 
 ## [0.8.0] - 2021-06-30
-### Added
+**Added**
 - Added mDNS support: Moonlight will automatically find Sunshine.
 - Added UPnP support. It's off by default.
 
 ## [0.7.7] - 2021-06-24
-### Added
+**Added**
 - (Linux) Added installation package for Debian
-### Changed
+
+**Changed**
 - Fixed incorrect scaling for absolute mouse coordinates when using multiple monitors.
 - Fixed incorrect colors when scaling for software encoder
 
 ## [0.7.1] - 2021-06-18
-### Changed
+**Changed**
 - (Linux) Fixed an issue where it was impossible to start sunshine on ubuntu 20.04
 
 ## [0.7.0] - 2021-06-16
-### Added
+**Added**
 - Added a Web Manager. Accessible through: https://localhost:47990 or https://<ip of your pc>:47990
 - (Linux) Added hardware encoding support for AMD on Linux
-### Changed
+
+**Changed**
 - (Linux) Moved certificates and saved pairings generated during runtime to .config/sunshine on Linux
 
 ## [0.6.0] - 2021-05-26
-### Added
+**Added**
 - Added support for surround audio
-### Changed
+
+**Changed**
 - Maintain aspect ratio when scaling video
 - Fix issue where Sunshine is forced to drop frames when they are too large
 
 ## [0.5.0] - 2021-05-13
-### Added
+**Added**
 - Added support for absolute mouse coordinates
 - (Linux) Added support for streaming specific monitor on Linux
 - (Windows) Added support for AMF on Windows
 
 ## [0.4.0] - 2020-05-03
-### Changed
+**Changed**
 - prep-cmd is now optional in apps.json
 - Fixed bug causing video artifacts
 - Fixed bug preventing Moonlight from closing app on exit
@@ -151,23 +538,57 @@
 - Fixed bug causing crash when monitor has resolution 1366x768
 
 ## [0.3.1] - 2020-04-24
-### Changed
+**Changed**
 - Fix a memory leak.
 
 ## [0.3.0] - 2020-04-23
-### Changed
+**Changed**
 - Hardware acceleration on NVidia GPU's for Video encoding on Windows
 
 ## [0.2.0] - 2020-03-21
-### Changed
+**Changed**
 - Multicasting is now supported: You can set the maximum simultaneous connections with the configurable option: channels
 - Configuration variables can be overwritten on the command line: "name=value" --> it can be useful to set min_log_level=debug without modifying the configuration file
 - Switches to make testing the pairing mechanism more convenient has been added, see "sunshine --help" for details
 
 ## [0.1.1] - 2020-01-30
-### Added
+**Added**
 - (Linux) Added deb package and service for Linux
 
 ## [0.1.0] - 2020-01-27
-### Added
+**Added**
 - The first official release for Sunshine!
+
+[0.1.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.1.0
+[0.1.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.1.1
+[0.2.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.2.0
+[0.3.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.3.0
+[0.3.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.3.1
+[0.4.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.4.0
+[0.5.0]: https://github.com/LizardByte/Sunshine/releases/tag/0.5.0
+[0.6.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.6.0
+[0.7.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.7.0
+[0.7.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.7.1
+[0.7.7]: https://github.com/LizardByte/Sunshine/releases/tag/v0.7.7
+[0.8.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.8.0
+[0.9.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.9.0
+[0.10.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.10.0
+[0.10.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.10.1
+[0.11.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.11.0
+[0.11.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.11.1
+[0.12.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.12.0
+[0.13.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.13.0
+[0.14.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.14.0
+[0.14.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.14.1
+[0.15.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.15.0
+[0.16.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.16.0
+[0.17.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.17.0
+[0.18.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.18.0
+[0.18.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.18.1
+[0.18.2]: https://github.com/LizardByte/Sunshine/releases/tag/v0.18.2
+[0.18.3]: https://github.com/LizardByte/Sunshine/releases/tag/v0.18.3
+[0.18.4]: https://github.com/LizardByte/Sunshine/releases/tag/v0.18.4
+[0.19.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.19.0
+[0.19.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.19.1
+[0.20.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.20.0
+[0.21.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.21.0

CMakeLists.txt

@@ -1,656 +1,55 @@
-cmake_minimum_required(VERSION 3.0)
+cmake_minimum_required(VERSION 3.18)
+# `CMAKE_CUDA_ARCHITECTURES` requires 3.18
+# todo - set this conditionally
 
-project(Sunshine VERSION 0.15.0
-		DESCRIPTION "Sunshine is a Gamestream host for Moonlight."
-		HOMEPAGE_URL "https://app.lizardbyte.dev"
-		)
+# todo - set version to 0.0.0 once confident in automated versioning
+project(Sunshine VERSION 0.21.0
+        DESCRIPTION "Sunshine is a self-hosted game stream host for Moonlight."
+        HOMEPAGE_URL "https://app.lizardbyte.dev/Sunshine")
 
-set(PROJECT_LONG_DESCRIPTION "Sunshine is a self hosted, low latency, cloud gaming solution with support for AMD, \
-Intel, and Nvidia GPUs. It is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield. \
-Connect to Sunshine from any Moonlight client, available for nearly any device imaginable.")
+set(PROJECT_LICENSE "GPL-3.0")
 
-option(SUNSHINE_CONFIGURE_APPIMAGE "Configuration specific for AppImage." OFF)
-option(SUNSHINE_CONFIGURE_AUR "Configure files required for AUR." OFF)
-option(SUNSHINE_CONFIGURE_FLATPAK_MAN "Configure manifest file required for Flatpak build." OFF)
-option(SUNSHINE_CONFIGURE_FLATPAK "Configuration specific for Flatpak." OFF)
-option(SUNSHINE_CONFIGURE_PORTFILE "Configure macOS Portfile." OFF)
-option(SUNSHINE_CONFIGURE_ONLY "Configure special files only, then exit." OFF)
+set(PROJECT_LONG_DESCRIPTION "Offering low latency, cloud gaming server capabilities with support for AMD, Intel, \
+and Nvidia GPUs for hardware encoding. Software encoding is also available. You can connect to Sunshine from any \
+Moonlight client on a variety of devices. A web UI is provided to allow configuration, and client pairing, from \
+your favorite web browser. Pair from the local server or any mobile device.")
 
-if(${SUNSHINE_CONFIGURE_APPIMAGE})
-	configure_file(packaging/linux/sunshine.desktop sunshine.desktop @ONLY)
-elseif(${SUNSHINE_CONFIGURE_AUR})
-	configure_file(packaging/linux/aur/PKGBUILD PKGBUILD @ONLY)
-elseif(${SUNSHINE_CONFIGURE_FLATPAK_MAN})
-	configure_file(packaging/linux/flatpak/dev.lizardbyte.sunshine.yml dev.lizardbyte.sunshine.yml @ONLY)
-elseif(${SUNSHINE_CONFIGURE_PORTFILE})
-	configure_file(packaging/macos/Portfile Portfile @ONLY)
-endif()
-
-# return if configure only is set
-if(${SUNSHINE_CONFIGURE_ONLY})
-	return()
+if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+    message(STATUS "Setting build type to 'Release' as none was specified.")
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# set the module path, used for includes
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
-set(SUNSHINE_SOURCE_ASSETS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src_assets")
 
-if(WIN32)
-	# Ugly hack to compile with #include <qos2.h>
-	add_compile_definitions(
-		QOS_FLOWID=UINT32
-		PQOS_FLOWID=UINT32*
-		QOS_NON_ADAPTIVE_FLOW=2)
-endif()
-if(APPLE)
-	macro(ADD_FRAMEWORK fwname appname)
-    find_library(FRAMEWORK_${fwname}
-    NAMES ${fwname}
-    PATHS ${CMAKE_OSX_SYSROOT}/System/Library
-    PATH_SUFFIXES Frameworks
-    NO_DEFAULT_PATH)
-    if( ${FRAMEWORK_${fwname}} STREQUAL FRAMEWORK_${fwname}-NOTFOUND)
-        MESSAGE(ERROR ": Framework ${fwname} not found")
-    else()
-        TARGET_LINK_LIBRARIES(${appname} "${FRAMEWORK_${fwname}}/${fwname}")
-        MESSAGE(STATUS "Framework ${fwname} found at ${FRAMEWORK_${fwname}}")
-    endif()
-	endmacro(ADD_FRAMEWORK)
+# set version info for this build
+include(${CMAKE_MODULE_PATH}/prep/build_version.cmake)
+
+# cmake build flags
+include(${CMAKE_MODULE_PATH}/prep/options.cmake)
+
+# configure special package files, such as sunshine.desktop, Flatpak manifest, Portfile , etc.
+include(${CMAKE_MODULE_PATH}/prep/special_package_configuration.cmake)
+
+# Exit early if END_BUILD is ON, i.e. when only generating package manifests
+if(${END_BUILD})
+    return()
 endif()
 
-add_subdirectory(third-party/moonlight-common-c/enet)
-add_subdirectory(third-party/Simple-Web-Server)
+# project constants
+include(${CMAKE_MODULE_PATH}/prep/constants.cmake)
 
-set(UPNPC_BUILD_SHARED OFF CACHE BOOL "no shared libraries")
-set(UPNPC_BUILD_TESTS OFF CACHE BOOL "Don't build tests for miniupnpc")
-set(UPNPC_BUILD_SAMPLE OFF CACHE BOOL "Don't build samples for miniupnpc")
-set(UPNPC_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for miniupnpc")
-add_subdirectory(third-party/miniupnp/miniupnpc)
-include_directories(third-party/miniupnp)
+# load macros
+include(${CMAKE_MODULE_PATH}/macros/common.cmake)
 
-find_package(Threads REQUIRED)
-find_package(OpenSSL REQUIRED)
-if(NOT APPLE)
-	set(Boost_USE_STATIC_LIBS ON)
-endif()
-find_package(Boost COMPONENTS log filesystem REQUIRED)
+# load dependencies
+include(${CMAKE_MODULE_PATH}/dependencies/common.cmake)
 
-list(APPEND SUNSHINE_COMPILE_OPTIONS -Wall -Wno-missing-braces -Wno-maybe-uninitialized -Wno-sign-compare)
+# setup compile definitions
+include(${CMAKE_MODULE_PATH}/compile_definitions/common.cmake)
 
-if(WIN32)
-	enable_language(RC)
-	set(CMAKE_RC_COMPILER windres)
-	file(
-		DOWNLOAD "https://github.com/TheElixZammuto/sunshine-prebuilt/releases/download/1.0.0/pre-compiled.zip" "${CMAKE_CURRENT_BINARY_DIR}/pre-compiled.zip"
-		TIMEOUT 60
-		EXPECTED_HASH SHA256=5d59986bd7f619eaaf82b2dd56b5127b747c9cbe8db61e3b898ff6b485298ed6)
+# target definitions
+include(${CMAKE_MODULE_PATH}/targets/common.cmake)
 
-	file(ARCHIVE_EXTRACT
-		INPUT "${CMAKE_CURRENT_BINARY_DIR}/pre-compiled.zip"
-		DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/pre-compiled)
-	set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
-
-	if(NOT DEFINED SUNSHINE_PREPARED_BINARIES)
-		set(SUNSHINE_PREPARED_BINARIES "${CMAKE_CURRENT_BINARY_DIR}/pre-compiled/windows")
-	endif()
-
-	add_compile_definitions(SUNSHINE_PLATFORM="windows")
-	add_subdirectory(tools)  # This is temporary, only tools for Windows are needed, for now
-
-	include_directories(third-party/ViGEmClient/include)
-
-	if(NOT DEFINED SUNSHINE_ICON_PATH)
-		set(SUNSHINE_ICON_PATH "${CMAKE_CURRENT_SOURCE_DIR}/sunshine.ico")
-	endif()
-	configure_file(src/platform/windows/windows.rs.in windows.rc @ONLY)
-	set(PLATFORM_TARGET_FILES
-		"${CMAKE_CURRENT_BINARY_DIR}/windows.rc"
-		src/platform/windows/publish.cpp
-		src/platform/windows/misc.h
-		src/platform/windows/misc.cpp
-		src/platform/windows/input.cpp
-		src/platform/windows/display.h
-		src/platform/windows/display_base.cpp
-		src/platform/windows/display_vram.cpp
-		src/platform/windows/display_ram.cpp
-		src/platform/windows/audio.cpp
-		third-party/ViGEmClient/src/ViGEmClient.cpp
-		third-party/ViGEmClient/include/ViGEm/Client.h
-		third-party/ViGEmClient/include/ViGEm/Common.h
-		third-party/ViGEmClient/include/ViGEm/Util.h
-		third-party/ViGEmClient/include/ViGEm/km/BusShared.h)
-
-	set(OPENSSL_LIBRARIES
-		libssl.a
-		libcrypto.a)
-
-	set(FFMPEG_INCLUDE_DIRS
-		${SUNSHINE_PREPARED_BINARIES}/include)
-	set(FFMPEG_LIBRARIES
-		${SUNSHINE_PREPARED_BINARIES}/lib/libavcodec.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libavdevice.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libavfilter.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libavformat.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libavutil.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libpostproc.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libswresample.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libswscale.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libx264.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libx265.a
-		${SUNSHINE_PREPARED_BINARIES}/lib/libhdr10plus.a
-		z lzma bcrypt libiconv.a)
-
-	list(PREPEND PLATFORM_LIBRARIES
-		libstdc++.a
-		libwinpthread.a
-		libssp.a
-		ksuser
-		wsock32
-		ws2_32
-		d3d11 dxgi D3DCompiler
-		setupapi
-		dwmapi
-		)
-
-	set_source_files_properties(third-party/ViGEmClient/src/ViGEmClient.cpp PROPERTIES COMPILE_DEFINITIONS "UNICODE=1;ERROR_INVALID_DEVICE_OBJECT_PARAMETER=650")
-	set_source_files_properties(third-party/ViGEmClient/src/ViGEmClient.cpp PROPERTIES COMPILE_FLAGS "-Wno-unknown-pragmas -Wno-misleading-indentation -Wno-class-memaccess")
-elseif(APPLE)
-	add_compile_definitions(SUNSHINE_PLATFORM="macos")
-
-	option(SUNSHINE_MACOS_PACKAGE "Should only be used when creating a MACOS package/dmg." OFF)
-
-	link_directories(/opt/local/lib)
-	link_directories(/usr/local/lib)
-	ADD_DEFINITIONS(-DBOOST_LOG_DYN_LINK)
-
-	find_package(FFmpeg REQUIRED)
-	FIND_LIBRARY(APP_SERVICES_LIBRARY ApplicationServices )
-	FIND_LIBRARY(AV_FOUNDATION_LIBRARY AVFoundation )
-	FIND_LIBRARY(CORE_MEDIA_LIBRARY CoreMedia )
-	FIND_LIBRARY(CORE_VIDEO_LIBRARY CoreVideo )
-	FIND_LIBRARY(FOUNDATION_LIBRARY Foundation )
-	list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
-		${APP_SERVICES_LIBRARY}
-		${AV_FOUNDATION_LIBRARY}
-		${CORE_MEDIA_LIBRARY}
-		${CORE_VIDEO_LIBRARY}
-		${FOUNDATION_LIBRARY})
-
-	set(PLATFORM_INCLUDE_DIRS
-		${Boost_INCLUDE_DIR})
-
-	set(APPLE_PLIST_FILE ${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/Info.plist)
-
-	set(PLATFORM_TARGET_FILES
-		src/platform/macos/av_audio.h
-		src/platform/macos/av_audio.m
-		src/platform/macos/av_img_t.h
-		src/platform/macos/av_video.h
-		src/platform/macos/av_video.m
-		src/platform/macos/display.mm
-		src/platform/macos/input.cpp
-		src/platform/macos/microphone.mm
-		src/platform/macos/misc.cpp
-		src/platform/macos/misc.h
-		src/platform/macos/nv12_zero_device.cpp
-		src/platform/macos/nv12_zero_device.h
-		src/platform/macos/publish.cpp
-		third-party/TPCircularBuffer/TPCircularBuffer.c
-		third-party/TPCircularBuffer/TPCircularBuffer.h
-		${APPLE_PLIST_FILE})
-else()
-	add_compile_definitions(SUNSHINE_PLATFORM="linux")
-
-	option(SUNSHINE_ENABLE_DRM "Enable KMS grab if available" ON)
-	option(SUNSHINE_ENABLE_X11 "Enable X11 grab if available" ON)
-	option(SUNSHINE_ENABLE_WAYLAND "Enable building wayland specific code" ON)
-	option(SUNSHINE_ENABLE_CUDA "Enable cuda specific code" ON)
-
-	if(${SUNSHINE_ENABLE_X11})
-		find_package(X11)
-	else()
-		set(X11_FOUND OFF)
-	endif()
-
-	set(CUDA_FOUND OFF)
-	if(${SUNSHINE_ENABLE_CUDA})
-		include(CheckLanguage)
-		check_language(CUDA)
-
-		if(CMAKE_CUDA_COMPILER)
-			if(NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
-				set(CMAKE_CUDA_ARCHITECTURES 35)
-			endif()
-
-			set(CUDA_FOUND ON)
-			enable_language(CUDA)
-		endif()
-	endif()
-	if(${SUNSHINE_ENABLE_DRM})
-		find_package(LIBDRM)
-		find_package(LIBCAP)
-	else()
-		set(LIBDRM_FOUND OFF)
-		set(LIBCAP_FOUND OFF)
-	endif()
-	if(${SUNSHINE_ENABLE_WAYLAND})
-		find_package(Wayland)
-	else()
-		set(WAYLAND_FOUND OFF)
-	endif()
-
-	find_package(FFMPEG REQUIRED)
-
-	if(X11_FOUND)
-		add_compile_definitions(SUNSHINE_BUILD_X11)
-		include_directories(${X11_INCLUDE_DIR})
-		list(APPEND PLATFORM_TARGET_FILES src/platform/linux/x11grab.cpp)
-	endif()
-
-	if(CUDA_FOUND)
-		include_directories(third-party/nvfbc)
-		list(APPEND PLATFORM_TARGET_FILES
-			src/platform/linux/cuda.cu
-			src/platform/linux/cuda.cpp
-			third-party/nvfbc/NvFBC.h)
-
-			add_compile_definitions(SUNSHINE_BUILD_CUDA)
-	endif()
-
-	if(LIBDRM_FOUND AND LIBCAP_FOUND)
-		add_compile_definitions(SUNSHINE_BUILD_DRM)
-		include_directories(${LIBDRM_INCLUDE_DIRS} ${LIBCAP_INCLUDE_DIRS})
-		list(APPEND PLATFORM_LIBRARIES ${LIBDRM_LIBRARIES} ${LIBCAP_LIBRARIES})
-		list(APPEND PLATFORM_TARGET_FILES src/platform/linux/kmsgrab.cpp)
-		list(APPEND SUNSHINE_DEFINITIONS EGL_NO_X11=1)
-	elseif(LIBDRM_FOUND)
-		message(WARNING "Found libdrm, yet there is no libcap")
-	elseif(LIBDRM_FOUND)
-		message(WARNING "Found libcap, yet there is no libdrm")
-	endif()
-
-	if(WAYLAND_FOUND)
-		add_compile_definitions(SUNSHINE_BUILD_WAYLAND)
-		macro(genWayland FILENAME)
-			make_directory(${CMAKE_BINARY_DIR}/generated-src)
-
-			message("wayland-scanner private-code ${CMAKE_SOURCE_DIR}/third-party/wayland-protocols/${FILENAME}.xml ${CMAKE_BINARY_DIR}/generated-src/${FILENAME}.c")
-			message("wayland-scanner client-header ${CMAKE_SOURCE_DIR}/third-party/wayland-protocols/${FILENAME}.xml ${CMAKE_BINARY_DIR}/generated-src/${FILENAME}.h")
-			execute_process(
-				COMMAND wayland-scanner private-code ${CMAKE_SOURCE_DIR}/third-party/wayland-protocols/${FILENAME}.xml ${CMAKE_BINARY_DIR}/generated-src/${FILENAME}.c
-				COMMAND wayland-scanner client-header ${CMAKE_SOURCE_DIR}/third-party/wayland-protocols/${FILENAME}.xml ${CMAKE_BINARY_DIR}/generated-src/${FILENAME}.h
-
-				RESULT_VARIABLE EXIT_INT
-			)
-
-			if(NOT ${EXIT_INT} EQUAL 0)
-				message(FATAL_ERROR "wayland-scanner failed")
-			endif()
-
-			list(APPEND PLATFORM_TARGET_FILES
-				${CMAKE_BINARY_DIR}/generated-src/${FILENAME}.c
-				${CMAKE_BINARY_DIR}/generated-src/${FILENAME}.h
-			)
-		endmacro()
-
-		genWayland(xdg-output-unstable-v1)
-		genWayland(wlr-export-dmabuf-unstable-v1)
-
-		include_directories(
-			${WAYLAND_INCLUDE_DIRS}
-			${CMAKE_BINARY_DIR}/generated-src
-		)
-
-		list(APPEND PLATFORM_LIBRARIES ${WAYLAND_LIBRARIES})
-		list(APPEND PLATFORM_TARGET_FILES
-			src/platform/linux/wlgrab.cpp
-			src/platform/linux/wayland.cpp)
-	endif()
-	if(NOT ${X11_FOUND} AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND}) AND NOT ${WAYLAND_FOUND} AND NOT ${})
-		message(FATAL_ERROR "Couldn't find either x11, wayland, cuda or (libdrm and libcap)")
-	endif()
-
-	list(APPEND PLATFORM_TARGET_FILES
-		src/platform/linux/publish.cpp
-		src/platform/linux/vaapi.h
-		src/platform/linux/vaapi.cpp
-		src/platform/linux/cuda.h
-		src/platform/linux/graphics.h
-		src/platform/linux/graphics.cpp
-		src/platform/linux/misc.h
-		src/platform/linux/misc.cpp
-		src/platform/linux/audio.cpp
-		src/platform/linux/input.cpp
-		src/platform/linux/x11grab.h
-		src/platform/linux/wayland.h
-		third-party/glad/src/egl.c
-		third-party/glad/src/gl.c
-		third-party/glad/include/EGL/eglplatform.h
-		third-party/glad/include/KHR/khrplatform.h
-		third-party/glad/include/glad/gl.h
-		third-party/glad/include/glad/egl.h)
-
-	list(APPEND PLATFORM_LIBRARIES
-		dl
-		evdev
-		pulse
-		pulse-simple
-		)
-
-	include_directories(
-		/usr/include/libevdev-1.0
-		third-party/nv-codec-headers/include
-		third-party/glad/include)
-
-	if(NOT DEFINED SUNSHINE_EXECUTABLE_PATH)
-		set(SUNSHINE_EXECUTABLE_PATH "sunshine")
-	endif()
-	configure_file(sunshine.service.in sunshine.service @ONLY)
-endif()
-
-configure_file(version.h.in version.h @ONLY)
-include_directories(${CMAKE_CURRENT_BINARY_DIR})
-
-set(SUNSHINE_TARGET_FILES
-	third-party/moonlight-common-c/reedsolomon/rs.c
-	third-party/moonlight-common-c/reedsolomon/rs.h
-	third-party/moonlight-common-c/src/Input.h
-	third-party/moonlight-common-c/src/Rtsp.h
-	third-party/moonlight-common-c/src/RtspParser.c
-	third-party/moonlight-common-c/src/Video.h
-	src/upnp.cpp
-	src/upnp.h
-	src/cbs.cpp
-	src/utility.h
-	src/uuid.h
-	src/config.h
-	src/config.cpp
-	src/main.cpp
-	src/main.h
-	src/crypto.cpp
-	src/crypto.h
-	src/nvhttp.cpp
-	src/nvhttp.h
-	src/httpcommon.cpp
-	src/httpcommon.h
-	src/confighttp.cpp
-	src/confighttp.h
-	src/rtsp.cpp
-	src/rtsp.h
-	src/stream.cpp
-	src/stream.h
-	src/video.cpp
-	src/video.h
-	src/input.cpp
-	src/input.h
-	src/audio.cpp
-	src/audio.h
-	src/platform/common.h
-	src/process.cpp
-	src/process.h
-	src/network.cpp
-	src/network.h
-	src/move_by_copy.h
-	src/task_pool.h
-	src/thread_pool.h
-	src/thread_safe.h
-	src/sync.h
-	src/round_robin.h
-	${PLATFORM_TARGET_FILES})
-
-set_source_files_properties(src/upnp.cpp PROPERTIES COMPILE_FLAGS -Wno-pedantic)
-
-include_directories(
-  ${CMAKE_CURRENT_SOURCE_DIR}
-  ${CMAKE_CURRENT_SOURCE_DIR}/third-party
-  ${CMAKE_CURRENT_SOURCE_DIR}/third-party/cbs/include
-  ${CMAKE_CURRENT_SOURCE_DIR}/third-party/moonlight-common-c/enet/include
-  ${CMAKE_CURRENT_SOURCE_DIR}/third-party/moonlight-common-c/reedsolomon
-  ${FFMPEG_INCLUDE_DIRS}
-  ${PLATFORM_INCLUDE_DIRS}
-)
-
-add_subdirectory(third-party/cbs)
-
-string(TOUPPER "x${CMAKE_BUILD_TYPE}" BUILD_TYPE)
-if("${BUILD_TYPE}" STREQUAL "XDEBUG")
-	list(APPEND SUNSHINE_COMPILE_OPTIONS -O0 -ggdb3)
-	if(WIN32)
-		set_source_files_properties(src/nvhttp.cpp PROPERTIES COMPILE_FLAGS -O2)
-	endif()
-else()
-	add_definitions(-DNDEBUG)
-	list(APPEND SUNSHINE_COMPILE_OPTIONS -O3)
-endif()
-
-# setup assets directory
-if(NOT SUNSHINE_ASSETS_DIR)
-	set(SUNSHINE_ASSETS_DIR "assets")
-endif()
-if(UNIX)
-	set(SUNSHINE_ASSETS_DIR "${CMAKE_INSTALL_PREFIX}/${SUNSHINE_ASSETS_DIR}")
-endif()
-
-# use relative assets path for AppImage... maybe for all unix
-if(${SUNSHINE_CONFIGURE_APPIMAGE})
-	string(REPLACE "${CMAKE_INSTALL_PREFIX}" ".${CMAKE_INSTALL_PREFIX}" SUNSHINE_ASSETS_DIR_DEF ${SUNSHINE_ASSETS_DIR})
-else()
-	set(SUNSHINE_ASSETS_DIR_DEF "${SUNSHINE_ASSETS_DIR}")
-endif()
-list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_ASSETS_DIR="${SUNSHINE_ASSETS_DIR_DEF}")
-
-
-list(APPEND CBS_EXTERNAL_LIBRARIES
-	cbs)
-
-list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
-		libminiupnpc-static
-		${CBS_EXTERNAL_LIBRARIES}
-		${CMAKE_THREAD_LIBS_INIT}
-		enet
-		opus
-		${FFMPEG_LIBRARIES}
-		${Boost_LIBRARIES}
-		${OPENSSL_LIBRARIES}
-		${PLATFORM_LIBRARIES})
-
-if(NOT WIN32)
-	list(APPEND SUNSHINE_EXTERNAL_LIBRARIES Boost::log)
-endif()
-
-add_executable(sunshine ${SUNSHINE_TARGET_FILES})
-target_link_libraries(sunshine ${SUNSHINE_EXTERNAL_LIBRARIES} ${EXTRA_LIBS})
-target_compile_definitions(sunshine PUBLIC ${SUNSHINE_DEFINITIONS})
-set_target_properties(sunshine PROPERTIES CXX_STANDARD 17
-                            VERSION ${PROJECT_VERSION}
-                            SOVERSION ${PROJECT_VERSION_MAJOR}
-                            )
-
-if(NOT DEFINED CMAKE_CUDA_STANDARD)
-    set(CMAKE_CUDA_STANDARD 17)
-    set(CMAKE_CUDA_STANDARD_REQUIRED ON)
-endif()
-
-if(APPLE)
-	target_link_options(sunshine PRIVATE LINKER:-sectcreate,__TEXT,__info_plist,${APPLE_PLIST_FILE})
-endif()
-
-foreach(flag IN LISTS SUNSHINE_COMPILE_OPTIONS)
-	list(APPEND SUNSHINE_COMPILE_OPTIONS_CUDA "$<$<COMPILE_LANGUAGE:CUDA>:--compiler-options=${flag}>")
-endforeach()
-
-target_compile_options(sunshine PRIVATE $<$<COMPILE_LANGUAGE:CXX>:${SUNSHINE_COMPILE_OPTIONS}>;$<$<COMPILE_LANGUAGE:CUDA>:${SUNSHINE_COMPILE_OPTIONS_CUDA};-std=c++17>)
-
-# CPACK / Packaging
-
-# Common options
-set(CPACK_PACKAGE_NAME "Sunshine")
-set(CPACK_PACKAGE_VENDOR "LizardByte")
-set(CPACK_PACKAGE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/cpack_artifacts)
-set(CPACK_PACKAGE_CONTACT "https://app.lizardbyte.dev")
-set(CPACK_DEBIAN_PACKAGE_MAINTAINER "https://github.com/LizardByte")
-set(CPACK_PACKAGE_DESCRIPTION ${CMAKE_PROJECT_DESCRIPTION})
-set(CPACK_PACKAGE_HOMEPAGE_URL ${CMAKE_PROJECT_HOMEPAGE_URL})
-set(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE)
-set(CPACK_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/sunshine.png)
-set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}")
-set(CPACK_STRIP_FILES YES)
-
-# Platform specific options
-if(WIN32) # see options at: https://cmake.org/cmake/help/latest/cpack_gen/nsis.html
-	install(TARGETS sunshine RUNTIME DESTINATION "." COMPONENT application)
-
-	# Adding tools
-	install(TARGETS dxgi-info RUNTIME DESTINATION "tools" COMPONENT dxgi)
-	install(TARGETS audio-info RUNTIME DESTINATION "tools" COMPONENT audio)
-	install(TARGETS sunshinesvc RUNTIME DESTINATION "tools" COMPONENT sunshinesvc)
-
-	# scripts
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/firewall/" DESTINATION "scripts" COMPONENT firewall)
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/service/" DESTINATION "scripts" COMPONENT service)
-
-	# Sunshine assets
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}" COMPONENT assets)
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}" COMPONENT assets)
-
-	# set(CPACK_NSIS_MUI_HEADERIMAGE "") # TODO: image should be 150x57 bmp
-	set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\sunshine.ico")
-	set(CPACK_NSIS_INSTALLED_ICON_NAME "${PROJECT__DIR}\\\\${PROJECT_EXE}")
-	set(CPACK_PACKAGE_INSTALL_DIRECTORY "${CPACK_PACKAGE_NAME}")  # The name of the directory that will be created in C:/Program files/
-	string(APPEND CPACK_NSIS_DEFINES "\n  RequestExecutionLevel admin")  # TODO: Not sure if this is needed but it took me a while to figure out where to put this option so I'm leaving it here
-
-	# Extra install commands
-	# Sets permissions on the installed folder so that we can write in it
-	# Install service
-	SET(CPACK_NSIS_EXTRA_INSTALL_COMMANDS
-		"${CPACK_NSIS_EXTRA_INSTALL_COMMANDS}
-    	ExecWait 'icacls \\\"$INSTDIR\\\" /grant:r Users:\\\(OI\\\)\\\(CI\\\)\\\(F\\\)'
-    	ExecWait '\\\"$INSTDIR\\\\scripts\\\\add-firewall-rule.bat\\\"'
-    	ExecWait '\\\"$INSTDIR\\\\scripts\\\\install-service.bat\\\"'
-    	")
-
-	# Extra uninstall commands
-	# Uninstall service
-	set(CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
-		"${CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS}
-		ExecWait '\\\"$INSTDIR\\\\scripts\\\\delete-firewall-rule.bat\\\"'
-    	ExecWait '\\\"$INSTDIR\\\\scripts\\\\uninstall-service.bat\\\"'
-    	MessageBox MB_YESNO|MB_ICONQUESTION 'Do you want to completely remove the directory $INSTDIR and all of its contents?' IDNO NoDelete
-      		RMDir /r \\\"$INSTDIR\\\" ; skipped if no
-    	NoDelete:
-		")
-
-	# Adding an option for the start menu and PATH
-	set(CPACK_NSIS_MODIFY_PATH "OFF") # TODO: it asks to add it to the PATH but is not working https://gitlab.kitware.com/cmake/cmake/-/issues/15635
-	set(CPACK_NSIS_EXECUTABLES_DIRECTORY ".")
-	set(CPACK_NSIS_MUI_FINISHPAGE_RUN "${CMAKE_PROJECT_NAME}.exe")
-	set(CPACK_NSIS_INSTALLED_ICON_NAME "${CMAKE_PROJECT_NAME}.exe")  # This will be shown on the installed apps Windows settings
-	set(CPACK_NSIS_CREATE_ICONS_EXTRA
-		"${CPACK_NSIS_CREATE_ICONS_EXTRA}
-		CreateShortCut '\$SMPROGRAMS\\\\$STARTMENU_FOLDER\\\\${CMAKE_PROJECT_NAME}.lnk' '\$INSTDIR\\\\${CMAKE_PROJECT_NAME}.exe'
-		")
-	set(CPACK_NSIS_DELETE_ICONS_EXTRA
-		"${CPACK_NSIS_DELETE_ICONS_EXTRA}
-		Delete '\$SMPROGRAMS\\\\$MUI_TEMP\\\\${CMAKE_PROJECT_NAME}.lnk'
-		")
-
-	# Checking for previous installed versions
-	# set(CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL "ON")  # TODO: doesn't work on my machine when Sunshine is already installed
-
-	set(CPACK_NSIS_HELP_LINK "https://docs.lizardbyte.dev/projects/sunshine/en/latest/about/installation.html")
-	set(CPACK_NSIS_URL_INFO_ABOUT "${CMAKE_PROJECT_HOMEPAGE_URL}")
-	set(CPACK_NSIS_CONTACT "${CMAKE_PROJECT_HOMEPAGE_URL}/support")
-
-	# Setting components groups and dependencies
-	# sunshine binary
-	set(CPACK_COMPONENT_APPLICATION_DISPLAY_NAME "${CMAKE_PROJECT_NAME}")
-	set(CPACK_COMPONENT_APPLICATION_DESCRIPTION "${CMAKE_PROJECT_NAME} main application.")
-	set(CPACK_COMPONENT_APPLICATION_GROUP "core")
-	set(CPACK_COMPONENT_APPLICATION_REQUIRED true)
-	set(CPACK_COMPONENT_APPLICATION_DEPENDS assets)
-
-	# assets
-	set(CPACK_COMPONENT_ASSETS_DISPLAY_NAME "assets")
-	set(CPACK_COMPONENT_ASSETS_DESCRIPTION "Shaders, default box art, and web ui.")
-	set(CPACK_COMPONENT_ASSETS_GROUP "core")
-	set(CPACK_COMPONENT_ASSETS_REQUIRED true)
-
-	# audio tool
-	set(CPACK_COMPONENT_AUDIO_DISPLAY_NAME "audio-info")
-	set(CPACK_COMPONENT_AUDIO_DESCRIPTION "CLI tool providing information about sound devices.")
-	set(CPACK_COMPONENT_AUDIO_GROUP "tools")
-
-	# display tool
-	set(CPACK_COMPONENT_DXGI_DISPLAY_NAME "dxgi-info")
-	set(CPACK_COMPONENT_DXGI_DESCRIPTION "CLI tool providing information about graphics cards and displays.")
-	set(CPACK_COMPONENT_DXGI_GROUP "tools")
-
-	# service
-	set(CPACK_COMPONENT_SUNSHINESVC_DISPLAY_NAME "sunshinesvc")
-	set(CPACK_COMPONENT_SUNSHINESVC_DESCRIPTION "CLI tool providing ability to enable/disable the Sunshine service.")
-	set(CPACK_COMPONENT_SUNSHINESVC_GROUP "tools")
-
-	# service scripts
-	set(CPACK_COMPONENT_SERVICE_DISPLAY_NAME "service-scripts")
-	set(CPACK_COMPONENT_SERVICE_DESCRIPTION "Scripts to enable/disable the service.")
-	set(CPACK_COMPONENT_SERVICE_GROUP "scripts")
-	set(CPACK_COMPONENT_SERVICE_DEPENDS sunshinesvc)
-
-	# firewall scripts
-	set(CPACK_COMPONENT_FIREWALL_DISPLAY_NAME "firewall-scripts")
-	set(CPACK_COMPONENT_FIREWALL_DESCRIPTION "Scripts to enable or disable firewall rules.")
-	set(CPACK_COMPONENT_FIREWALL_GROUP "scripts")
-endif()
-if(APPLE)
-	# TODO: bundle doesn't produce a valid .app use cpack -G DragNDrop
-	set(CPACK_BUNDLE_NAME "${CMAKE_PROJECT_NAME}")
-	set(CPACK_BUNDLE_PLIST "${APPLE_PLIST_FILE}")
-	set(CPACK_BUNDLE_ICON "${PROJECT_SOURCE_DIR}/sunshine.icns")
-	# set(CPACK_BUNDLE_STARTUP_COMMAND "${INSTALL_RUNTIME_DIR}/sunshine")
-endif()
-if(APPLE AND SUNSHINE_MACOS_PACKAGE)  # TODO
-	set(prefix "${CMAKE_PROJECT_NAME}.app/Contents")
-	set(INSTALL_RUNTIME_DIR "${prefix}/MacOS")
-
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}")
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}")
-
-	install(TARGETS sunshine
-			BUNDLE DESTINATION . COMPONENT Runtime
-			RUNTIME DESTINATION ${INSTALL_RUNTIME_DIR} COMPONENT Runtime)
-elseif(UNIX)
-	# Installation destination dir
-	set(CPACK_SET_DESTDIR true)
-	if(NOT CMAKE_INSTALL_PREFIX)
-		set(CMAKE_INSTALL_PREFIX "/usr/share/sunshine")
-	endif()
-
-	install(TARGETS sunshine RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}")
-
-	install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}")
-
-	if(APPLE)
-		install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}")
-		install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/misc/uninstall_pkg.sh" DESTINATION "${SUNSHINE_ASSETS_DIR}")
-	else()
-		install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}")
-		if(${SUNSHINE_CONFIGURE_APPIMAGE} OR ${SUNSHINE_CONFIGURE_FLATPAK})
-			install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules" DESTINATION "${SUNSHINE_ASSETS_DIR}/udev/rules.d")
-			install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service" DESTINATION "${SUNSHINE_ASSETS_DIR}/systemd/user")
-		else()
-			install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules" DESTINATION "${CMAKE_INSTALL_LIBDIR}/udev/rules.d")
-			install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service" DESTINATION "${CMAKE_INSTALL_LIBDIR}/systemd/user")
-		endif()
-
-		# Post install
-		set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/postinst")
-		set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/postinst")
-
-		# Dependencies
-		set(CPACK_DEB_COMPONENT_INSTALL ON)
-		set(CPACK_DEBIAN_PACKAGE_DEPENDS "openssl, libavdevice58, libboost-thread1.67.0 | libboost-thread1.71.0 | libboost-thread1.74.0, libboost-filesystem1.67.0 | libboost-filesystem1.71.0 | libboost-filesystem1.74.0, libboost-log1.67.0 | libboost-log1.71.0 | libboost-log1.74.0, libpulse0, libopus0, libxcb-shm0, libxcb-xfixes0, libxtst6, libevdev2, libdrm2, libcap2")
-		set(CPACK_RPM_PACKAGE_REQUIRES "openssl >= 1.1, libavdevice >= 4.3, boost-thread >= 1.67.0, boost-filesystem >= 1.67.0, boost-log >= 1.67.0, pulseaudio-libs >= 10.0, libopusenc >= 0.2.1, libxcb >= 1.13, libXtst >= 1.2.3, libevdev >= 1.5.6, libdrm >= 2.4.97, libcap >= 2.22")
-		set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS OFF)  # This should automatically figure out dependencies, doesn't work with the current config
-	endif()
-endif()
-
-include(CPack)
+# packaging
+include(${CMAKE_MODULE_PATH}/packaging/common.cmake)

DOCKER_README.md

@@ -1,17 +1,44 @@
 # Docker
 
+## Important note
+Starting with v0.18.0, tag names have changed. You may no longer use `latest`, `master`, `vX.X.X`.
+
 ## Build your own containers
 This image provides a method for you to easily use the latest Sunshine release in your own docker projects. It is not
 intended to use as a standalone container at this point, and should be considered experimental.
 
 ```dockerfile
-FROM  lizardbyte/sunshine
+ARG SUNSHINE_VERSION=latest
+ARG SUNSHINE_OS=ubuntu-22.04
+FROM lizardbyte/sunshine:${SUNSHINE_VERSION}-${SUNSHINE_OS}
 
 # install Steam, Wayland, etc.
 
 ENTRYPOINT steam && sunshine
 ```
 
+### SUNSHINE_VERSION
+- `latest`, `master`, `vX.X.X`
+- `nightly`
+- commit hash
+
+### SUNSHINE_OS
+Sunshine images are available with the following tag suffixes, based on their respective base images.
+
+- `archlinux`
+- `debian-bullseye`
+- `fedora-36`
+- `fedora-37`
+- `ubuntu-20.04`
+- `ubuntu-22.04`
+
+### Tags
+You must combine the `SUNSHINE_VERSION` and `SUNSHINE_OS` to determine the tag to pull. The format should be
+`<SUNSHINE_VERSION>-<SUNSHINE_OS>`. For example, `latest-ubuntu-22.04`.
+
+See all our available tags on [docker hub](https://hub.docker.com/r/lizardbyte/sunshine/tags) or
+[ghcr](https://github.com/LizardByte/Sunshine/pkgs/container/sunshine/versions) for more info.
+
 ## Where used
 This is a list of docker projects using Sunshine. Something missing? Let us know about it!
 
@@ -71,13 +98,13 @@ port `47990` (e.g. `http://<host_ip>:47990`). The internal port must be `47990`,
 (e.g. `-p 8080:47990`). All the ports listed in the `docker run` and `docker-compose` examples are required.
 
 
-| Parameter                   | Function                  | Example Value      | Required |
-|-----------------------------|---------------------------|--------------------|----------|
-| `-p <port>:47990`           | Web UI Port               | `47990`            | True     |
-| `-v <path to data>:/config` | Volume mapping            | `/home/sunshine`   | True     |
-| `-e PUID=<uid>`             | User ID                   | `1001`             | False    |
-| `-e PGID=<gid>`             | Group ID                  | `1001`             | False    |
-| `-e TZ=<timezone>`          | Lookup TZ value [here][1] | `America/New_York` | False    |
+| Parameter                   | Function             | Example Value      | Required |
+|-----------------------------|----------------------|--------------------|----------|
+| `-p <port>:47990`           | Web UI Port          | `47990`            | True     |
+| `-v <path to data>:/config` | Volume mapping       | `/home/sunshine`   | True     |
+| `-e PUID=<uid>`             | User ID              | `1001`             | False    |
+| `-e PGID=<gid>`             | Group ID             | `1001`             | False    |
+| `-e TZ=<timezone>`          | Lookup [TZ value][1] | `America/New_York` | False    |
 
 [1]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 
@@ -94,3 +121,19 @@ uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
 ```
 
 If you want to change the PUID or PGID after the image has been built, it will require rebuilding the image.
+
+## Supported Architectures
+
+Specifying `lizardbyte/sunshine:latest-<SUNSHINE_OS>` or `ghcr.io/lizardbyte/sunshine:latest-<SUNSHINE_OS>` should
+retrieve the correct image for your architecture.
+
+The architectures supported by these images are shown in the table below.
+
+| tag suffix      | amd64/x86_64 | arm64/aarch64 |
+|-----------------|--------------|---------------|
+| archlinux       | ✅            | ❌             |
+| debian-bullseye | ✅            | ✅             |
+| fedora-36       | ✅            | ✅             |
+| fedora-37       | ✅            | ✅             |
+| ubuntu-20.04    | ✅            | ✅             |
+| ubuntu-22.04    | ✅            | ✅             |

Dockerfile

@@ -1,92 +0,0 @@
-FROM ubuntu:22.04 AS sunshine-base
-
-ARG DEBIAN_FRONTEND=noninteractive
-
-FROM sunshine-base as sunshine-build
-
-SHELL ["/bin/bash", "-o", "pipefail", "-c"]
-RUN apt-get update -y \
-     && apt-get install -y --no-install-recommends \
-        build-essential=12.9* \
-        cmake=3.22.1* \
-        libavdevice-dev=7:4.4.* \
-        libboost-filesystem-dev=1.74.0* \
-        libboost-log-dev=1.74.0* \
-        libboost-thread-dev=1.74.0* \
-        libcap-dev=1:2.44* \
-        libdrm-dev=2.4.110* \
-        libevdev-dev=1.12.1* \
-        libpulse-dev=1:15.99.1* \
-        libopus-dev=1.3.1* \
-        libssl-dev=3.0.2* \
-        libwayland-dev=1.20.0* \
-        libx11-dev=2:1.7.5* \
-        libxcb-shm0-dev=1.14* \
-        libxcb-xfixes0-dev=1.14* \
-        libxcb1-dev=1.14* \
-        libxfixes-dev=1:6.0.0* \
-        libxrandr-dev=2:1.5.2* \
-        libxtst-dev=2:1.2.3* \
-        nvidia-cuda-dev=11.5.1* \
-        nvidia-cuda-toolkit=11.5.1* \
-    && apt-get clean \
-    && rm -rf /var/lib/apt/lists/*
-
-# copy repository
-WORKDIR /root/sunshine-build/
-COPY . .
-
-# setup build directory
-WORKDIR /root/sunshine-build/build
-
-# cmake and cpack
-RUN cmake -DCMAKE_BUILD_TYPE=Release \
-        -DCMAKE_INSTALL_PREFIX=/usr \
-        -DSUNSHINE_ASSETS_DIR=share/sunshine \
-        -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
-        -DSUNSHINE_ENABLE_WAYLAND=ON \
-        -DSUNSHINE_ENABLE_X11=ON \
-        -DSUNSHINE_ENABLE_DRM=ON \
-        -DSUNSHINE_ENABLE_CUDA=ON \
-        /root/sunshine-build \
-    && make -j "$(nproc)" \
-    && cpack -G DEB
-
-FROM sunshine-base as sunshine
-
-# copy deb from builder
-COPY --from=sunshine-build /root/sunshine-build/build/cpack_artifacts/Sunshine.deb /sunshine.deb
-
-# install sunshine
-RUN apt-get update -y \
-    && apt-get install -y --no-install-recommends /sunshine.deb \
-    && apt-get clean \
-    && rm -rf /var/lib/apt/lists/*
-
-# network setup
-EXPOSE 47984-47990/tcp
-EXPOSE 48010
-EXPOSE 47998-48000/udp
-
-# setup user
-ARG PGID=1000
-ENV PGID=${PGID}
-ARG PUID=1000
-ENV PUID=${PUID}
-ENV TZ="UTC"
-ARG UNAME=lizard
-ENV UNAME=${UNAME}
-
-ENV HOME=/home/$UNAME
-
-RUN groupadd -f -g "${PGID}" "${UNAME}" && \
-    useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -G input -u "${PUID}" "${UNAME}" && \
-    mkdir -p ${HOME}/.config/sunshine && \
-    ln -s ${HOME}/.config/sunshine /config && \
-    chown -R ${UNAME} ${HOME}
-
-USER ${UNAME}
-WORKDIR ${HOME}
-
-# entrypoint
-ENTRYPOINT ["/usr/bin/sunshine"]

README.rst

@@ -1,71 +1,128 @@
 Overview
 ========
-LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`_.
+LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`__.
 
 About
 -----
-Sunshine is a Game stream host for Moonlight.
-Sunshine is a self hosted, low latency, cloud gaming solution with support for AMD, Intel, and Nvidia gpus.
-It is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield.
-Connect to Sunshine from any Moonlight client, available for nearly any device imaginable.
+Sunshine is a self-hosted game stream host for Moonlight.
+Offering low latency, cloud gaming server capabilities with support for AMD, Intel, and Nvidia GPUs for hardware
+encoding. Software encoding is also available. You can connect to Sunshine from any Moonlight client on a variety of
+devices. A web UI is provided to allow configuration, and client pairing, from your favorite web browser. Pair from
+the local server or any mobile device.
 
-These are the advantages of Sunshine over GeForce Experience.
+System Requirements
+-------------------
 
-- FOSS (Free and Open Source Software)
-- Multi-platform
+.. warning:: This table is a work in progress. Do not purchase hardware based on this.
 
-  - Linux
-  - macOS
-  - Windows
+**Minimum Requirements**
 
-- Pair over web ui
-- Supports AMD, Intel, and Nvidia GPUs for encoding
-- Supports software encoding
-- Supports streaming to multiple clients
-- Web UI for configuration
++------------+------------------------------------------------------------+
+| GPU        | AMD: VCE 1.0 or higher, see `obs-amd hardware support`_    |
+|            +------------------------------------------------------------+
+|            | Intel: VAAPI-compatible, see: `VAAPI hardware support`_    |
+|            +------------------------------------------------------------+
+|            | Nvidia: NVENC enabled cards, see `nvenc support matrix`_   |
++------------+------------------------------------------------------------+
+| CPU        | AMD: Ryzen 3 or higher                                     |
+|            +------------------------------------------------------------+
+|            | Intel: Core i3 or higher                                   |
++------------+------------------------------------------------------------+
+| RAM        | 4GB or more                                                |
++------------+------------------------------------------------------------+
+| OS         | Windows: 10+ (Windows Server not supported)                |
+|            +------------------------------------------------------------+
+|            | macOS: 11.7+                                               |
+|            +------------------------------------------------------------+
+|            | Linux/Debian: 11 (bullseye)                                |
+|            +------------------------------------------------------------+
+|            | Linux/Fedora: 36+                                          |
+|            +------------------------------------------------------------+
+|            | Linux/Ubuntu: 20.04+ (focal)                               |
++------------+------------------------------------------------------------+
+| Network    | Host: 5GHz, 802.11ac                                       |
+|            +------------------------------------------------------------+
+|            | Client: 5GHz, 802.11ac                                     |
++------------+------------------------------------------------------------+
+
+**4k Suggestions**
+
++------------+------------------------------------------------------------+
+| GPU        | AMD: Video Coding Engine 3.1 or higher                     |
+|            +------------------------------------------------------------+
+|            | Intel: HD Graphics 510 or higher                           |
+|            +------------------------------------------------------------+
+|            | Nvidia: GeForce GTX 1080 or higher                         |
++------------+------------------------------------------------------------+
+| CPU        | AMD: Ryzen 5 or higher                                     |
+|            +------------------------------------------------------------+
+|            | Intel: Core i5 or higher                                   |
++------------+------------------------------------------------------------+
+| Network    | Host: CAT5e ethernet or better                             |
+|            +------------------------------------------------------------+
+|            | Client: CAT5e ethernet or better                           |
++------------+------------------------------------------------------------+
+
+**HDR Suggestions**
+
++------------+------------------------------------------------------------+
+| GPU        | AMD: Video Coding Engine 3.4 or higher                     |
+|            +------------------------------------------------------------+
+|            | Intel: UHD Graphics 730 or higher                          |
+|            +------------------------------------------------------------+
+|            | Nvidia: Pascal-based GPU (GTX 10-series) or higher         |
++------------+------------------------------------------------------------+
+| CPU        | AMD: todo                                                  |
+|            +------------------------------------------------------------+
+|            | Intel: todo                                                |
++------------+------------------------------------------------------------+
+| Network    | Host: CAT5e ethernet or better                             |
+|            +------------------------------------------------------------+
+|            | Client: CAT5e ethernet or better                           |
++------------+------------------------------------------------------------+
 
 Integrations
 ------------
 
-.. image:: https://img.shields.io/github/workflow/status/lizardbyte/sunshine/CI/master?label=CI%20build&logo=github&style=for-the-badge
+.. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/CI.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge
    :alt: GitHub Workflow Status (CI)
    :target: https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster
 
-.. image:: https://img.shields.io/github/workflow/status/lizardbyte/sunshine/localize/nightly?label=localize%20build&logo=github&style=for-the-badge
+.. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/localize.yml.svg?branch=nightly&label=localize%20build&logo=github&style=for-the-badge
    :alt: GitHub Workflow Status (localize)
    :target: https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Anightly
 
-.. image:: https://img.shields.io/readthedocs/sunshinestream?label=Docs&style=for-the-badge&logo=readthedocs
+.. image:: https://img.shields.io/readthedocs/sunshinestream.svg?label=Docs&style=for-the-badge&logo=readthedocs
    :alt: Read the Docs
    :target: http://sunshinestream.readthedocs.io/
 
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=localized&style=for-the-badge&query=%24.progress..data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json&logo=crowdin
-   :alt: CrowdIn
-   :target: https://crowdin.com/project/sunshinestream
-
 Support
----------
+-------
 
 Our support methods are listed in our
-`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`_.
+`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`__.
 
 Downloads
 ---------
 
-.. image:: https://img.shields.io/github/downloads/lizardbyte/sunshine/total?style=for-the-badge&logo=github
+.. image:: https://img.shields.io/github/downloads/lizardbyte/sunshine/total.svg?style=for-the-badge&logo=github
    :alt: GitHub Releases
    :target: https://github.com/LizardByte/Sunshine/releases/latest
 
-.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine?style=for-the-badge&logo=docker
+.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine.svg?style=for-the-badge&logo=docker
    :alt: Docker
    :target: https://hub.docker.com/r/lizardbyte/sunshine
 
+.. image:: https://img.shields.io/badge/dynamic/xml.svg?color=orange&label=Winget&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27winget%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=microsoft
+   :alt: Winget Version
+   :target: https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine
+
 Stats
 ------
-.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine?logo=github&style=for-the-badge
+.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge
    :alt: GitHub stars
    :target: https://github.com/LizardByte/Sunshine
 
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=AUR&style=for-the-badge&query=$.results.0.NumVotes&url=https%3A%2F%2Fapp.lizardbyte.dev%2Funo%2Faur%2Fsunshine.json&logo=archlinux
-   :alt: AUR votes
-   :target: https://aur.archlinux.org/packages/sunshine
+.. _nvenc support matrix: https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new
+.. _obs-amd hardware support: https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support
+.. _VAAPI hardware support: https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html

cmake/FindFFMPEG.cmake

@@ -1,144 +0,0 @@
-# - Try to find FFMPEG
-# Once done this will define
-#  FFMPEG_FOUND - System has FFMPEG
-#  FFMPEG_INCLUDE_DIRS - The FFMPEG include directories
-#  FFMPEG_LIBRARIES - The libraries needed to use FFMPEG
-#  FFMPEG_LIBRARY_DIRS - The directory to find FFMPEG libraries
-#
-# written by Roy Shilkrot 2013 http://www.morethantechnical.com/
-#
-
-find_package(PkgConfig)
-
-
-MACRO(FFMPEG_FIND varname shortname headername)
-
-  IF(NOT WIN32)
-		PKG_CHECK_MODULES(PC_${varname} ${shortname})
-
-		FIND_PATH(${varname}_INCLUDE_DIR "${shortname}/${headername}" 
-			HINTS ${PC_${varname}_INCLUDEDIR} ${PC_${varname}_INCLUDE_DIRS}
-			NO_DEFAULT_PATH
-			)
-	ELSE()
-		FIND_PATH(${varname}_INCLUDE_DIR "${shortname}/${headername}")
-	ENDIF()
-		
-	IF(${varname}_INCLUDE_DIR STREQUAL "${varname}_INCLUDE_DIR-NOTFOUND")
-		message(STATUS "look for newer strcture")
-		IF(NOT WIN32)
-			PKG_CHECK_MODULES(PC_${varname} "lib${shortname}")
-
-			FIND_PATH(${varname}_INCLUDE_DIR "lib${shortname}/${headername}"
-				HINTS ${PC_${varname}_INCLUDEDIR} ${PC_${varname}_INCLUDE_DIRS}
-				NO_DEFAULT_PATH
-				)
-		ELSE()
-			FIND_PATH(${varname}_INCLUDE_DIR "lib${shortname}/${headername}")
-			IF(${${varname}_INCLUDE_DIR} STREQUAL "${varname}_INCLUDE_DIR-NOTFOUND")
-				#Desperate times call for desperate measures
-				MESSAGE(STATUS "globbing...")
-				FILE(GLOB_RECURSE ${varname}_INCLUDE_DIR "/ffmpeg*/${headername}")
-				MESSAGE(STATUS "found: ${${varname}_INCLUDE_DIR}")
-				IF(${varname}_INCLUDE_DIR)
-					GET_FILENAME_COMPONENT(${varname}_INCLUDE_DIR "${${varname}_INCLUDE_DIR}" PATH)
-					GET_FILENAME_COMPONENT(${varname}_INCLUDE_DIR "${${varname}_INCLUDE_DIR}" PATH)
-				ELSE()
-					SET(${varname}_INCLUDE_DIR "${varname}_INCLUDE_DIR-NOTFOUND")
-				ENDIF()
-			ENDIF()
-		ENDIF()
-	ENDIF()
-
-
-	IF(${${varname}_INCLUDE_DIR} STREQUAL "${varname}_INCLUDE_DIR-NOTFOUND")
-		MESSAGE(STATUS "Can't find includes for ${shortname}...")
-	ELSE()
-		MESSAGE(STATUS "Found ${shortname} include dirs: ${${varname}_INCLUDE_DIR}")
-
-		#GET_DIRECTORY_PROPERTY(FFMPEG_PARENT DIRECTORY ${${varname}_INCLUDE_DIR} PARENT_DIRECTORY)
-		GET_FILENAME_COMPONENT(FFMPEG_PARENT ${${varname}_INCLUDE_DIR} PATH)
-		MESSAGE(STATUS "Using FFMpeg dir parent as hint: ${FFMPEG_PARENT}")
-
-		IF(NOT WIN32)
-			FIND_LIBRARY(${varname}_LIBRARIES NAMES ${shortname}
-				HINTS ${PC_${varname}_LIBDIR} ${PC_${varname}_LIBRARY_DIR} ${FFMPEG_PARENT})
-		ELSE()
-			FIND_PATH(${varname}_LIBRARIES "${shortname}.dll.a" HINTS ${FFMPEG_PARENT})
-			#			FILE(GLOB_RECURSE ${varname}_LIBRARIES "${FFMPEG_PARENT}/*${shortname}.lib") 
-			# GLOBing is very bad... but windows sux, this is the only thing that works
-		ENDIF()
-
-		IF(${varname}_LIBRARIES STREQUAL "${varname}_LIBRARIES-NOTFOUND")
-			MESSAGE(STATUS "look for newer structure for library")
-			FIND_LIBRARY(${varname}_LIBRARIES NAMES lib${shortname}
-				HINTS ${PC_${varname}_LIBDIR} ${PC_${varname}_LIBRARY_DIR} ${FFMPEG_PARENT})
-		ENDIF()
-
-
-		IF(${varname}_LIBRARIES STREQUAL "${varname}_LIBRARIES-NOTFOUND")
-			MESSAGE(STATUS "Can't find lib for ${shortname}...")
-		ELSE()
-			MESSAGE(STATUS "Found ${shortname} libs: ${${varname}_LIBRARIES}")
-		ENDIF()
-
-
-		IF(NOT ${varname}_INCLUDE_DIR STREQUAL "${varname}_INCLUDE_DIR-NOTFOUND"
-			AND NOT ${varname}_LIBRARIES STREQUAL ${varname}_LIBRARIES-NOTFOUND)
-
-			MESSAGE(STATUS "found ${shortname}: include ${${varname}_INCLUDE_DIR} lib ${${varname}_LIBRARIES}")
-			SET(FFMPEG_${varname}_FOUND 1)
-			SET(FFMPEG_${varname}_INCLUDE_DIRS ${${varname}_INCLUDE_DIR})
-			SET(FFMPEG_${varname}_LIBS ${${varname}_LIBRARIES})
-		ELSE()
-			MESSAGE(STATUS "Can't find ${shortname}")
-		ENDIF()
-
-	ENDIF()
-
-ENDMACRO(FFMPEG_FIND)
-
-FFMPEG_FIND(LIBAVFORMAT avformat avformat.h)
-FFMPEG_FIND(LIBAVDEVICE avdevice avdevice.h)
-FFMPEG_FIND(LIBAVCODEC  avcodec  avcodec.h)
-FFMPEG_FIND(LIBAVUTIL   avutil   avutil.h)
-FFMPEG_FIND(LIBSWSCALE  swscale  swscale.h)
-
-SET(FFMPEG_FOUND "NO")
-IF   (FFMPEG_LIBAVFORMAT_FOUND AND 
-	FFMPEG_LIBAVDEVICE_FOUND AND 
-	FFMPEG_LIBAVCODEC_FOUND AND 
-	FFMPEG_LIBAVUTIL_FOUND AND
-	FFMPEG_LIBSWSCALE_FOUND
-	)
-
-
-    SET(FFMPEG_FOUND "YES")
-
-    SET(FFMPEG_INCLUDE_DIRS ${FFMPEG_LIBAVFORMAT_INCLUDE_DIRS})
-
-    SET(FFMPEG_LIBRARY_DIRS ${FFMPEG_LIBAVFORMAT_LIBRARY_DIRS})
-
-    SET(FFMPEG_LIBRARIES
-        ${FFMPEG_LIBAVFORMAT_LIBS}
-        ${FFMPEG_LIBAVDEVICE_LIBS}
-        ${FFMPEG_LIBAVCODEC_LIBS}
-        ${FFMPEG_LIBAVUTIL_LIBS}
-	${FFMPEG_LIBSWSCALE_LIBS}
-	)
-
-ELSE ()
-
-   MESSAGE(STATUS "Could not find FFMPEG")
-
-ENDIF()
-
-message(STATUS ${FFMPEG_LIBRARIES} ${FFMPEG_LIBAVFORMAT_LIBRARIES})
-
-include(FindPackageHandleStandardArgs)
-# handle the QUIETLY and REQUIRED arguments and set FFMPEG_FOUND to TRUE
-# if all listed variables are TRUE
-find_package_handle_standard_args(FFMPEG DEFAULT_MSG
-                                  FFMPEG_LIBRARIES FFMPEG_INCLUDE_DIRS)
-
-mark_as_advanced(FFMPEG_INCLUDE_DIRS FFMPEG_LIBRARY_DIRS FFMPEG_LIBRARIES)

cmake/FindLIBDRM.cmake

@@ -18,4 +18,4 @@ find_library(LIBDRM_LIBRARIES NAMES libdrm.so PATHS ${PC_LIBDRM_LIBDIR} ${PC_LIB
 mark_as_advanced(LIBDRM_INCLUDE_DIRS LIBDRM_LIBRARIES)
 
 include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(LIBDRM REQUIRED_VARS LIBDRM_LIBRARIES LIBDRM_INCLUDE_DIRS)
+find_package_handle_standard_args(LIBDRM REQUIRED_VARS LIBDRM_LIBRARIES LIBDRM_INCLUDE_DIRS)

cmake/FindWayland.cmake

@@ -22,57 +22,59 @@
 
 IF (NOT WIN32)
 
-  # Use pkg-config to get the directories and then use these values
-  # in the find_path() and find_library() calls
-  find_package(PkgConfig)
-  PKG_CHECK_MODULES(PKG_WAYLAND QUIET wayland-client wayland-server wayland-egl wayland-cursor)
+    # Use pkg-config to get the directories and then use these values
+    # in the find_path() and find_library() calls
+    find_package(PkgConfig)
+    PKG_CHECK_MODULES(PKG_WAYLAND QUIET wayland-client wayland-server wayland-egl wayland-cursor)
 
-  set(WAYLAND_DEFINITIONS ${PKG_WAYLAND_CFLAGS})
+    set(WAYLAND_DEFINITIONS ${PKG_WAYLAND_CFLAGS})
 
-  find_path(WAYLAND_CLIENT_INCLUDE_DIRS NAMES wayland-client.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
-  find_library(WAYLAND_CLIENT_LIBRARIES NAMES wayland-client   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
-  if(WAYLAND_CLIENT_INCLUDE_DIRS AND WAYLAND_CLIENT_LIBRARIES)
-    set(Wayland_Client_FOUND TRUE)
-  else()
-    set(Wayland_Client_FOUND FALSE)
-  endif()
-  mark_as_advanced(WAYLAND_CLIENT_INCLUDE_DIRS WAYLAND_CLIENT_LIBRARIES)
+    find_path(WAYLAND_CLIENT_INCLUDE_DIRS NAMES wayland-client.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_CLIENT_LIBRARIES NAMES wayland-client   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_CLIENT_INCLUDE_DIRS AND WAYLAND_CLIENT_LIBRARIES)
+        set(Wayland_Client_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_Client_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_CLIENT_INCLUDE_DIRS WAYLAND_CLIENT_LIBRARIES)
 
-  find_path(WAYLAND_CURSOR_INCLUDE_DIRS NAMES wayland-cursor.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
-  find_library(WAYLAND_CURSOR_LIBRARIES NAMES wayland-cursor   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
-  if(WAYLAND_CURSOR_INCLUDE_DIRS AND WAYLAND_CURSOR_LIBRARIES)
-    set(Wayland_Cursor_FOUND TRUE)
-  else()
-    set(Wayland_Cursor_FOUND FALSE)
-  endif()
-  mark_as_advanced(WAYLAND_CURSOR_INCLUDE_DIRS WAYLAND_CURSOR_LIBRARIES)
+    find_path(WAYLAND_CURSOR_INCLUDE_DIRS NAMES wayland-cursor.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_CURSOR_LIBRARIES NAMES wayland-cursor   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_CURSOR_INCLUDE_DIRS AND WAYLAND_CURSOR_LIBRARIES)
+        set(Wayland_Cursor_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_Cursor_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_CURSOR_INCLUDE_DIRS WAYLAND_CURSOR_LIBRARIES)
 
-  find_path(WAYLAND_EGL_INCLUDE_DIRS    NAMES wayland-egl.h    HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
-  find_library(WAYLAND_EGL_LIBRARIES    NAMES wayland-egl      HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
-  if(WAYLAND_EGL_INCLUDE_DIRS AND WAYLAND_EGL_LIBRARIES)
-    set(Wayland_EGL_FOUND TRUE)
-  else()
-    set(Wayland_EGL_FOUND FALSE)
-  endif()
-  mark_as_advanced(WAYLAND_EGL_INCLUDE_DIRS WAYLAND_EGL_LIBRARIES)
+    find_path(WAYLAND_EGL_INCLUDE_DIRS    NAMES wayland-egl.h    HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_EGL_LIBRARIES    NAMES wayland-egl      HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_EGL_INCLUDE_DIRS AND WAYLAND_EGL_LIBRARIES)
+        set(Wayland_EGL_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_EGL_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_EGL_INCLUDE_DIRS WAYLAND_EGL_LIBRARIES)
 
-  find_path(WAYLAND_SERVER_INCLUDE_DIRS NAMES wayland-server.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
-  find_library(WAYLAND_SERVER_LIBRARIES NAMES wayland-server   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
-  if(WAYLAND_SERVER_INCLUDE_DIRS AND WAYLAND_SERVER_LIBRARIES)
-    set(Wayland_Server_FOUND TRUE)
-  else()
-    set(Wayland_Server_FOUND FALSE)
-  endif()
-  mark_as_advanced(WAYLAND_SERVER_INCLUDE_DIRS WAYLAND_SERVER_LIBRARIES)
+    find_path(WAYLAND_SERVER_INCLUDE_DIRS NAMES wayland-server.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_SERVER_LIBRARIES NAMES wayland-server   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_SERVER_INCLUDE_DIRS AND WAYLAND_SERVER_LIBRARIES)
+        set(Wayland_Server_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_Server_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_SERVER_INCLUDE_DIRS WAYLAND_SERVER_LIBRARIES)
 
-  set(WAYLAND_INCLUDE_DIRS ${WAYLAND_CLIENT_INCLUDE_DIRS} ${WAYLAND_SERVER_INCLUDE_DIRS} ${WAYLAND_EGL_INCLUDE_DIRS} ${WAYLAND_CURSOR_INCLUDE_DIRS})
-  set(WAYLAND_LIBRARIES ${WAYLAND_CLIENT_LIBRARIES} ${WAYLAND_SERVER_LIBRARIES} ${WAYLAND_EGL_LIBRARIES} ${WAYLAND_CURSOR_LIBRARIES})
-  mark_as_advanced(WAYLAND_INCLUDE_DIRS WAYLAND_LIBRARIES)
+    set(WAYLAND_INCLUDE_DIRS ${WAYLAND_CLIENT_INCLUDE_DIRS} ${WAYLAND_SERVER_INCLUDE_DIRS}
+            ${WAYLAND_EGL_INCLUDE_DIRS} ${WAYLAND_CURSOR_INCLUDE_DIRS})
+    set(WAYLAND_LIBRARIES ${WAYLAND_CLIENT_LIBRARIES} ${WAYLAND_SERVER_LIBRARIES}
+            ${WAYLAND_EGL_LIBRARIES} ${WAYLAND_CURSOR_LIBRARIES})
+    mark_as_advanced(WAYLAND_INCLUDE_DIRS WAYLAND_LIBRARIES)
 
-  list(REMOVE_DUPLICATES WAYLAND_INCLUDE_DIRS)
+    list(REMOVE_DUPLICATES WAYLAND_INCLUDE_DIRS)
 
-  include(FindPackageHandleStandardArgs)
+    include(FindPackageHandleStandardArgs)
 
-  find_package_handle_standard_args(Wayland REQUIRED_VARS WAYLAND_LIBRARIES WAYLAND_INCLUDE_DIRS HANDLE_COMPONENTS)
+    find_package_handle_standard_args(Wayland REQUIRED_VARS WAYLAND_LIBRARIES WAYLAND_INCLUDE_DIRS HANDLE_COMPONENTS)
 
 ENDIF ()

cmake/compile_definitions/common.cmake

@@ -0,0 +1,129 @@
+# common compile definitions
+# this file will also load platform specific definitions
+
+list(APPEND SUNSHINE_COMPILE_OPTIONS -Wall -Wno-sign-compare)
+# Wall - enable all warnings
+# Wno-sign-compare - disable warnings for signed/unsigned comparisons
+
+# setup assets directory
+if(NOT SUNSHINE_ASSETS_DIR)
+    set(SUNSHINE_ASSETS_DIR "assets")
+endif()
+
+# platform specific compile definitions
+if(WIN32)
+    include(${CMAKE_MODULE_PATH}/compile_definitions/windows.cmake)
+elseif(UNIX)
+    include(${CMAKE_MODULE_PATH}/compile_definitions/unix.cmake)
+
+    if(APPLE)
+        include(${CMAKE_MODULE_PATH}/compile_definitions/macos.cmake)
+    else()
+        include(${CMAKE_MODULE_PATH}/compile_definitions/linux.cmake)
+    endif()
+endif()
+
+include_directories(SYSTEM third-party/nv-codec-headers/include)
+file(GLOB NVENC_SOURCES CONFIGURE_DEPENDS "src/nvenc/*.cpp" "src/nvenc/*.h")
+list(APPEND PLATFORM_TARGET_FILES ${NVENC_SOURCES})
+
+configure_file(src/version.h.in version.h @ONLY)
+include_directories(${CMAKE_CURRENT_BINARY_DIR})
+
+set(SUNSHINE_TARGET_FILES
+        third-party/nanors/rs.c
+        third-party/nanors/rs.h
+        third-party/moonlight-common-c/src/Input.h
+        third-party/moonlight-common-c/src/Rtsp.h
+        third-party/moonlight-common-c/src/RtspParser.c
+        third-party/moonlight-common-c/src/Video.h
+        third-party/tray/tray.h
+        src/upnp.cpp
+        src/upnp.h
+        src/cbs.cpp
+        src/utility.h
+        src/uuid.h
+        src/config.h
+        src/config.cpp
+        src/main.cpp
+        src/main.h
+        src/crypto.cpp
+        src/crypto.h
+        src/nvhttp.cpp
+        src/nvhttp.h
+        src/httpcommon.cpp
+        src/httpcommon.h
+        src/confighttp.cpp
+        src/confighttp.h
+        src/rtsp.cpp
+        src/rtsp.h
+        src/stream.cpp
+        src/stream.h
+        src/video.cpp
+        src/video.h
+        src/video_colorspace.cpp
+        src/video_colorspace.h
+        src/input.cpp
+        src/input.h
+        src/audio.cpp
+        src/audio.h
+        src/platform/common.h
+        src/process.cpp
+        src/process.h
+        src/network.cpp
+        src/network.h
+        src/move_by_copy.h
+        src/system_tray.cpp
+        src/system_tray.h
+        src/task_pool.h
+        src/thread_pool.h
+        src/thread_safe.h
+        src/sync.h
+        src/round_robin.h
+        src/stat_trackers.h
+        src/stat_trackers.cpp
+        ${PLATFORM_TARGET_FILES})
+
+set_source_files_properties(src/upnp.cpp PROPERTIES COMPILE_FLAGS -Wno-pedantic)
+
+set_source_files_properties(third-party/nanors/rs.c
+        PROPERTIES COMPILE_FLAGS "-include deps/obl/autoshim.h -ftree-vectorize")
+
+if(NOT SUNSHINE_ASSETS_DIR_DEF)
+    set(SUNSHINE_ASSETS_DIR_DEF "${SUNSHINE_ASSETS_DIR}")
+endif()
+list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_ASSETS_DIR="${SUNSHINE_ASSETS_DIR_DEF}")
+
+list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_TRAY=${SUNSHINE_TRAY})
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+
+include_directories(
+        SYSTEM
+        ${CMAKE_CURRENT_SOURCE_DIR}/third-party
+        ${CMAKE_CURRENT_SOURCE_DIR}/third-party/moonlight-common-c/enet/include
+        ${CMAKE_CURRENT_SOURCE_DIR}/third-party/nanors
+        ${CMAKE_CURRENT_SOURCE_DIR}/third-party/nanors/deps/obl
+        ${FFMPEG_INCLUDE_DIRS}
+        ${PLATFORM_INCLUDE_DIRS}
+)
+
+string(TOUPPER "x${CMAKE_BUILD_TYPE}" BUILD_TYPE)
+if("${BUILD_TYPE}" STREQUAL "XDEBUG")
+    if(WIN32)
+        set_source_files_properties(src/nvhttp.cpp PROPERTIES COMPILE_FLAGS -O2)
+    endif()
+else()
+    add_definitions(-DNDEBUG)
+endif()
+
+list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
+        libminiupnpc-static
+        ${CMAKE_THREAD_LIBS_INIT}
+        enet
+        opus
+        ${FFMPEG_LIBRARIES}
+        ${Boost_LIBRARIES}
+        ${OPENSSL_LIBRARIES}
+        ${CURL_LIBRARIES}
+        ${PLATFORM_LIBRARIES})

cmake/compile_definitions/linux.cmake

@@ -0,0 +1,227 @@
+# linux specific compile definitions
+
+add_compile_definitions(SUNSHINE_PLATFORM="linux")
+
+# AppImage
+if(${SUNSHINE_BUILD_APPIMAGE})
+    # use relative assets path for AppImage
+    string(REPLACE "${CMAKE_INSTALL_PREFIX}" ".${CMAKE_INSTALL_PREFIX}" SUNSHINE_ASSETS_DIR_DEF ${SUNSHINE_ASSETS_DIR})
+endif()
+
+if(NOT DEFINED SUNSHINE_EXECUTABLE_PATH)
+    set(SUNSHINE_EXECUTABLE_PATH "sunshine")
+endif()
+
+# cuda
+set(CUDA_FOUND OFF)
+if(${SUNSHINE_ENABLE_CUDA})
+    include(CheckLanguage)
+    check_language(CUDA)
+
+    if(CMAKE_CUDA_COMPILER)
+        set(CUDA_FOUND ON)
+        enable_language(CUDA)
+
+        message(STATUS "CUDA Compiler Version: ${CMAKE_CUDA_COMPILER_VERSION}")
+        set(CMAKE_CUDA_ARCHITECTURES "")
+
+        # https://tech.amikelive.com/node-930/cuda-compatibility-of-nvidia-display-gpu-drivers/
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_LESS 6.5)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 10)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_10,code=sm_10")
+        elseif(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER_EQUAL 6.5)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 50 52)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_50,code=sm_50")
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_52,code=sm_52")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_LESS 7.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 11)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_11,code=sm_11")
+        elseif(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER 7.6)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 60 61 62)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_60,code=sm_60")
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_61,code=sm_61")
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_62,code=sm_62")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_LESS 9.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 20)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_20,code=sm_20")
+        elseif(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER_EQUAL 9.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 70)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_70,code=sm_70")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER_EQUAL 10.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 75)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_75,code=sm_75")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_LESS 11.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 30)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_30,code=sm_30")
+        elseif(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER_EQUAL 11.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 80)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_80,code=sm_80")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER_EQUAL 11.1)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 86)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_86,code=sm_86")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_GREATER_EQUAL 11.8)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 90)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_90,code=sm_90")
+        endif()
+
+        if(CMAKE_CUDA_COMPILER_VERSION VERSION_LESS 12.0)
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 35)
+            # set(CUDA_NVCC_FLAGS "${CUDA_NVCC_FLAGS} -gencode arch=compute_35,code=sm_35")
+        endif()
+
+        # sort the architectures
+        list(SORT CMAKE_CUDA_ARCHITECTURES COMPARE NATURAL)
+
+        # message(STATUS "CUDA NVCC Flags: ${CUDA_NVCC_FLAGS}")
+        message(STATUS "CUDA Architectures: ${CMAKE_CUDA_ARCHITECTURES}")
+    endif()
+endif()
+if(CUDA_FOUND)
+    include_directories(SYSTEM third-party/nvfbc)
+    list(APPEND PLATFORM_TARGET_FILES
+            src/platform/linux/cuda.cu
+            src/platform/linux/cuda.cpp
+            third-party/nvfbc/NvFBC.h)
+
+    add_compile_definitions(SUNSHINE_BUILD_CUDA)
+endif()
+
+# drm
+if(${SUNSHINE_ENABLE_DRM})
+    find_package(LIBDRM)
+    find_package(LIBCAP)
+else()
+    set(LIBDRM_FOUND OFF)
+    set(LIBCAP_FOUND OFF)
+endif()
+if(LIBDRM_FOUND AND LIBCAP_FOUND)
+    add_compile_definitions(SUNSHINE_BUILD_DRM)
+    include_directories(SYSTEM ${LIBDRM_INCLUDE_DIRS} ${LIBCAP_INCLUDE_DIRS})
+    list(APPEND PLATFORM_LIBRARIES ${LIBDRM_LIBRARIES} ${LIBCAP_LIBRARIES})
+    list(APPEND PLATFORM_TARGET_FILES src/platform/linux/kmsgrab.cpp)
+    list(APPEND SUNSHINE_DEFINITIONS EGL_NO_X11=1)
+elseif(NOT LIBDRM_FOUND)
+    message(WARNING "Missing libdrm")
+elseif(NOT LIBDRM_FOUND)
+    message(WARNING "Missing libcap")
+endif()
+
+# wayland
+if(${SUNSHINE_ENABLE_WAYLAND})
+    find_package(Wayland)
+else()
+    set(WAYLAND_FOUND OFF)
+endif()
+if(WAYLAND_FOUND)
+    add_compile_definitions(SUNSHINE_BUILD_WAYLAND)
+
+    GEN_WAYLAND("wayland-protocols" "unstable/xdg-output" xdg-output-unstable-v1)
+    GEN_WAYLAND("wlr-protocols" "unstable" wlr-export-dmabuf-unstable-v1)
+
+    include_directories(
+            SYSTEM
+            ${WAYLAND_INCLUDE_DIRS}
+            ${CMAKE_BINARY_DIR}/generated-src
+    )
+
+    list(APPEND PLATFORM_LIBRARIES ${WAYLAND_LIBRARIES})
+    list(APPEND PLATFORM_TARGET_FILES
+            src/platform/linux/wlgrab.cpp
+            src/platform/linux/wayland.cpp)
+endif()
+
+# x11
+if(${SUNSHINE_ENABLE_X11})
+    find_package(X11)
+else()
+    set(X11_FOUND OFF)
+endif()
+if(X11_FOUND)
+    add_compile_definitions(SUNSHINE_BUILD_X11)
+    include_directories(SYSTEM ${X11_INCLUDE_DIR})
+    list(APPEND PLATFORM_LIBRARIES ${X11_LIBRARIES})
+    list(APPEND PLATFORM_TARGET_FILES src/platform/linux/x11grab.cpp)
+endif()
+
+if(NOT ${CUDA_FOUND} AND NOT ${WAYLAND_FOUND} AND NOT ${X11_FOUND} AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND}))
+    message(FATAL_ERROR "Couldn't find either x11, wayland, cuda or (libdrm and libcap)")
+endif()
+
+# tray icon
+if(${SUNSHINE_ENABLE_TRAY})
+    pkg_check_modules(APPINDICATOR appindicator3-0.1)
+    if(APPINDICATOR_FOUND)
+        list(APPEND SUNSHINE_DEFINITIONS TRAY_LEGACY_APPINDICATOR=1)
+    else()
+        pkg_check_modules(APPINDICATOR ayatana-appindicator3-0.1)
+        if(APPINDICATOR_FOUND)
+            list(APPEND SUNSHINE_DEFINITIONS TRAY_AYATANA_APPINDICATOR=1)
+        endif ()
+    endif()
+    pkg_check_modules(LIBNOTIFY libnotify)
+    if(NOT APPINDICATOR_FOUND OR NOT LIBNOTIFY_FOUND)
+        set(SUNSHINE_TRAY 0)
+        message(WARNING "Missing appindicator or libnotify, disabling tray icon")
+        message(STATUS "APPINDICATOR_FOUND: ${APPINDICATOR_FOUND}")
+        message(STATUS "LIBNOTIFY_FOUND: ${LIBNOTIFY_FOUND}")
+    else()
+        include_directories(SYSTEM ${APPINDICATOR_INCLUDE_DIRS} ${LIBNOTIFY_INCLUDE_DIRS})
+        link_directories(${APPINDICATOR_LIBRARY_DIRS} ${LIBNOTIFY_LIBRARY_DIRS})
+
+        list(APPEND PLATFORM_TARGET_FILES third-party/tray/tray_linux.c)
+        list(APPEND SUNSHINE_EXTERNAL_LIBRARIES ${APPINDICATOR_LIBRARIES} ${LIBNOTIFY_LIBRARIES})
+    endif()
+else()
+    set(SUNSHINE_TRAY 0)
+    message(STATUS "Tray icon disabled")
+endif()
+
+if (${SUNSHINE_TRAY} EQUAL 0 AND SUNSHINE_REQUIRE_TRAY)
+    message(FATAL_ERROR "Tray icon is required")
+endif()
+
+list(APPEND PLATFORM_TARGET_FILES
+        src/platform/linux/publish.cpp
+        src/platform/linux/vaapi.h
+        src/platform/linux/vaapi.cpp
+        src/platform/linux/cuda.h
+        src/platform/linux/graphics.h
+        src/platform/linux/graphics.cpp
+        src/platform/linux/misc.h
+        src/platform/linux/misc.cpp
+        src/platform/linux/audio.cpp
+        src/platform/linux/input.cpp
+        src/platform/linux/x11grab.h
+        src/platform/linux/wayland.h
+        third-party/glad/src/egl.c
+        third-party/glad/src/gl.c
+        third-party/glad/include/EGL/eglplatform.h
+        third-party/glad/include/KHR/khrplatform.h
+        third-party/glad/include/glad/gl.h
+        third-party/glad/include/glad/egl.h)
+
+list(APPEND PLATFORM_LIBRARIES
+        Boost::dynamic_linking
+        dl
+        evdev
+        numa
+        pulse
+        pulse-simple)
+
+include_directories(
+        SYSTEM
+        /usr/include/libevdev-1.0
+        third-party/nv-codec-headers/include
+        third-party/glad/include)

cmake/compile_definitions/macos.cmake

@@ -0,0 +1,49 @@
+# macos specific compile definitions
+
+add_compile_definitions(SUNSHINE_PLATFORM="macos")
+
+link_directories(/opt/local/lib)
+link_directories(/usr/local/lib)
+link_directories(/opt/homebrew/lib)
+ADD_DEFINITIONS(-DBOOST_LOG_DYN_LINK)
+
+list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
+        ${APP_SERVICES_LIBRARY}
+        ${AV_FOUNDATION_LIBRARY}
+        ${CORE_MEDIA_LIBRARY}
+        ${CORE_VIDEO_LIBRARY}
+        ${VIDEO_TOOLBOX_LIBRARY}
+        ${FOUNDATION_LIBRARY})
+
+set(PLATFORM_INCLUDE_DIRS
+        ${Boost_INCLUDE_DIR})
+
+set(APPLE_PLIST_FILE ${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/Info.plist)
+
+# todo - tray is not working on macos
+set(SUNSHINE_TRAY 0)
+
+set(PLATFORM_TARGET_FILES
+        src/platform/macos/av_audio.h
+        src/platform/macos/av_audio.m
+        src/platform/macos/av_img_t.h
+        src/platform/macos/av_video.h
+        src/platform/macos/av_video.m
+        src/platform/macos/display.mm
+        src/platform/macos/input.cpp
+        src/platform/macos/microphone.mm
+        src/platform/macos/misc.mm
+        src/platform/macos/misc.h
+        src/platform/macos/nv12_zero_device.cpp
+        src/platform/macos/nv12_zero_device.h
+        src/platform/macos/publish.cpp
+        third-party/TPCircularBuffer/TPCircularBuffer.c
+        third-party/TPCircularBuffer/TPCircularBuffer.h
+        ${APPLE_PLIST_FILE})
+
+if(SUNSHINE_ENABLE_TRAY)
+    list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
+            ${COCOA})
+    list(APPEND PLATFORM_TARGET_FILES
+            third-party/tray/tray_darwin.m)
+endif()

cmake/compile_definitions/unix.cmake

@@ -0,0 +1,9 @@
+# unix specific compile definitions
+# put anything here that applies to both linux and macos
+
+list(APPEND SUNSHINE_EXTERNAL_LIBRARIES Boost::log)
+
+# add install prefix to assets path if not already there
+if(NOT SUNSHINE_ASSETS_DIR MATCHES "^${CMAKE_INSTALL_PREFIX}")
+    set(SUNSHINE_ASSETS_DIR "${CMAKE_INSTALL_PREFIX}/${SUNSHINE_ASSETS_DIR}")
+endif()

cmake/compile_definitions/windows.cmake

@@ -0,0 +1,78 @@
+# windows specific compile definitions
+
+add_compile_definitions(SUNSHINE_PLATFORM="windows")
+
+enable_language(RC)
+set(CMAKE_RC_COMPILER windres)
+set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
+
+# curl
+add_definitions(-DCURL_STATICLIB)
+include_directories(SYSTEM ${CURL_STATIC_INCLUDE_DIRS})
+link_directories(${CURL_STATIC_LIBRARY_DIRS})
+
+# extra tools/binaries for audio/display devices
+add_subdirectory(tools)  # todo - this is temporary, only tools for Windows are needed, for now
+
+# nvidia
+include_directories(SYSTEM third-party/nvapi-open-source-sdk)
+file(GLOB NVPREFS_FILES CONFIGURE_DEPENDS
+        "third-party/nvapi-open-source-sdk/*.h"
+        "src/platform/windows/nvprefs/*.cpp"
+        "src/platform/windows/nvprefs/*.h")
+
+# vigem
+include_directories(SYSTEM third-party/ViGEmClient/include)
+set_source_files_properties(third-party/ViGEmClient/src/ViGEmClient.cpp
+        PROPERTIES COMPILE_DEFINITIONS "UNICODE=1;ERROR_INVALID_DEVICE_OBJECT_PARAMETER=650")
+set_source_files_properties(third-party/ViGEmClient/src/ViGEmClient.cpp
+        PROPERTIES COMPILE_FLAGS "-Wno-unknown-pragmas -Wno-misleading-indentation -Wno-class-memaccess")
+
+# sunshine icon
+if(NOT DEFINED SUNSHINE_ICON_PATH)
+    set(SUNSHINE_ICON_PATH "${CMAKE_CURRENT_SOURCE_DIR}/sunshine.ico")
+endif()
+
+configure_file(src/platform/windows/windows.rs.in windows.rc @ONLY)
+
+set(PLATFORM_TARGET_FILES
+        "${CMAKE_CURRENT_BINARY_DIR}/windows.rc"
+        src/platform/windows/publish.cpp
+        src/platform/windows/misc.h
+        src/platform/windows/misc.cpp
+        src/platform/windows/input.cpp
+        src/platform/windows/display.h
+        src/platform/windows/display_base.cpp
+        src/platform/windows/display_vram.cpp
+        src/platform/windows/display_ram.cpp
+        src/platform/windows/audio.cpp
+        third-party/ViGEmClient/src/ViGEmClient.cpp
+        third-party/ViGEmClient/include/ViGEm/Client.h
+        third-party/ViGEmClient/include/ViGEm/Common.h
+        third-party/ViGEmClient/include/ViGEm/Util.h
+        third-party/ViGEmClient/include/ViGEm/km/BusShared.h
+        ${NVPREFS_FILES})
+
+set(OPENSSL_LIBRARIES
+        libssl.a
+        libcrypto.a)
+
+list(PREPEND PLATFORM_LIBRARIES
+        libstdc++.a
+        libwinpthread.a
+        libssp.a
+        ksuser
+        wsock32
+        ws2_32
+        d3d11 dxgi D3DCompiler
+        setupapi
+        dwmapi
+        userenv
+        synchronization.lib
+        avrt
+        ${CURL_STATIC_LIBRARIES})
+
+if(SUNSHINE_ENABLE_TRAY)
+    list(APPEND PLATFORM_TARGET_FILES
+            third-party/tray/tray_windows.c)
+endif()

cmake/dependencies/common.cmake

@@ -0,0 +1,86 @@
+# load common dependencies
+# this file will also load platform specific dependencies
+
+# submodules
+# moonlight common library
+set(ENET_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for enet")
+add_subdirectory(third-party/moonlight-common-c/enet)
+
+# web server
+add_subdirectory(third-party/Simple-Web-Server)
+
+# miniupnp
+set(UPNPC_BUILD_SHARED OFF CACHE BOOL "No shared libraries")
+set(UPNPC_BUILD_TESTS OFF CACHE BOOL "Don't build tests for miniupnpc")
+set(UPNPC_BUILD_SAMPLE OFF CACHE BOOL "Don't build samples for miniupnpc")
+set(UPNPC_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for miniupnpc")
+add_subdirectory(third-party/miniupnp/miniupnpc)
+include_directories(SYSTEM third-party/miniupnp/miniupnpc/include)
+
+# ffmpeg pre-compiled binaries
+if(WIN32)
+    if(NOT CMAKE_SYSTEM_PROCESSOR STREQUAL "AMD64")
+        message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR})
+    endif()
+    set(FFMPEG_PLATFORM_LIBRARIES mfplat ole32 strmiids mfuuid vpl)
+    set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-windows-x86_64")
+elseif(APPLE)
+    if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
+        set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-macos-x86_64")
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64")
+        set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-macos-aarch64")
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "powerpc")
+        message(FATAL_ERROR "PowerPC is not supported on macOS")
+    else()
+        message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR})
+    endif()
+elseif(UNIX)
+    set(FFMPEG_PLATFORM_LIBRARIES va va-drm va-x11 vdpau X11)
+    if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
+        list(APPEND FFMPEG_PLATFORM_LIBRARIES mfx)
+        set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-linux-x86_64")
+        set(CPACK_DEB_PLATFORM_PACKAGE_DEPENDS "libmfx1,")
+        set(CPACK_RPM_PLATFORM_PACKAGE_REQUIRES "intel-mediasdk >= 22.3.0,")
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64")
+        set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-linux-aarch64")
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "ppc64le" OR CMAKE_SYSTEM_PROCESSOR STREQUAL "ppc64")
+        set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-linux-powerpc64le")
+    else()
+        message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR})
+    endif()
+endif()
+set(FFMPEG_INCLUDE_DIRS
+        ${FFMPEG_PREPARED_BINARIES}/include)
+if(EXISTS ${FFMPEG_PREPARED_BINARIES}/lib/libhdr10plus.a)
+    set(HDR10_PLUS_LIBRARY
+            ${FFMPEG_PREPARED_BINARIES}/lib/libhdr10plus.a)
+endif()
+set(FFMPEG_LIBRARIES
+        ${FFMPEG_PREPARED_BINARIES}/lib/libavcodec.a
+        ${FFMPEG_PREPARED_BINARIES}/lib/libavutil.a
+        ${FFMPEG_PREPARED_BINARIES}/lib/libcbs.a
+        ${FFMPEG_PREPARED_BINARIES}/lib/libSvtAv1Enc.a
+        ${FFMPEG_PREPARED_BINARIES}/lib/libswscale.a
+        ${FFMPEG_PREPARED_BINARIES}/lib/libx264.a
+        ${FFMPEG_PREPARED_BINARIES}/lib/libx265.a
+        ${HDR10_PLUS_LIBRARY}
+        ${FFMPEG_PLATFORM_LIBRARIES})
+
+# common dependencies
+find_package(OpenSSL REQUIRED)
+find_package(PkgConfig REQUIRED)
+find_package(Threads REQUIRED)
+pkg_check_modules(CURL REQUIRED libcurl)
+
+# platform specific dependencies
+if(WIN32)
+    include(${CMAKE_MODULE_PATH}/dependencies/windows.cmake)
+elseif(UNIX)
+    include(${CMAKE_MODULE_PATH}/dependencies/unix.cmake)
+
+    if(APPLE)
+        include(${CMAKE_MODULE_PATH}/dependencies/macos.cmake)
+    else()
+        include(${CMAKE_MODULE_PATH}/dependencies/linux.cmake)
+    endif()
+endif()

cmake/dependencies/linux.cmake

@@ -0,0 +1 @@
+# linux specific dependencies

cmake/dependencies/macos.cmake

@@ -0,0 +1,12 @@
+# macos specific dependencies
+
+FIND_LIBRARY(APP_SERVICES_LIBRARY ApplicationServices)
+FIND_LIBRARY(AV_FOUNDATION_LIBRARY AVFoundation)
+FIND_LIBRARY(CORE_MEDIA_LIBRARY CoreMedia)
+FIND_LIBRARY(CORE_VIDEO_LIBRARY CoreVideo)
+FIND_LIBRARY(FOUNDATION_LIBRARY Foundation)
+FIND_LIBRARY(VIDEO_TOOLBOX_LIBRARY VideoToolbox)
+
+if(SUNSHINE_ENABLE_TRAY)
+    FIND_LIBRARY(COCOA Cocoa REQUIRED)
+endif()

cmake/dependencies/unix.cmake

@@ -0,0 +1,4 @@
+# unix specific dependencies
+# put anything here that applies to both linux and macos
+
+find_package(Boost COMPONENTS locale log filesystem program_options REQUIRED)

cmake/dependencies/windows.cmake

@@ -0,0 +1,6 @@
+# windows specific dependencies
+
+set(Boost_USE_STATIC_LIBS ON)  # cmake-lint: disable=C0103
+# Boost >= 1.82.0 is required for boost::json::value::set_at_pointer() support
+# todo - are we actually using json? I think this was attempted to be used in a PR, but we ended up not using json
+find_package(Boost 1.82.0 COMPONENTS locale log filesystem program_options json REQUIRED)

cmake/macros/common.cmake

@@ -0,0 +1,15 @@
+# common macros
+# this file will also load platform specific macros
+
+# platform specific macros
+if(WIN32)
+    include(${CMAKE_MODULE_PATH}/macros/windows.cmake)
+elseif(UNIX)
+    include(${CMAKE_MODULE_PATH}/macros/unix.cmake)
+
+    if(APPLE)
+        include(${CMAKE_MODULE_PATH}/macros/macos.cmake)
+    else()
+        include(${CMAKE_MODULE_PATH}/macros/linux.cmake)
+    endif()
+endif()

cmake/macros/linux.cmake

@@ -0,0 +1,31 @@
+# linux specific macros
+
+# GEN_WAYLAND: args = `filename`
+macro(GEN_WAYLAND wayland_directory subdirectory filename)
+    file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/generated-src)
+
+    message("wayland-scanner private-code \
+${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml \
+${CMAKE_BINARY_DIR}/generated-src/${filename}.c")
+    message("wayland-scanner client-header \
+${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml \
+${CMAKE_BINARY_DIR}/generated-src/${filename}.h")
+    execute_process(
+            COMMAND wayland-scanner private-code
+            ${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml
+            ${CMAKE_BINARY_DIR}/generated-src/${filename}.c
+            COMMAND wayland-scanner client-header
+            ${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml
+            ${CMAKE_BINARY_DIR}/generated-src/${filename}.h
+
+            RESULT_VARIABLE EXIT_INT
+    )
+
+    if(NOT ${EXIT_INT} EQUAL 0)
+        message(FATAL_ERROR "wayland-scanner failed")
+    endif()
+
+    list(APPEND PLATFORM_TARGET_FILES
+            ${CMAKE_BINARY_DIR}/generated-src/${filename}.c
+            ${CMAKE_BINARY_DIR}/generated-src/${filename}.h)
+endmacro()

cmake/macros/macos.cmake

@@ -0,0 +1,16 @@
+# macos specific macros
+
+# ADD_FRAMEWORK: args = `fwname`, `appname`
+macro(ADD_FRAMEWORK fwname appname)
+    find_library(FRAMEWORK_${fwname}
+            NAMES ${fwname}
+            PATHS ${CMAKE_OSX_SYSROOT}/System/Library
+            PATH_SUFFIXES Frameworks
+            NO_DEFAULT_PATH)
+    if( ${FRAMEWORK_${fwname}} STREQUAL FRAMEWORK_${fwname}-NOTFOUND)
+        MESSAGE(ERROR ": Framework ${fwname} not found")
+    else()
+        TARGET_LINK_LIBRARIES(${appname} "${FRAMEWORK_${fwname}}/${fwname}")
+        MESSAGE(STATUS "Framework ${fwname} found at ${FRAMEWORK_${fwname}}")
+    endif()
+endmacro(ADD_FRAMEWORK)

cmake/macros/unix.cmake

@@ -0,0 +1,2 @@
+# unix specific macros
+# put anything here that applies to both linux and macos

cmake/macros/windows.cmake

@@ -0,0 +1 @@
+# windows specific macros

cmake/packaging/common.cmake

@@ -0,0 +1,32 @@
+# common packaging
+
+# common cpack options
+set(CPACK_PACKAGE_NAME ${CMAKE_PROJECT_NAME})
+set(CPACK_PACKAGE_VENDOR "LizardByte")
+set(CPACK_PACKAGE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/cpack_artifacts)
+set(CPACK_PACKAGE_CONTACT "https://app.lizardbyte.dev")
+set(CPACK_PACKAGE_DESCRIPTION ${CMAKE_PROJECT_DESCRIPTION})
+set(CPACK_PACKAGE_HOMEPAGE_URL ${CMAKE_PROJECT_HOMEPAGE_URL})
+set(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE)
+set(CPACK_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/sunshine.png)
+set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}")
+set(CPACK_STRIP_FILES YES)
+
+# install npm modules
+install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/node_modules"
+        DESTINATION "${SUNSHINE_ASSETS_DIR}/web")
+
+# platform specific packaging
+if(WIN32)
+    include(${CMAKE_MODULE_PATH}/packaging/windows.cmake)
+elseif(UNIX)
+    include(${CMAKE_MODULE_PATH}/packaging/unix.cmake)
+
+    if(APPLE)
+        include(${CMAKE_MODULE_PATH}/packaging/macos.cmake)
+    else()
+        include(${CMAKE_MODULE_PATH}/packaging/linux.cmake)
+    endif()
+endif()
+
+include(CPack)

cmake/packaging/linux.cmake

@@ -0,0 +1,105 @@
+# linux specific packaging
+
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/assets/"
+        DESTINATION "${SUNSHINE_ASSETS_DIR}")
+if(${SUNSHINE_BUILD_APPIMAGE} OR ${SUNSHINE_BUILD_FLATPAK})
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules"
+            DESTINATION "${SUNSHINE_ASSETS_DIR}/udev/rules.d")
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service"
+            DESTINATION "${SUNSHINE_ASSETS_DIR}/systemd/user")
+else()
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/udev/rules.d")
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/systemd/user")
+endif()
+
+# Post install
+set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/postinst")
+set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/postinst")
+
+# Dependencies
+set(CPACK_DEB_COMPONENT_INSTALL ON)
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "\
+            ${CPACK_DEB_PLATFORM_PACKAGE_DEPENDS} \
+            libboost-filesystem${Boost_VERSION}, \
+            libboost-locale${Boost_VERSION}, \
+            libboost-log${Boost_VERSION}, \
+            libboost-program-options${Boost_VERSION}, \
+            libcap2, \
+            libcurl4, \
+            libdrm2, \
+            libevdev2, \
+            libnuma1, \
+            libopus0, \
+            libpulse0, \
+            libva2, \
+            libva-drm2, \
+            libvdpau1, \
+            libwayland-client0, \
+            libx11-6, \
+            openssl | libssl3")
+set(CPACK_RPM_PACKAGE_REQUIRES "\
+            ${CPACK_RPM_PLATFORM_PACKAGE_REQUIRES} \
+            boost-filesystem >= ${Boost_VERSION}, \
+            boost-locale >= ${Boost_VERSION}, \
+            boost-log >= ${Boost_VERSION}, \
+            boost-program-options >= ${Boost_VERSION}, \
+            libcap >= 2.22, \
+            libcurl >= 7.0, \
+            libdrm >= 2.4.97, \
+            libevdev >= 1.5.6, \
+            libopusenc >= 0.2.1, \
+            libva >= 2.14.0, \
+            libvdpau >= 1.5, \
+            libwayland-client >= 1.20.0, \
+            libX11 >= 1.7.3.1, \
+            numactl-libs >= 2.0.14, \
+            openssl >= 3.0.2, \
+            pulseaudio-libs >= 10.0")
+
+# This should automatically figure out dependencies, doesn't work with the current config
+set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS OFF)
+
+# application icon
+install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
+        DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/apps")
+
+# tray icon
+if(${SUNSHINE_TRAY} STREQUAL 1)
+    install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status"
+            RENAME "sunshine-tray.svg")
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/images/sunshine-playing.svg"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status")
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/images/sunshine-pausing.svg"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status")
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/images/sunshine-locked.svg"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status")
+
+    set(CPACK_DEBIAN_PACKAGE_DEPENDS "\
+                    ${CPACK_DEBIAN_PACKAGE_DEPENDS}, \
+                    libayatana-appindicator3-1, \
+                    libnotify4")
+    set(CPACK_RPM_PACKAGE_REQUIRES "\
+                    ${CPACK_RPM_PACKAGE_REQUIRES}, \
+                    libappindicator-gtk3 >= 12.10.0")
+endif()
+
+# desktop file
+# todo - validate desktop files with `desktop-file-validate`
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.desktop"
+        DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications")
+if(NOT ${SUNSHINE_BUILD_APPIMAGE})
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_terminal.desktop"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications")
+endif()
+if(${SUNSHINE_BUILD_FLATPAK})
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_kms.desktop"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications")
+endif()
+
+# metadata file
+# todo - validate file with `appstream-util validate-relax`
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.appdata.xml"
+        DESTINATION "${CMAKE_INSTALL_PREFIX}/share/metainfo")

cmake/packaging/macos.cmake

@@ -0,0 +1,26 @@
+# macos specific packaging
+
+# todo - bundle doesn't produce a valid .app use cpack -G DragNDrop
+set(CPACK_BUNDLE_NAME "${CMAKE_PROJECT_NAME}")
+set(CPACK_BUNDLE_PLIST "${APPLE_PLIST_FILE}")
+set(CPACK_BUNDLE_ICON "${PROJECT_SOURCE_DIR}/sunshine.icns")
+# set(CPACK_BUNDLE_STARTUP_COMMAND "${INSTALL_RUNTIME_DIR}/sunshine")
+
+if(SUNSHINE_PACKAGE_MACOS)  # todo
+    set(MAC_PREFIX "${CMAKE_PROJECT_NAME}.app/Contents")
+    set(INSTALL_RUNTIME_DIR "${MAC_PREFIX}/MacOS")
+
+    install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/"
+            DESTINATION "${SUNSHINE_ASSETS_DIR}")
+    install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/"
+            DESTINATION "${SUNSHINE_ASSETS_DIR}")
+
+    install(TARGETS sunshine
+            BUNDLE DESTINATION . COMPONENT Runtime
+            RUNTIME DESTINATION ${INSTALL_RUNTIME_DIR} COMPONENT Runtime)
+else()
+    install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/"
+            DESTINATION "${SUNSHINE_ASSETS_DIR}")
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/misc/uninstall_pkg.sh"
+            DESTINATION "${SUNSHINE_ASSETS_DIR}")
+endif()

cmake/packaging/unix.cmake

@@ -0,0 +1,18 @@
+# unix specific packaging
+# put anything here that applies to both linux and macos
+
+# return here if building a macos package
+if(SUNSHINE_PACKAGE_MACOS)
+    return()
+endif()
+
+# Installation destination dir
+set(CPACK_SET_DESTDIR true)
+if(NOT CMAKE_INSTALL_PREFIX)
+    set(CMAKE_INSTALL_PREFIX "/usr/share/sunshine")
+endif()
+
+install(TARGETS sunshine RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}")
+
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/"
+        DESTINATION "${SUNSHINE_ASSETS_DIR}")

cmake/packaging/windows.cmake

@@ -0,0 +1,155 @@
+# windows specific packaging
+
+# see options at: https://cmake.org/cmake/help/latest/cpack_gen/nsis.html
+install(TARGETS sunshine RUNTIME DESTINATION "." COMPONENT application)
+
+# Hardening: include zlib1.dll (loaded via LoadLibrary() in openssl's libcrypto.a)
+install(FILES "${ZLIB}" DESTINATION "." COMPONENT application)
+
+# Adding tools
+install(TARGETS dxgi-info RUNTIME DESTINATION "tools" COMPONENT dxgi)
+install(TARGETS audio-info RUNTIME DESTINATION "tools" COMPONENT audio)
+
+# Mandatory tools
+install(TARGETS ddprobe RUNTIME DESTINATION "tools" COMPONENT application)
+install(TARGETS sunshinesvc RUNTIME DESTINATION "tools" COMPONENT application)
+
+# Mandatory scripts
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/service/"
+        DESTINATION "scripts"
+        COMPONENT assets)
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/migration/"
+        DESTINATION "scripts"
+        COMPONENT assets)
+
+# Configurable options for the service
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/autostart/"
+        DESTINATION "scripts"
+        COMPONENT autostart)
+
+# scripts
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/firewall/"
+        DESTINATION "scripts"
+        COMPONENT firewall)
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/gamepad/"
+        DESTINATION "scripts"
+        COMPONENT gamepad)
+
+# Sunshine assets
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/"
+        DESTINATION "${SUNSHINE_ASSETS_DIR}"
+        COMPONENT assets)
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/assets/"
+        DESTINATION "${SUNSHINE_ASSETS_DIR}"
+        COMPONENT assets)
+
+# set(CPACK_NSIS_MUI_HEADERIMAGE "") # TODO: image should be 150x57 bmp
+set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\sunshine.ico")
+set(CPACK_NSIS_INSTALLED_ICON_NAME "${PROJECT__DIR}\\\\${PROJECT_EXE}")
+# The name of the directory that will be created in C:/Program files/
+set(CPACK_PACKAGE_INSTALL_DIRECTORY "${CPACK_PACKAGE_NAME}")
+
+# Extra install commands
+# Restores permissions on the install directory
+# Migrates config files from the root into the new config folder
+# Install service
+SET(CPACK_NSIS_EXTRA_INSTALL_COMMANDS
+        "${CPACK_NSIS_EXTRA_INSTALL_COMMANDS}
+        IfSilent +2 0
+        ExecShell 'open' 'https://sunshinestream.readthedocs.io/'
+        nsExec::ExecToLog 'icacls \\\"$INSTDIR\\\" /reset'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\migrate-config.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\add-firewall-rule.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-service.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-gamepad.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\autostart-service.bat\\\"'
+        NoController:
+        ")
+
+# Extra uninstall commands
+# Uninstall service
+set(CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
+        "${CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS}
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\delete-firewall-rule.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\uninstall-service.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\sunshine.exe\\\" --restore-nvprefs-undo'
+        MessageBox MB_YESNO|MB_ICONQUESTION \
+            'Do you want to remove Virtual Gamepad)?' \
+            /SD IDNO IDNO NoGamepad
+            nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\uninstall-gamepad.bat\\\"'; skipped if no
+        NoGamepad:
+        MessageBox MB_YESNO|MB_ICONQUESTION \
+            'Do you want to remove $INSTDIR (this includes the configuration, cover images, and settings)?' \
+            /SD IDNO IDNO NoDelete
+            RMDir /r \\\"$INSTDIR\\\"; skipped if no
+        NoDelete:
+        ")
+
+# Adding an option for the start menu
+set(CPACK_NSIS_MODIFY_PATH "OFF")
+set(CPACK_NSIS_EXECUTABLES_DIRECTORY ".")
+# This will be shown on the installed apps Windows settings
+set(CPACK_NSIS_INSTALLED_ICON_NAME "${CMAKE_PROJECT_NAME}.exe")
+set(CPACK_NSIS_CREATE_ICONS_EXTRA
+        "${CPACK_NSIS_CREATE_ICONS_EXTRA}
+        CreateShortCut '\$SMPROGRAMS\\\\$STARTMENU_FOLDER\\\\${CMAKE_PROJECT_NAME}.lnk' \
+            '\$INSTDIR\\\\${CMAKE_PROJECT_NAME}.exe' '--shortcut'
+        ")
+set(CPACK_NSIS_DELETE_ICONS_EXTRA
+        "${CPACK_NSIS_DELETE_ICONS_EXTRA}
+        Delete '\$SMPROGRAMS\\\\$MUI_TEMP\\\\${CMAKE_PROJECT_NAME}.lnk'
+        ")
+
+# Checking for previous installed versions
+set(CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL "ON")
+
+set(CPACK_NSIS_HELP_LINK "https://sunshinestream.readthedocs.io/about/installation.html")
+set(CPACK_NSIS_URL_INFO_ABOUT "${CMAKE_PROJECT_HOMEPAGE_URL}")
+set(CPACK_NSIS_CONTACT "${CMAKE_PROJECT_HOMEPAGE_URL}/support")
+
+set(CPACK_NSIS_MENU_LINKS
+        "https://sunshinestream.readthedocs.io" "Sunshine documentation"
+        "https://app.lizardbyte.dev" "LizardByte Web Site"
+        "https://app.lizardbyte.dev/support" "LizardByte Support")
+set(CPACK_NSIS_MANIFEST_DPI_AWARE true)
+
+# Setting components groups and dependencies
+set(CPACK_COMPONENT_GROUP_CORE_EXPANDED true)
+
+# sunshine binary
+set(CPACK_COMPONENT_APPLICATION_DISPLAY_NAME "${CMAKE_PROJECT_NAME}")
+set(CPACK_COMPONENT_APPLICATION_DESCRIPTION "${CMAKE_PROJECT_NAME} main application and required components.")
+set(CPACK_COMPONENT_APPLICATION_GROUP "Core")
+set(CPACK_COMPONENT_APPLICATION_REQUIRED true)
+set(CPACK_COMPONENT_APPLICATION_DEPENDS assets)
+
+# service auto-start script
+set(CPACK_COMPONENT_AUTOSTART_DISPLAY_NAME "Launch on Startup")
+set(CPACK_COMPONENT_AUTOSTART_DESCRIPTION "If enabled, launches Sunshine automatically on system startup.")
+set(CPACK_COMPONENT_AUTOSTART_GROUP "Core")
+
+# assets
+set(CPACK_COMPONENT_ASSETS_DISPLAY_NAME "Required Assets")
+set(CPACK_COMPONENT_ASSETS_DESCRIPTION "Shaders, default box art, and web UI.")
+set(CPACK_COMPONENT_ASSETS_GROUP "Core")
+set(CPACK_COMPONENT_ASSETS_REQUIRED true)
+
+# audio tool
+set(CPACK_COMPONENT_AUDIO_DISPLAY_NAME "audio-info")
+set(CPACK_COMPONENT_AUDIO_DESCRIPTION "CLI tool providing information about sound devices.")
+set(CPACK_COMPONENT_AUDIO_GROUP "Tools")
+
+# display tool
+set(CPACK_COMPONENT_DXGI_DISPLAY_NAME "dxgi-info")
+set(CPACK_COMPONENT_DXGI_DESCRIPTION "CLI tool providing information about graphics cards and displays.")
+set(CPACK_COMPONENT_DXGI_GROUP "Tools")
+
+# firewall scripts
+set(CPACK_COMPONENT_FIREWALL_DISPLAY_NAME "Add Firewall Exclusions")
+set(CPACK_COMPONENT_FIREWALL_DESCRIPTION "Scripts to enable or disable firewall rules.")
+set(CPACK_COMPONENT_FIREWALL_GROUP "Scripts")
+
+# gamepad scripts
+set(CPACK_COMPONENT_GAMEPAD_DISPLAY_NAME "Virtual Gamepad")
+set(CPACK_COMPONENT_GAMEPAD_DESCRIPTION "Scripts to install and uninstall Virtual Gamepad.")
+set(CPACK_COMPONENT_GAMEPAD_GROUP "Scripts")

cmake/prep/build_version.cmake

@@ -0,0 +1,58 @@
+# Check if env vars are defined before attempting to access them, variables will be defined even if blank
+if((DEFINED ENV{BRANCH}) AND (DEFINED ENV{BUILD_VERSION}) AND (DEFINED ENV{COMMIT}))  # cmake-lint: disable=W0106
+    if(($ENV{BRANCH} STREQUAL "master") AND (NOT $ENV{BUILD_VERSION} STREQUAL ""))
+        # If BRANCH is "master" and BUILD_VERSION is not empty, then we are building a master branch
+        MESSAGE("Got from CI master branch and version $ENV{BUILD_VERSION}")
+        set(PROJECT_VERSION $ENV{BUILD_VERSION})
+    elseif((DEFINED ENV{BRANCH}) AND (DEFINED ENV{COMMIT}))
+        # If BRANCH is set but not BUILD_VERSION we are building nightly, we gather only the commit hash
+        MESSAGE("Got from CI $ENV{BRANCH} branch and commit $ENV{COMMIT}")
+        set(PROJECT_VERSION ${PROJECT_VERSION}.$ENV{COMMIT})
+    endif()
+    # Generate Sunshine Version based of the git tag
+    # https://github.com/nocnokneo/cmake-git-versioning-example/blob/master/LICENSE
+else()
+    find_package(Git)
+    if(GIT_EXECUTABLE)
+        MESSAGE("${CMAKE_CURRENT_SOURCE_DIR}")
+        get_filename_component(SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR} DIRECTORY)
+        #Get current Branch
+        execute_process(
+                COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
+                #WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                OUTPUT_VARIABLE GIT_DESCRIBE_BRANCH
+                RESULT_VARIABLE GIT_DESCRIBE_ERROR_CODE
+                OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        # Gather current commit
+        execute_process(
+                COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
+                #WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                OUTPUT_VARIABLE GIT_DESCRIBE_VERSION
+                RESULT_VARIABLE GIT_DESCRIBE_ERROR_CODE
+                OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        # Check if Dirty
+        execute_process(
+                COMMAND ${GIT_EXECUTABLE} diff --quiet --exit-code
+                #WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                RESULT_VARIABLE GIT_IS_DIRTY
+                OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        if(NOT GIT_DESCRIBE_ERROR_CODE)
+            MESSAGE("Sunshine Branch: ${GIT_DESCRIBE_BRANCH}")
+            if(NOT GIT_DESCRIBE_BRANCH STREQUAL "master")
+                set(PROJECT_VERSION ${PROJECT_VERSION}.${GIT_DESCRIBE_VERSION})
+                MESSAGE("Sunshine Version: ${GIT_DESCRIBE_VERSION}")
+            endif()
+            if(GIT_IS_DIRTY)
+                set(PROJECT_VERSION ${PROJECT_VERSION}.dirty)
+                MESSAGE("Git tree is dirty!")
+            endif()
+        else()
+            MESSAGE(ERROR ": Got git error while fetching tags: ${GIT_DESCRIBE_ERROR_CODE}")
+        endif()
+    else()
+        MESSAGE(WARNING ": Git not found, cannot find git version")
+    endif()
+endif()

cmake/prep/constants.cmake

@@ -0,0 +1,5 @@
+# source assets will be installed from this directory
+set(SUNSHINE_SOURCE_ASSETS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src_assets")
+
+# enable system tray, we will disable this later if we cannot find the required package config on linux
+set(SUNSHINE_TRAY 1)

cmake/prep/options.cmake

@@ -0,0 +1,31 @@
+# if this option is set, the build will exit after configuring special package configuration files
+option(SUNSHINE_CONFIGURE_ONLY "Configure special files only, then exit." OFF)
+
+option(SUNSHINE_ENABLE_TRAY "Enable system tray icon. This option will be ignored on macOS." ON)
+option(SUNSHINE_REQUIRE_TRAY "Require system tray icon. Fail the build if tray requirements are not met." ON)
+
+if(APPLE)
+    option(SUNSHINE_CONFIGURE_PORTFILE
+            "Configure macOS Portfile. Recommended to use with SUNSHINE_CONFIGURE_ONLY" OFF)
+    option(SUNSHINE_PACKAGE_MACOS
+            "Should only be used when creating a macOS package/dmg." OFF)
+elseif(UNIX)  # Linux
+    option(SUNSHINE_BUILD_APPIMAGE
+            "Enable an AppImage build." OFF)
+    option(SUNSHINE_BUILD_FLATPAK
+            "Enable a Flatpak build." OFF)
+    option(SUNSHINE_CONFIGURE_PKGBUILD
+            "Configure files required for AUR. Recommended to use with SUNSHINE_CONFIGURE_ONLY" OFF)
+    option(SUNSHINE_CONFIGURE_FLATPAK_MAN
+            "Configure manifest file required for Flatpak build. Recommended to use with SUNSHINE_CONFIGURE_ONLY" OFF)
+
+    # Linux capture methods
+    option(SUNSHINE_ENABLE_CUDA
+            "Enable cuda specific code." ON)
+    option(SUNSHINE_ENABLE_DRM
+            "Enable KMS grab if available." ON)
+    option(SUNSHINE_ENABLE_WAYLAND
+            "Enable building wayland specific code." ON)
+    option(SUNSHINE_ENABLE_X11
+            "Enable X11 grab if available." ON)
+endif()

cmake/prep/special_package_configuration.cmake

@@ -0,0 +1,42 @@
+if (APPLE)
+    if(${SUNSHINE_CONFIGURE_PORTFILE})
+        configure_file(packaging/macos/Portfile Portfile @ONLY)
+    endif()
+elseif (UNIX)
+    # configure the .desktop file
+    if(${SUNSHINE_BUILD_APPIMAGE})
+        configure_file(packaging/linux/AppImage/sunshine.desktop sunshine.desktop @ONLY)
+    elseif(${SUNSHINE_BUILD_FLATPAK})
+        configure_file(packaging/linux/flatpak/sunshine.desktop sunshine.desktop @ONLY)
+        configure_file(packaging/linux/flatpak/sunshine_kms.desktop sunshine_kms.desktop @ONLY)
+        configure_file(packaging/linux/sunshine_terminal.desktop sunshine_terminal.desktop @ONLY)
+    else()
+        configure_file(packaging/linux/sunshine.desktop sunshine.desktop @ONLY)
+        configure_file(packaging/linux/sunshine_terminal.desktop sunshine_terminal.desktop @ONLY)
+    endif()
+
+    # configure metadata file
+    configure_file(packaging/linux/sunshine.appdata.xml sunshine.appdata.xml @ONLY)
+
+    # configure service
+    configure_file(packaging/linux/sunshine.service.in sunshine.service @ONLY)
+
+    # configure the arch linux pkgbuild
+    if(${SUNSHINE_CONFIGURE_PKGBUILD})
+        configure_file(packaging/linux/Arch/PKGBUILD PKGBUILD @ONLY)
+    endif()
+
+    # configure the flatpak manifest
+    if(${SUNSHINE_CONFIGURE_FLATPAK_MAN})
+        configure_file(packaging/linux/flatpak/dev.lizardbyte.sunshine.yml dev.lizardbyte.sunshine.yml @ONLY)
+    endif()
+endif()
+
+# return if configure only is set
+if(${SUNSHINE_CONFIGURE_ONLY})
+    # message
+    message(STATUS "SUNSHINE_CONFIGURE_ONLY: ON, exiting...")
+    set(END_BUILD ON)
+else()
+    set(END_BUILD OFF)
+endif()

cmake/targets/common.cmake

@@ -0,0 +1,35 @@
+# common target definitions
+# this file will also load platform specific macros
+
+add_executable(sunshine ${SUNSHINE_TARGET_FILES})
+
+# platform specific target definitions
+if(WIN32)
+    include(${CMAKE_MODULE_PATH}/targets/windows.cmake)
+elseif(UNIX)
+    include(${CMAKE_MODULE_PATH}/targets/unix.cmake)
+
+    if(APPLE)
+        include(${CMAKE_MODULE_PATH}/targets/macos.cmake)
+    else()
+        include(${CMAKE_MODULE_PATH}/targets/linux.cmake)
+    endif()
+endif()
+
+# todo - is this necessary? ... for anything except linux?
+if(NOT DEFINED CMAKE_CUDA_STANDARD)
+    set(CMAKE_CUDA_STANDARD 17)
+    set(CMAKE_CUDA_STANDARD_REQUIRED ON)
+endif()
+
+target_link_libraries(sunshine ${SUNSHINE_EXTERNAL_LIBRARIES} ${EXTRA_LIBS})
+target_compile_definitions(sunshine PUBLIC ${SUNSHINE_DEFINITIONS})
+set_target_properties(sunshine PROPERTIES CXX_STANDARD 17
+        VERSION ${PROJECT_VERSION}
+        SOVERSION ${PROJECT_VERSION_MAJOR})
+
+foreach(flag IN LISTS SUNSHINE_COMPILE_OPTIONS)
+    list(APPEND SUNSHINE_COMPILE_OPTIONS_CUDA "$<$<COMPILE_LANGUAGE:CUDA>:--compiler-options=${flag}>")
+endforeach()
+
+target_compile_options(sunshine PRIVATE $<$<COMPILE_LANGUAGE:CXX>:${SUNSHINE_COMPILE_OPTIONS}>;$<$<COMPILE_LANGUAGE:CUDA>:${SUNSHINE_COMPILE_OPTIONS_CUDA};-std=c++17>)  # cmake-lint: disable=C0301

cmake/targets/linux.cmake

@@ -0,0 +1 @@
+# linux specific target definitions

cmake/targets/macos.cmake

@@ -0,0 +1,4 @@
+# macos specific target definitions
+target_link_options(sunshine PRIVATE LINKER:-sectcreate,__TEXT,__info_plist,${APPLE_PLIST_FILE})
+# Tell linker to dynamically load these symbols at runtime, in case they're unavailable:
+target_link_options(sunshine PRIVATE -Wl,-U,_CGPreflightScreenCaptureAccess -Wl,-U,_CGRequestScreenCaptureAccess)

cmake/targets/unix.cmake

@@ -0,0 +1,2 @@
+# unix specific target definitions
+# put anything here that applies to both linux and macos

cmake/targets/windows.cmake

@@ -0,0 +1,6 @@
+# windows specific target definitions
+set_target_properties(sunshine PROPERTIES LINK_SEARCH_START_STATIC 1)
+set(CMAKE_FIND_LIBRARY_SUFFIXES ".dll")
+find_library(ZLIB ZLIB1)
+list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
+        Wtsapi32.lib)

docker/archlinux.dockerfile

@@ -0,0 +1,149 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64
+# archlinux does not have an arm64 base image
+# no-cache-filters: artifacts,sunshine
+ARG BASE=archlinux
+ARG TAG=base-devel
+FROM ${BASE}:${TAG} AS sunshine-base
+
+# install dependencies
+RUN <<_DEPS
+#!/bin/bash
+set -e
+pacman -Syu --disable-download-timeout --needed --noconfirm \
+  archlinux-keyring
+_DEPS
+
+# Setup builder user, arch prevents running makepkg as root
+RUN useradd -m builder && \
+    echo 'builder ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+# makepkg is used in sunshine-build and uploader build stages
+
+FROM sunshine-base as sunshine-build
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+ARG CLONE_URL
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+# cuda, libcap, and libdrm are optional dependencies for PKGBUILD
+RUN <<_DEPS
+#!/bin/bash
+set -e
+pacman -Syu --disable-download-timeout --needed --noconfirm \
+  base-devel \
+  cmake \
+  cuda \
+  git \
+  libcap \
+  libdrm \
+  namcap
+_DEPS
+
+# Setup builder user
+USER builder
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# configure PKGBUILD file
+RUN <<_MAKE
+#!/bin/bash
+set -e
+if [[ "${BUILD_VERSION}" == '' ]]; then
+  sub_version=".r${COMMIT}"
+else
+  sub_version=""
+fi
+cmake \
+  -DSUNSHINE_CONFIGURE_PKGBUILD=ON \
+  -DSUNSHINE_SUB_VERSION="${sub_version}" \
+  -DGITHUB_CLONE_URL="${CLONE_URL}" \
+  -DGITHUB_BRANCH=${BRANCH} \
+  -DGITHUB_BUILD_VERSION=${BUILD_VERSION} \
+  -DGITHUB_COMMIT="${COMMIT}" \
+  -DSUNSHINE_CONFIGURE_ONLY=ON \
+  /build/sunshine
+_MAKE
+
+WORKDIR /build/sunshine/pkg
+RUN mv /build/sunshine/build/PKGBUILD .
+
+# namcap and build PKGBUILD file
+RUN <<_PKGBUILD
+#!/bin/bash
+set -e
+namcap -i PKGBUILD
+makepkg -si --noconfirm
+ls -a
+_PKGBUILD
+
+FROM scratch as artifacts
+
+COPY --link --from=sunshine-build /build/sunshine/pkg/PKGBUILD /PKGBUILD
+COPY --link --from=sunshine-build /build/sunshine/pkg/sunshine*.pkg.tar.zst /sunshine.pkg.tar.zst
+
+FROM sunshine-base as sunshine
+
+# copy from uploader instead of artifacts or uploader stage will not run
+COPY --link --from=artifacts /sunshine.pkg.tar.zst /
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+# update keyring to prevent cached keyring errors
+pacman -Syu --disable-download-timeout --needed --noconfirm \
+  archlinux-keyring
+pacman -U --disable-download-timeout --needed --noconfirm \
+  /sunshine.pkg.tar.zst
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+# first delete the builder user
+userdel -r builder
+
+# then create the lizard user
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/debian-bookworm.dockerfile

@@ -0,0 +1,175 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=debian
+ARG TAG=bookworm
+FROM ${BASE}:${TAG} AS sunshine-base
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+FROM sunshine-base as sunshine-build
+
+ARG TARGETPLATFORM
+RUN echo "target_platform: ${TARGETPLATFORM}"
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+RUN <<_DEPS
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends \
+  build-essential \
+  cmake=3.25.* \
+  git \
+  libavdevice-dev \
+  libayatana-appindicator3-dev \
+  libboost-filesystem-dev=1.74.* \
+  libboost-locale-dev=1.74.* \
+  libboost-log-dev=1.74.* \
+  libboost-program-options-dev=1.74.* \
+  libcap-dev \
+  libcurl4-openssl-dev \
+  libdrm-dev \
+  libevdev-dev \
+  libnotify-dev \
+  libnuma-dev \
+  libopus-dev \
+  libpulse-dev \
+  libssl-dev \
+  libva-dev \
+  libvdpau-dev \
+  libwayland-dev \
+  libx11-dev \
+  libxcb-shm0-dev \
+  libxcb-xfixes0-dev \
+  libxcb1-dev \
+  libxfixes-dev \
+  libxrandr-dev \
+  libxtst-dev \
+  nodejs \
+  npm \
+  wget
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  apt-get install -y --no-install-recommends \
+    libmfx-dev
+fi
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_DEPS
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="12.0.0"
+ENV CUDA_BUILD="525.60.13"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G DEB
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends /sunshine.deb
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/debian-bullseye.dockerfile

@@ -0,0 +1,175 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=debian
+ARG TAG=bullseye
+FROM ${BASE}:${TAG} AS sunshine-base
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+FROM sunshine-base as sunshine-build
+
+ARG TARGETPLATFORM
+RUN echo "target_platform: ${TARGETPLATFORM}"
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+RUN <<_DEPS
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends \
+  build-essential \
+  cmake=3.18.* \
+  git \
+  libavdevice-dev \
+  libayatana-appindicator3-dev \
+  libboost-filesystem-dev=1.74.* \
+  libboost-locale-dev=1.74.* \
+  libboost-log-dev=1.74.* \
+  libboost-program-options-dev=1.74.* \
+  libcap-dev \
+  libcurl4-openssl-dev \
+  libdrm-dev \
+  libevdev-dev \
+  libnotify-dev \
+  libnuma-dev \
+  libopus-dev \
+  libpulse-dev \
+  libssl-dev \
+  libva-dev \
+  libvdpau-dev \
+  libwayland-dev \
+  libx11-dev \
+  libxcb-shm0-dev \
+  libxcb-xfixes0-dev \
+  libxcb1-dev \
+  libxfixes-dev \
+  libxrandr-dev \
+  libxtst-dev \
+  nodejs \
+  npm \
+  wget
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  apt-get install -y --no-install-recommends \
+    libmfx-dev
+fi
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_DEPS
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="11.8.0"
+ENV CUDA_BUILD="520.61.05"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G DEB
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends /sunshine.deb
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/fedora-37.dockerfile

@@ -0,0 +1,173 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=fedora
+ARG TAG=37
+FROM ${BASE}:${TAG} AS sunshine-base
+
+FROM sunshine-base as sunshine-build
+
+ARG TARGETPLATFORM
+RUN echo "target_platform: ${TARGETPLATFORM}"
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+# hadolint ignore=DL3041
+RUN <<_DEPS
+#!/bin/bash
+set -e
+dnf -y update
+dnf -y group install "Development Tools"
+dnf -y install \
+  boost-devel-1.78.* \
+  cmake-3.27.* \
+  gcc-12.2.* \
+  gcc-c++-12.2.* \
+  git \
+  libappindicator-gtk3-devel \
+  libcap-devel \
+  libcurl-devel \
+  libdrm-devel \
+  libevdev-devel \
+  libnotify-devel \
+  libva-devel \
+  libvdpau-devel \
+  libX11-devel \
+  libxcb-devel \
+  libXcursor-devel \
+  libXfixes-devel \
+  libXi-devel \
+  libXinerama-devel \
+  libXrandr-devel \
+  libXtst-devel \
+  mesa-libGL-devel \
+  nodejs-npm \
+  numactl-devel \
+  openssl-devel \
+  opus-devel \
+  pulseaudio-libs-devel \
+  rpm-build \
+  wget \
+  which
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  dnf -y install intel-mediasdk-devel
+fi
+dnf clean all
+rm -rf /var/cache/yum
+_DEPS
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="12.0.0"
+ENV CUDA_BUILD="525.60.13"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G RPM
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.rpm /sunshine-${BASE}-${TAG}-${TARGETARCH}.rpm
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.rpm /sunshine.rpm
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+dnf -y update
+dnf -y install /sunshine.rpm
+dnf clean all
+rm -rf /var/cache/yum
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/fedora-38.dockerfile

@@ -0,0 +1,175 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=fedora
+ARG TAG=38
+FROM ${BASE}:${TAG} AS sunshine-base
+
+FROM sunshine-base as sunshine-build
+
+ARG TARGETPLATFORM
+RUN echo "target_platform: ${TARGETPLATFORM}"
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+# hadolint ignore=DL3041
+RUN <<_DEPS
+#!/bin/bash
+set -e
+dnf -y update
+dnf -y group install "Development Tools"
+dnf -y install \
+  boost-devel-1.78.0* \
+  cmake-3.27.* \
+  gcc-13.2.* \
+  gcc-c++-13.2.* \
+  git \
+  libappindicator-gtk3-devel \
+  libcap-devel \
+  libcurl-devel \
+  libdrm-devel \
+  libevdev-devel \
+  libnotify-devel \
+  libva-devel \
+  libvdpau-devel \
+  libX11-devel \
+  libxcb-devel \
+  libXcursor-devel \
+  libXfixes-devel \
+  libXi-devel \
+  libXinerama-devel \
+  libXrandr-devel \
+  libXtst-devel \
+  mesa-libGL-devel \
+  nodejs-npm \
+  numactl-devel \
+  openssl-devel \
+  opus-devel \
+  pulseaudio-libs-devel \
+  rpm-build \
+  wget \
+  which
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  dnf -y install intel-mediasdk-devel
+fi
+dnf clean all
+rm -rf /var/cache/yum
+_DEPS
+
+# todo - enable cuda once it's supported for gcc 13 and fedora 38
+## install cuda
+#WORKDIR /build/cuda
+## versions: https://developer.nvidia.com/cuda-toolkit-archive
+#ENV CUDA_VERSION="12.0.0"
+#ENV CUDA_BUILD="525.60.13"
+## hadolint ignore=SC3010
+#RUN <<_INSTALL_CUDA
+##!/bin/bash
+#set -e
+#cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+#cuda_suffix=""
+#if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+#  cuda_suffix="_sbsa"
+#fi
+#url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+#echo "cuda url: ${url}"
+#wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+#chmod a+x ./cuda.run
+#./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+#rm ./cuda.run
+#_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+# todo - add cmake argument back in for cuda support "-DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \"
+# todo - re-enable "DSUNSHINE_ENABLE_CUDA"
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=OFF \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G RPM
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.rpm /sunshine-${BASE}-${TAG}-${TARGETARCH}.rpm
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.rpm /sunshine.rpm
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+dnf -y update
+dnf -y install /sunshine.rpm
+dnf clean all
+rm -rf /var/cache/yum
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/ubuntu-20.04.dockerfile

@@ -0,0 +1,211 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=ubuntu
+ARG TAG=20.04
+FROM ${BASE}:${TAG} AS sunshine-base
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+FROM sunshine-base as sunshine-build
+
+ARG TARGETPLATFORM
+RUN echo "target_platform: ${TARGETPLATFORM}"
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+RUN <<_DEPS
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends \
+  build-essential \
+  gcc-10=10.5.* \
+  g++-10=10.5.* \
+  git \
+  libayatana-appindicator3-dev \
+  libavdevice-dev \
+  libboost-filesystem-dev=1.71.* \
+  libboost-locale-dev=1.71.* \
+  libboost-log-dev=1.71.* \
+  libboost-program-options-dev=1.71.* \
+  libcap-dev \
+  libcurl4-openssl-dev \
+  libdrm-dev \
+  libevdev-dev \
+  libnotify-dev \
+  libnuma-dev \
+  libopus-dev \
+  libpulse-dev \
+  libssl-dev \
+  libva-dev \
+  libvdpau-dev \
+  libwayland-dev \
+  libx11-dev \
+  libxcb-shm0-dev \
+  libxcb-xfixes0-dev \
+  libxcb1-dev \
+  libxfixes-dev \
+  libxrandr-dev \
+  libxtst-dev \
+  nodejs \
+  npm \
+  wget
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  apt-get install -y --no-install-recommends \
+    libmfx-dev
+fi
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_DEPS
+
+# Update gcc alias
+# https://stackoverflow.com/a/70653945/11214013
+RUN <<_GCC_ALIAS
+#!/bin/bash
+set -e
+update-alternatives --install \
+  /usr/bin/gcc gcc /usr/bin/gcc-10 100 \
+  --slave /usr/bin/g++ g++ /usr/bin/g++-10 \
+  --slave /usr/bin/gcov gcov /usr/bin/gcov-10 \
+  --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-10 \
+  --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-10
+_GCC_ALIAS
+
+# install cmake
+# sunshine requires cmake >= 3.18
+WORKDIR /build/cmake
+# https://cmake.org/download/
+ENV CMAKE_VERSION="3.25.1"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CMAKE
+#!/bin/bash
+set -e
+cmake_prefix="https://github.com/Kitware/CMake/releases/download/v"
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  cmake_arch="x86_64"
+elif [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cmake_arch="aarch64"
+fi
+url="${cmake_prefix}${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-${cmake_arch}.sh"
+echo "cmake url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cmake.sh
+sh ./cmake.sh --prefix=/usr/local --skip-license
+rm ./cmake.sh
+_INSTALL_CMAKE
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="11.8.0"
+ENV CUDA_BUILD="520.61.05"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G DEB
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends /sunshine.deb
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/ubuntu-22.04.dockerfile

@@ -0,0 +1,175 @@
+# syntax=docker/dockerfile:1.4
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=ubuntu
+ARG TAG=22.04
+FROM ${BASE}:${TAG} AS sunshine-base
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+FROM sunshine-base as sunshine-build
+
+ARG TARGETPLATFORM
+RUN echo "target_platform: ${TARGETPLATFORM}"
+
+ARG BRANCH
+ARG BUILD_VERSION
+ARG COMMIT
+# note: BUILD_VERSION may be blank
+
+ENV BRANCH=${BRANCH}
+ENV BUILD_VERSION=${BUILD_VERSION}
+ENV COMMIT=${COMMIT}
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+# install dependencies
+RUN <<_DEPS
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends \
+  build-essential \
+  cmake=3.22.* \
+  git \
+  libayatana-appindicator3-dev \
+  libavdevice-dev \
+  libboost-filesystem-dev=1.74.* \
+  libboost-locale-dev=1.74.* \
+  libboost-log-dev=1.74.* \
+  libboost-program-options-dev=1.74.* \
+  libcap-dev \
+  libcurl4-openssl-dev \
+  libdrm-dev \
+  libevdev-dev \
+  libnotify-dev \
+  libnuma-dev \
+  libopus-dev \
+  libpulse-dev \
+  libssl-dev \
+  libva-dev \
+  libvdpau-dev \
+  libwayland-dev \
+  libx11-dev \
+  libxcb-shm0-dev \
+  libxcb-xfixes0-dev \
+  libxcb1-dev \
+  libxfixes-dev \
+  libxrandr-dev \
+  libxtst-dev \
+  nodejs \
+  npm \
+  wget
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  apt-get install -y --no-install-recommends \
+    libmfx-dev
+fi
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_DEPS
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="11.8.0"
+ENV CUDA_BUILD="520.61.05"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G DEB
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends /sunshine.deb
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docs/requirements.txt

@@ -1,4 +1,8 @@
-furo==2022.9.29
-m2r2==0.3.3
-Sphinx==5.3.0
-sphinx-copybutton==0.5.0
+breathe==4.35.0
+furo==2023.9.10
+m2r2==0.3.3.post2
+rstcheck[sphinx]==6.2.0
+rstfmt==0.0.14
+Sphinx==7.2.6
+sphinx-copybutton==0.5.2
+sphinx_inline_tabs==2023.4.21

docs/source/about/advanced_usage.rst

@@ -2,6 +2,18 @@ Advanced Usage
 ==============
 Sunshine will work with the default settings for most users. In some cases you may want to configure Sunshine further.
 
+Performance Tips
+----------------
+
+AMD
+^^^
+In Windows, enabling `Enhanced Sync` in AMD's settings may help reduce the latency by an additional frame. This
+applies to `amfenc` and `libx264`.
+
+Nvidia
+^^^^^^
+Enabling `Fast Sync` in Nvidia settings may help reduce latency.
+
 Configuration
 -------------
 The default location for the configuration file is listed below. You can use another location if you
@@ -21,7 +33,7 @@ location by modifying the configuration file.
    Docker      /config/
    Linux       ~/.config/sunshine/
    macOS       ~/.config/sunshine/
-   Windows     ./config/
+   Windows     %ProgramFiles%\\Sunshine\\config
    =========   ===========
 
 **Example**
@@ -81,6 +93,34 @@ min_log_level
 
       min_log_level = info
 
+log_path
+^^^^^^^^
+
+**Description**
+   The path where the sunshine log is stored.
+
+**Default**
+   ``sunshine.log``
+
+**Example**
+   .. code-block:: text
+
+      log_path = sunshine.log
+
+global_prep_cmd
+^^^^^^^^^^^^^^^
+
+**Description**
+   A list of commands to be run before/after all applications. If any of the prep-commands fail, starting the application is aborted.
+
+**Default**
+   ``[]``
+
+**Example**
+   .. code-block:: text
+
+      global_prep_cmd = [{"do":"nircmd.exe setdisplay 1280 720 32 144","undo":"nircmd.exe setdisplay 2560 1440 32 144"}]
+
 Controls
 --------
 
@@ -100,30 +140,46 @@ gamepad
    =====     ===========
    Value     Description
    =====     ===========
-   x360      xbox 360 controller
-   ds4       dualshock controller (PS4)
+   auto      Selected based on information from client
+   x360      Xbox 360 controller
+   ds4       DualShock 4 controller (PS4)
    =====     ===========
 
 **Default**
-   ``x360``
+   ``auto``
 
 **Example**
    .. code-block:: text
 
-      gamepad = x360
+      gamepad = auto
+      
+ds4_back_as_touchpad_click
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Description**
+   .. Hint:: Only applies when gamepad is set to ds4 manually. Unused in other gamepad modes. 
+
+   Allow Select/Back inputs to also trigger DS4 touchpad click. Useful for clients looking to emulate touchpad click
+   on Xinput devices.
+
+**Default**
+   ``enabled``
+
+**Example**
+   .. code-block:: text
+
+      ds4_back_as_touchpad_click = enabled
 
 back_button_timeout
 ^^^^^^^^^^^^^^^^^^^
 
 **Description**
-   If, after the timeout, the back/select button is still pressed down, Home/Guide button press is emulated.
-
-   On Nvidia Shield, the home and power button are not passed to Moonlight.
+   If the Back/Select button is held down for the specified number of milliseconds, a Home/Guide button press is emulated.
 
    .. Tip:: If back_button_timeout < 0, then the Home/Guide button will not be emulated.
 
 **Default**
-   ``2000``
+   ``-1``
 
 **Example**
    .. code-block:: text
@@ -134,7 +190,7 @@ key_repeat_delay
 ^^^^^^^^^^^^^^^^
 
 **Description**
-   The initial delay in milliseconds before repeating keys. Controls how fast keys will repeat themselves.
+   The initial delay, in milliseconds, before repeating keys. Controls how fast keys will repeat themselves.
 
 **Default**
    ``500``
@@ -153,25 +209,50 @@ key_repeat_frequency
    .. Tip:: This configurable option supports decimals.
 
 **Default**
-   .. Todo:: Unknown
+   ``24.9``
 
 **Example**
    .. code-block:: text
 
       key_repeat_frequency = 24.9
 
+always_send_scancodes
+^^^^^^^^^^^^^^^^^^^^^
+
+**Description**
+   Sending scancodes enhances compatibility with games and apps but may result in incorrect keyboard input
+   from certain clients that aren't using a US English keyboard layout.
+
+   Enable if keyboard input is not working at all in certain applications.
+
+   Disable if keys on the client are generating the wrong input on the host.
+
+   .. Caution:: Applies to Windows only.
+
+**Default**
+   ``enabled``
+
+**Example**
+   .. code-block:: text
+
+      always_send_scancodes = enabled
+
 keybindings
 ^^^^^^^^^^^
 
 **Description**
    Sometimes it may be useful to map keybindings. Wayland won't allow clients to capture the Win Key for example.
 
-   .. Tip:: See `virtual key codes <https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes>`_
+   .. Tip:: See `virtual key codes <https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes>`__
 
    .. Hint:: keybindings needs to have a multiple of two elements.
 
 **Default**
-   None
+   .. code-block:: text
+
+      0x10, 0xA0,
+      0x11, 0xA2,
+      0x12, 0xA4
 
 **Example**
    .. code-block:: text
@@ -191,7 +272,7 @@ key_rightalt_to_key_win
    make Sunshine think the Right Alt key is the Windows key.
 
 **Default**
-   None
+   ``disabled``
 
 **Example**
    .. code-block:: text
@@ -255,13 +336,18 @@ output_name
    .. Tip:: To find the name of the appropriate values follow these instructions.
 
       **Linux**
-         .. code-block:: bash
+         During Sunshine startup, you should see the list of detected monitors:
 
-            xrandr --listmonitors
+         .. code-block:: text
 
-         Example output: ``0: +HDMI-1 1920/518x1200/324+0+0  HDMI-1``
+            Info: Detecting connected monitors
+            Info: Detected monitor 0: DVI-D-0, connected: false
+            Info: Detected monitor 1: HDMI-0, connected: true
+            Info: Detected monitor 2: DP-0, connected: true
+            Info: Detected monitor 3: DP-1, connected: false
+            Info: Detected monitor 4: DVI-D-1, connected: false
 
-         You need to use the value before the colon in the output, e.g. ``0``.
+         You need to use the value before the colon in the output, e.g. ``1``.
 
       .. Todo:: macOS
 
@@ -296,7 +382,7 @@ fps
       fps is supported.
 
 **Default**
-   .. Todo:: Unknown
+   ``[10, 30, 60, 90, 120]``
 
 **Example**
    .. code-block:: text
@@ -313,7 +399,20 @@ resolutions
       resolution is supported.
 
 **Default**
-   .. Todo:: Unknown
+   .. code-block:: text
+
+      [
+        352x240,
+        480x360,
+        858x480,
+        1280x720,
+        1920x1080,
+        2560x1080,
+        3440x1440,
+        1920x1200,
+        3840x2160,
+        3840x1600,
+      ]
 
 **Example**
    .. code-block:: text
@@ -327,28 +426,10 @@ resolutions
         2560x1080,
         3440x1440,
         1920x1200,
-        3860x2160,
+        3840x2160,
         3840x1600,
       ]
 
-dwmflush
-^^^^^^^^
-
-**Description**
-   Invoke DwmFlush() to sync screen capture to the Windows presentation interval.
-
-   .. Caution:: Applies to Windows only. Alleviates visual stuttering during mouse movement.
-      If enabled, this feature will automatically deactivate if the client framerate exceeds
-      the host monitor's current refresh rate.
-
-**Default**
-   ``enabled``
-
-**Example**
-   .. code-block:: text
-
-      dwmflush = enabled
-
 Audio
 -----
 
@@ -374,14 +455,18 @@ audio_sink
 
       **macOS**
          Sunshine can only access microphones on macOS due to system limitations. To stream system audio use
-         `Soundflower <https://github.com/mattingalls/Soundflower>`_ or
-         `BlackHole <https://github.com/ExistentialAudio/BlackHole>`_.
+         `Soundflower <https://github.com/mattingalls/Soundflower>`__ or
+         `BlackHole <https://github.com/ExistentialAudio/BlackHole>`__.
 
       **Windows**
          .. code-block:: batch
 
             tools\audio-info.exe
 
+         .. Tip:: If you have multiple audio devices with identical names, use the Device ID instead.
+
+   .. Tip:: If you want to mute the host speakers, use `virtual_sink`_ instead.
+
 **Default**
    Sunshine will select the default audio device.
 
@@ -399,7 +484,7 @@ audio_sink
    **Windows**
       .. code-block:: text
 
-         audio_sink = {0.0.0.00000000}.{FD47D9CC-4218-4135-9CE2-0C195C87405B}
+         audio_sink = Speakers (High Definition Audio Device)
 
 virtual_sink
 ^^^^^^^^^^^^
@@ -410,13 +495,35 @@ virtual_sink
 
    .. Tip:: See `audio_sink`_!
 
-**Default**
-   .. Todo:: Unknown
+   .. Tip:: These are some options for virtual sound devices.
+
+      - Stream Streaming Speakers (Linux, macOS, Windows)
+
+        - Steam must be installed.
+        - Enable `install_steam_audio_drivers`_ or use Steam Remote Play at least once to install the drivers.
+
+      - `Virtual Audio Cable <https://vb-audio.com/Cable/>`__ (macOS, Windows)
 
 **Example**
    .. code-block:: text
 
-      virtual_sink = {0.0.0.00000000}.{8edba70c-1125-467c-b89c-15da389bc1d4}
+      virtual_sink = Steam Streaming Speakers
+
+install_steam_audio_drivers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Description**
+   Installs the Steam Streaming Speakers driver (if Steam is installed) to support surround sound and muting host audio.
+
+   .. Tip:: This option is only supported on Windows.
+
+**Default**
+   ``enabled``
+
+**Example**
+   .. code-block:: text
+
+      install_steam_audio_drivers = enabled
 
 Network
 -------
@@ -457,16 +564,43 @@ port
    Mic (unused)     48002 UDP    +13
    ================ ============ ===========================
 
-.. Attention:: Custom ports are only allowed on select Moonlight clients.
+.. Attention:: Custom ports may not be supported by all Moonlight clients.
 
 **Default**
    ``47989``
 
+**Range**
+   ``1029-65514``
+
 **Example**
    .. code-block:: text
 
       port = 47989
 
+address_family
+^^^^^^^^^^^^^^
+
+**Description**
+   Set the address family that Sunshine will use.
+
+.. table::
+   :widths: auto
+
+   =====     ===========
+   Value     Description
+   =====     ===========
+   ipv4      IPv4 only
+   both      IPv4+IPv6
+   =====     ===========
+
+**Default**
+   ``ipv4``
+
+**Example**
+   .. code-block:: text
+
+      address_family = both
+
 pkey
 ^^^^
 
@@ -474,7 +608,7 @@ pkey
    The private key. This must be 2048 bits.
 
 **Default**
-   .. Todo:: Unknown
+   ``credentials/cakey.pem``
 
 **Example**
    .. code-block:: text
@@ -488,40 +622,13 @@ cert
    The certificate. Must be signed with a 2048 bit key.
 
 **Default**
-   .. Todo:: Unknown
+   ``credentials/cacert.pem``
 
 **Example**
    .. code-block:: text
 
       cert = /dir/cert.pem
 
-origin_pin_allowed
-^^^^^^^^^^^^^^^^^^
-
-**Description**
-   The origin of the remote endpoint address that is not denied for HTTP method /pin.
-
-**Choices**
-
-.. table::
-   :widths: auto
-
-   =====     ===========
-   Value     Description
-   =====     ===========
-   pc        Only localhost may access /pin
-   lan       Only LAN devices may access /pin
-   wan       Anyone may access /pin
-   =====     ===========
-
-**Default**
-   ``pc``
-
-**Example**
-   .. code-block:: text
-
-      origin_pin_allowed = pc
-
 origin_web_ui_allowed
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -568,7 +675,7 @@ upnp
    =====     ===========
 
 **Default**
-   ``off``
+   ``disabled``
 
 **Example**
    .. code-block:: text
@@ -579,7 +686,7 @@ ping_timeout
 ^^^^^^^^^^^^
 
 **Description**
-   How long to wait in milliseconds for data from Moonlight before shutting down the stream.
+   How long to wait, in milliseconds, for data from Moonlight before shutting down the stream.
 
 **Default**
    ``10000``
@@ -638,7 +745,7 @@ qp
 ^^
 
 **Description**
-   Quantitization Parameter. Some devices don't support Constant Bit Rate. For those devices, QP is used instead.
+   Quantization Parameter. Some devices don't support Constant Bit Rate. For those devices, QP is used instead.
 
    .. Warning:: Higher value means more compression, but less quality.
 
@@ -654,7 +761,7 @@ min_threads
 ^^^^^^^^^^^
 
 **Description**
-   Minimum number of threads used by ffmpeg to encode the video.
+   Minimum number of threads used for software encoding.
 
    .. Note:: Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually worth it to gain
       the use of more CPU cores for encoding. The ideal value is the lowest value that can reliably encode at your
@@ -685,7 +792,7 @@ hevc_mode
    =====     ===========
    Value     Description
    =====     ===========
-   0         advertise support for HEVC based on encoder
+   0         advertise support for HEVC based on encoder capabilities (recommended)
    1         do not advertise support for HEVC
    2         advertise support for HEVC Main profile
    3         advertise support for HEVC Main and Main10 (HDR) profiles
@@ -699,6 +806,71 @@ hevc_mode
 
       hevc_mode = 2
 
+av1_mode
+^^^^^^^^^
+
+**Description**
+   Allows the client to request AV1 Main 8-bit or 10-bit video streams.
+
+   .. Warning:: AV1 is more CPU-intensive to encode, so enabling this may reduce performance when using software
+      encoding.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   =====     ===========
+   Value     Description
+   =====     ===========
+   0         advertise support for AV1 based on encoder capabilities (recommended)
+   1         do not advertise support for AV1
+   2         advertise support for AV1 Main 8-bit profile
+   3         advertise support for AV1 Main 8-bit and 10-bit (HDR) profiles
+   =====     ===========
+
+**Default**
+   ``0``
+
+**Example**
+   .. code-block:: text
+
+      av1_mode = 2
+
+capture
+^^^^^^^
+
+**Description**
+   Force specific screen capture method.
+
+   .. Caution:: Applies to Linux only.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   =========  ===========
+   Value      Description
+   =========  ===========
+   nvfbc      Use NVIDIA Frame Buffer Capture to capture direct to GPU memory. This is usually the fastest method for
+              NVIDIA cards. For GeForce cards it will only work with drivers patched with
+              `nvidia-patch <https://github.com/keylase/nvidia-patch/>`__
+              or `nvlax <https://github.com/illnyang/nvlax/>`__.
+   wlr        Capture for wlroots based Wayland compositors via DMA-BUF.
+   kms        DRM/KMS screen capture from the kernel. This requires that sunshine has cap_sys_admin capability.
+              See :ref:`Linux Setup <about/usage:linux>`.
+   x11        Uses XCB. This is the slowest and most CPU intensive so should be avoided if possible.
+   =========  ===========
+
+**Default**
+   Automatic. Sunshine will use the first capture method available in the order of the table above.
+
+**Example**
+   .. code-block:: text
+
+      capture = kms
+
 encoder
 ^^^^^^^
 
@@ -710,13 +882,14 @@ encoder
 .. table::
    :widths: auto
 
-   ========  ===========
-   Value     Description
-   ========  ===========
-   nvenc     For Nvidia graphics cards
-   amdvce    For AMD graphics cards
-   software  Encoding occurs on the CPU
-   ========  ===========
+   =========  ===========
+   Value      Description
+   =========  ===========
+   nvenc      For NVIDIA graphics cards
+   quicksync  For Intel graphics cards
+   amdvce     For AMD graphics cards
+   software   Encoding occurs on the CPU
+   =========  ===========
 
 **Default**
    Sunshine will use the first encoder that is available.
@@ -734,7 +907,7 @@ sw_preset
 
    .. Note:: This option only applies when using software `encoder`_.
 
-   .. Note:: From `FFmpeg <https://trac.ffmpeg.org/wiki/Encode/H.264#preset>`_.
+   .. Note:: From `FFmpeg <https://trac.ffmpeg.org/wiki/Encode/H.264#preset>`__.
 
          A preset is a collection of options that will provide a certain encoding speed to compression ratio. A slower
          preset will provide better compression (compression is quality per filesize). This means that, for example, if
@@ -754,12 +927,10 @@ sw_preset
    ultrafast fastest
    superfast
    veryfast
-   superfast
    faster
    fast
    medium
    slow
-   slow
    slower
    veryslow  slowest
    ========= ===========
@@ -780,7 +951,7 @@ sw_tune
 
    .. Note:: This option only applies when using software `encoder`_.
 
-   .. Note:: From `FFmpeg <https://trac.ffmpeg.org/wiki/Encode/H.264#preset>`_.
+   .. Note:: From `FFmpeg <https://trac.ffmpeg.org/wiki/Encode/H.264#preset>`__.
 
          You can optionally use -tune to change settings based upon the specifics of your input.
 
@@ -808,13 +979,140 @@ sw_tune
 
       sw_tune    = zerolatency
 
-nv_preset
-^^^^^^^^^
+nvenc_preset
+^^^^^^^^^^^^
+
+**Description**
+   NVENC encoder performance preset.
+   Higher numbers improve compression (quality at given bitrate) at the cost of increased encoding latency.
+   Recommended to change only when limited by network or decoder, otherwise similar effect can be accomplished by increasing bitrate.
+
+   .. Note:: This option only applies when using NVENC `encoder`_.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   ========== ===========
+   Value      Description
+   ========== ===========
+   1          P1 (fastest)
+   2          P2
+   3          P3
+   4          P4
+   5          P5
+   6          P6
+   7          P7 (slowest)
+   ========== ===========
+
+**Default**
+   ``1``
+
+**Example**
+   .. code-block:: text
+
+      nvenc_preset = 1
+
+nvenc_twopass
+^^^^^^^^^^^^^
+
+**Description**
+   Enable two-pass mode in NVENC encoder.
+   This allows to detect more motion vectors, better distribute bitrate across the frame and more strictly adhere to bitrate limits.
+   Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet loss.
+
+   .. Note:: This option only applies when using NVENC `encoder`_.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   =========== ===========
+   Value       Description
+   =========== ===========
+   disabled    One pass (fastest)
+   quarter_res Two passes, first pass at quarter resolution (faster)
+   full_res    Two passes, first pass at full resolution (slower)
+   =========== ===========
+
+**Default**
+   ``quarter_res``
+
+**Example**
+   .. code-block:: text
+
+      nvenc_twopass = quarter_res
+
+nvenc_realtime_hags
+^^^^^^^^^^^^^^^^^^^
+
+**Description**
+   Use realtime gpu scheduling priority in NVENC when hardware accelerated gpu scheduling (HAGS) is enabled in Windows.
+   Currently NVIDIA drivers may freeze in encoder when HAGS is enabled, realtime priority is used and VRAM utilization is close to maximum.
+   Disabling this option lowers the priority to high, sidestepping the freeze at the cost of reduced capture performance when the GPU is heavily loaded.
+
+   .. Note:: This option only applies when using NVENC `encoder`_.
+
+   .. Caution:: Applies to Windows only.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   ========== ===========
+   Value      Description
+   ========== ===========
+   disabled   Use high priority
+   enabled    Use realtime priority
+   ========== ===========
+
+**Default**
+   ``enabled``
+
+**Example**
+   .. code-block:: text
+
+      nvenc_realtime_hags = enabled
+
+nvenc_h264_cavlc
+^^^^^^^^^^^^^^^^
+
+**Description**
+   Prefer CAVLC entropy coding over CABAC in H.264 when using NVENC.
+   CAVLC is outdated and needs around 10% more bitrate for same quality, but provides slightly faster decoding when using software decoder.
+
+   .. Note:: This option only applies when using H.264 format with NVENC `encoder`_.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   ========== ===========
+   Value      Description
+   ========== ===========
+   disabled   Prefer CABAC
+   enabled    Prefer CAVLC
+   ========== ===========
+
+**Default**
+   ``disabled``
+
+**Example**
+   .. code-block:: text
+
+      nvenc_h264_cavlc = disabled
+
+qsv_preset
+^^^^^^^^^^
 
 **Description**
    The encoder preset to use.
 
-   .. Note:: This option only applies when using nvenc `encoder`_.
+   .. Note:: This option only applies when using quicksync `encoder`_.
 
 **Choices**
 
@@ -824,70 +1122,30 @@ nv_preset
    ========== ===========
    Value      Description
    ========== ===========
-   default    let ffmpeg decide
-   hp         high performance
-   hq         high quality
-   slow       high quality, 2 passes
-   medium     high quality, 1 pass
-   fast       high performance, 1 pass
-   bd
-   ll         low latency
-   llhq       low latency, high quality
-   llhp       low latency, high performance
-   lossless   lossless
-   losslesshp lossless, high performance
+   veryfast   fastest (lowest quality)
+   faster     faster (lower quality)
+   fast       fast (low quality)
+   medium     medium (default)
+   slow       slow (good quality)
+   slower     slower (better quality)
+   veryslow   slowest (best quality)
    ========== ===========
 
 **Default**
-   ``llhq``
+   ``medium``
 
 **Example**
    .. code-block:: text
 
-      nv_preset = llhq
+      qsv_preset = medium
 
-nv_rc
-^^^^^
-
-**Description**
-   The encoder rate control.
-
-   .. Note:: This option only applies when using nvenc `encoder`_.
-
-   .. Note:: Moonlight does not currently support variable bitrate, although it can still be selected here.
-
-**Choices**
-
-.. table::
-   :widths: auto
-
-   ========== ===========
-   Value      Description
-   ========== ===========
-   auto       let ffmpeg decide
-   constqp    constant QP mode
-   cbr        constant bitrate
-   cbr_hq     constant bitrate, high quality
-   cbr_ld_hq  constant bitrate, low delay, high quality
-   vbr        variable bitrate
-   vbr_hq     variable bitrate, high quality
-   ========== ===========
-
-**Default**
-   ``auto``
-
-**Example**
-   .. code-block:: text
-
-      nv_rc = auto
-
-nv_coder
-^^^^^^^^
+qsv_coder
+^^^^^^^^^
 
 **Description**
    The entropy encoding to use.
 
-   .. Note:: This option only applies when using nvenc `encoder`_.
+   .. Note:: This option only applies when using H264 with quicksync `encoder`_.
 
 **Choices**
 
@@ -898,8 +1156,8 @@ nv_coder
    Value      Description
    ========== ===========
    auto       let ffmpeg decide
-   cabac
-   cavlc
+   cabac      context adaptive binary arithmetic coding - higher quality
+   cavlc      context adaptive variable-length coding - faster decode
    ========== ===========
 
 **Default**
@@ -908,7 +1166,7 @@ nv_coder
 **Example**
    .. code-block:: text
 
-      nv_coder = auto
+      qsv_coder = auto
 
 amd_quality
 ^^^^^^^^^^^
@@ -926,9 +1184,9 @@ amd_quality
    ========== ===========
    Value      Description
    ========== ===========
-   default    let ffmpeg decide
-   speed      fast
-   balanced   balance performance and speed
+   speed      prefer speed
+   balanced   balanced
+   quality    prefer quality
    ========== ===========
 
 **Default**
@@ -947,8 +1205,6 @@ amd_rc
 
    .. Note:: This option only applies when using amdvce `encoder`_.
 
-   .. Note:: Moonlight does not currently support variable bitrate, although it can still be selected here.
-
 **Choices**
 
 .. table::
@@ -957,20 +1213,81 @@ amd_rc
    =========== ===========
    Value       Description
    =========== ===========
-   auto        let ffmpeg decide
-   constqp     constant QP mode
+   cqp         constant qp mode
    cbr         constant bitrate
    vbr_latency variable bitrate, latency constrained
    vbr_peak    variable bitrate, peak constrained
    =========== ===========
 
 **Default**
-   ``auto``
+   ``vbr_latency``
 
 **Example**
    .. code-block:: text
 
-      amd_rc = auto
+      amd_rc = vbr_latency
+
+amd_usage
+^^^^^^^^^
+
+**Description**
+   The encoder usage profile, used to balance latency with encoding quality.
+
+   .. Note:: This option only applies when using amdvce `encoder`_.
+
+**Choices**
+
+.. table::
+   :widths: auto
+
+   =============== ===========
+   Value           Description
+   =============== ===========
+   transcoding     transcoding (slowest)
+   webcam          webcam (slow)
+   lowlatency      low latency (fast)
+   ultralowlatency ultra low latency (fastest)
+   =============== ===========
+
+**Default**
+   ``ultralowlatency``
+
+**Example**
+   .. code-block:: text
+
+      amd_usage = ultralowlatency
+
+amd_preanalysis
+^^^^^^^^^^^^^^^
+
+**Description**
+   Preanalysis can increase encoding quality at the cost of latency.
+
+   .. Note:: This option only applies when using amdvce `encoder`_.
+
+**Default**
+   ``disabled``
+
+**Example**
+   .. code-block:: text
+
+      amd_preanalysis = disabled
+
+amd_vbaq
+^^^^^^^^
+
+**Description**
+   Variance Based Adaptive Quantization (VBAQ) can increase subjective visual quality.
+
+   .. Note:: This option only applies when using amdvce `encoder`_.
+
+**Default**
+   ``enabled``
+
+**Example**
+   .. code-block:: text
+
+      amd_vbaq = enabled
 
 amd_coder
 ^^^^^^^^^
@@ -978,7 +1295,7 @@ amd_coder
 **Description**
    The entropy encoding to use.
 
-   .. Note:: This option only applies when using nvenc `encoder`_.
+   .. Note:: This option only applies when using H264 with amdvce `encoder`_.
 
 **Choices**
 
@@ -989,8 +1306,8 @@ amd_coder
    Value      Description
    ========== ===========
    auto       let ffmpeg decide
-   cabac
-   cavlc
+   cabac      context adaptive variable-length coding - higher quality
+   cavlc      context adaptive binary arithmetic coding - faster decode
    ========== ===========
 
 **Default**

docs/source/about/changelog.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../../CHANGELOG.md

docs/source/about/docker.rst

@@ -1,3 +1 @@
-:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/DOCKER_README.md
-
 .. mdinclude:: ../../../DOCKER_README.md

docs/source/about/guides/app_examples.rst

@@ -0,0 +1,289 @@
+App Examples
+============
+Since not all applications behave the same, we decided to create some examples to help you get started adding games
+and applications to Sunshine.
+
+.. Attention:: Throughout these examples, any fields not shown are left blank. You can enhance your experience by
+   adding an image or a log file (via the ``Output`` field).
+
+Common Examples
+---------------
+
+Desktop
+^^^^^^^
+
++----------------------+-----------------+
+| **Field**            | **Value**       |
++----------------------+-----------------+
+| Application Name     | ``Desktop``     |
++----------------------+-----------------+
+| Image                | ``desktop.png`` |
++----------------------+-----------------+
+
+Steam Big Picture
+^^^^^^^^^^^^^^^^^
+
+.. Note:: Steam is launched as a detached command because Steam starts with a process that self updates itself and the original
+   process is killed. Since the original process ends it will not work as a regular command.
+
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| **Field**            | **Linux**                                | **macOS**                        | **Windows**                       |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| Application Name     | ``Steam Big Picture``                                                                                           |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| Detached Commands    | ``setsid steam steam://open/bigpicture`` | ``open steam://open/bigpicture`` | ``steam steam://open/bigpicture`` |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| Image                | ``steam.png``                                                                                                   |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+
+Epic Game Store game
+^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched
+   using the "Command" and therefore the stream will not end when the game ends.
+
+URI (Epic)
+""""""""""
+
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Field**            | **Windows**                                                                                                                                               |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                                                        |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Detached Commands    | ``cmd /C "start com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true"`` |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Binary (Epic w/ working directory)
+""""""""""""""""""""""""""""""""""
+
++----------------------+-----------------------------------------------+
+| **Field**            | **Windows**                                   |
++----------------------+-----------------------------------------------+
+| Application Name     | ``Surviving Mars``                            |
++----------------------+-----------------------------------------------+
+| Command              | ``cmd /c "MarsEpic.exe"``                     |
++----------------------+-----------------------------------------------+
+| Working Directory    | ``C:\Program Files\Epic Games\SurvivingMars`` |
++----------------------+-----------------------------------------------+
+
+Binary (Epic w/o working directory)
+"""""""""""""""""""""""""""""""""""
+
++----------------------+--------------------------------------------------------------+
+| **Field**            | **Windows**                                                  |
++----------------------+--------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                           |
++----------------------+--------------------------------------------------------------+
+| Command              | ``"C:\Program Files\Epic Games\SurvivingMars\MarsEpic.exe"`` |
++----------------------+--------------------------------------------------------------+
+
+
+Steam game
+^^^^^^^^^^
+
+.. Note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched
+   using the "Command" and therefore the stream will not end when the game ends.
+
+URI (Steam)
+"""""""""""
+
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+| **Field**            | **Linux**                                 | **macOS**                         | **Windows**                                 |
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                          |
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+| Detached Commands    | ``setsid steam steam://rungameid/464920`` | ``open steam://rungameid/464920`` | ``cmd /C "start steam://rungameid/464920"`` |
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+
+Binary (Steam w/ working directory)
+"""""""""""""""""""""""""""""""""""
+
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| **Field**            | **Linux**               | **macOS**               | **Windows**                                                      |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                   |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| Command              | ``MarsSteam``                                     | ``cmd /c "MarsSteam.exe"``                                       |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| Working Directory    | ``~/.steam/steam/SteamApps/common/Survivng Mars`` | ``C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars`` |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+
+Binary (Steam w/o working directory)
+""""""""""""""""""""""""""""""""""""
+
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+| **Field**            | **Linux**                    | **macOS**                    | **Windows**                                                                      |
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                                             |
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+| Command              | ``~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam`` | ``"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars\MarsSteam.exe"`` |
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+
+Linux
+-----
+
+Changing Resolution and Refresh Rate (Linux - X11)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                                                             |
++----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``sh -c "xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}\" --rate ${SUNSHINE_CLIENT_FPS}"``    |
+|                      +---------------------------------------------------------------------------------------------------------------------------------------+
+|                      | Undo: ``xrandr --output HDMI-1 --mode 3840x2160 --rate 120``                                                                          |
++----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+.. hint::
+   The above only works if the xrandr mode already exists. You will need to create new modes to stream to macOS and iOS devices, since they use non standard resolutions.
+
+   You can update the ``Do`` command to this:
+      .. code-block:: bash
+
+         bash -c "${HOME}/scripts/set-custom-res.sh \"${SUNSHINE_CLIENT_WIDTH}\" \"${SUNSHINE_CLIENT_HEIGHT}\" \"${SUNSHINE_CLIENT_FPS}\""
+
+   The ``set-custom-res.sh`` will have this content:
+      .. code-block:: bash
+
+         #!/bin/bash
+
+         # Get params and set any defaults
+         width=${1:-1920}
+         height=${2:-1080}
+         refresh_rate=${3:-60}
+
+         # You may need to adjust the scaling differently so the UI/text isn't too small / big
+         scale=${4:-0.55}
+
+         # Get the name of the active display
+         display_output=$(xrandr | grep " connected" | awk '{ print $1 }')
+
+         # Get the modeline info from the 2nd row in the cvt output
+         modeline=$(cvt ${width} ${height} ${refresh_rate} | awk 'FNR == 2')
+         xrandr_mode_str=${modeline//Modeline \"*\" /}
+         mode_alias="${width}x${height}"
+
+         echo "xrandr setting new mode ${mode_alias} ${xrandr_mode_str}"
+         xrandr --newmode ${mode_alias} ${xrandr_mode_str}
+         xrandr --addmode ${display_output} ${mode_alias}
+
+         # Reset scaling
+         xrandr --output ${display_output} --scale 1
+
+         # Apply new xrandr mode
+         xrandr --output ${display_output} --primary --mode ${mode_alias} --pos 0x0 --rotate normal --scale ${scale}
+
+         # Optional reset your wallpaper to fit to new resolution
+         # xwallpaper --zoom /path/to/wallpaper.png
+
+Changing Resolution and Refresh Rate (Linux - Wayland)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                                                           |
++----------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``sh -c "wlr-xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}Hz\""``   |
+|                      +-------------------------------------------------------------------------------------------------------------------------------------+
+|                      | Undo: ``wlr-xrandr --output HDMI-1 --mode 3840x2160@120Hz``                                                                         |
++----------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+
+Changing Resolution and Refresh Rate (Linux - KDE Plasma - Wayland and X11)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------------+----------------------------------------------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                                                        |
++----------------------+----------------------------------------------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``sh -c "kscreen-doctor output.HDMI-A-1.mode.${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}"``    |
+|                      +----------------------------------------------------------------------------------------------------------------------------------+
+|                      | Undo: ``kscreen-doctor output.HDMI-A-1.mode.3840x2160@120``                                                                      |
++----------------------+----------------------------------------------------------------------------------------------------------------------------------+
+
+Changing Resolution (Linux - NVIDIA)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------------+------------------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                            |
++----------------------+------------------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``sh -c "${HOME}/scripts/set-custom-res.sh ${SUNSHINE_CLIENT_WIDTH} ${SUNSHINE_CLIENT_HEIGHT}"`` |
+|                      +------------------------------------------------------------------------------------------------------+
+|                      | Undo: ``sh -c "${HOME}/scripts/set-custom-res.sh 3840 2160"``                                        |
++----------------------+------------------------------------------------------------------------------------------------------+
+
+The ``set-custom-res.sh`` will have this content:
+   .. code-block:: bash
+
+      #!/bin/bash
+
+      # Get params and set any defaults
+      width=${1:-1920}
+      height=${2:-1080}
+      output=${3:-HDMI-1}
+      nvidia-settings -a CurrentMetaMode="${output}: nvidia-auto-select { ViewPortIn=${width}x${height}, ViewPortOut=${width}x${height}+0+0 }"
+
+Flatpak
+^^^^^^^
+
+.. Attention:: Because Flatpak packages run in a sandboxed environment and do not normally have access to the host,
+   the Flatpak of Sunshine requires commands to be prefixed with ``flatpak-spawn --host``.
+
+macOS
+-----
+
+Changing Resolution and Refresh Rate (macOS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: This example uses the `displayplacer` tool to change the resolution.
+   This tool can be installed following instructions in their
+   `GitHub repository <https://github.com/jakehilborn/displayplacer>`__.
+
++----------------------+-----------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                     |
++----------------------+-----------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``displayplacer "id:<screenId> res:1920x1080 hz:60 scaling:on origin:(0,0) degree:0"``    |
+|                      +-----------------------------------------------------------------------------------------------+
+|                      | Undo: ``displayplacer "id:<screenId> res:3840x2160 hz:120 scaling:on origin:(0,0) degree:0"`` |
++----------------------+-----------------------------------------------------------------------------------------------+
+
+Windows
+-------
+
+Changing Resolution and Refresh Rate (Windows)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: This example uses the `QRes` tool to change the resolution and refresh rate.
+   This tool can be downloaded from their `SourceForge repository <https://sourceforge.net/projects/qres/>`__.
+
++----------------------+------------------------------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                                        |
++----------------------+------------------------------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``cmd /C FullPath\qres.exe /x:%SUNSHINE_CLIENT_WIDTH% /y:%SUNSHINE_CLIENT_HEIGHT% /r:%SUNSHINE_CLIENT_FPS%`` |
+|                      +------------------------------------------------------------------------------------------------------------------+
+|                      | Undo: ``cmd /C FullPath\qres.exe /x:3840 /y:2160 /r:120``                                                        |
++----------------------+------------------------------------------------------------------------------------------------------------------+
+
+Elevating Commands (Windows)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you've installed Sunshine as a service (default), you can now specify if a command should be elevated with adminsitrative privileges.
+Simply enable the elevated option in the WEB UI, or add it to the JSON configuration.
+This is an option for both prep-cmd and regular commands and will launch the process with the current user without a UAC prompt.
+
+.. Note:: It's important to write the values "true" and "false" as string values, not as the typical true/false values in most JSON.
+
+**Example**
+   .. code-block:: json
+
+        {
+            "name": "Game With AntiCheat that Requires Admin",
+            "output": "",
+            "cmd": "ping 127.0.0.1",
+            "exclude-global-prep-cmd": "false",
+            "elevated": "true",
+            "prep-cmd": [
+                {
+                    "do": "powershell.exe -command \"Start-Streaming\"",
+                    "undo": "powershell.exe -command \"Stop-Streaming\"",
+                    "elevated": "false"
+                }
+            ],
+            "image-path": ""
+        }

docs/source/about/guides/guides.rst

@@ -0,0 +1,10 @@
+Guides
+======
+
+Collection of guides written by the community!
+
+.. toctree::
+   :maxdepth: 2
+
+   app_examples
+   linux/linux

docs/source/about/guides/linux/headless_ssh.rst

@@ -0,0 +1,526 @@
+Remote SSH Headless Setup
+=========================
+
+.. csv-table:: Remote SSH Headless Setup
+   :header-rows: 0
+   :stub-columns: 1
+
+   Author, `Eric Dong <https://github.com/e-dong>`__
+   Difficulty, Intermediate
+
+This is a guide to setup remote SSH into host to startup X server and sunshine without physical login and dummy plug.
+The virtual display is accelerated by the NVidia GPU using the TwinView configuration.
+
+.. attention::
+    This guide is specific for Xorg and NVidia GPUs. I start the X server using the ``startx`` command.
+    I also only tested this on an Artix runit init system on LAN.
+    I didn't have to do anything special with pulseaudio (pipewire untested).
+
+    Keep your monitors plugged in until the `Checkpoint`_ step
+
+.. tip::
+   Prior to editing any system configurations, you should make a copy of the original file.
+   This will allow you to use it for reference or revert your changes easily.
+
+The Big Picture
+---------------
+Once you are done, you will need to perform these 3 steps:
+
+#. Turn on the host machine
+#. Start sunshine on remote host with a script that:
+
+   - Edits permissions of ``/dev/uinput`` (added sudo config to execute script with no password prompt)
+   - Starts X server with ``startx`` on virtual display
+   - Starts ``Sunshine``
+
+#. Startup Moonlight on the client of interest and connect to host
+
+.. hint::
+
+   As an alternative to SSH...
+
+   **Step 2** can be replaced with autologin and starting sunshine as a service or putting
+   ``sunshine &`` in your ``.xinitrc`` file if you start your X server with ``startx``.
+   In this case, the workaround for ``/dev/uinput`` permissions is not needed because the udev rule would be triggered
+   for "physical" login. See :ref:`Linux Setup <about/usage:linux>`. I personally think autologin compromises the
+   security of the PC, so I went with the remote SSH route. I use the PC more than for gaming, so I don't need a
+   virtual display everytime I turn on the PC (E.g running updates, config changes, file/media server).
+
+First we will setup the host and then the SSH Client (Which may not be the same as the machine running the
+moonlight client)
+
+Host Setup
+----------
+
+We will be setting up:
+
+#. `Static IP Setup`_
+#. `SSH Server Setup`_
+#. `Virtual Display Setup`_
+#. `Uinput Permissions Workaround`_
+#. `Stream Launcher Script`_
+
+
+Static IP Setup
+^^^^^^^^^^^^^^^
+Setup static IP Address for host. For LAN connections you can use DHCP reservation within your assigned range.
+e.g. 192.168.x.x. This will allow you to ssh to the host consistently, so the assigned IP address does
+not change. It is preferred to set this through your router config.
+
+
+SSH Server Setup
+^^^^^^^^^^^^^^^^
+
+.. note::
+   Most distros have OpenSSH already installed. If it is not present, install OpenSSH using your package manager.
+
+.. tab:: Debian/Ubuntu
+
+   .. code-block:: bash
+
+      sudo apt update
+      sudo apt install openssh-server
+
+.. tab:: Arch/Artix
+
+   .. code-block:: bash
+
+      sudo pacman -S openssh
+      # Install  openssh-<other_init> if you are not using SystemD
+      # e.g. sudo pacman -S openssh-runit
+
+.. tab:: Alpine
+
+   .. code-block:: bash
+
+        sudo apk update
+        sudo apk add openssh
+
+.. tab:: CentOS/RHEL/Fedora
+
+   **CentOS/RHEL 7**
+      .. code-block:: bash
+
+         sudo yum install openssh-server
+
+   **CentOS/Fedora/RHEL 8**
+      .. code-block:: bash
+
+         sudo dnf install openssh-server
+
+Next make sure the OpenSSH daemon is enabled to run when the system starts.
+
+.. tab:: SystemD
+
+    .. code-block:: bash
+
+      sudo systemctl enable sshd.service
+      sudo systemctl start sshd.service  # Starts the service now
+      sudo systemctl status sshd.service  # See if the service is running
+
+.. tab:: Runit
+
+   .. code-block:: bash
+
+      sudo ln -s /etc/runit/sv/sshd /run/runit/service  # Enables the OpenSSH daemon to run when system starts
+      sudo sv start sshd  # Starts the service now
+      sudo sv status sshd  # See if the service is running
+
+.. tab:: OpenRC
+
+    .. code-block:: bash
+
+        rc-update add sshd  # Enables service
+        rc-status  # List services to verify sshd is enabled
+        rc-service sshd start  # Starts the service now
+
+**Disabling PAM in sshd**
+
+I noticed when the ssh session is disconnected for any reason, ``pulseaudio`` would disconnect.
+This is due to PAM handling sessions. When running ``dmesg``, I noticed ``elogind`` would say removed user session.
+In this `Gentoo Forums post <https://forums.gentoo.org/viewtopic-t-1090186-start-0.html>`__,
+someone had a similar issue. Starting the X server in the background and exiting out of the console would cause your
+session to be removed.
+
+.. caution::
+   According to this `article <https://devicetests.com/ssh-usepam-security-session-status>`__
+   disabling PAM increases security, but reduces certain functionality in terms of session handling.
+   *Do so at your own risk!*
+
+Edit the ``sshd_config`` file with the following to disable PAM.
+
+.. code-block:: text
+
+   usePAM no
+
+After making changes to the ``sshd_config``, restart the sshd service for changes to take effect.
+
+.. tip::
+   Run the command to check the ssh configuration prior to restarting the sshd service.
+
+   .. code-block:: bash
+
+      sudo sshd -t -f /etc/ssh/sshd_config
+
+   An incorrect configuration will prevent the sshd service from starting, which might mean
+   losing SSH access to the server.
+
+.. tab:: SystemD
+
+    .. code-block:: bash
+
+      sudo systemctl restart sshd.service
+
+.. tab:: Runit
+
+    .. code-block:: bash
+
+      sudo sv restart sshd
+
+.. tab:: OpenRC
+
+    .. code-block:: bash
+
+      sudo rc-service sshd restart
+
+
+Virtual Display Setup
+^^^^^^^^^^^^^^^^^^^^^
+
+As an alternative to a dummy dongle, you can use this config to create a virtual display.
+
+.. important::
+   This is only available for NVidia GPUs using Xorg.
+
+.. hint::
+   Use ``xrandr`` to see name of your active display output. Usually it starts with ``DP`` or ``HDMI``. For me, it is ``DP-0``.
+   Put this name for the ``ConnectedMonitor`` option under the ``Device`` section.
+
+   .. code-block:: bash
+
+      xrandr | grep " connected" | awk '{ print $1 }'
+
+
+.. code-block:: xorg.conf
+
+   Section "ServerLayout"
+       Identifier "TwinLayout"
+       Screen 0 "metaScreen" 0 0
+   EndSection
+
+   Section "Monitor"
+       Identifier "Monitor0"
+       Option "Enable" "true"
+   EndSection
+
+   Section "Device"
+       Identifier "Card0"
+       Driver "nvidia"
+       VendorName "NVIDIA Corporation"
+       Option "MetaModes" "1920x1080"
+       Option "ConnectedMonitor" "DP-0"
+       Option "ModeValidation" "NoDFPNativeResolutionCheck,NoVirtualSizeCheck,NoMaxPClkCheck,NoHorizSyncCheck,NoVertRefreshCheck,NoWidthAlignmentCheck"
+   EndSection
+
+   Section "Screen"
+       Identifier "metaScreen"
+       Device "Card0"
+       Monitor "Monitor0"
+       DefaultDepth 24
+       Option "TwinView" "True"
+       SubSectionSub "Display"
+           Modes "1920x1080"
+       EndSubSection
+   EndSection
+
+.. note::
+   The ``ConnectedMonitor`` tricks the GPU into thinking a monitor is connected,
+   even if there is none actually connected! This allows a virtual display to be created that is accelerated with
+   your GPU! The ``ModeValidation`` option disables valid resolution checks, so you can choose any
+   resolution on the host!
+
+   **References**
+
+   - `issue comment on virtual-display-linux
+     <https://github.com/dianariyanto/virtual-display-linux/issues/9#issuecomment-786389065>`__
+   - `Nvidia Documentation on Configuring TwinView
+     <https://download.nvidia.com/XFree86/Linux-x86/270.29/README/configtwinview.html>`__
+   - `Arch Wiki Nvidia#TwinView <https://wiki.archlinux.org/title/NVIDIA#TwinView>`__
+   - `Unix Stack Exchange - How to add virtual display monitor with Nvidia proprietary driver
+     <https://unix.stackexchange.com/questions/559918/how-to-add-virtual-monitor-with-nvidia-proprietary-driver>`__
+
+
+Uinput Permissions Workaround
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Steps**
+
+We can use ``chown`` to change the permissions from a script. Since this requires ``sudo``,
+we will need to update the sudo configuration to execute this without being prompted for a password.
+
+#. Create a ``sunshine-setup.sh`` script to update permissions on ``/dev/uinput``. Since we aren't logged into the host,
+   the udev rule doesn't apply.
+#. Update user sudo configuration ``/etc/sudoers.d/<user>`` to allow the ``sunshine-setup.sh``
+   script to be executed with ``sudo``.
+
+.. note::
+   After I setup the :ref:`udev rule <about/usage:linux>` to get access to ``/dev/uinput``,
+   I noticed when I sshed into the host without physical login, the ACL permissions on ``/dev/uinput`` were not changed.
+   So I asked `reddit
+   <https://www.reddit.com/r/linux_gaming/comments/14htuzv/does_sshing_into_host_trigger_udev_rule_on_the/>`__.
+   I discovered that SSH sessions are not the same as a physical login.
+   I suppose it's not possible for SSH to trigger a udev rule or create a physical login session.
+
+**Setup Script**
+
+This script will take care of any precondtions prior to starting up sunshine.
+
+Run the following to create a script named something like ``sunshine-setup.sh``:
+   .. code-block:: bash
+
+      echo "chown $(id -un):$(id -gn) /dev/uinput" > sunshine-setup.sh &&\
+        chmod +x sunshine-setup.sh
+
+(**Optional**) To Ensure ethernet is being used for streaming,
+you can block WiFi with ``rfkill``.
+
+Run this command to append the rfkill block command to the script:
+   .. code-block:: bash
+
+      echo "rfkill block $(rfkill list | grep "Wireless LAN" \
+        | sed 's/^\([[:digit:]]\).*/\1/')" >> sunshine-setup.sh
+
+**Sudo Configuration**
+
+We will manually change the permissions of ``/dev/uinput`` using ``chown``.
+You need to use ``sudo`` to make this change, so add/update the entry in ``/etc/sudoers.d/${USER}``
+
+.. danger::
+   Do so at your own risk! It is more secure to give sudo and no password prompt to a single script,
+   than a generic executable like chown.
+
+.. warning::
+   Be very careful of messing this config up. If you make a typo, *YOU LOSE THE ABILITY TO USE SUDO*.
+   Fortunately, your system is not borked, you will need to login as root to fix the config.
+   You may want to setup a backup user / SSH into the host as root to fix the config if this happens.
+   Otherwise you will need to plug your machine back into a monitor and login as root to fix this.
+   To enable root login over SSH edit your SSHD config, and add ``PermitRootLogin yes``, and restart the SSH server.
+
+#. First make a backup of your ``/etc/sudoers.d/${USER}`` file.
+
+   .. code-block:: bash
+
+      sudo cp /etc/sudoers.d/${USER} /etc/sudoers.d/${USER}.backup
+
+#. ``cd`` to the parent dir of the ``sunshine-setup.sh`` script.
+#. Execute the following to update your sudoer config file.
+
+   .. code-block:: bash
+
+      echo "${USER} ALL=(ALL:ALL) ALL, NOPASSWD: $(pwd)/sunshine-setup.sh" \
+        | sudo tee /etc/sudoers.d/${USER}
+
+These changes allow the script to use sudo without being prompted with a password.
+
+e.g. ``sudo $(pwd)/sunshine-setup.sh``
+
+
+Stream Launcher Script
+^^^^^^^^^^^^^^^^^^^^^^
+
+This is the main entrypoint script that will run the ``sunshine-setup.sh`` script, start up X server, and Sunshine.
+The client will call this script that runs on the host via ssh.
+
+
+**Sunshine Startup Script**
+
+This guide will refer to this script as ``~/scripts/sunshine.sh``.
+The setup script will be referred as ``~/scripts/sunshine-setup.sh``
+
+.. code-block:: bash
+
+    #!/bin/bash
+
+    export DISPLAY=:0
+
+    # Check existing X server
+    ps -e | grep X >/dev/null
+    [[ ${?} -ne 0 ]] && {
+     echo "Starting X server"
+     startx &>/dev/null &
+     [[ ${?} -eq 0 ]] && {
+       echo "X server started successfully"
+     } || echo "X server failed to start"
+    } || echo "X server already running"
+
+    # Check if sunshine is already running
+    ps -e | grep -e .*sunshine$ >/dev/null
+    [[ ${?} -ne 0 ]] && {
+     sudo ~/scripts/sunshine-setup.sh
+     echo "Starting Sunshine!"
+     sunshine > /dev/null &
+     [[ ${?} -eq 0 ]] && {
+       echo "Sunshine started successfully"
+     } || echo "Sunshine failed to start"
+    } || echo "Sunshine is already running"
+
+    # Add any other Programs that you want to startup automatically
+    # e.g.
+    # steam &> /dev/null &
+    # firefox &> /dev/null &
+    # kdeconnect-app &> /dev/null &
+
+----
+
+SSH Client Setup
+----------------
+
+We will be setting up:
+
+#. `SSH Key Authentication Setup`_
+#. `SSH Client Script (Optional)`_
+
+SSH Key Authentication Setup
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Setup your SSH keys with ``ssh-keygen`` and use ``ssh-copy-id`` to authorize remote login to your host.
+   Run ``ssh <user>@<ip_address>`` to login to your host.
+   SSH keys automate login so you don't need to input your password!
+#. Optionally setup a ``~/.ssh/config`` file to simplify the ``ssh`` command
+
+   .. code-block:: text
+
+      Host <some_alias>
+          Hostname <ip_address>
+          User <username>
+          IdentityFile ~/.ssh/<your_private_key>
+
+   Now you can use ``ssh <some_alias>``.
+   ``ssh <some_alias> <commands/script>`` will execute the command or script on the remote host.
+
+Checkpoint
+^^^^^^^^^^
+
+As a sanity check, let's make sure your setup is working so far!
+
+**Test Steps**
+
+With your monitor still plugged into your Sunshine host PC:
+
+#. ``ssh <alias>``
+#. ``~/scripts/sunshine.sh``
+#. ``nvidia-smi``
+
+   You should see the sunshine and Xorg processing running:
+
+   .. code-block:: bash
+
+      nvidia-smi
+
+   *Output:*
+
+   .. code-block:: console
+
+       +---------------------------------------------------------------------------------------+
+       | NVIDIA-SMI 535.104.05             Driver Version: 535.104.05   CUDA Version: 12.2     |
+       |-----------------------------------------+----------------------+----------------------+
+       | GPU  Name                 Persistence-M | Bus-Id        Disp.A | Volatile Uncorr. ECC |
+       | Fan  Temp   Perf          Pwr:Usage/Cap |         Memory-Usage | GPU-Util  Compute M. |
+       |                                         |                      |               MIG M. |
+       |=========================================+======================+======================|
+       |   0  NVIDIA GeForce RTX 3070        Off | 00000000:01:00.0  On |                  N/A |
+       | 30%   46C    P2              45W / 220W |    549MiB /  8192MiB |      2%      Default |
+       |                                         |                      |                  N/A |
+       +-----------------------------------------+----------------------+----------------------+
+
+       +---------------------------------------------------------------------------------------+
+       | Processes:                                                                            |
+       |  GPU   GI   CI        PID   Type   Process name                            GPU Memory |
+       |        ID   ID                                                             Usage      |
+       |=======================================================================================|
+       |    0   N/A  N/A      1393      G   /usr/lib/Xorg                                86MiB |
+       |    0   N/A  N/A      1440    C+G   sunshine                                    293MiB |
+       +---------------------------------------------------------------------------------------+
+
+#. Check ``/dev/uinput`` permissions
+
+   .. code-block:: bash
+
+      ls -l /dev/uinput
+
+   *Output:*
+
+   .. code-block:: console
+
+      crw------- 1 <user> <primary_group> 10, 223 Aug 29 17:31 /dev/uinput
+
+#. Connect to Sunshine host from a moonlight client
+
+Now kill X and sunshine by running ``pkill X`` on the host,
+unplug your monitors from your GPU, and repeat steps 1 - 5.
+You should get the same result.
+With this setup you don't need to modify the Xorg config regardless if monitors are plugged in or not.
+
+.. code-block:: bash
+
+   pkill X
+
+
+SSH Client Script (Optional)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+At this point you have a working setup! For convenience I created this bash script to automate the
+startup of the X server and Sunshine on the host.
+This can be run on Unix systems, or on Windows using the ``git-bash`` or any bash shell.
+
+For Android/iOS you can install Linux emulators, e.g. ``Userland`` for Android and ``ISH`` for iOS.
+The neat part is that you can execute one script to launch Sunshine from your phone or tablet!
+
+.. code-block:: bash
+
+   #!/bin/bash
+
+   ssh_args="<user>@192.168.X.X" # Or use alias set in ~/.ssh/config
+
+   check_ssh(){
+     result=1
+      # Note this checks infinitely, you could update this to have a max # of retries
+     while [[ $result -ne 0 ]]
+     do
+       echo "checking host..."
+       ssh $ssh_args "exit 0" 2>/dev/null
+       result=$?
+       [[ $result -ne 0 ]] && {
+          echo "Failed to ssh to $ssh_args, with exit code $result"
+       }
+       sleep 3
+     done
+     echo "Host is ready for streaming!"
+   }
+
+   start_stream(){
+     echo "Starting sunshine server on host..."
+     echo "Start moonlight on your client of choice"
+      # -f runs ssh in the background
+     ssh -f $ssh_args "~/scripts/sunshine.sh &"
+   }
+
+   check_ssh
+   start_stream
+   exit_code=${?}
+
+   sleep 3
+   exit ${exit_code}
+
+Next Steps
+----------
+
+Congrats you can now stream your desktop headless! When trying this the first time,
+keep your monitors close by incase something isn't working right.
+
+If you have any feedback and any suggestions, feel free to make a post on Discord!
+
+.. seealso::
+   Now that you have a virtual display, you may want to automate changing the resolution
+   and refresh rate prior to connecting to an app. See :ref:`Changing Resolution and
+   Refresh Rate <about/guides/app_examples:linux>` for more information.

docs/source/about/guides/linux/linux.rst

@@ -0,0 +1,9 @@
+Linux
+======
+
+Collection of Sunshine Linux host guides.
+
+.. toctree::
+   :maxdepth: 1
+
+   headless_ssh

docs/source/about/installation.rst

@@ -21,34 +21,49 @@ See :ref:`Docker <about/docker:docker>` for additional information.
 
 Linux
 -----
-First, follow the instructions for your preferred package type below.
+Follow the instructions for your preferred package type below.
 
-Then start sunshine with the following command, unless a start command is listed in the specified package.
+**CUDA Compatibility**
 
-.. code-block:: bash
+CUDA is used for NVFBC capture.
 
-   sunshine
+.. Tip:: See `CUDA GPUS <https://developer.nvidia.com/cuda-gpus>`__ to cross reference Compute Capability to your GPU.
+
+.. table::
+   :widths: auto
+
+   ===========================================  ==============   ==============    ================================
+   Package                                      CUDA Version     Min Driver        CUDA Compute Capabilities
+   ===========================================  ==============   ==============    ================================
+   PKGBUILD                                     User dependent   User dependent    User dependent
+   sunshine.AppImage                            11.8.0           450.80.02         35;50;52;60;61;62;70;75;80;86;90
+   sunshine.pkg.tar.zst                         11.8.0           450.80.02         35;50;52;60;61;62;70;75;80;86;90
+   sunshine_{arch}.flatpak                      12.0.0           525.60.13         50;52;60;61;62;70;75;80;86;90
+   sunshine-debian-bookworm-{arch}.deb          12.0.0           525.60.13         50;52;60;61;62;70;75;80;86;90
+   sunshine-debian-bullseye-{arch}.deb          11.8.0           450.80.02         35;50;52;60;61;62;70;75;80;86;90
+   sunshine-fedora-37-{arch}.rpm                12.0.0           525.60.13         50;52;60;61;62;70;75;80;86;90
+   sunshine-fedora-38-{arch}.rpm                unavailable      unavailable       none
+   sunshine-ubuntu-20.04-{arch}.deb             11.8.0           450.80.02         35;50;52;60;61;62;70;75;80;86;90
+   sunshine-ubuntu-22.04-{arch}.deb             11.8.0           450.80.02         35;50;52;60;61;62;70;75;80;86;90
+   ===========================================  ==============   ==============    ================================
 
 AppImage
 ^^^^^^^^
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/pkg:appimage?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
-
 According to AppImageLint the supported distro matrix of the AppImage is below.
 
 - [✖] Debian oldstable (buster)
 - [✔] Debian stable (bullseye)
 - [✔] Debian testing (bookworm)
 - [✔] Debian unstable (sid)
+- [✔] Ubuntu kinetic
 - [✔] Ubuntu jammy
-- [✔] Ubuntu impish
 - [✔] Ubuntu focal
 - [✖] Ubuntu bionic
 - [✖] Ubuntu xenial
 - [✖] Ubuntu trusty
 - [✖] CentOS 7
 
-#. Download ``sunshine-appimage.zip`` and extract the contents to your home directory.
+#. Download ``sunshine.AppImage`` to your home directory.
 #. Open terminal and run the following code.
 
    .. code-block:: bash
@@ -65,14 +80,13 @@ Uninstall:
 
       ./sunshine.AppImage --remove
 
-AUR Package
-^^^^^^^^^^^
+Archlinux PKGBUILD
+^^^^^^^^^^^^^^^^^^
 #. Open terminal and run the following code.
 
    .. code-block:: bash
 
-      git clone https://aur.archlinux.org/sunshine.git
-      cd sunshine
+      wget https://github.com/LizardByte/Sunshine/releases/latest/download/PKGBUILD
       makepkg -fi
 
 Uninstall:
@@ -80,16 +94,30 @@ Uninstall:
 
       pacman -R sunshine
 
+Archlinux pkg
+^^^^^^^^^^^^^
+#. Open terminal and run the following code.
+
+   .. code-block:: bash
+
+      wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.pkg.tar.zst
+      pacman -U --noconfirm sunshine.pkg.tar.zst
+
+Uninstall:
+   .. code-block:: bash
+
+      pacman -R sunshine
+
 Debian Package
 ^^^^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/pkg:deb?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
-
-#. Download ``sunshine.deb`` and run the following code.
+#. Download ``sunshine-{ubuntu-version}.deb`` and run the following code.
 
    .. code-block:: bash
 
-      sudo apt install -f ./sunshine.deb
+      sudo apt install -f ./sunshine-{ubuntu-version}.deb
+
+.. Note:: The ``{ubuntu-version}`` is the version of ubuntu we built the package on. If you are not using Ubuntu and
+   have an issue with one package, you can try another.
 
 .. Tip:: You can double click the deb file to see details about the package and begin installation.
 
@@ -100,21 +128,25 @@ Uninstall:
 
 Flatpak Package
 ^^^^^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/pkg:flatpak?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
+#. Install `Flatpak <https://flatpak.org/setup/>`__ as required.
+#. Download ``sunshine_{arch}.flatpak`` and run the following code.
 
-#. Install `Flatpak <https://flatpak.org/setup/>`_ as required.
-#. Download ``sunshine.flatpak`` and run the following code.
+   .. Note:: Be sure to replace ``{arch}`` with the architecture for your operating system.
 
    System level (recommended)
       .. code-block:: bash
 
-         flatpak install --system sunshine.flatpak
+         flatpak install --system ./sunshine_{arch}.flatpak
 
    User level
       .. code-block:: bash
 
-         flatpak install --user sunshine.flatpak
+         flatpak install --user ./sunshine_{arch}.flatpak
+
+   Additional installation (required)
+      .. code-block:: bash
+
+         flatpak run --command=additional-install.sh dev.lizardbyte.sunshine
 
 Start:
    X11 and NVFBC capture (X11 Only)
@@ -130,13 +162,11 @@ Start:
 Uninstall:
    .. code-block:: bash
 
-      flatpak uninstall --delete-data sunshine.flatpak
+      flatpak run --command=remove-additional-install.sh dev.lizardbyte.sunshine
+      flatpak uninstall --delete-data dev.lizardbyte.sunshine
 
 RPM Package
 ^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/pkg:rpm?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
-
 #. Add `rpmfusion` repositories by running the following code.
 
    .. code-block:: bash
@@ -159,14 +189,13 @@ Uninstall:
 
 macOS
 -----
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/os:macos?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
+Sunshine on macOS is experimental. Gamepads do not work. Other features may not work as expected.
 
-pkg
+dmg
 ^^^
-.. Warning:: The `pkg` does not include runtime dependencies and should be considered experimental.
+.. Warning:: The `dmg` does not include runtime dependencies.
 
-#. Download the ``sunshine.pkg`` file and install it as normal.
+#. Download the ``sunshine.dmg`` file and install it.
 
 Uninstall:
    .. code-block:: bash
@@ -176,7 +205,7 @@ Uninstall:
 
 Portfile
 ^^^^^^^^
-#. Install `MacPorts <https://www.macports.org>`_
+#. Install `MacPorts <https://www.macports.org>`__
 #. Update the Macports sources.
 
    .. code-block:: bash
@@ -207,22 +236,20 @@ Uninstall:
 
 Windows
 -------
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/os:windows:10?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
-
-.. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/os:windows:11?logo=github&style=for-the-badge
-   :alt: GitHub issues by-label
 
 Installer
 ^^^^^^^^^
-#. Download and install ``sunshine-windows.exe``
+#. Download and install ``sunshine-windows-installer.exe``
 
-To uninstall, find Sunshine in the list `here <ms-settings:installed-apps>`_ and select "Uninstall" from the overflow
+.. Attention:: You should carefully select or unselect the options you want to install. Do not blindly install or enable
+   features.
+
+To uninstall, find Sunshine in the list `here <ms-settings:installed-apps>`__ and select "Uninstall" from the overflow
 menu. Different versions of Windows may provide slightly different steps for uninstall.
 
 Standalone
 ^^^^^^^^^^
-#. Download and extract ``sunshine-windows.zip``
+#. Download and extract ``sunshine-windows-portable.zip``
 
 To uninstall, delete the extracted directory which contains the ``sunshine.exe`` file.
 

docs/source/about/usage.rst

@@ -1,23 +1,59 @@
 Usage
 =====
 #. See the `setup`_ section for your specific OS.
-#. Run ``sunshine <directory of conf file>/sunshine.conf``.
+#. If you did not install the service, then start sunshine with the following command, unless a start command is listed
+   in the specified package :ref:`installation <about/installation:installation>` instructions.
 
-   .. Note:: You do not need to specify a config file. If no config file is entered the default location will be used.
+   .. Note:: A service is a process that runs in the background. Running multiple instances of Sunshine is not
+      advised.
 
-   .. Attention:: The configuration file specified will be created if it doesn't exist.
+   **Basic usage**
+      .. code-block:: bash
 
-   .. Tip:: If using the Linux AppImage, replace ``sunshine`` with ``./sunshine.AppImage``
+         sunshine
+
+   **Specify config file**
+      .. code-block:: bash
+
+         sunshine <directory of conf file>/sunshine.conf
+
+      .. Note:: You do not need to specify a config file. If no config file is entered the default location will be used.
+
+      .. Attention:: The configuration file specified will be created if it doesn't exist.
+
+   **Start Sunshine over SSH (Linux/X11)**
+      Assuming you are already logged into the host, you can use this command
+
+      .. code-block:: bash
+
+         ssh <user>@<ip_address> 'export DISPLAY=:0; sunshine'
+
+      If you are logged into the host with only a tty (teletypewriter), you can use ``startx`` to start the
+      X server prior to executing sunshine.
+      You nay need to add ``sleep`` between ``startx`` and ``sunshine`` to allow more time for the display to be ready.
+
+      .. code-block:: bash
+
+         ssh <user>@<ip_address> 'startx &; export DISPLAY=:0; sunshine'
+
+      .. tip:: You could also utilize the ``~/.bash_profile`` or ``~/.bashrc`` files to setup the ``DISPLAY``
+         variable.
+
+      .. seealso::
+
+         See :ref:`Remote SSH Headless Setup
+         <about/guides/linux/headless_ssh:Remote SSH Headless Setup>` on
+         how to setup a headless streaming server without autologin and dummy plugs (X11 + NVidia GPUs)
 
 #. Configure Sunshine in the web ui
 
-   The web ui is available on `https://localhost:47990 <https://localhost:47990>`_ by default. You may replace
+   The web ui is available on `https://localhost:47990 <https://localhost:47990>`__ by default. You may replace
    `localhost` with your internal ip address.
 
-   .. Attention:: Ignore any warning given by your browser about "insecure website".
+   .. Attention:: Ignore any warning given by your browser about "insecure website". This is due to the SSL certificate
+      being self signed.
 
-   .. Caution:: If running for the first time, make sure to note the username and password Sunshine showed to you,
-      since you cannot get back later!
+   .. Caution:: If running for the first time, make sure to note the username and password that you created.
 
    **Add games and applications.**
          This can be configured in the web ui.
@@ -26,8 +62,6 @@ Usage
             list of applications that are started just before running a stream. This is the directory within the GitHub
             repo.
 
-         .. Attention:: Application list is not fully supported on macOS
-
 #. In Moonlight, you may need to add the PC manually.
 #. When Moonlight request you insert the correct pin on sunshine:
 
@@ -54,33 +88,33 @@ Setup
 
 Linux
 ^^^^^
-The `deb`, `rpm`, and `AppImage` packages handle these steps automatically. The flatpak does not, third party packages
-also may not.
+The `deb`, `rpm`, `Flatpak` and `AppImage` packages handle these steps automatically. Third party packages may not.
 
 Sunshine needs access to `uinput` to create mouse and gamepad events.
 
-#. Add user to group `input`, if this is the first time installing.
+#. Create `udev` rules.
       .. code-block:: bash
 
-         sudo usermod -a -G input $USER
-
-#. Create `udev` rules.
-      .. code-block::
-
-         echo 'KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"' | \
-         sudo tee /etc/udev/rules.d/85-sunshine-input.rules
+         echo 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' | \
+         sudo tee /etc/udev/rules.d/85-sunshine.rules
 
 #. Optionally, configure autostart service
 
    - filename: ``~/.config/systemd/user/sunshine.service``
    - contents:
-         .. code-block::
+         .. code-block:: cfg
 
             [Unit]
-            Description=Sunshine Gamestream Server for Moonlight
+            Description=Sunshine self-hosted game stream host for Moonlight.
+            StartLimitIntervalSec=500
+            StartLimitBurst=5
 
             [Service]
             ExecStart=<see table>
+            Restart=on-failure
+            RestartSec=5s
+            #Flatpak Only
+            #ExecStop=flatpak kill dev.lizardbyte.sunshine
 
             [Install]
             WantedBy=graphical-session.target
@@ -95,7 +129,7 @@ Sunshine needs access to `uinput` to create mouse and gamepad events.
             deb        /usr/bin/sunshine                                ✔
             rpm        /usr/bin/sunshine                                ✔
             AppImage   ~/sunshine.AppImage                              ✔
-            Flatpak    flatpak run dev.lizardbyte.sunshine              ✖
+            Flatpak    flatpak run dev.lizardbyte.sunshine              ✔
             ========   ==============================================   ===============
 
    **Start once**
@@ -117,7 +151,7 @@ Sunshine needs access to `uinput` to create mouse and gamepad events.
 
             sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine))
 
-      **Disable**
+      **Disable (for Xorg/X11)**
          .. code-block:: bash
 
             sudo setcap -r $(readlink -f $(which sunshine))
@@ -130,9 +164,8 @@ Sunshine needs access to `uinput` to create mouse and gamepad events.
 macOS
 ^^^^^
 Sunshine can only access microphones on macOS due to system limitations. To stream system audio use
-`Soundflower <https://github.com/mattingalls/Soundflower>`_ or
-`BlackHole <https://github.com/ExistentialAudio/BlackHole>`_ and
-select their sink as audio device in `sunshine.conf`.
+`Soundflower <https://github.com/mattingalls/Soundflower>`__ or
+`BlackHole <https://github.com/ExistentialAudio/BlackHole>`__.
 
 .. Note:: Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.
 
@@ -146,46 +179,82 @@ Configure autostart service
 
 Windows
 ^^^^^^^
-For gamepad support, install `ViGEmBus <https://github.com/ViGEm/ViGEmBus/releases/latest>`_
+For gamepad support, install `Nefarius Virtual Gamepad <https://github.com/nefarius/ViGEmBus/releases/latest>`__
+
+Sunshine firewall
+   **Add rule**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         add-firewall-rule.bat
+
+   **Remove rule**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         remove-firewall-rule.bat
+
+Sunshine service
+   **Enable**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         install-service.bat
+
+   **Disable**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         uninstall-service.bat
 
 Shortcuts
 ---------
 All shortcuts start with ``CTRL + ALT + SHIFT``, just like Moonlight
 
 - ``CTRL + ALT + SHIFT + N`` - Hide/Unhide the cursor (This may be useful for Remote Desktop Mode for Moonlight)
-- ``CTRL + ALT + SHIFT + F1/F13`` - Switch to different monitor for Streaming
+- ``CTRL + ALT + SHIFT + F1/F12`` - Switch to different monitor for Streaming
 
 Application List
 ----------------
 - Applications should be configured via the web UI.
-- A basic understanding of working directories and commands is recommended.
+- A basic understanding of working directories and commands is required.
 - You can use Environment variables in place of values
 - ``$(HOME)`` will be replaced by the value of ``$HOME``
 - ``$$`` will be replaced by ``$``, e.g. ``$$(HOME)`` will be become ``$(HOME)``
 - ``env`` - Adds or overwrites Environment variables for the commands/applications run by Sunshine
 - ``"Variable name":"Variable value"``
 - ``apps`` - The list of applications
-- Example application:
+- Advanced users may want to edit the application list manually. The format is ``json``.
+- Example ``json`` application:
    .. code-block:: json
 
       {
-      "name":"An App",
-      "cmd":"command to open app",
-      "prep-cmd":[
-            {
-               "do":"some-command",
-               "undo":"undo-that-command"
-            }
-         ],
-      "detached":[
-         "some-command",
-         "another-command"
-         ]
+          "cmd": "command to open app",
+          "detached": [
+              "some-command",
+              "another-command"
+          ],
+          "image-path": "/full-path/to/png-image",
+          "name": "An App",
+          "output": "/full-path/to/command-log-file",
+          "prep-cmd": [
+              {
+                  "do": "some-command",
+                  "undo": "undo-that-command"
+              }
+          ],
+          "working-dir": "/full-path/to/working-directory"
       }
 
+   - ``cmd`` - The main application
+   - ``detached`` - A list of commands to be run and forgotten about
+
+     - If not specified, a process is started that sleeps indefinitely
+
+   - ``image-path`` - The full path to the cover art image to use.
    - ``name`` - The name of the application/game
    - ``output`` - The file where the output of the command is stored
-   - ``detached`` - A list of commands to be run and forgotten about
+   - ``auto-detach`` - Specifies whether the app should be treated as detached if it exits quickly
    - ``prep-cmd`` - A list of commands to be run before/after the application
 
      - If any of the prep-commands fail, starting the application is aborted
@@ -195,21 +264,51 @@ Application List
 
      - ``undo`` - Run after the application has terminated
 
-       - This should not fail considering it is supposed to undo the ``do`` commands
-       - If it fails, Sunshine is terminated
+       - Failures of ``undo`` commands are ignored
 
-     - ``cmd`` - The main application
+   - ``working-dir`` - The working directory to use. If not specified, Sunshine will use the application directory.
 
-       - If not specified, a process is started that sleeps indefinitely
+- For more examples see :ref:`app examples <about/guides/app_examples:app examples>`.
 
 Considerations
 --------------
+- On Windows, Sunshine uses the Desktop Duplication API which only supports capturing from the GPU used for display.
+  If you want to capture and encode on the eGPU, connect a display or HDMI dummy display dongle to it and run the games
+  on that display.
 - When an application is started, if there is an application already running, it will be terminated.
 - When the application has been shutdown, the stream shuts down as well.
 
   - For example, if you attempt to run ``steam`` as a ``cmd`` instead of ``detached`` the stream will immediately fail.
     This is due to the method in which the steam process is executed. Other applications may behave similarly.
 
-- In addition to the apps listed, one app "Desktop" is hardcoded into Sunshine. It does not start an application,
-  instead it simply starts a stream.
+- The "Desktop" app works the same as any other application except it has no commands. It does not start an application,
+  instead it simply starts a stream. If you removed it and would like to get it back, just add a new application with
+  the name "Desktop" and "desktop.png" as the image path.
 - For the Linux flatpak you must prepend commands with ``flatpak-spawn --host``.
+
+HDR Support
+-----------
+Streaming HDR content is supported for Windows hosts with NVIDIA, AMD, or Intel GPUs that support encoding HEVC Main 10.
+You must have an HDR-capable display or EDID emulator dongle connected to your host PC to activate HDR in Windows.
+
+- Ensure you enable the HDR option in your Moonlight client settings, otherwise the stream will be SDR.
+- A good HDR experience relies on proper HDR display calibration both in Windows and in game. HDR calibration can differ significantly between client and host displays.
+- We recommend calibrating the display by streaming the Windows HDR Calibration app to your client device and saving an HDR calibration profile to use while streaming.
+- You may also need to tune the brightness slider or HDR calibration options in game to the different HDR brightness capabilities of your client's display.
+- Older games that use NVIDIA-specific NVAPI HDR rather than native Windows 10 OS HDR support may not display in HDR.
+- Some GPUs can produce lower image quality or encoding performance when streaming in HDR compared to SDR.
+
+.. seealso::
+   `Arch wiki on HDR Support for Linux <https://wiki.archlinux.org/title/HDR_monitor_support>`__ and
+   `Reddit Guide for HDR Support for AMD GPUs
+   <https://www.reddit.com/r/linux_gaming/comments/10m2gyx/guide_alpha_test_hdr_on_linux>`__
+
+Tutorials and Guides
+--------------------
+Tutorial videos are available `here <https://www.youtube.com/playlist?list=PLMYr5_xSeuXAbhxYHz86hA1eCDugoxXY0>`_.
+
+Guides are available :doc:`here <./guides/guides>`.
+
+.. admonition:: Community!
+
+   Tutorials and Guides are community generated. Want to contribute? Reach out to us on our discord server.

docs/source/building/build.rst

@@ -1,6 +1,6 @@
 Build
 =====
-Sunshine binaries are built using `CMake <https://cmake.org/>`_. Cross compilation is not
+Sunshine binaries are built using `CMake <https://cmake.org/>`__. Cross compilation is not
 supported. That means the binaries must be built on the target operating system and architecture.
 
 Building Locally
@@ -8,7 +8,7 @@ Building Locally
 
 Clone
 ^^^^^
-Ensure `git <https://git-scm.com/>`_ is installed and run the following:
+Ensure `git <https://git-scm.com/>`__ is installed and run the following:
    .. code-block:: bash
 
       git clone https://github.com/lizardbyte/sunshine.git --recurse-submodules

docs/source/building/linux.rst

@@ -4,9 +4,10 @@ Linux
 Requirements
 ------------
 
-Debian Bullseye
-^^^^^^^^^^^^^^^
-End of Life: TBD
+Debian Bullseye/Bookworm
+^^^^^^^^^^^^^^^^^^^^^^^^
+End of Life (Bullseye): July, 2024
+End of Life (Bookworm): TBD
 
 Install Requirements
    .. code-block:: bash
@@ -15,15 +16,23 @@ Install Requirements
           build-essential \
           cmake \
           libavdevice-dev \
+          libayatana-appindicator3-dev \
           libboost-filesystem-dev \
+          libboost-locale-dev \
           libboost-log-dev \
-          libboost-thread-dev \
+          libboost-program-options-dev \
           libcap-dev \  # KMS
+          libcurl4-openssl-dev \
           libdrm-dev \  # KMS
           libevdev-dev \
-          libpulse-dev \
+          libmfx-dev \  # x86_64 only
+          libnotify-dev \
+          libnuma-dev \
           libopus-dev \
+          libpulse-dev \
           libssl-dev \
+          libva-dev \
+          libvdpau-dev \
           libwayland-dev \  # Wayland
           libx11-dev \  # X11
           libxcb-shm0-dev \  # X11
@@ -32,107 +41,50 @@ Install Requirements
           libxfixes-dev \  # X11
           libxrandr-dev \  # X11
           libxtst-dev \  # X11
+          nodejs \
+          npm \
           nvidia-cuda-dev \  # Cuda, NvFBC
-          nvidia-cuda-toolkit \  # Cuda, NvFBC
+          nvidia-cuda-toolkit  # Cuda, NvFBC
 
-Fedora 35
-^^^^^^^^^
-End of Life: TBD
-
-Install Repositories
-   .. code-block:: bash
-
-      sudo dnf update && \
-          sudo dnf group install "Development Tools" && \
-          sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
+Fedora 37, 38
+^^^^^^^^^^^^^
 
 Install Requirements
    .. code-block:: bash
 
+      sudo dnf update && \
+      sudo dnf group install "Development Tools" && \
       sudo dnf install \
           boost-devel \
-          boost-static.x86_64 \
           cmake \
-          ffmpeg-devel \
+          gcc \
           gcc-c++ \
+          intel-mediasdk-devel \ # x86_64 only
+          libappindicator-gtk3-devel \
+          libcap-devel \
+          libcurl-devel \
+          libdrm-devel \
           libevdev-devel \
+          libnotify-devel \
+          libva-devel \
+          libvdpau-devel \
           libX11-devel \  # X11
           libxcb-devel \  # X11
           libXcursor-devel \  # X11
           libXfixes-devel \  # X11
-          libXinerama-devel \  # X11
           libXi-devel \  # X11
+          libXinerama-devel \  # X11
           libXrandr-devel \  # X11
           libXtst-devel \  # X11
           mesa-libGL-devel \
+          npm \
+          numactl-devel \
           openssl-devel \
           opus-devel \
           pulseaudio-libs-devel \
           rpm-build \  # if you want to build an RPM binary package
-
-Ubuntu 18.04
-^^^^^^^^^^^^
-End of Life: April 2028
-
-Install Repositories
-   .. code-block:: bash
-
-      sudo apt update && sudo apt install \
-          software-properties-common \
-      && add-apt-repository ppa:savoury1/graphics && \
-      add-apt-repository ppa:savoury1/multimedia && \
-      add-apt-repository ppa:savoury1/ffmpeg4 && \
-      add-apt-repository ppa:savoury1/boost-defaults-1.71 && \
-      add-apt-repository ppa:ubuntu-toolchain-r/test && \
-
-Install Requirements
-   .. code-block:: bash
-
-      sudo apt install \
-          build-essential \
-          cmake \
-          gcc-10 \
-          g++-10 \
-          libavdevice-dev \
-          libboost-filesystem1.71-dev \
-          libboost-log1.71-dev \
-          libboost-regex1.71-dev \
-          libboost-thread1.71-dev \
-          libcap-dev \  # KMS
-          libdrm-dev \  # KMS
-          libevdev-dev \
-          libpulse-dev \
-          libopus-dev \
-          libssl-dev \
-          libwayland-dev \  # Wayland
-          libx11-dev \  # X11
-          libxcb-shm0-dev \  # X11
-          libxcb-xfixes0-dev \  # X11
-          libxcb1-dev \  # X11
-          libxfixes-dev \  # X11
-          libxrandr-dev \  # X11
-          libxtst-dev \  # X11
-          wget \
-
-Update gcc alias
-   .. code-block:: bash
-
-      update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10
-
-Install CuDA
-   .. code-block:: bash
-
-      wget https://developer.download.nvidia.com/compute/cuda/11.4.2/local_installers/cuda_11.4.2_470.57.02_linux.run --progress=bar:force:noscroll -q --show-progress -O ./cuda.run && chmod a+x ./cuda.run
-      ./cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm && rm ./cuda.run
-
-Install CMake
-   .. code-block:: bash
-
-      wget https://cmake.org/files/v3.22/cmake-3.22.2-linux-x86_64.sh
-      mkdir /opt/cmake
-      sh /cmake-3.22.2-linux-x86_64.sh --prefix=/opt/cmake --skip-license
-      ln -s /opt/cmake/bin/cmake /usr/local/bin/cmake
-      cmake --version
+          wget \  # necessary for cuda install with `run` file
+          which   # necessary for cuda install with `run` file
 
 Ubuntu 20.04
 ^^^^^^^^^^^^
@@ -145,16 +97,23 @@ Install Requirements
           build-essential \
           cmake \
           g++-10 \
+          libayatana-appindicator3-dev \
           libavdevice-dev \
           libboost-filesystem-dev \
+          libboost-locale-dev \
           libboost-log-dev \
-          libboost-thread-dev \
+          libboost-program-options-dev \
           libcap-dev \  # KMS
           libdrm-dev \  # KMS
           libevdev-dev \
-          libpulse-dev \
+          libmfx-dev \  # x86_64 only
+          libnotify-dev \
+          libnuma-dev \
           libopus-dev \
+          libpulse-dev \
           libssl-dev \
+          libva-dev \
+          libvdpau-dev \
           libwayland-dev \  # Wayland
           libx11-dev \  # X11
           libxcb-shm0-dev \  # X11
@@ -163,18 +122,19 @@ Install Requirements
           libxfixes-dev \  # X11
           libxrandr-dev \  # X11
           libxtst-dev \  # X11
-          wget \
+          nodejs \
+          npm \
+          wget  # necessary for cuda install with `run` file
 
 Update gcc alias
    .. code-block:: bash
 
-      update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10
-
-Install CuDA
-   .. code-block:: bash
-
-      wget https://developer.download.nvidia.com/compute/cuda/11.4.2/local_installers/cuda_11.4.2_470.57.02_linux.run --progress=bar:force:noscroll -q --show-progress -O ./cuda.run && chmod a+x ./cuda.run
-      ./cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm && rm ./cuda.run
+      update-alternatives --install \
+        /usr/bin/gcc gcc /usr/bin/gcc-10 100 \
+        --slave /usr/bin/g++ g++ /usr/bin/g++-10 \
+        --slave /usr/bin/gcov gcov /usr/bin/gcov-10 \
+        --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-10 \
+        --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-10
 
 Ubuntu 22.04
 ^^^^^^^^^^^^
@@ -186,15 +146,20 @@ Install Requirements
       sudo apt update && sudo apt install \
           build-essential \
           cmake \
+          libappindicator3-dev \
           libavdevice-dev \
           libboost-filesystem-dev \
+          libboost-locale-dev \
           libboost-log-dev \
-          libboost-thread-dev \
+          libboost-program-options-dev \
           libcap-dev \  # KMS
           libdrm-dev \  # KMS
           libevdev-dev \
-          libpulse-dev \
+          libmfx-dev \  # x86_64 only
+          libnotify-dev \
+          libnuma-dev \
           libopus-dev \
+          libpulse-dev \
           libssl-dev \
           libwayland-dev \  # Wayland
           libx11-dev \  # X11
@@ -204,26 +169,44 @@ Install Requirements
           libxfixes-dev \  # X11
           libxrandr-dev \  # X11
           libxtst-dev \  # X11
-          nvidia-cuda-dev \  # Cuda, NvFBC
-          nvidia-cuda-toolkit \  # Cuda, NvFBC
+          nodejs \
+          npm \
+          nvidia-cuda-dev \  # CUDA, NvFBC
+          nvidia-cuda-toolkit  # CUDA, NvFBC
+
+CUDA
+----
+If the version of CUDA available from your distro is not adequate, manually install CUDA.
+
+.. Tip:: The version of CUDA you use will determine compatibility with various GPU generations.
+   See `CUDA compatibility <https://docs.nvidia.com/deploy/cuda-compatibility/index.html>`__ for more info.
+
+   Select the appropriate run file based on your desired CUDA version and architecture according to
+   `CUDA Toolkit Archive <https://developer.nvidia.com/cuda-toolkit-archive>`__.
+
+.. code-block:: bash
+
+   wget https://developer.download.nvidia.com/compute/cuda/11.8.0/local_installers/cuda_11.8.0_520.61.05_linux.run \
+     --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+   chmod a+x ./cuda.run
+   ./cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm
+   rm ./cuda.run
+
+npm dependencies
+----------------
+Install npm dependencies.
+   .. code-block:: bash
+
+      npm install
 
 Build
 -----
 .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
 
-Debian based OSes
-   .. code-block:: bash
+.. code-block:: bash
 
-      cmake -DCMAKE_C_COMPILER=gcc-10 -DCMAKE_CXX_COMPILER=g++-10 ..
+   cmake ..
+   make -j ${nproc}
 
-Red Hat based OSes
-   .. code-block:: bash
-
-      cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ ..
-
-Finally
-   .. code-block:: bash
-
-      make -j ${nproc}
-      cpack -G DEB  # optionally, create a deb package
-      cpack -G RPM  # optionally, create a rpm package
+   cpack -G DEB  # optionally, create a deb package
+   cpack -G RPM  # optionally, create a rpm package

docs/source/building/macos.rst

@@ -5,25 +5,32 @@ Requirements
 ------------
 macOS Big Sur and Xcode 12.5+
 
-Use either `MacPorts <https://www.macports.org>`_ or `Homebrew <https://brew.sh>`_
+Use either `MacPorts <https://www.macports.org>`__ or `Homebrew <https://brew.sh>`__
 
 MacPorts
 """"""""
 Install Requirements
    .. code-block:: bash
 
-      sudo port install cmake boost ffmpeg libopus
+      sudo port install avahi boost180 cmake curl libopus npm9 pkgconfig
 
 Homebrew
 """"""""
 Install Requirements
    .. code-block:: bash
 
-      brew install boost cmake ffmpeg opus
+      brew install boost cmake node opus pkg-config
       # if there are issues with an SSL header that is not found:
       cd /usr/local/include
       ln -s ../opt/openssl/include/openssl .
 
+npm dependencies
+----------------
+Install npm dependencies.
+   .. code-block:: bash
+
+      npm install
+
 Build
 -----
 .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
@@ -36,5 +43,4 @@ Build
    cpack -G DragNDrop  # optionally, create a macOS dmg package
 
 If cmake fails complaining to find Boost, try to set the path explicitly.
-  ``cmake -DBOOST_ROOT=[boost path] ..``, e.g., ``cmake -DBOOST_ROOT=/opt/local/libexec/boost/1.76 ..``
-
+  ``cmake -DBOOST_ROOT=[boost path] ..``, e.g., ``cmake -DBOOST_ROOT=/opt/local/libexec/boost/1.80 ..``

docs/source/building/windows.rst

@@ -3,14 +3,30 @@ Windows
 
 Requirements
 ------------
-First you need to install `MSYS2 <https://www.msys2.org>`_, then startup "MSYS2 MinGW 64-bit" and install the
-following packages using:
+First you need to install `MSYS2 <https://www.msys2.org>`__, then startup "MSYS2 MinGW 64-bit" and execute the following
+codes.
 
-.. code-block:: bash
+Update all packages:
+   .. code-block:: bash
 
-   pacman -S mingw-w64-x86_64-binutils mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake \
-   mingw-w64-x86_64-toolchain mingw-w64-x86_64-opus mingw-w64-x86_64-x265 mingw-w64-x86_64-boost \
-   git mingw-w64-x86_64-make cmake make gcc
+      pacman -Suy
+
+Install dependencies:
+   .. code-block:: bash
+
+      pacman -S base-devel cmake diffutils gcc git make mingw-w64-x86_64-binutils \
+      mingw-w64-x86_64-boost mingw-w64-x86_64-cmake mingw-w64-x86_64-curl \
+      mingw-w64-x86_64-onevpl mingw-w64-x86_64-openssl mingw-w64-x86_64-opus \
+      mingw-w64-x86_64-toolchain
+
+npm dependencies
+----------------
+Install nodejs and npm. Downloads available `here <https://nodejs.org/en/download/>`__.
+
+Install npm dependencies.
+   .. code-block:: bash
+
+      npm install
 
 Build
 -----
@@ -18,10 +34,8 @@ Build
 
 .. code-block:: bash
 
-   cmake -G"Unix Makefiles" ..
-   cmake -G"MinGW Makefiles" ..  # alternatively
-
-   mingw32-make
+   cmake -G "MinGW Makefiles" ..
+   mingw32-make -j$(nproc)
 
    cpack -G NSIS  # optionally, create a windows installer
    cpack -G ZIP  # optionally, create a windows standalone package

docs/source/conf.py

@@ -8,6 +8,7 @@
 from datetime import datetime
 import os
 import re
+import subprocess
 
 
 # -- Path setup --------------------------------------------------------------
@@ -22,7 +23,7 @@ root_dir = os.path.dirname(source_dir)  # the root folder directory
 
 # -- Project information -----------------------------------------------------
 project = 'Sunshine'
-copyright = f'{datetime.now ().year}, {project}'
+project_copyright = f'{datetime.now ().year}, {project}'
 author = 'ReenigneArcher'
 
 # The full version, including alpha/beta/rc tags
@@ -43,11 +44,14 @@ To use cmake method for obtaining version instead of regex,
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'breathe',  # c++ support for sphinx with doxygen
     'm2r2',  # enable markdown files
     'sphinx.ext.autosectionlabel',
     'sphinx.ext.todo',  # enable to-do sections
+    'sphinx.ext.graphviz',  # enable graphs for breathe
     'sphinx.ext.viewcode',  # add links to view source code
     'sphinx_copybutton',  # add a copy button to code blocks
+    'sphinx_inline_tabs',  # add tabs
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -64,13 +68,15 @@ source_suffix = ['.rst', '.md']
 
 # -- Options for HTML output -------------------------------------------------
 
+# images
+html_favicon = os.path.join(root_dir, 'src_assets', 'common', 'assets', 'web', 'images', 'sunshine.ico')
+html_logo = os.path.join(root_dir, 'sunshine.png')
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # html_static_path = ['_static']
 
-html_logo = os.path.join(root_dir, 'sunshine.png')
-
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'furo'
@@ -82,4 +88,24 @@ html_theme_options = {
 
 # extension config options
 autosectionlabel_prefix_document = True  # Make sure the target is unique
+breathe_default_project = 'src'
+breathe_implementation_filename_extensions = ['.c', '.cc', '.cpp', '.mm']
+breathe_order_parameters_first = False
+breathe_projects = dict(
+    src="../build/doxyxml"
+)
 todo_include_todos = True
+
+# disable epub mimetype warnings
+# https://github.com/readthedocs/readthedocs.org/blob/eadf6ac6dc6abc760a91e1cb147cc3c5f37d1ea8/docs/conf.py#L235-L236
+suppress_warnings = ["epub.unknown_project_files"]
+
+# get doxygen version
+doxy_proc = subprocess.run('doxygen --version', shell=True, cwd=source_dir, capture_output=True)
+doxy_version = doxy_proc.stdout.decode('utf-8').strip()
+print('doxygen version: ' + doxy_version)
+
+# run doxygen
+doxy_proc = subprocess.run('doxygen Doxyfile', shell=True, cwd=source_dir)
+if doxy_proc.returncode != 0:
+    raise RuntimeError('doxygen failed with return code ' + str(doxy_proc.returncode))

docs/source/contributing/contributing.rst

@@ -2,4 +2,4 @@ Contributing
 ============
 
 Read our contribution guide in our organization level
-`docs <https://lizardbyte.readthedocs.io/en/latest/developers/contributing.html>`_.
+`docs <https://lizardbyte.readthedocs.io/en/latest/developers/contributing.html>`__.

docs/source/contributing/localization.rst

@@ -1,26 +1,14 @@
 Localization
 ============
-Sunshine is being localized into various languages. The default language is `en` (English) and is highlighted green.
+Sunshine and related LizardByte projects are being localized into various languages. The default language is
+`en` (English).
 
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=de&style=for-the-badge&query=%24.progress.0.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=green&label=en&style=for-the-badge&query=%24.progress.1.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=en-GB&style=for-the-badge&query=%24.progress.2.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=en-US&style=for-the-badge&query=%24.progress.3.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=es-ES&style=for-the-badge&query=%24.progress.4.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=fr&style=for-the-badge&query=%24.progress.5.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=it&style=for-the-badge&query=%24.progress.6.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=ru&style=for-the-badge&query=%24.progress.7.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
-
-Graph
-   .. image:: https://badges.awesome-crowdin.com/translation-15178612-503956.png
+ .. image:: https://badges.awesome-crowdin.com/translation-15178612-606145.png
 
 CrowdIn
 -------
-The translations occur on
-`CrowdIn <https://crowdin.com/project/sunshinestream>`_. Feel free to contribute to localization there.
-Only elements of the API are planned to be translated.
-
-.. Attention:: The rest API has not yet been implemented.
+The translations occur on `CrowdIn <https://translate.lizardbyte.dev/>`__. Anyone is free to contribute to
+localization there.
 
 **Translations Basics**
    - The brand names `LizardByte` and `Sunshine` should never be translated.
@@ -49,10 +37,12 @@ situations. For example if a system tray icon is added it should be localized as
    .. code-block:: cpp
 
       #include <boost/locale.hpp>
-      boost::locale::translate("Hello world!")
+      #include <string>
+
+      std::string msg = boost::locale::translate("Hello world!");
 
 .. Tip:: More examples can be found in the documentation for
-   `boost locale <https://www.boost.org/doc/libs/1_70_0/libs/locale/doc/html/messages_formatting.html>`_.
+   `boost locale <https://www.boost.org/doc/libs/1_70_0/libs/locale/doc/html/messages_formatting.html>`__.
 
 .. Warning:: This is for information only. Contributors should never include manually updated template files, or
    manually compiled language files in Pull Requests.
@@ -68,7 +58,7 @@ any of the following paths are modified.
 
 When testing locally it may be desirable to manually extract, initialize, update, and compile strings. Python is
 required for this, along with the python dependencies in the `./scripts/requirements.txt` file. Additionally,
-`xgettext <https://www.gnu.org/software/gettext/>`_ must be installed.
+`xgettext <https://www.gnu.org/software/gettext/>`__ must be installed.
 
 **Extract, initialize, and update**
    .. code-block:: bash

docs/source/contributing/testing.rst

@@ -7,20 +7,28 @@ Source code is tested against the `.clang-format` file for linting errors. The w
 format testing is `.github/workflows/cpp-clang-format-lint.yml`.
 
 Test clang-format locally.
-   .. Todo:: This documentation needs to be improved.
-
    .. code-block:: bash
 
-      clang-format ...
+      find ./ -iname *.cpp -o -iname *.h -iname *.m -iname *.mm | xargs clang-format -i
 
 Sphinx
 ------
-Sunshine uses `Sphinx <https://www.sphinx-doc.org/en/master/>`_ for documentation building. Sphinx, along with other
-required documentation depencies are included in the `./docs/requirements.txt` file. Python is required to build
+Sunshine uses `Sphinx <https://www.sphinx-doc.org/en/master/>`__ for documentation building. Sphinx, along with other
+required python dependencies are included in the `./docs/requirements.txt` file. Python is required to build
 sphinx docs. Installation and setup of python will not be covered here.
 
+Doxygen is used to generate the XML files required by Sphinx. Doxygen can be obtained from
+`Doxygen downloads <https://www.doxygen.nl/download.html>`__. Ensure that the `doxygen` executable is in your path.
+
+.. seealso::
+   Sphinx is configured to use the graphviz extension. To obtain the dot executable from the Graphviz library,
+   see the `library’s downloads section <https://graphviz.org/download/>`__.
+
+
 The config file for Sphinx is `docs/source/conf.py`. This is already included in the repo and should not be modified.
 
+The config file for Doxygen is `docs/Doxyfile`. This is already included in the repo and should not be modified.
+
 Test with Sphinx
    .. code-block:: bash
 
@@ -34,6 +42,21 @@ Test with Sphinx
       cd docs
       sphinx-build -b html source build
 
+Lint with rstcheck
+   .. code-block:: bash
+
+      rstcheck -r .
+
+Check formatting with rstfmt
+   .. code-block:: bash
+
+      rstfmt --check --diff -w 120 .
+
+Format inplace with rstfmt
+   .. code-block:: bash
+
+      rstfmt -w 120 .
+
 Unit Testing
 ------------
 .. Todo:: Sunshine does not currently have any unit tests. If you would like to help us improve please get in contact

docs/source/gamestream/gamestream.rst

@@ -0,0 +1,28 @@
+GameStream
+==========
+Nvidia announced that their GameStream service for Nvidia Games clients will be discontinued in February 2023.
+Luckily, Sunshine performance is now on par with Nvidia GameStream. Many users have even reported that Sunshine
+outperforms GameStream, so rest assured that Sunshine will be equally performant moving forward.
+
+Migration
+---------
+We have developed a simple migration tool to help you migrate your GameStream games and apps to Sunshine automatically.
+Please check out our `GSMS <https://github.com/LizardByte/GSMS>`__ project if you're interested in an automated
+migration option. At the time of writing this GSMS offers the ability to migrate your custom games and apps. The
+working directory, command, and image are all set in Sunshine's ``apps.json`` file. The box-art image is also copied
+to a specified directory.
+
+Internet Streaming
+------------------
+If you are using the Moonlight Internet Hosting Tool, you can remove it from your system when you migrate to Sunshine.
+To stream over the Internet with Sunshine and a UPnP-capable router, enable the UPnP option in the Sunshine Web UI.
+
+.. note:: Running Sunshine together with versions of the Moonlight Internet Hosting Tool prior to v5.6 will cause UPnP
+   port forwarding to become unreliable. Either uninstall the tool entirely or update it to v5.6 or later.
+
+Limitations
+-----------
+Sunshine does have some limitations, as compared to Nvidia GameStream.
+
+- Automatic game/application list.
+- Changing game settings automatically, to optimize streaming.

docs/source/index.rst

@@ -1,5 +1,3 @@
-:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/index.rst
-
 Table of Contents
 =================
 .. include:: toc.rst

docs/source/legal/legal.rst

@@ -0,0 +1,21 @@
+Legal
+=====
+.. Attention:: This documentation is for informational purposes only and is not intended as legal advice. If you have
+   any legal questions or concerns about using Sunshine, we recommend consulting with a lawyer.
+
+Sunshine is licensed under the GPL-3.0 license, which allows for free use and modification of the software.
+The full text of the license can be reviewed `here <https://github.com/LizardByte/Sunshine/blob/master/LICENSE>`__.
+
+Commercial Use
+--------------
+Sunshine can be used in commercial applications without any limitations. This means that businesses and organizations
+can use Sunshine to create and sell products or services without needing to seek permission or pay a fee.
+
+However, it is important to note that the GPL-3.0 license does not grant any rights to distribute or sell the encoders
+contained within Sunshine. If you plan to sell access to Sunshine as part of their distribution, you are responsible
+for obtaining the necessary licenses to do so. This may include obtaining a license from the
+Motion Picture Experts Group (MPEG-LA) and/or any other necessary licensing requirements.
+
+In summary, while Sunshine is free to use, it is the user's responsibility to ensure compliance with all applicable
+licensing requirements when redistributing the software as part of a commercial offering. If you have any questions or
+concerns about using Sunshine in a commercial setting, we recommend consulting with a lawyer.

docs/source/source/src.rst

@@ -0,0 +1,86 @@
+src
+===
+We are in process of improving the source code documentation. Code should be documented using Doxygen syntax.
+Some examples exist in `main.h` and `main.cpp`. In order for documentation within the code to appear in the
+rendered docs, the definition of the object must be in a header file, although the documentation itself can (and
+should) be in the source file.
+
+Example Documentation Blocks
+----------------------------
+
+**file.h**
+
+.. code-block:: c
+
+   // functions
+   int main(int argc, char *argv[]);
+
+**file.cpp** (with markdown)
+
+.. code-block:: cpp
+
+   /**
+    * @brief Main application entry point.
+    * @param argc The number of arguments.
+    * @param argv The arguments.
+    *
+    * EXAMPLES:
+    * ```cpp
+    * main(1, const char* args[] = {"hello", "markdown", nullptr});
+    * ```
+    */
+   int main(int argc, char *argv[]) {
+     // do stuff
+   }
+
+**file.cpp** (with ReStructuredText)
+
+.. code-block:: cpp
+
+   /**
+    * @brief Main application entry point.
+    * @param argc The number of arguments.
+    * @param argv The arguments.
+    * @rst
+    * EXAMPLES:
+    *
+    * .. code-block:: cpp
+    *    main(1, const char* args[] = {"hello", "rst", nullptr});
+    * @endrst
+    */
+   int main(int argc, char *argv[]) {
+     // do stuff
+   }
+
+Code
+----
+
+.. toctree::
+   :maxdepth: 2
+   :caption: src
+
+   src/main
+   src/audio
+   src/cbs
+   src/config
+   src/confighttp
+   src/crypto
+   src/httpcommon
+   src/input
+   src/move_by_copy
+   src/network
+   src/nvhttp
+   src/process
+   src/round_robin
+   src/rtsp
+   src/stream
+   src/sync
+   src/system_tray
+   src/task_pool
+   src/thread_pool
+   src/thread_safe
+   src/upnp
+   src/utility
+   src/uuid
+   src/video
+   src/platform

docs/source/source/src/audio.rst

@@ -0,0 +1,5 @@
+audio
+=====
+
+.. doxygenfile:: audio.h
+   :allow-dot-graphs:

docs/source/source/src/cbs.rst

@@ -0,0 +1,5 @@
+cbs
+===
+
+.. doxygenfile:: cbs.h
+   :allow-dot-graphs: