refactor: re-use windows platform utf-8 functions

build(deps): bump packaging/linux/flatpak/deps/flatpak-builder-tools

---
updated-dependencies:
- dependency-name: packaging/linux/flatpak/deps/flatpak-builder-tools
  dependency-version: f9453999da8746d2ade2ccd254efcca903a633cb
  dependency-type: direct:production
...

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

.clang-format

@@ -6,27 +6,34 @@
 # Generated from CLion C/C++ Code Style settings
 BasedOnStyle: LLVM
 AccessModifierOffset: -2
-AlignAfterOpenBracket: DontAlign
-AlignConsecutiveAssignments: false
+AlignAfterOpenBracket: BlockIndent
+AlignConsecutiveAssignments: None
+AlignEscapedNewlines: DontAlign
 AlignOperands: Align
 AllowAllArgumentsOnNextLine: false
 AllowAllConstructorInitializersOnNextLine: false
 AllowAllParametersOfDeclarationOnNextLine: false
-AllowShortBlocksOnASingleLine: Always
+AllowShortBlocksOnASingleLine: Empty
 AllowShortCaseLabelsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: All
-AllowShortIfStatementsOnASingleLine: WithoutElse
-AllowShortLambdasOnASingleLine: All
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: None
 AllowShortLoopsOnASingleLine: true
 AlignTrailingComments: false
-AlwaysBreakAfterReturnType: All
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
 AlwaysBreakTemplateDeclarations: MultiLine
-BreakBeforeBraces: Custom
+BinPackArguments: false
+BinPackParameters: false
+BracedInitializerIndentWidth: 2
 BraceWrapping:
   AfterCaseLabel: false
   AfterClass: false
   AfterControlStatement: Never
   AfterEnum: false
+  AfterExternBlock: true
   AfterFunction: false
   AfterNamespace: false
   AfterObjCDeclaration: false
@@ -36,39 +43,75 @@ BraceWrapping:
   IndentBraces: false
   SplitEmptyFunction: false
   SplitEmptyRecord: true
+BreakArrays: true
 BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
 BreakBeforeTernaryOperators: false
 BreakConstructorInitializers: AfterColon
 BreakInheritanceList: AfterColon
 ColumnLimit: 0
 CompactNamespaces: false
 ContinuationIndentWidth: 2
+Cpp11BracedListStyle: true
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: Always
+ExperimentalAutoDetectBinPacking: true
+FixNamespaceComments: true
+IncludeBlocks: Regroup
+IndentAccessModifiers: false
+IndentCaseBlocks: true
 IndentCaseLabels: true
+IndentExternBlock: Indent
+IndentGotoLabels: true
 IndentPPDirectives: BeforeHash
 IndentWidth: 2
+IndentWrappedFunctionNames: true
+InsertBraces: true
+InsertNewlineAtEOF: true
 KeepEmptyLinesAtTheStartOfBlocks: false
+LineEnding: LF
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: All
+ObjCBinPackProtocolList: Never
 ObjCSpaceAfterProperty: true
 ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: Never
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 1
+PenaltyBreakString: 1
+PenaltyBreakFirstLessLess: 0
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 100000000
 PointerAlignment: Right
+ReferenceAlignment: Pointer
 ReflowComments: true
+RemoveBracesLLVM: false
+RemoveSemicolon: false
+SeparateDefinitionBlocks: Always
+SortIncludes: CaseInsensitive
+SortUsingDeclarations: Lexicographic
 SpaceAfterCStyleCast: true
 SpaceAfterLogicalNot: false
-SpaceAfterTemplateKeyword: true
+SpaceAfterTemplateKeyword: false
 SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
 SpaceBeforeCpp11BracedList: true
 SpaceBeforeCtorInitializerColon: false
 SpaceBeforeInheritanceColon: false
+SpaceBeforeJsonColon: false
 SpaceBeforeParens: ControlStatements
 SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
 SpacesInAngles: Never
 SpacesInCStyleCastParentheses: false
 SpacesInContainerLiterals: false
+SpacesInLineCommentPrefix:
+  Maximum: 3
+  Minimum: 1
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 TabWidth: 2
-Cpp11BracedListStyle: false
 UseTab: Never

.codeql-prebuild-cpp.sh

@@ -1,56 +0,0 @@
-# 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 \
-  libminiupnpc-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

.dockerignore

@@ -4,15 +4,22 @@
 # do not ignore .git, needed for versioning
 !/.git
 
+# do not ignore .rstcheck.cfg, needed to test building docs
+!/.rstcheck.cfg
+
 # ignore repo directories and files
-docs/
+docker/
 gh-pages-template/
 scripts/
 tools/
 crowdin.yml
 
+# don't ignore linux build script
+!scripts/linux_build.sh
+
 # ignore dev directories
 build/
+cmake-*/
 venv/
 
 # ignore artifacts

.flake8

@@ -1,7 +1,7 @@
 [flake8]
 filename =
-    *.py,
-    *.pys
+    *.py
 max-line-length = 120
 extend-exclude =
+    .venv/
     venv/

.gitattributes

@@ -0,0 +1,6 @@
+# ensure dockerfiles are checked out with LF line endings
+Dockerfile text eol=lf
+*.dockerfile text eol=lf
+
+# ensure flatpak lint json files are checked out with LF line endings
+*flatpak-lint-*.json text eol=lf

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -7,33 +7,32 @@ body:
       value: >
         **THIS IS NOT THE PLACE TO ASK FOR SUPPORT!**
         Please use our [Support Center](https://app.lizardbyte.dev/support) for support issues.
-        Non actionable bug reports will be locked and closed!
+        Non actionable bug reports will be LOCKED and CLOSED!
   - type: checkboxes
     attributes:
       label: Is there an existing issue for this?
       description: Please search to see if an issue already exists for the bug you encountered.
       options:
         - label: I have searched the existing issues
-          required: true
   - type: checkboxes
     attributes:
       label: Is your issue described in the documentation?
       description: Please read our [documentation](https://docs.lizardbyte.dev/projects/sunshine)
       options:
         - label: I have read the documentation
-          required: true
-  - type: checkboxes
+  - type: dropdown
     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
+      label: Is your issue present in the latest beta/pre-release?
+      description: Please test the latest [pre-release](https://github.com/LizardByte/Sunshine/releases).
       options:
-        - label: This issue is present in the nightly release
-          required: true
+        - "I didn't read the issue template"
+        - "I'm too lazy to test"
+        - "This issue is present in the latest pre-release"
   - type: textarea
     id: description
     attributes:
       label: Describe the Bug
-      description: A clear and concise description of the bug.
+      description: A clear and concise description of the bug, list the reproduction steps.
     validations:
       required: true
   - type: textarea
@@ -71,9 +70,8 @@ body:
     attributes:
       label: Architecture
       options:
-        - 32 bit
-        - 64 bit
-        - arm
+        - amd64/x86_64
+        - arm64/aarch64
         - other, n/a
     validations:
       required: true
@@ -81,7 +79,9 @@ body:
     id: version
     attributes:
       label: Sunshine commit or version
-      placeholder: eg. 0.18.0
+      description: |
+        Use `sunshine --verison` to get the version, or get the version from web UI.
+        Please don't just copy the latest commit from our repo, if that's not the commit you're actually using.
     validations:
       required: true
   - type: dropdown
@@ -94,19 +94,21 @@ body:
         - Linux - AUR (Third Party)
         - Linux - deb
         - Linux - Docker
-        - Linux - flatpak
+        - Linux - Fedora Copr
+        - Linux - flathub/flatpak
+        - Linux - Homebrew
+        - Linux - LizardByte/pacman-repo
         - Linux - nixpkgs (Third Party)
-        - Linux - PKGBUILD
         - Linux - pkg.tar.zst
-        - Linux - rpm
         - Linux - solus (Third Party)
-        - macOS - dmg
+        - Linux - Unraid (Third Party)
+        - macOS - Homebrew
         - macOS - Portfile
         - Windows - Chocolatey (Third Party)
-        - Windows - installer
-        - Windows - portable
+        - Windows - installer (recommended)
+        - Windows - portable (not recommended)
         - Windows - Scoop (Third Party)
-        - Windows - Winget (Third Party)
+        - Windows - Winget
         - other (not listed)
         - other (self built)
         - other (fork of this repo)
@@ -120,8 +122,9 @@ body:
       description: The type of the installed graphics card.
       options:
         - AMD
+        - Apple Silicon
         - Intel
-        - Nvidia
+        - NVIDIA
         - none (software encoding)
         - n/a
     validations:
@@ -131,7 +134,6 @@ body:
     attributes:
       label: GPU Model
       description: The model of the installed graphics card.
-      placeholder: e.g. GeForce RTX 2080 SUPER
     validations:
       required: true
   - type: input
@@ -139,15 +141,21 @@ body:
     attributes:
       label: GPU Driver/Mesa Version
       description: The driver/mesa version of the installed graphics card.
-      placeholder: e.g. 497.29
     validations:
       required: true
-  - type: input
+  - type: dropdown
     id: capture_method
     attributes:
-      label: Capture Method (Linux Only)
-      description: If on Linux, the capture method being used.
-      placeholder: e.g. PipeWire/KVM/X11/KMS
+      label: Capture Method
+      description: The capture method being used.
+      options:
+        - AVCaptureScreen (macOS)
+        - KMS (Linux)
+        - NvFBC (Linux)
+        - wlroots (Linux)
+        - X11 (Linux)
+        - Desktop Duplication API (Windows)
+        - Windows.Graphics.Capture (Windows)
     validations:
       required: false
   - type: textarea
@@ -158,7 +166,7 @@ body:
         Please copy and paste your config (`sunshine.conf`) file.
       render: Shell
     validations:
-      required: true
+      required: false
   - type: textarea
     id: apps
     attributes:

.github/ISSUE_TEMPLATE/config.yml

@@ -1,13 +1,19 @@
 ---
-# This action is centrally managed in https://github.com/<organization>/.github/
+# This file 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.
 
 blank_issues_enabled: false
 contact_links:
+  - name: Discussions
+    url: https://github.com/orgs/LizardByte/discussions
+    about: Community discussions
+  - name: Questions
+    url: https://github.com/orgs/LizardByte/discussions
+    about: Ask questions
+  - name: Feature Requests
+    url: https://github.com/orgs/LizardByte/discussions
+    about: Request new features
   - name: Support Center
     url: https://app.lizardbyte.dev/support
     about: Official LizardByte support
-  - name: Feature request
-    url: https://ideas.moonlight-stream.org
-    about: Share your suggestions or ideas to help Moonlight and Sunshine improve

.github/dependabot.yml

@@ -1,10 +1,17 @@
 ---
-# This action is centrally managed in https://github.com/<organization>/.github/
+# This file 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.
 
 version: 2
 updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "07:30"
+    open-pull-requests-limit: 10
+
   - package-ecosystem: "docker"
     directory: "/"
     schedule:
@@ -18,6 +25,20 @@ updates:
       interval: "daily"
       time: "08:30"
     open-pull-requests-limit: 10
+    groups:
+      docker-actions:
+        applies-to: version-updates
+        patterns:
+          - "docker/*"
+      github-actions:
+        applies-to: version-updates
+        patterns:
+          - "actions/*"
+          - "github/*"
+      lizardbyte-actions:
+        applies-to: version-updates
+        patterns:
+          - "LizardByte/*"
 
   - package-ecosystem: "npm"
     directory: "/"
@@ -25,6 +46,10 @@ updates:
       interval: "daily"
       time: "09:00"
     open-pull-requests-limit: 10
+    groups:
+      dev-dependencies:
+        applies-to: version-updates
+        dependency-type: "development"
 
   - package-ecosystem: "nuget"
     directory: "/"
@@ -39,6 +64,11 @@ updates:
       interval: "daily"
       time: "10:00"
     open-pull-requests-limit: 10
+    groups:
+      pytest-dependencies:
+        applies-to: version-updates
+        patterns:
+          - "pytest*"
 
   - package-ecosystem: "gitsubmodule"
     directory: "/"

.github/label-actions.yml

@@ -1,49 +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.
-
-# Configuration for Label Actions - https://github.com/dessant/label-actions
-
-added:
-  comment: >
-    This feature has been added and will be available in the next release.
-fixed:
-  comment: >
-    This issue has been fixed and will be available in the next release.
-invalid:duplicate:
-  comment: >
-    :wave: @{issue-author}, this appears to be a duplicate of a pre-existing issue.
-  close: true
-  lock: true
-  unlabel: 'status:awaiting-triage'
-
--invalid:duplicate:
-  reopen: true
-  unlock: true
-
-invalid:support:
-  comment: >
-    :wave: @{issue-author}, we use the issue tracker exclusively for bug reports.
-    However, this issue appears to be a support request. Please use our
-    [Support Center](https://app.lizardbyte.dev/support) for support issues. Thanks.
-  close: true
-  lock: true
-  lock-reason: 'off-topic'
-  unlabel: 'status:awaiting-triage'
-
--invalid:support:
-  reopen: true
-  unlock: true
-
-invalid:template-incomplete:
-  issues:
-    comment: >
-      :wave: @{issue-author}, please edit your issue to complete the template with
-      all the required info. Your issue will be automatically closed in 5 days if
-      the template is not completed. Thanks.
-  prs:
-    comment: >
-      :wave: @{issue-author}, please edit your PR to complete the template with
-      all the required info. Your PR will be automatically closed in 5 days if
-      the template is not completed. Thanks.

.github/pr_release_template.md

@@ -1,28 +0,0 @@
-## Description
-<!--- Please include a summary of the changes. --->
-This PR was created automatically.
-
-
-### Screenshot
-<!--- Include screenshots if the changes are UI-related. --->
-
-
-### Issues Fixed or Closed
-<!--- Close issue example: `- Closes #1` --->
-<!--- Fix bug issue example: `- Fixes #2` --->
-<!--- Resolve issue example: `- Resolves #3` --->
-
-
-## Type of Change
-- [ ] 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, 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/semantic.yml

@@ -0,0 +1,15 @@
+---
+# This file 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 is the configuration file for https://github.com/Ezard/semantic-prs
+
+enabled: true
+titleOnly: true  # We only use the PR title as we squash and merge
+commitsOnly: false
+titleAndCommits: false
+anyCommit: false
+allowMergeCommits: false
+allowRevertCommits: false
+targetUrl: https://docs.lizardbyte.dev/latest/developers/contributing.html#creating-a-pull-request

.github/workflows/CI.yml

@@ -1,858 +0,0 @@
----
-name: CI
-
-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:
-  github_env:
-    name: GitHub Env Debug
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Dump github context
-        run: echo "$GITHUB_CONTEXT"
-        shell: bash
-        env:
-          GITHUB_CONTEXT: ${{ toJson(github) }}
-
-  check_changelog:
-    name: Check Changelog
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-        uses: actions/checkout@v4
-
-      - name: Verify Changelog
-        id: verify_changelog
-        if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-        # base_ref for pull request check, ref for push
-        uses: LizardByte/.github/actions/verify_changelog@master
-        with:
-          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 }}
-
-  # todo - remove this job once versioning is fully automated by cmake
-  check_versions:
-    name: Check Versions
-    runs-on: ubuntu-latest
-    needs: check_changelog
-    if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-    # base_ref for pull request check, ref for push
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Check CMakeLists.txt Version
-        run: |
-          version=$(grep -o -E '^project\(Sunshine VERSION [0-9]+\.[0-9]+\.[0-9]+' CMakeLists.txt | \
-            grep -o -E '[0-9]+\.[0-9]+\.[0-9]+')
-          echo "cmakelists_version=${version}" >> $GITHUB_ENV
-
-      - name: Compare CMakeList.txt Version
-        if: ${{ env.cmakelists_version != needs.check_changelog.outputs.next_version_bare }}
-        run: |
-          echo CMakeLists version: "$cmakelists_version"
-          echo Changelog version: "${{ needs.check_changelog.outputs.next_version_bare }}"
-          echo Within 'CMakeLists.txt' change "project(Sunshine [VERSION $cmakelists_version]" to \
-            "project(Sunshine [VERSION ${{ needs.check_changelog.outputs.next_version_bare }}]"
-          exit 1
-
-  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 }}
-
-  setup_flatpak_matrix:
-    name: Setup Flatpak Matrix
-    runs-on: ubuntu-latest
-    steps:
-      - name: Set release details
-        id: flatpak_matrix
-        # https://www.cynkra.com/blog/2020-12-23-dynamic-gha
-        run: |
-          # determine which architectures to build
-          if [[ $GITHUB_EVENT_NAME == "push" ]]; then
-            matrix=$((
-              echo '{ "arch" : ["x86_64", "aarch64"] }'
-            ) | jq -c .)
-          else
-            matrix=$((
-              echo '{ "arch" : ["x86_64"] }'
-            ) | jq -c .)
-          fi
-
-          echo $matrix
-          echo $matrix | jq .
-          echo "matrix=$matrix" >> $GITHUB_OUTPUT
-
-    outputs:
-      matrix: ${{ steps.flatpak_matrix.outputs.matrix }}
-
-  build_linux_flatpak:
-    name: Linux Flatpak
-    runs-on: ubuntu-22.04
-    needs: [setup_release, setup_flatpak_matrix]
-    strategy:
-      fail-fast: false  # false to test all, true to fail entire job if any fail
-      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@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 \
-            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 }}/${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
-        with:
-          path: ./build/.flatpak-builder
-          key: flatpak-${{ matrix.arch }}-${{ github.sha }}
-          restore-keys: |
-            flatpak-${{ matrix.arch }}-
-
-      - name: Configure Flatpak Manifest
-        run: |
-          # variables for manifest
-          branch=${GITHUB_HEAD_REF}
-
-          # check the branch variable
-          if [ -z "$branch" ]
-          then
-            echo "This is a PUSH event"
-            branch=${{ github.ref_name }}
-            commit=${{ github.sha }}
-            clone_url=${{ github.event.repository.clone_url }}
-          else
-            echo "This is a PR event"
-            commit=${{ github.event.pull_request.head.sha }}
-            clone_url=${{ github.event.pull_request.head.repo.clone_url }}
-          fi
-          echo "Branch: ${branch}"
-          echo "Commit: ${commit}"
-          echo "Clone URL: ${clone_url}"
-
-          mkdir -p build
-          mkdir -p artifacts
-
-          cd build
-          cmake -DGITHUB_CLONE_URL=${clone_url} \
-            -DGITHUB_BRANCH=${branch} \
-            -DGITHUB_COMMIT=${commit} \
-            -DSUNSHINE_CONFIGURE_FLATPAK_MAN=ON \
-            -DSUNSHINE_CONFIGURE_ONLY=ON \
-            ..
-
-      - name: Build Linux Flatpak
-        working-directory: build
-        run: |
-          sudo su $(whoami) -c 'flatpak run org.flatpak.Builder --arch=${{ matrix.arch }} --repo=repo --force-clean \
-            --stop-at=cuda build-sunshine dev.lizardbyte.sunshine.yml'
-          cp -r .flatpak-builder copy-of-flatpak-builder
-          sudo su $(whoami) -c 'flatpak run org.flatpak.Builder --arch=${{ matrix.arch }} --repo=repo --force-clean \
-            build-sunshine dev.lizardbyte.sunshine.yml'
-          rm -rf .flatpak-builder
-          mv copy-of-flatpak-builder .flatpak-builder
-          sudo su $(whoami) -c 'flatpak build-bundle --arch=${{ matrix.arch }} ./repo \
-            ../artifacts/sunshine_${{ matrix.arch }}.flatpak dev.lizardbyte.sunshine'
-          sudo su $(whoami) -c 'flatpak build-bundle --runtime --arch=${{ matrix.arch }} ./repo \
-            ../artifacts/sunshine_debug_${{ matrix.arch }}.flatpak dev.lizardbyte.sunshine.Debug'
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: sunshine-linux-flatpak-${{ matrix.arch }}
-          path: artifacts/
-
-      - 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_linux:
-    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: 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: 30720
-          remove-dotnet: 'true'
-          remove-android: 'true'
-          remove-haskell: 'true'
-          remove-codeql: 'true'
-          remove-docker-images: 'false'
-
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Setup Dependencies Linux
-        run: |
-          sudo add-apt-repository ppa:ubuntu-toolchain-r/test -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.3_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 \
-            gcc-10 \
-            g++-10 \
-            libayatana-appindicator3-dev \
-            libavdevice-dev \
-            libcap-dev \
-            libcurl4-openssl-dev \
-            libdrm-dev \
-            libevdev-dev \
-            libminiupnpc-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
-
-      - 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
-
-          cd build
-          cmake \
-            -DBUILD_WERROR=ON \
-            -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 \
-            ${{ matrix.EXTRA_ARGS }} \
-            ..
-          make -j ${nproc}
-
-      - name: Package Linux - CPACK
-        # todo - this is no longer used
-        if: ${{ matrix.type == 'cpack' }}
-        working-directory: build
-        run: |
-          cpack -G DEB
-          mv ./cpack_artifacts/Sunshine.deb ../artifacts/sunshine-${{ matrix.dist }}.deb
-
-          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)
-        run: |
-          version=${{ needs.check_changelog.outputs.next_version_bare }}
-          echo "VERSION=${version}" >> $GITHUB_ENV
-
-      - name: Package Linux - AppImage
-        if: ${{ matrix.type == 'AppImage' }}
-        working-directory: build
-        run: |
-          # install sunshine to the DESTDIR
-          make install DESTDIR=AppDir
-
-          # custom AppRun file
-          cp -f ../packaging/linux/AppImage/AppRun ./AppDir/
-          chmod +x ./AppDir/AppRun
-
-          # variables
-          DESKTOP_FILE="${DESKTOP_FILE:-sunshine.desktop}"
-          ICON_FILE="${ICON_FILE:-sunshine.png}"
-
-          # AppImage
-          # https://docs.appimage.org/packaging-guide/index.html
-          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" \
-            --output appimage
-
-          # move
-          mv Sunshine*.AppImage ../artifacts/sunshine.AppImage
-
-          # permissions
-          chmod +x ../artifacts/sunshine.AppImage
-
-      - name: Verify 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
-
-          # rm -rf ~/.cache/appimagelint/
-
-          ./appimagelint-x86_64.AppImage ./artifacts/sunshine.AppImage
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: sunshine-linux-${{ matrix.type }}-${{ matrix.dist }}
-          path: artifacts/
-
-      - 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:
-    name: MacOS
-    runs-on: macos-11
-    needs: [check_changelog, setup_release]
-    env:
-      BOOST_VERSION: 1.83.0
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Setup Dependencies MacOS
-        run: |
-          # install dependencies using homebrew
-          brew install cmake curl miniupnpc node openssl opus pkg-config
-
-          # fix openssl header not found
-          # ln -sf /usr/local/opt/openssl/include/openssl /usr/local/include/openssl
-
-          # by installing boost from source, several headers cannot be found...
-          # the above commented out link only works if boost is installed from homebrew... does not make sense
-          ln -sf $(find /usr/local/Cellar -type d -name "openssl" -path "*/openssl@3/*/include" | head -n 1) \
-            /usr/local/include/openssl
-
-          # fix opus header not found
-          ln -sf $(find /usr/local/Cellar -type d -name "opus" -path "*/opus/*/include" | head -n 1) \
-            /usr/local/include/opus
-
-          # fix miniupnpc header not found
-          ln -sf $(find /usr/local/Cellar -type d -name "miniupnpc" -path "*/miniupnpc/*/include" | head -n 1) \
-            /usr/local/include/miniupnpc
-
-      - name: Install Boost
-        # installing boost from homebrew takes 30 minutes in a GitHub runner
-        run: |
-          export BOOST_ROOT=${HOME}/boost-${BOOST_VERSION}
-
-          # install boost
-          wget \
-            https://github.com/boostorg/boost/releases/download/boost-${BOOST_VERSION}/boost-${BOOST_VERSION}.tar.gz \
-            --progress=bar:force:noscroll -q --show-progress
-          tar xf boost-${BOOST_VERSION}.tar.gz
-          cd boost-${BOOST_VERSION}
-
-          # libdir should be set by --prefix but isn't
-          ./bootstrap.sh \
-            --prefix=${BOOST_ROOT} \
-            --libdir=${BOOST_ROOT}/lib \
-            --with-libraries=locale,log,program_options,system,thread
-          ./b2 headers
-          ./b2 install \
-            --prefix=${BOOST_ROOT} \
-            --libdir=${BOOST_ROOT}/lib \
-            -j$(sysctl -n hw.ncpu) \
-            link=shared,static \
-            variant=release \
-            cxxflags=-std=c++14 \
-            cxxflags=-stdlib=libc++ \
-            linkflags=-stdlib=libc++
-
-          # put boost in cmake prefix path
-          echo "BOOST_ROOT=${BOOST_ROOT}" >> ${GITHUB_ENV}
-
-      - 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: |
-          mkdir build
-          cd build
-          cmake \
-            -DBUILD_WERROR=ON \
-            -DCMAKE_BUILD_TYPE=Release \
-            -DCMAKE_INSTALL_PREFIX=/usr \
-            -DSUNSHINE_ASSETS_DIR=local/sunshine/assets \
-            -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
-            ..
-          make -j $(sysctl -n hw.ncpu)
-
-      - name: Package MacOS
-        run: |
-          mkdir -p artifacts
-          cd build
-
-          # package
-          cpack -G DragNDrop
-          mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine.dmg
-
-          # cpack -G Bundle
-          # mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-bundle.dmg
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: sunshine-macos
-          path: artifacts/
-
-      - 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: [check_changelog, setup_release]
-    runs-on: macos-11
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Checkout ports
-        uses: actions/checkout@v4
-        with:
-          repository: macports/macports-ports
-          fetch-depth: 64
-          path: ports
-
-      - name: Checkout mpbb
-        uses: actions/checkout@v4
-        with:
-          repository: macports/mpbb
-          path: mpbb
-
-      - name: Setup Dependencies Macports
-        run: |
-          # install dependencies using homebrew
-          brew install cmake
-
-      - name: Configure Portfile
-        run: |
-          # variables for Portfile
-          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 }}
-          else
-            echo "This is a PR event"
-            commit=${{ github.event.pull_request.head.sha }}
-            clone_url=${{ github.event.pull_request.head.repo.clone_url }}
-          fi
-          echo "Commit: ${commit}"
-          echo "Clone URL: ${clone_url}"
-
-          mkdir build
-          cd build
-          cmake \
-            -DGITHUB_COMMIT=${commit} \
-            -DGITHUB_CLONE_URL=${clone_url} \
-            -DSUNSHINE_CONFIGURE_PORTFILE=ON \
-            -DSUNSHINE_CONFIGURE_ONLY=ON \
-            ..
-          cd ..
-
-          # copy Portfile to artifacts
-          mkdir -p artifacts
-          cp -f ./build/Portfile ./artifacts/
-
-          # copy Portfile to ports
-          mkdir -p ./ports/multimedia/Sunshine
-          cp -f ./build/Portfile ./ports/multimedia/Sunshine/Portfile
-
-          # testing
-          cat ./artifacts/Portfile
-
-      - name: Bootstrap MacPorts
-        run: |
-          . ports/.github/workflows/bootstrap.sh
-
-          # Add getopt, mpbb and the MacPorts paths to $PATH for the subsequent steps.
-          echo "/opt/mports/bin" >> $GITHUB_PATH
-          echo "${PWD}/mpbb" >> $GITHUB_PATH
-          echo "/opt/local/bin" >> $GITHUB_PATH
-          echo "/opt/local/sbin" >> $GITHUB_PATH
-
-      - name: Run port lint
-        run: |
-          port -q lint "Sunshine"
-
-      - name: Build port
-        env:
-          subportlist: ${{ steps.subportlist.outputs.subportlist }}
-        run: |
-          subport="Sunshine"
-
-          workdir="/tmp/mpbb/$subport"
-          mkdir -p "$workdir/logs"
-
-          echo "::group::Installing dependencies"
-          sudo mpbb \
-            --work-dir "$workdir" \
-            install-dependencies \
-            "$subport"
-          echo "::endgroup::"
-
-          echo "::group::Installing ${subport}"
-          sudo mpbb \
-            --work-dir "$workdir" \
-            install-port \
-            --source \
-            "$subport"
-          echo "::endgroup::"
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: sunshine-macports
-          path: artifacts/
-
-      - 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_win:
-    name: Windows
-    runs-on: windows-2019
-    needs: [check_changelog, setup_release]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Setup Dependencies Windows
-        uses: msys2/setup-msys2@v2
-        with:
-          update: true
-          install: >-
-            base-devel
-            diffutils
-            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-miniupnpc
-            mingw-w64-x86_64-nlohmann-json
-            mingw-w64-x86_64-nodejs
-            mingw-w64-x86_64-nsis
-            mingw-w64-x86_64-onevpl
-            mingw-w64-x86_64-openssl
-            mingw-w64-x86_64-opus
-            mingw-w64-x86_64-toolchain
-            nasm
-            wget
-            yasm
-
-      - 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 \
-            -DBUILD_WERROR=ON \
-            -DCMAKE_BUILD_TYPE=RelWithDebInfo \
-            -DSUNSHINE_ASSETS_DIR=assets \
-            -G "MinGW Makefiles" \
-            ..
-          mingw32-make -j$(nproc)
-
-      - name: Package Windows
-        shell: msys2 {0}
-        run: |
-          mkdir -p artifacts
-          cd build
-
-          # package
-          cpack -G NSIS
-          cpack -G ZIP
-
-          # move
-          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@v4
-        with:
-          name: sunshine-windows
-          path: artifacts/
-
-      - 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 }}
-
-  release-winget:
-    name: Release to WinGet
-    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@v2
-        with:
-          identifier: LizardByte.Sunshine
-          release-tag: ${{ needs.setup_release.outputs.release_tag }}
-          installers-regex: '\.exe$'  # only .exe files
-          token: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/_codeql.yml

@@ -0,0 +1,30 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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: CodeQL
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron: '00 12 * * 0'  # every Sunday at 12:00 UTC
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  call-codeql:
+    name: CodeQL
+    uses: LizardByte/.github/.github/workflows/__call-codeql.yml@master
+    if: ${{ github.repository != 'LizardByte/.github' }}

.github/workflows/_common-lint.yml

@@ -0,0 +1,27 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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: common lint
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    branches:
+      - master
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Common Lint
+    uses: LizardByte/.github/.github/workflows/__call-common-lint.yml@master
+    if: ${{ github.repository != 'LizardByte/.github' }}

.github/workflows/_release-notifier.yml

@@ -0,0 +1,23 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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.
+
+# Create a blog post for a new release and open a PR to the blog repo
+
+name: Release Notifications
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - released  # this triggers when a release is published, but does not include pre-releases or drafts
+
+jobs:
+  update-blog:
+    name: Update blog
+    uses: LizardByte/.github/.github/workflows/__call-release-notifier.yml@master
+    if: github.repository_owner == 'LizardByte'
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/_update-changelog.yml

@@ -0,0 +1,31 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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: Update changelog
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - created
+      - edited
+      - deleted
+  workflow_dispatch:
+
+concurrency:
+  group: "${{ github.workflow }}"
+  cancel-in-progress: true
+
+jobs:
+  update-changelog:
+    name: Update Changelog
+    uses: LizardByte/.github/.github/workflows/__call-update-changelog.yml@master
+    if: >-
+      github.repository_owner == 'LizardByte' &&
+      (github.event_name == 'workflow_dispatch' ||
+      (!github.event.release.prerelease && !github.event.release.draft))
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/_update-docs.yml

@@ -0,0 +1,34 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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.
+
+# To use, add the `rtd` repository label to identify repositories that should trigger this workflow.
+# If the project slug is not the repository name, add a repository variable named `READTHEDOCS_SLUG` with the value of
+# the ReadTheDocs project slug.
+
+# Update readthedocs on release events.
+
+name: Update docs
+permissions: {}
+
+on:
+  release:
+    types:
+      - created
+      - edited
+      - deleted
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.release.tag_name }}"
+  cancel-in-progress: true
+
+jobs:
+  update-docs:
+    name: Update docs
+    uses: LizardByte/.github/.github/workflows/__call-update-docs.yml@master
+    if: github.repository_owner == 'LizardByte'
+    with:
+      readthedocs_slug: ${{ vars.READTHEDOCS_SLUG }}
+    secrets:
+      READTHEDOCS_TOKEN: ${{ secrets.READTHEDOCS_TOKEN }}

.github/workflows/_update-flathub-repo.yml

@@ -0,0 +1,29 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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.
+
+# To use, add the `flathub-pkg` repository label to identify repositories that should trigger this workflow.
+
+# Update Flathub on release events.
+
+name: Update Flathub repo
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - released
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.release.tag_name }}"
+  cancel-in-progress: true
+
+jobs:
+  update-flathub-repo:
+    name: Update Flathub Repo
+    uses: LizardByte/.github/.github/workflows/__call-update-flathub-repo.yml@master
+    if: github.repository_owner == 'LizardByte'
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/_update-homebrew-repo.yml

@@ -0,0 +1,31 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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.
+
+# To use, add the `homebrew-pkg` repository label to identify repositories that should trigger this workflow.
+
+# Update Homebrew on release events.
+
+name: Update Homebrew repo
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - released
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.release.tag_name }}"
+  cancel-in-progress: true
+
+jobs:
+  update-homebrew-repo:
+    name: Update Homebrew repo
+    uses: LizardByte/.github/.github/workflows/__call-update-homebrew-repo.yml@master
+    if: github.repository_owner == 'LizardByte'
+    secrets:
+      GH_EMAIL: ${{ secrets.GH_BOT_EMAIL }}
+      GH_USERNAME: ${{ secrets.GH_BOT_NAME }}
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/_update-pacman-repo.yml

@@ -0,0 +1,29 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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.
+
+# To use, add the `pacman-pkg` repository label to identify repositories that should trigger this workflow.
+
+# Update pacman repo on release events.
+
+name: Update pacman repo
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - released
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.release.tag_name }}"
+  cancel-in-progress: true
+
+jobs:
+  update-homebrew-release:
+    name: Update pacman repo
+    uses: LizardByte/.github/.github/workflows/__call-update-pacman-repo.yml@master
+    if: github.repository_owner == 'LizardByte'
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/_update-winget-repo.yml

@@ -0,0 +1,29 @@
+---
+# This workflow is centrally managed in https://github.com/LizardByte/.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.
+
+# To use, add the `winget-pkg` repository label to identify repositories that should trigger this workflow.
+
+# Update Winget on release events.
+
+name: Update Winget repo
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - released
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.release.tag_name }}"
+  cancel-in-progress: true
+
+jobs:
+  update-winget-repo:
+    name: Update Winget repo
+    uses: LizardByte/.github/.github/workflows/__call-update-winget-repo.yml@master
+    if: github.repository_owner == 'LizardByte'
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

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

@@ -1,35 +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  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:
-  push:
-    branches:
-      - 'nightly'
-
-jobs:
-  create_pr:
-    if: startsWith(github.repository, 'LizardByte/')
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Create Pull Request
-        uses: repo-sync/pull-request@v2
-        with:
-          source_branch: ""  # should be "nightly" as it's the triggering branch
-          destination_branch: "master"
-          pr_title: "Pulling ${{ github.ref_name }} into master"
-          pr_template: ".github/pr_release_template.md"
-          pr_assignee: "${{ secrets.GH_BOT_NAME }}"
-          pr_draft: true
-          pr_allow_empty: false
-          github_token: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/automerge.yml

@@ -1,64 +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 will, first, automatically approve PRs created by @LizardByte-bot. Then it will automerge relevant PRs.
-
-name: Automerge PR
-
-on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  autoapprove:
-    if: >-
-      contains(fromJson('["LizardByte-bot"]'), github.event.pull_request.user.login) &&
-      contains(fromJson('["LizardByte-bot"]'), github.actor) &&
-      startsWith(github.repository, 'LizardByte/')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Autoapproving
-        uses: hmarr/auto-approve-action@v3
-        with:
-          github-token: "${{ secrets.GITHUB_TOKEN }}"
-
-      - name: Label autoapproved
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GH_BOT_TOKEN }}
-          script: |
-            github.rest.issues.addLabels({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              labels: ['autoapproved', 'autoupdate']
-            })
-
-  automerge:
-    if: startsWith(github.repository, 'LizardByte/')
-    needs: [autoapprove]
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Automerging
-        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: "!dependencies"
-          MERGE_METHOD: "squash"
-          MERGE_COMMIT_MESSAGE: "{pullRequest.title} (#{pullRequest.number})"
-          MERGE_DELETE_BRANCH: true
-          MERGE_ERROR_FAIL: true
-          MERGE_FILTER_AUTHOR: ${{ secrets.GH_BOT_NAME }}
-          MERGE_RETRIES: "240"  # 1 hour
-          MERGE_RETRY_SLEEP: "15000"  # 15 seconds

.github/workflows/ci-copr.yml

@@ -0,0 +1,68 @@
+---
+name: CI-Copr
+permissions:
+  contents: read
+
+on:
+  release:
+    types:
+      - prereleased
+      - released
+  workflow_call:
+    secrets:
+      COPR_BETA_WEBHOOK_TOKEN:
+        required: false
+      COPR_STABLE_WEBHOOK_TOKEN:
+        required: false
+      COPR_CLI_CONFIG:
+        required: false
+
+concurrency:
+  group: "_${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  call-copr-ci:
+    uses: LizardByte/copr-ci/.github/workflows/copr-ci.yml@master
+    with:
+      copr_pr_webhook_token: "05fc9b07-a19b-4f83-89b2-ae1e7e0b5282"
+      github_org_owner: LizardByte
+      copr_ownername: lizardbyte
+      auto_update_package: true
+      job_timeout: 90
+    secrets:
+      COPR_BETA_WEBHOOK_TOKEN: ${{ secrets.COPR_BETA_WEBHOOK_TOKEN }}
+      COPR_STABLE_WEBHOOK_TOKEN: ${{ secrets.COPR_STABLE_WEBHOOK_TOKEN }}
+      COPR_CLI_CONFIG: ${{ secrets.COPR_CLI_CONFIG }}
+
+  release:
+    name: Release
+    if:
+      github.event_name == 'release' &&
+      startsWith(github.repository, 'LizardByte/')
+    needs:
+      - call-copr-ci
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+          pattern: build-*
+          merge-multiple: true
+
+      - name: Debug artifacts
+        run: ls -l artifacts
+
+      - name: Update GitHub Release
+        uses: LizardByte/actions/actions/release_create@v2025.715.25226
+        with:
+          allowUpdates: true
+          body: ${{ github.event.release.body }}
+          deleteOtherPreReleases: false
+          generateReleaseNotes: false
+          name: ${{ github.event.release.name }}
+          prerelease: true
+          tag: ${{ github.event.release.tag_name }}
+          token: ${{ secrets.GH_BOT_TOKEN }}
+          virustotal_api_key: ${{ secrets.VIRUSTOTAL_API_KEY }}

.github/workflows/ci-docker.yml

@@ -1,425 +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 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:
-  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:
-  check_dockerfiles:
-    name: Check Dockerfiles
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Find dockerfiles
-        id: find
-        run: |
-          dockerfiles=$(find . -type f -iname "Dockerfile" -o -iname "*.dockerfile")
-
-          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:
-      dockerfiles: ${{ steps.find.outputs.dockerfiles }}
-      matrix: ${{ steps.find.outputs.matrix }}
-
-  check_changelog:
-    name: Check Changelog
-    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@v4
-
-      - name: Verify Changelog
-        id: verify_changelog
-        if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }}
-        # base_ref for pull request check, ref for push
-        uses: LizardByte/.github/actions/verify_changelog@master
-        with:
-          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:
-    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@v4
-        with:
-          submodules: recursive
-
-      - name: Prepare
-        id: prepare
-        env:
-          NV: ${{ needs.check_changelog.outputs.next_version }}
-        run: |
-          # get branch name
-          BRANCH=${GITHUB_HEAD_REF}
-
-          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
-          if [[ $GITHUB_EVENT_NAME == "push" ]]; then
-            PUSH=true
-          else
-            PUSH=false
-          fi
-
-          # setup the tags
-          REPOSITORY=${{ github.repository }}
-          BASE_TAG=$(echo $REPOSITORY | tr '[:upper:]' '[:lower:]')
-
-          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${{ 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${{ matrix.tag }},ghcr.io/${BASE_TAG}:nightly${{ matrix.tag }}"
-          else
-            TAGS="${TAGS},${BASE_TAG}:test${{ matrix.tag }},ghcr.io/${BASE_TAG}:test${{ matrix.tag }}"
-          fi
-
-          if [[ ${NV} != "" ]]; then
-            TAGS="${TAGS},${BASE_TAG}:${NV}${{ matrix.tag }},ghcr.io/${BASE_TAG}:${NV}${{ matrix.tag }}"
-          fi
-
-          # 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@v3
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-        id: buildx
-
-      - name: Cache Docker Layers
-        uses: actions/cache@v3
-        with:
-          path: /tmp/.buildx-cache
-          key: Docker-buildx${{ matrix.tag }}-${{ github.sha }}
-          restore-keys: |
-            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@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@v3
-        with:
-          registry: ghcr.io
-          username: ${{ secrets.GH_BOT_NAME }}
-          password: ${{ secrets.GH_BOT_TOKEN }}
-
-      - name: Build artifacts
-        if: ${{ steps.prepare.outputs.artifacts == 'true' }}
-        id: build_artifacts
-        uses: docker/build-push-action@v5
-        with:
-          context: ./
-          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: |
-            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: 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@v4
-        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' }}
-        uses: peter-evans/dockerhub-description@v3
-        with:
-          username: ${{ secrets.DOCKER_HUB_USERNAME }}
-          password: ${{ secrets.DOCKER_HUB_PASSWORD }}  # token is not currently supported
-          repository: ${{ env.BASE_TAG }}
-          short-description: ${{ github.event.repository.description }}
-          readme-filepath: ./DOCKER_README.md

.github/workflows/ci-flatpak.yml

@@ -0,0 +1,213 @@
+---
+name: CI-Flatpak
+permissions:
+  contents: read
+
+on:
+  workflow_call:
+    inputs:
+      release_commit:
+        required: true
+        type: string
+      release_version:
+        required: true
+        type: string
+
+jobs:
+  build_linux_flatpak:
+    name: ${{ matrix.arch }}
+    env:
+      APP_ID: dev.lizardbyte.app.Sunshine
+      NODE_VERSION: "20"
+      PLATFORM_VERSION: "23.08"
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - arch: x86_64
+            runner: ubuntu-22.04
+          - arch: aarch64
+            runner: ubuntu-22.04-arm
+    steps:
+      - name: Maximize build space
+        if: matrix.arch == 'x86_64'
+        uses: easimon/maximize-build-space@v10
+        with:
+          root-reserve-mb: 10240
+          remove-dotnet: 'true'
+          remove-android: 'true'
+          remove-haskell: 'true'
+          remove-codeql: 'true'
+          remove-docker-images: 'true'
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup node
+        id: node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install npm dependencies
+        run: npm install --package-lock-only
+
+      - name: Debug package-lock.json
+        run: cat package-lock.json
+
+      - name: Setup python
+        id: python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Setup Dependencies Linux Flatpak
+        run: |
+          python -m pip install ./packaging/linux/flatpak/deps/flatpak-builder-tools/node
+
+          sudo apt-get update -y
+          sudo apt-get install -y \
+            cmake \
+            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 \
+            org.flatpak.Builder \
+            org.freedesktop.Platform/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            org.freedesktop.Sdk/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            org.freedesktop.Sdk.Extension.node${NODE_VERSION}/${{ matrix.arch }}/${PLATFORM_VERSION} \
+            "
+
+          flatpak run org.flatpak.Builder --version
+
+      - name: flatpak node generator
+        # https://github.com/flatpak/flatpak-builder-tools/blob/master/node/README.md
+        run: flatpak-node-generator npm package-lock.json
+
+      - name: Debug generated-sources.json
+        run: cat generated-sources.json
+
+      - name: Cache Flatpak build
+        uses: actions/cache@v4
+        with:
+          path: ./build/.flatpak-builder
+          key: flatpak-${{ matrix.arch }}-${{ github.sha }}
+          restore-keys: |
+            flatpak-${{ matrix.arch }}-
+
+      - name: Configure Flatpak Manifest
+        run: |
+          # variables for manifest
+          branch="${{ github.head_ref }}"
+          build_version=${{ inputs.release_version }}
+          commit=${{ inputs.release_commit }}
+
+          # check the branch variable
+          if [ -z "$branch" ]
+          then
+            echo "This is a PUSH event"
+            branch=${{ github.ref_name }}
+            clone_url=${{ github.event.repository.clone_url }}
+          else
+            echo "This is a PR event"
+            clone_url=${{ github.event.pull_request.head.repo.clone_url }}
+          fi
+          echo "Branch: ${branch}"
+          echo "Commit: ${commit}"
+          echo "Clone URL: ${clone_url}"
+
+          export BRANCH=${branch}
+          export BUILD_VERSION=${build_version}
+          export CLONE_URL=${clone_url}
+          export COMMIT=${commit}
+
+          mkdir -p build
+          mkdir -p artifacts
+
+          cmake -DGITHUB_CLONE_URL=${clone_url} \
+            -B build \
+            -S . \
+            -DSUNSHINE_CONFIGURE_FLATPAK_MAN=ON \
+            -DSUNSHINE_CONFIGURE_ONLY=ON
+
+      - name: Debug Manifest
+        working-directory: build
+        run: cat ${APP_ID}.yml
+
+      - name: Build Linux Flatpak
+        working-directory: build
+        run: |
+          sudo su $(whoami) -c "flatpak run org.flatpak.Builder \
+            --arch=${{ matrix.arch }} \
+            --force-clean \
+            --repo=repo \
+            --sandbox \
+            --stop-at=cuda build-sunshine ${APP_ID}.yml"
+          cp -r .flatpak-builder copy-of-flatpak-builder
+          sudo su $(whoami) -c "flatpak run org.flatpak.Builder \
+            --arch=${{ matrix.arch }} \
+            --force-clean \
+            --repo=repo \
+            --sandbox \
+            build-sunshine ${APP_ID}.yml"
+          rm -rf .flatpak-builder
+          mv copy-of-flatpak-builder .flatpak-builder
+          sudo su $(whoami) -c "flatpak build-bundle \
+            --arch=${{ matrix.arch }} \
+            ./repo \
+            ../artifacts/sunshine_${{ matrix.arch }}.flatpak ${APP_ID}"
+          sudo su $(whoami) -c "flatpak build-bundle \
+            --runtime \
+            --arch=${{ matrix.arch }} \
+            ./repo \
+            ../artifacts/sunshine_debug_${{ matrix.arch }}.flatpak ${APP_ID}.Debug"
+
+      - name: Lint Flatpak
+        working-directory: build
+        run: |
+          exceptions_file="${{ github.workspace }}/packaging/linux/flatpak/exceptions.json"
+
+          echo "Linting flatpak manifest"
+          flatpak run --command=flatpak-builder-lint org.flatpak.Builder \
+            --exceptions \
+            --user-exceptions "${exceptions_file}" \
+            manifest \
+            ${APP_ID}.yml
+
+          echo "Linting flatpak repo"
+          # TODO: add arg
+          # --mirror-screenshots-url=https://dl.flathub.org/media \
+          flatpak run --command=flatpak-builder-lint org.flatpak.Builder \
+            --exceptions \
+            --user-exceptions "${exceptions_file}" \
+            repo \
+            repo
+
+      - name: Package Flathub repo archive
+        # copy files required to generate the Flathub repo
+        if: matrix.arch == 'x86_64'
+        run: |
+          mkdir -p flathub/modules
+          cp ./build/generated-sources.json ./flathub/
+          cp ./build/package-lock.json ./flathub/
+          cp ./build/${APP_ID}.yml ./flathub/
+          cp ./build/${APP_ID}.metainfo.xml ./flathub/
+          cp ./packaging/linux/flatpak/README.md ./flathub/
+          cp ./packaging/linux/flatpak/flathub.json ./flathub/
+          cp -r ./packaging/linux/flatpak/modules/. ./flathub/modules/
+          # submodules will need to be handled in the workflow that creates the PR
+
+          # create the archive
+          tar -czf ./artifacts/flathub.tar.gz -C ./flathub .
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-Linux-Flatpak-${{ matrix.arch }}
+          path: artifacts/
+          if-no-files-found: error

.github/workflows/ci-homebrew.yml

@@ -0,0 +1,230 @@
+---
+name: CI-Homebrew
+permissions:
+  contents: read
+
+on:
+  workflow_call:
+    inputs:
+      publish_release:
+        required: true
+        type: string
+      release_commit:
+        required: true
+        type: string
+      release_tag:
+        required: true
+        type: string
+      release_version:
+        required: true
+        type: string
+    secrets:
+      GH_TOKEN:
+        required: true
+      GIT_EMAIL:
+        required: true
+      GIT_USERNAME:
+        required: true
+
+jobs:
+  build_homebrew:
+    name: ${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}
+    runs-on: ${{ matrix.os_name }}-${{ matrix.os_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories
+          # while GitHub has larger macOS runners, they are not available for our repos :(
+          - os_version: "13"
+            os_name: "macos"
+          - os_version: "14"
+            os_name: "macos"
+          - os_version: "15"
+            os_name: "macos"
+          - os_version: "latest"
+            os_name: "ubuntu"
+          - os_version: "latest"  # this job will only configure the formula for release, no validation
+            os_name: "ubuntu"
+            release: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Fix homebrew python
+        if: matrix.os_name == 'macos' && matrix.os_version == '13'
+        run: |
+          rm '/usr/local/bin/2to3'
+          rm '/usr/local/bin/2to3-3.12'
+          rm '/usr/local/bin/idle3'
+          rm '/usr/local/bin/idle3.12'
+          rm '/usr/local/bin/idle3.13'
+          rm '/usr/local/bin/pip3.12'
+          rm '/usr/local/bin/pip3.13'
+          rm '/usr/local/bin/pydoc3'
+          rm '/usr/local/bin/pydoc3.12'
+          rm '/usr/local/bin/pydoc3.13'
+          rm '/usr/local/bin/python3'
+          rm '/usr/local/bin/python3.12'
+          rm '/usr/local/bin/python3.13'
+          rm '/usr/local/bin/python3-config'
+          rm '/usr/local/bin/python3.12-config'
+          rm '/usr/local/bin/python3.13-config'
+          brew install python3
+
+      - name: Configure formula
+        run: |
+          # variables for formula
+          branch="${{ github.head_ref }}"
+          build_version=${{ inputs.release_version }}
+          commit=${{ inputs.release_commit }}
+
+          # check the branch variable
+          if [ -z "$branch" ]
+          then
+            echo "This is a PUSH event"
+            clone_url=${{ github.event.repository.clone_url }}
+            branch="${{ github.ref_name }}"
+            default_branch="${{ github.event.repository.default_branch }}"
+
+            if [ "${{ matrix.release }}" == "true" ]; then
+              # we will publish the formula with the release tag
+              tag="${{ inputs.release_tag }}"
+            else
+              tag="${{ github.ref_name }}"
+            fi
+          else
+            echo "This is a PR event"
+            clone_url=${{ github.event.pull_request.head.repo.clone_url }}
+            branch="${{ github.event.pull_request.head.ref }}"
+            default_branch="${{ github.event.pull_request.head.repo.default_branch }}"
+            tag="${{ github.event.pull_request.head.ref }}"
+          fi
+          echo "Branch: ${branch}"
+          echo "Clone URL: ${clone_url}"
+          echo "Tag: ${tag}"
+
+          export BRANCH=${branch}
+          export BUILD_VERSION=${build_version}
+          export CLONE_URL=${clone_url}
+          export COMMIT=${commit}
+          export TAG=${tag}
+
+          mkdir -p build
+          cmake \
+            -B build \
+            -S . \
+            -DGITHUB_DEFAULT_BRANCH="${default_branch}" \
+            -DSUNSHINE_CONFIGURE_HOMEBREW=ON \
+            -DSUNSHINE_CONFIGURE_ONLY=ON
+
+          # copy formula to artifacts
+          mkdir -p homebrew
+          cp -f ./build/sunshine.rb ./homebrew/sunshine.rb
+
+          # testing
+          cat ./homebrew/sunshine.rb
+
+      - name: Upload Artifacts
+        if: matrix.release
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-Homebrew
+          path: homebrew/
+          if-no-files-found: error
+
+      - name: Setup Xvfb
+        if: matrix.release != true && runner.os == 'Linux'
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y \
+            xvfb
+
+          export DISPLAY=:1
+          Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+
+          echo "DISPLAY=${DISPLAY}" >> $GITHUB_ENV
+
+      - name: Validate Homebrew Formula
+        id: test
+        if: matrix.release != true
+        uses: LizardByte/actions/actions/release_homebrew@v2025.715.25226
+        with:
+          formula_file: ${{ github.workspace }}/homebrew/sunshine.rb
+          git_email: ${{ secrets.GIT_EMAIL }}
+          git_username: ${{ secrets.GIT_USERNAME }}
+          publish: false
+          token: ${{ secrets.GH_TOKEN }}
+          validate: true
+
+      - name: Setup python
+        id: python
+        if: false
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Generate gcov report
+        id: test_report
+        # any except canceled or skipped
+        # TODO: fix coverage, no .gcno files are being created
+        # TODO: .gcno files are supposed to be created next to .o files
+        if: false
+        # if: >-
+        #   always() &&
+        #   matrix.release != true &&
+        #   (steps.test.outcome == 'success' || steps.test.outcome == 'failure')
+        run: |
+          cp -rf ${{ steps.test.outputs.buildpath }}/build/ ./build/
+          cd build
+          ls -Ra
+
+          ${{ steps.python.outputs.python-path }} -m pip install gcovr
+          ${{ steps.python.outputs.python-path }} -m gcovr . -r ../src \
+            --exclude-noncode-lines \
+            --exclude-throw-branches \
+            --exclude-unreachable-branches \
+            --verbose \
+            --xml-pretty \
+            -o coverage.xml
+
+      - name: Upload coverage artifact
+        if: >-
+          always() &&
+          matrix.release != true &&
+          (steps.test.outcome == 'success' || steps.test.outcome == 'failure') &&
+          startsWith(github.repository, 'LizardByte/')
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-Homebrew-${{ matrix.os_name }}-${{ matrix.os_version }}
+          path: |
+            build/coverage.xml
+            ${{ steps.test.outputs.testpath }}/test_results.xml
+          if-no-files-found: error
+
+      - name: Patch homebrew formula
+        # create beta version of the formula
+        # don't run this on macOS, as the sed command fails
+        if: matrix.release
+        run: |
+          # variables
+          formula_file="homebrew/sunshine-beta.rb"
+
+          # rename the file
+          mv homebrew/sunshine.rb $formula_file
+
+          # update the formula
+          sed -i 's/class Sunshine < Formula/class SunshineBeta < Formula/' $formula_file
+          sed -i 's/# conflicts_with/conflicts_with/' $formula_file
+
+          # print new file
+          echo "New formula:"
+          cat $formula_file
+
+      - name: Upload Artifacts (Beta)
+        if: matrix.release
+        uses: actions/upload-artifact@v4
+        with:
+          name: beta-Homebrew
+          path: homebrew/
+          if-no-files-found: error

.github/workflows/ci-linux.yml

@@ -0,0 +1,216 @@
+---
+name: CI-Linux
+permissions:
+  contents: read
+
+on:
+  workflow_call:
+    inputs:
+      release_commit:
+        required: true
+        type: string
+      release_version:
+        required: true
+        type: string
+
+jobs:
+  build_linux:
+    name: ${{ matrix.name }}
+    env:
+      APP_ID: dev.lizardbyte.app.Sunshine
+    runs-on: ubuntu-${{ matrix.dist }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: AppImage
+            EXTRA_ARGS: '--appimage-build'
+            dist: 22.04
+    steps:
+      - name: Maximize build space
+        uses: easimon/maximize-build-space@v10
+        with:
+          root-reserve-mb: 30720
+          remove-dotnet: 'true'
+          remove-android: 'true'
+          remove-haskell: 'true'
+          remove-codeql: 'true'
+          remove-docker-images: 'true'
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Dependencies Linux
+        timeout-minutes: 5
+        run: |
+          # create the artifacts directory
+          mkdir -p artifacts
+
+          # allow libfuse2 for appimage on 22.04+
+          sudo add-apt-repository universe
+
+          sudo apt-get install -y \
+            libdrm-dev \
+            libfuse2 \
+            libgl-dev \
+            libwayland-dev \
+            libx11-xcb-dev \
+            libxcb-dri3-dev \
+            libxfixes-dev
+
+      - name: Setup python
+        id: python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Build latest libva
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        timeout-minutes: 5
+        run: |
+          gh release download --archive=tar.gz --repo=intel/libva
+          tar xzf libva-*.tar.gz && rm libva-*.tar.gz
+          cd libva-*
+          ./autogen.sh --prefix=/usr --libdir=/usr/lib/x86_64-linux-gnu \
+            --enable-drm \
+            --enable-x11 \
+            --enable-glx \
+            --enable-wayland \
+            --without-legacy  # emgd, nvctrl, fglrx
+          make -j $(nproc)
+          sudo make install
+          cd .. && rm -rf libva-*
+
+      - name: Build Linux
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ inputs.release_version }}
+          COMMIT: ${{ inputs.release_commit }}
+        run: |
+          chmod +x ./scripts/linux_build.sh
+          ./scripts/linux_build.sh \
+            --publisher-name='${{ github.repository_owner }}' \
+            --publisher-website='https://app.lizardbyte.dev' \
+            --publisher-issue-url='https://app.lizardbyte.dev/support' \
+            --skip-cleanup \
+            --skip-package \
+            --ubuntu-test-repo ${{ matrix.EXTRA_ARGS }}
+
+      - name: Set AppImage Version
+        if: matrix.name == 'AppImage'
+        run: |
+          version=${{ inputs.release_version }}
+          echo "VERSION=${version}" >> $GITHUB_ENV
+
+      - name: Package Linux - AppImage
+        if: matrix.name == 'AppImage'
+        working-directory: build
+        run: |
+          # install sunshine to the DESTDIR
+          DESTDIR=AppDir ninja install
+
+          # custom AppRun file
+          cp -f ../packaging/linux/AppImage/AppRun ./AppDir/
+          chmod +x ./AppDir/AppRun
+
+          # variables
+          DESKTOP_FILE="${DESKTOP_FILE:-${APP_ID}.desktop}"
+          ICON_FILE="${ICON_FILE:-sunshine.png}"
+
+          # AppImage
+          # https://docs.appimage.org/packaging-guide/index.html
+          wget -q 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 -q 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" \
+            --output appimage
+
+          # move
+          mv Sunshine*.AppImage ../artifacts/sunshine.AppImage
+
+          # permissions
+          chmod +x ../artifacts/sunshine.AppImage
+
+      - name: Delete CUDA
+        # free up space on the runner
+        run: |
+          rm -rf ./build/cuda
+
+      - name: Verify AppImage
+        if: matrix.name == 'AppImage'
+        run: |
+          wget https://github.com/TheAssassin/appimagelint/releases/download/continuous/appimagelint-x86_64.AppImage
+          chmod +x appimagelint-x86_64.AppImage
+
+          ./appimagelint-x86_64.AppImage ./artifacts/sunshine.AppImage
+
+      - name: Install test deps
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y \
+            x11-xserver-utils \
+            xvfb
+
+          # clean apt cache
+          sudo apt-get clean
+          sudo rm -rf /var/lib/apt/lists/*
+
+      - name: Run tests
+        id: test
+        working-directory: build/tests
+        run: |
+          export DISPLAY=:1
+          Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+          sleep 5  # give Xvfb time to start
+
+          ./test_sunshine --gtest_color=yes --gtest_output=xml:test_results.xml
+
+      - name: Generate gcov report
+        id: test_report
+        # any except canceled or skipped
+        if: >-
+          always() &&
+          (steps.test.outcome == 'success' || steps.test.outcome == 'failure')
+        working-directory: build
+        run: |
+          ${{ steps.python.outputs.python-path }} -m pip install gcovr
+          ${{ steps.python.outputs.python-path }} -m gcovr . -r ../src \
+            --exclude-noncode-lines \
+            --exclude-throw-branches \
+            --exclude-unreachable-branches \
+            --verbose \
+            --xml-pretty \
+            -o coverage.xml
+
+      - name: Upload coverage artifact
+        if: >-
+          always() &&
+          (steps.test_report.outcome == 'success')
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-Linux-${{ matrix.name }}
+          path: |
+            build/coverage.xml
+            build/tests/test_results.xml
+          if-no-files-found: error
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-Linux-${{ matrix.name }}
+          path: artifacts/
+          if-no-files-found: error

.github/workflows/ci-windows.yml

@@ -0,0 +1,345 @@
+---
+name: CI-Windows
+permissions:
+  contents: read
+
+on:
+  workflow_call:
+    inputs:
+      release_commit:
+        required: true
+        type: string
+      release_version:
+        required: true
+        type: string
+    secrets:
+      CODECOV_TOKEN:
+        required: false
+
+jobs:
+  build_windows:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: msys2 {0}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Windows-AMD64
+            os: windows-2022
+            arch: x86_64
+            msystem: ucrt64
+            toolchain: ucrt-x86_64
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Prepare tests
+        id: prepare-tests
+        if: false  # todo: DirectX11 is not available, so even software encoder fails
+        shell: pwsh
+        run: |
+          # function to download and extract a zip file
+          function DownloadAndExtract {
+            param (
+              [string]$Uri,
+              [string]$OutFile
+            )
+
+            $maxRetries = 5
+            $retryCount = 0
+            $success = $false
+
+            while (-not $success -and $retryCount -lt $maxRetries) {
+              $retryCount++
+              Write-Host "Downloading $Uri to $OutFile, attempt $retryCount of $maxRetries"
+              try {
+                Invoke-WebRequest -Uri $Uri -OutFile $OutFile
+                $success = $true
+              } catch {
+                Write-Host "Attempt $retryCount of $maxRetries failed with error: $($_.Exception.Message). Retrying..."
+                Start-Sleep -Seconds 5
+              }
+            }
+
+            if (-not $success) {
+              Write-Host "Failed to download the file after $maxRetries attempts."
+              exit 1
+            }
+
+            # use .NET to get the base name of the file
+            $baseName = (Get-Item $OutFile).BaseName
+
+            # Extract the zip file
+            Expand-Archive -Path $OutFile -DestinationPath $baseName
+          }
+
+          # virtual display driver
+          DownloadAndExtract `
+            -Uri "https://www.amyuni.com/downloads/usbmmidd_v2.zip" `
+            -OutFile "usbmmidd_v2.zip"
+
+          # install
+          Set-Location -Path usbmmidd_v2/usbmmidd_v2
+          ./deviceinstaller64 install usbmmidd.inf usbmmidd
+
+          # create the virtual display
+          ./deviceinstaller64 enableidd 1
+
+          # move up a directory
+          Set-Location -Path ../..
+
+          # install devcon
+          DownloadAndExtract `
+            -Uri "https://github.com/Drawbackz/DevCon-Installer/releases/download/1.4-rc/Devcon.Installer.zip" `
+            -OutFile "Devcon.Installer.zip"
+          Set-Location -Path Devcon.Installer
+          # hash needs to match OS version
+          # https://github.com/Drawbackz/DevCon-Installer/blob/master/devcon_sources.json
+          Start-Process -FilePath "./Devcon Installer.exe" -Wait -ArgumentList `
+            'install', `
+            '-hash', '54004C83EE34F6A55380528A8B29F4C400E61FBB947A19E0AB9E5A193D7D961E', `
+            '-addpath', `
+            '-update', `
+            '-dir', 'C:\Windows\System32'
+
+          # disable Hyper-V Video
+          # https://stackoverflow.com/a/59490940
+          C:\Windows\System32\devcon.exe disable "VMBUS\{da0a7802-e377-4aac-8e77-0558eb1073f8}"
+
+          # move up a directory
+          Set-Location -Path ..
+
+          # multi monitor tool
+          DownloadAndExtract `
+            -Uri "http://www.nirsoft.net/utils/multimonitortool-x64.zip" `
+            -OutFile "multimonitortool.zip"
+
+          # enable the virtual display
+          # http://www.nirsoft.net/utils/multi_monitor_tool.html
+          Set-Location -Path multimonitortool
+
+          # Original Hyper-V is \\.\DISPLAY1, it will recreate itself as \\.\DISPLAY6 (or something higher than 2)
+          # USB Mobile Monitor Virtual Display is \\.\DISPLAY2
+
+          # these don't seem to work if not using runAs
+          # todo: do they work if not using runAs?
+          Start-Process powershell -Verb runAs -ArgumentList '-Command ./MultiMonitorTool.exe /enable \\.\DISPLAY2'
+          Start-Process powershell -Verb runAs -ArgumentList '-Command ./MultiMonitorTool.exe /SetPrimary \\.\DISPLAY2'
+
+          # wait a few seconds
+          Start-Sleep -s 5
+
+          # list monitors
+          ./MultiMonitorTool.exe /stext monitor_list.txt
+
+          # wait a few seconds
+          Start-Sleep -s 5
+
+          # print the monitor list
+          Get-Content -Path monitor_list.txt
+
+      - name: Setup Dependencies Windows
+        # if a dependency needs to be pinned, see https://github.com/LizardByte/build-deps/pull/186
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: ${{ matrix.msystem }}
+          update: true
+          install: >-
+            wget
+
+      - name: Update Windows dependencies
+        env:
+          MSYSTEM: ${{ matrix.msystem }}
+          TOOLCHAIN: ${{ matrix.toolchain }}
+        shell: msys2 {0}
+        run: |
+          # variables
+          declare -A pinned_deps
+
+          # dependencies
+          dependencies=(
+            "git"
+            "mingw-w64-${TOOLCHAIN}-cmake"
+            "mingw-w64-${TOOLCHAIN}-cppwinrt"
+            "mingw-w64-${TOOLCHAIN}-curl-winssl"
+            "mingw-w64-${TOOLCHAIN}-gcc"
+            "mingw-w64-${TOOLCHAIN}-graphviz"
+            "mingw-w64-${TOOLCHAIN}-MinHook"
+            "mingw-w64-${TOOLCHAIN}-miniupnpc"
+            "mingw-w64-${TOOLCHAIN}-nlohmann-json"
+            "mingw-w64-${TOOLCHAIN}-nodejs"
+            "mingw-w64-${TOOLCHAIN}-nsis"
+            "mingw-w64-${TOOLCHAIN}-onevpl"
+            "mingw-w64-${TOOLCHAIN}-openssl"
+            "mingw-w64-${TOOLCHAIN}-opus"
+            "mingw-w64-${TOOLCHAIN}-toolchain"
+          )
+
+          # do not modify below this line
+
+          ignore_packages=()
+          tarballs=""
+          for pkg in "${!pinned_deps[@]}"; do
+            ignore_packages+=("${pkg}")
+            version="${pinned_deps[$pkg]}"
+            tarball="${pkg}-${version}-any.pkg.tar.zst"
+
+            # download working version
+            wget "https://repo.msys2.org/mingw/${MSYSTEM}/${tarball}"
+
+            tarballs="${tarballs} ${tarball}"
+          done
+
+          # Create the ignore string for pacman
+          ignore_list=$(IFS=,; echo "${ignore_packages[*]}")
+
+          # install pinned dependencies
+          if [ -n "$tarballs" ]; then
+            pacman -U --noconfirm ${tarballs}
+          fi
+
+          # Only add --ignore if we have packages to ignore
+          if [ -n "$ignore_list" ]; then
+            pacman -Syu --noconfirm --ignore="${ignore_list}" "${dependencies[@]}"
+          else
+            pacman -Syu --noconfirm "${dependencies[@]}"
+          fi
+
+      - name: Install Doxygen
+        # GCC compiled doxygen has issues when running graphviz
+        env:
+          DOXYGEN_VERSION: "1.11.0"
+        shell: pwsh
+        run: |
+          # Set version variables
+          $doxy_ver = $env:DOXYGEN_VERSION
+          $_doxy_ver = $doxy_ver.Replace(".", "_")
+
+          # Download the Doxygen installer
+          Invoke-WebRequest -Uri `
+            "https://github.com/doxygen/doxygen/releases/download/Release_${_doxy_ver}/doxygen-${doxy_ver}-setup.exe" `
+            -OutFile "doxygen-setup.exe"
+
+          # Run the installer
+          Start-Process `
+            -FilePath .\doxygen-setup.exe `
+            -ArgumentList `
+              '/VERYSILENT' `
+          -Wait `
+          -NoNewWindow
+
+          # Clean up
+          Remove-Item -Path doxygen-setup.exe
+
+      - name: Setup python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Python Path
+        id: python-path
+        shell: msys2 {0}
+        run: |
+          # replace backslashes with double backslashes
+          python_path=$(echo "${{ steps.setup-python.outputs.python-path }}" | sed 's/\\/\\\\/g')
+
+          # step output
+          echo "python-path=${python_path}"
+          echo "python-path=${python_path}" >> $GITHUB_OUTPUT
+
+      - name: Build Windows
+        shell: msys2 {0}
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ inputs.release_version }}
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          COMMIT: ${{ inputs.release_commit }}
+        run: |
+          mkdir -p build
+          cmake \
+            -B build \
+            -G Ninja \
+            -S . \
+            -DBUILD_WERROR=ON \
+            -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+            -DSUNSHINE_ASSETS_DIR=assets \
+            -DSUNSHINE_PUBLISHER_NAME='${{ github.repository_owner }}' \
+            -DSUNSHINE_PUBLISHER_WEBSITE='https://app.lizardbyte.dev' \
+            -DSUNSHINE_PUBLISHER_ISSUE_URL='https://app.lizardbyte.dev/support'
+          ninja -C build
+
+      - name: Package Windows
+        shell: msys2 {0}
+        run: |
+          mkdir -p artifacts
+          cd build
+
+          # package
+          cpack -G NSIS
+          cpack -G ZIP
+
+          # move
+          mv ./cpack_artifacts/Sunshine.exe ../artifacts/Sunshine-${{ matrix.name }}-installer.exe
+          mv ./cpack_artifacts/Sunshine.zip ../artifacts/Sunshine-${{ matrix.name }}-portable.zip
+
+      - name: Run tests
+        id: test
+        shell: msys2 {0}
+        working-directory: build/tests
+        run: |
+          ./test_sunshine.exe --gtest_color=yes --gtest_output=xml:test_results.xml
+
+      - name: Generate gcov report
+        id: test_report
+        # any except canceled or skipped
+        if: always() && (steps.test.outcome == 'success' || steps.test.outcome == 'failure')
+        shell: msys2 {0}
+        working-directory: build
+        run: |
+          ${{ steps.python-path.outputs.python-path }} -m pip install gcovr
+          ${{ steps.python-path.outputs.python-path }} -m gcovr . -r ../src \
+            --exclude-noncode-lines \
+            --exclude-throw-branches \
+            --exclude-unreachable-branches \
+            --verbose \
+            --xml-pretty \
+            -o coverage.xml
+
+      - name: Upload coverage artifact
+        if: >-
+          always() &&
+          (steps.test_report.outcome == 'success')
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.name }}
+          path: |
+            build/coverage.xml
+            build/tests/test_results.xml
+          if-no-files-found: error
+
+      - name: Package Windows Debug Info
+        shell: pwsh
+        working-directory: build
+        run: |
+          # use .dbg file extension for binaries to avoid confusion with real packages
+          Get-ChildItem -File -Recurse | `
+            % { Rename-Item -Path $_.PSPath -NewName $_.Name.Replace(".exe",".dbg") }
+
+          # save the binaries with debug info
+          7z -r `
+            "-xr!CMakeFiles" `
+            "-xr!cpack_artifacts" `
+            a "../artifacts/Sunshine-${{ matrix.name }}-debuginfo.7z" "*.dbg"
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-${{ matrix.name }}
+          path: artifacts/
+          if-no-files-found: error

.github/workflows/ci.yml

@@ -0,0 +1,241 @@
+---
+name: CI
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    branches:
+      - master
+    types:
+      - opened
+      - synchronize
+      - reopened
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  github-env:
+    name: GitHub Env Debug
+    uses: LizardByte/.github/.github/workflows/__call-github-env.yml@master
+
+  release-setup:
+    name: Release Setup
+    outputs:
+      publish_release: ${{ steps.release-setup.outputs.publish_release }}
+      release_body: ${{ steps.release-setup.outputs.release_body }}
+      release_commit: ${{ steps.release-setup.outputs.release_commit }}
+      release_generate_release_notes: ${{ steps.release-setup.outputs.release_generate_release_notes }}
+      release_tag: ${{ steps.release-setup.outputs.release_tag }}
+      release_version: ${{ steps.release-setup.outputs.release_version }}
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Release Setup
+        id: release-setup
+        uses: LizardByte/actions/actions/release_setup@v2025.715.25226
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+  build-docker:
+    name: Docker
+    needs: release-setup
+    permissions:
+      contents: read
+      packages: write
+    uses: LizardByte/.github/.github/workflows/__call-docker.yml@master
+    with:
+      maximize_build_space: true
+      publish_release: ${{ needs.release-setup.outputs.publish_release }}
+      release_commit: ${{ needs.release-setup.outputs.release_commit }}
+      release_tag: ${{ needs.release-setup.outputs.release_tag }}
+      release_version: ${{ needs.release-setup.outputs.release_version }}
+    secrets:
+      DOCKER_HUB_USERNAME: ${{ secrets.DOCKER_HUB_USERNAME }}
+      DOCKER_HUB_PASSWORD: ${{ secrets.DOCKER_HUB_PASSWORD }}
+      DOCKER_HUB_ACCESS_TOKEN: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+      GH_BOT_NAME: ${{ secrets.GH_BOT_NAME }}
+      GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  build-homebrew:
+    name: Homebrew
+    needs: release-setup
+    uses: ./.github/workflows/ci-homebrew.yml
+    with:
+      publish_release: ${{ needs.release-setup.outputs.publish_release }}
+      release_commit: ${{ needs.release-setup.outputs.release_commit }}
+      release_tag: ${{ needs.release-setup.outputs.release_tag }}
+      release_version: ${{ needs.release-setup.outputs.release_version }}
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
+      GIT_EMAIL: ${{ secrets.GH_BOT_EMAIL }}
+      GIT_USERNAME: ${{ secrets.GH_BOT_NAME }}
+
+  build-linux:
+    name: Linux
+    needs: release-setup
+    uses: ./.github/workflows/ci-linux.yml
+    with:
+      release_commit: ${{ needs.release-setup.outputs.release_commit }}
+      release_version: ${{ needs.release-setup.outputs.release_version }}
+
+  build-linux-copr:
+    name: Linux Copr
+    if: github.event_name != 'push'  # releases are handled directly in ci-copr.yml
+    needs: release-setup
+    uses: ./.github/workflows/ci-copr.yml
+    secrets:
+      COPR_BETA_WEBHOOK_TOKEN: ${{ secrets.COPR_BETA_WEBHOOK_TOKEN }}
+      COPR_STABLE_WEBHOOK_TOKEN: ${{ secrets.COPR_STABLE_WEBHOOK_TOKEN }}
+      COPR_CLI_CONFIG: ${{ secrets.COPR_CLI_CONFIG }}
+
+  build-linux-flatpak:
+    name: Linux Flatpak
+    needs: release-setup
+    uses: ./.github/workflows/ci-flatpak.yml
+    with:
+      release_commit: ${{ needs.release-setup.outputs.release_commit }}
+      release_version: ${{ needs.release-setup.outputs.release_version }}
+
+  build-windows:
+    name: Windows
+    needs: release-setup
+    uses: ./.github/workflows/ci-windows.yml
+    with:
+      release_commit: ${{ needs.release-setup.outputs.release_commit }}
+      release_version: ${{ needs.release-setup.outputs.release_version }}
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  coverage:
+    name: Coverage-${{ matrix.name }}
+    if: >-
+      always() &&
+      !cancelled() &&
+      startsWith(github.repository, 'LizardByte/')
+    needs:
+      - build-linux
+      - build-linux-flatpak
+      - build-homebrew
+      - build-windows
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Linux-AppImage
+            coverage: true
+          - name: Homebrew-macos-13
+            coverage: false
+          - name: Homebrew-macos-14
+            coverage: false
+          - name: Homebrew-macos-15
+            coverage: false
+          - name: Homebrew-ubuntu-latest
+            coverage: false
+          - name: Windows-AMD64
+            coverage: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download coverage artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-${{ matrix.name }}
+          path: _coverage
+
+      - name: Upload test results
+        uses: codecov/test-results-action@v1
+        with:
+          disable_search: true
+          fail_ci_if_error: true
+          files: ./_coverage/tests/test_results.xml
+          flags: ${{ matrix.name }}
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5
+        if: matrix.coverage != false
+        with:
+          disable_search: true
+          fail_ci_if_error: true
+          files: ./_coverage/coverage.xml
+          flags: ${{ matrix.name }}
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+
+  release:
+    name: Release
+    if:
+      needs.release-setup.outputs.publish_release == 'true' &&
+      startsWith(github.repository, 'LizardByte/')
+    needs:
+      - release-setup
+      - build-docker
+      - build-linux
+      - build-linux-flatpak
+      - build-homebrew
+      - build-windows
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+          pattern: build-*
+          merge-multiple: true
+
+      - name: Debug artifacts
+        run: ls -l artifacts
+
+      - name: Create/Update GitHub Release
+        uses: LizardByte/actions/actions/release_create@v2025.715.25226
+        with:
+          allowUpdates: false
+          body: ${{ needs.release-setup.outputs.release_body }}
+          generateReleaseNotes: ${{ needs.release-setup.outputs.release_generate_release_notes }}
+          name: ${{ needs.release-setup.outputs.release_tag }}
+          prerelease: true
+          tag: ${{ needs.release-setup.outputs.release_tag }}
+          token: ${{ secrets.GH_BOT_TOKEN }}
+          virustotal_api_key: ${{ secrets.VIRUSTOTAL_API_KEY }}
+
+  release-homebrew-beta:
+    name: Release Homebrew Beta
+    if:
+      needs.release-setup.outputs.publish_release == 'true' &&
+      startsWith(github.repository, 'LizardByte/')
+    needs:
+      - release-setup
+      - build-homebrew
+      - release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download homebrew artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: beta-Homebrew
+          path: homebrew
+
+      - name: Upload Homebrew Beta Formula
+        uses: LizardByte/actions/actions/release_homebrew@v2025.715.25226
+        with:
+          formula_file: ${{ github.workspace }}/homebrew/sunshine-beta.rb
+          git_email: ${{ secrets.GH_BOT_EMAIL }}
+          git_username: ${{ secrets.GH_BOT_NAME }}
+          publish: true
+          token: ${{ secrets.GH_BOT_TOKEN }}
+          validate: false

.github/workflows/codeql.yml

@@ -1,147 +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 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@v7
-        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@v7
-        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@v3
-        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@v3
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
-        with:
-          category: "/language:${{matrix.language}}"

.github/workflows/cpp-lint.yml

@@ -1,120 +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.
-
-# 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@v4
-        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@v5
-        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/issues-stale.yml

@@ -1,61 +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.
-
-# Manage stale issues and PRs.
-
-name: Stale Issues / PRs
-
-on:
-  schedule:
-    - 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@v9
-        with:
-          close-issue-message: >
-            This issue was closed because it has been stalled for 10 days with no activity.
-          close-pr-message: >
-            This PR was closed because it has been stalled for 10 days with no activity.
-          days-before-stale: 90
-          days-before-close: 10
-          exempt-all-assignees: true
-          exempt-issue-labels: 'added,fixed'
-          exempt-pr-labels: 'dependencies,l10n'
-          stale-issue-label: 'stale'
-          stale-issue-message: >
-            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: >
-            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@v9
-        with:
-          close-issue-message: >
-            This issue was closed because the the template was not completed after 5 days.
-          close-pr-message: >
-            This PR was closed because the the template was not completed after 5 days.
-          days-before-stale: 0
-          days-before-close: 5
-          only-labels: 'invalid:template-incomplete'
-          stale-issue-label: 'invalid:template-incomplete'
-          stale-issue-message: >
-            Invalid issues template.
-          stale-pr-label: 'invalid:template-incomplete'
-          stale-pr-message: >
-            Invalid PR template.
-          repo-token: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/issues.yml

@@ -1,25 +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.
-
-# Label and un-label actions using `../label-actions.yml`.
-
-name: Issues
-
-on:
-  issues:
-    types: [labeled, unlabeled]
-  discussion:
-    types: [labeled, unlabeled]
-
-jobs:
-  label:
-    name: Label Actions
-    if: startsWith(github.repository, 'LizardByte/')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Label Actions
-        uses: dessant/label-actions@v4
-        with:
-          github-token: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/localize.yml

@@ -1,10 +1,13 @@
 ---
 name: localize
+permissions:
+  contents: read
 
 on:
   push:
-    branches: [nightly]
-    paths:  # prevents workflow from running unless these files change
+    branches:
+      - master
+    paths:
       - '.github/workflows/localize.yml'
       - 'src/**'
       - 'locale/sunshine.po'
@@ -54,7 +57,7 @@ jobs:
           python ./scripts/_locale.py --extract
 
       - name: git diff
-        if: ${{ env.new_file == 'false' }}
+        if: env.new_file == 'false'
         run: |
           # disable the pager
           git config --global pager.diff false
@@ -68,7 +71,9 @@ jobs:
 
       - name: git reset
         # only run if a single line changed (date/time) and file already existed
-        if: ${{ env.git_diff == '1 1 locale/sunshine.po' && env.new_file == 'false' }}
+        if: >-
+          env.git_diff == '1 1 locale/sunshine.po' &&
+          env.new_file == 'false'
         run: |
           git reset --hard
 
@@ -77,16 +82,16 @@ jobs:
         run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
 
       - name: Create/Update Pull Request
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           add-paths: |
             locale/*.po
           token: ${{ secrets.GH_BOT_TOKEN }}  # must trigger PR tests
-          commit-message: New localization template
+          commit-message: "chore(l10n): new babel updates"
           branch: localize/update
           delete-branch: true
-          base: nightly
-          title: New Babel Updates
+          base: master
+          title: "chore(l10n): new babel updates"
           body: |
             Update report
             - Updated ${{ steps.date.outputs.date }}

.github/workflows/python-flake8.yml

@@ -1,38 +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.
-
-# Lint python files with flake8.
-
-name: flake8
-
-on:
-  pull_request:
-    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@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5  # https://github.com/actions/setup-python
-        with:
-          python-version: '3.10'
-
-      - name: Install dependencies
-        run: |
-          # 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: |
-          python -m flake8 --verbose

.github/workflows/release-notifier-moonlight.yml

@@ -1,22 +1,38 @@
 ---
 name: Release Notifications (Moonlight)
+permissions: {}
 
 on:
   release:
-    types: [published]
+    types:
+      - released  # this triggers when a release is published, but does not include prereleases or drafts
 
 jobs:
   discord:
+    if: github.repository_owner == 'LizardByte'
     runs-on: ubuntu-latest
     steps:
-      - name: discord
-        uses: sarisia/actions-status-discord@v1  # https://github.com/sarisia/actions-status-discord
+      - name: Check if latest GitHub release
+        id: check-release
+        uses: actions/github-script@v7
         with:
-          webhook: ${{ secrets.DISCORD_RELEASE_WEBHOOK_MOONLIGHT }}
+          script: |
+            const latestRelease = await github.rest.repos.getLatestRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo
+            });
+
+            core.setOutput('isLatestRelease', latestRelease.data.tag_name === context.payload.release.tag_name);
+
+      - name: discord
+        if: steps.check-release.outputs.isLatestRelease == 'true'
+        uses: sarisia/actions-status-discord@v1
+        with:
+          avatar_url: ${{ vars.ORG_LOGO_URL }}256
+          color: 0x${{ vars.COLOR_HEX_GREEN }}
+          description: ${{ github.event.release.body }}
           nodetail: true
           nofail: false
-          username: ${{ secrets.DISCORD_USERNAME }}
-          avatar_url: ${{ secrets.ORG_LOGO_URL }}
           title: ${{ github.event.repository.name }} ${{ github.ref_name }} Released
-          description: ${{ github.event.release.body }}
-          color: 0xFF4500
+          username: ${{ secrets.DISCORD_USERNAME }}
+          webhook: ${{ secrets.DISCORD_RELEASE_WEBHOOK_MOONLIGHT }}

.github/workflows/release-notifier.yml

@@ -1,103 +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.
-
-# Send release notification to various platforms.
-
-name: Release Notifications
-
-on:
-  release:
-    types: [published]
-    # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onevent_nametypes
-
-jobs:
-  discord:
-    if: >-
-      startsWith(github.repository, 'LizardByte/') &&
-      not(github.event.release.prerelease) &&
-      not(github.event.release.draft)
-    runs-on: ubuntu-latest
-    steps:
-      - name: discord
-        uses: sarisia/actions-status-discord@v1
-        with:
-          webhook: ${{ secrets.DISCORD_RELEASE_WEBHOOK }}
-          nodetail: true
-          nofail: false
-          username: ${{ secrets.DISCORD_USERNAME }}
-          avatar_url: ${{ secrets.ORG_LOGO_URL }}
-          title: ${{ github.event.repository.name }} ${{ github.ref_name }} Released
-          description: ${{ github.event.release.body }}
-          color: 0xFF4500
-
-  facebook_group:
-    if: >-
-      startsWith(github.repository, 'LizardByte/') &&
-      not(github.event.release.prerelease) &&
-      not(github.event.release.draft)
-    runs-on: ubuntu-latest
-    steps:
-      - name: facebook-post-action
-        uses: ReenigneArcher/facebook-post-action@v1
-        with:
-          page_id: ${{ secrets.FACEBOOK_GROUP_ID }}
-          access_token: ${{ secrets.FACEBOOK_ACCESS_TOKEN }}
-          message: |
-            ${{ github.event.repository.name }} ${{ github.ref_name }} Released
-            ${{ github.event.release.body }}
-          url: ${{ github.event.release.html_url }}
-
-  facebook_page:
-    if: >-
-      startsWith(github.repository, 'LizardByte/') &&
-      not(github.event.release.prerelease) &&
-      not(github.event.release.draft)
-    runs-on: ubuntu-latest
-    steps:
-      - name: facebook-post-action
-        uses: ReenigneArcher/facebook-post-action@v1
-        with:
-          page_id: ${{ secrets.FACEBOOK_PAGE_ID }}
-          access_token: ${{ secrets.FACEBOOK_ACCESS_TOKEN }}
-          message: |
-            ${{ github.event.repository.name }} ${{ github.ref_name }} Released
-            ${{ github.event.release.body }}
-          url: ${{ github.event.release.html_url }}
-
-  reddit:
-    if: >-
-      startsWith(github.repository, 'LizardByte/') &&
-      not(github.event.release.prerelease) &&
-      not(github.event.release.draft)
-    runs-on: ubuntu-latest
-    steps:
-      - name: reddit
-        uses: bluwy/release-for-reddit-action@v2
-        with:
-          username: ${{ secrets.REDDIT_USERNAME }}
-          password: ${{ secrets.REDDIT_PASSWORD }}
-          app-id: ${{ secrets.REDDIT_CLIENT_ID }}
-          app-secret: ${{ secrets.REDDIT_CLIENT_SECRET }}
-          subreddit: ${{ secrets.REDDIT_SUBREDDIT }}
-          title: ${{ github.event.repository.name }} ${{ github.ref_name }} Released
-          url: ${{ github.event.release.html_url }}
-          flair-id: ${{ secrets.REDDIT_FLAIR_ID }}  # https://www.reddit.com/r/<subreddit>>/api/link_flair.json
-          comment: ${{ github.event.release.body }}
-
-  twitter:
-    if: >-
-      startsWith(github.repository, 'LizardByte/') &&
-      not(github.event.release.prerelease) &&
-      not(github.event.release.draft)
-    runs-on: ubuntu-latest
-    steps:
-      - name: twitter
-        uses: nearform-actions/github-action-notify-twitter@v1
-        with:
-          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

@@ -1,62 +1,49 @@
 ---
 name: Build GH-Pages
+permissions:
+  contents: read
 
 on:
   pull_request:
-    branches: [master, nightly]
-    types: [opened, synchronize, reopened]
+    branches:
+      - master
+    types:
+      - opened
+      - synchronize
+      - reopened
   push:
-    branches: [master]
+    branches:
+      - master
   workflow_dispatch:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: "${{ github.workflow }}-${{ github.ref }}"
   cancel-in-progress: true
 
 jobs:
-  update_pages:
+  prep:
     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' }}
+      - name: Upload artifact
         uses: actions/upload-artifact@v4
         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: prep
+          path: gh-pages-template/
+          if-no-files-found: error
+          include-hidden-files: true
+          retention-days: 1
 
-      - 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 }}
+  call-jekyll-build:
+    needs: prep
+    uses: LizardByte/LizardByte.github.io/.github/workflows/jekyll-build.yml@master
+    secrets:
+      GH_BOT_EMAIL: ${{ secrets.GH_BOT_EMAIL }}
+      GH_BOT_NAME: ${{ secrets.GH_BOT_NAME }}
+      GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
+    with:
+      clean_gh_pages: true
+      site_artifact: 'prep'
+      target_branch: 'gh-pages'

.github/workflows/yaml-lint.yml

@@ -1,66 +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.
-
-# Lint yaml files.
-
-name: yaml lint
-
-on:
-  pull_request:
-    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@v4
-
-      - name: Find additional files
-        id: find-files
-        run: |
-          # space separated list of files
-          FILES=.clang-format
-
-          # empty placeholder
-          FOUND=""
-
-          for FILE in ${FILES}; do
-            if [ -f "$FILE" ]
-            then
-              FOUND="$FOUND $FILE"
-            fi
-          done
-
-          echo "found=${FOUND}" >> $GITHUB_OUTPUT
-
-      - name: yaml lint
-        id: yaml-lint
-        uses: ibiqlik/action-yamllint@v3
-        with:
-          # https://yamllint.readthedocs.io/en/stable/configuration.html#default-configuration
-          config_data: |
-            extends: default
-            rules:
-              comments:
-                level: error
-              line-length:
-                max: 120
-              truthy:
-                # GitHub uses "on" for workflow event triggers
-                # .clang-format file has options of "Yes" "No" that will be caught by this, so changed to "warning"
-                allowed-values: ['true', 'false', 'on']
-                check-keys: true
-                level: warning
-          file_or_dir: . ${{ steps.find-files.outputs.found }}
-
-      - name: Log
-        run: |
-          cat "${{ steps.yaml-lint.outputs.logfile }}" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -1,13 +1,46 @@
-build
-cmake-build*
-.DS_Store
-.vscode
-.vs
-*.swp
-*.kdev4
+# Prerequisites
+*.d
 
-.cache
-.idea
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# JetBrains IDE
+.idea/
+
+# VSCode IDE
+.vscode/
+
+# build directories
+build/
+cmake-*/
+docs/doxyconfig*
 
 # npm
 node_modules/
@@ -16,3 +49,10 @@ package-lock.json
 # Translations
 *.mo
 *.pot
+
+# Dummy macOS files
+.DS_Store
+
+# Python
+*.pyc
+venv/

.gitmodules

@@ -1,7 +1,31 @@
+[submodule "packaging/linux/flatpak/deps/flatpak-builder-tools"]
+	path = packaging/linux/flatpak/deps/flatpak-builder-tools
+	url = https://github.com/flatpak/flatpak-builder-tools.git
+	branch = master
+[submodule "packaging/linux/flatpak/deps/shared-modules"]
+	path = packaging/linux/flatpak/deps/shared-modules
+	url = https://github.com/flathub/shared-modules.git
+	branch = master
 [submodule "third-party/build-deps"]
 	path = third-party/build-deps
 	url = https://github.com/LizardByte/build-deps.git
 	branch = dist
+[submodule "third-party/doxyconfig"]
+	path = third-party/doxyconfig
+	url = https://github.com/LizardByte/doxyconfig.git
+	branch = master
+[submodule "third-party/googletest"]
+	path = third-party/googletest
+	url = https://github.com/google/googletest.git
+	branch = main
+[submodule "third-party/inputtino"]
+	path = third-party/inputtino
+	url = https://github.com/games-on-whales/inputtino.git
+	branch = stable
+[submodule "third-party/libdisplaydevice"]
+	path = third-party/libdisplaydevice
+	url = https://github.com/LizardByte/libdisplaydevice.git
+	branch = master
 [submodule "third-party/moonlight-common-c"]
 	path = third-party/moonlight-common-c
 	url = https://github.com/moonlight-stream/moonlight-common-c.git
@@ -12,23 +36,23 @@
 	branch = master
 [submodule "third-party/nv-codec-headers"]
 	path = third-party/nv-codec-headers
-	url = https://github.com/FFmpeg/nv-codec-headers
+	url = https://github.com/FFmpeg/nv-codec-headers.git
 	branch = sdk/12.0
 [submodule "third-party/nvapi-open-source-sdk"]
 	path = third-party/nvapi-open-source-sdk
-	url = https://github.com/LizardByte/nvapi-open-source-sdk
+	url = https://github.com/LizardByte/nvapi-open-source-sdk.git
 	branch = sdk
 [submodule "third-party/Simple-Web-Server"]
 	path = third-party/Simple-Web-Server
-	url = https://gitlab.com/eidheim/Simple-Web-Server.git
+	url = https://github.com/LizardByte-infrastructure/Simple-Web-Server.git
 	branch = master
 [submodule "third-party/TPCircularBuffer"]
 	path = third-party/TPCircularBuffer
-	url = https://github.com/michaeltyson/TPCircularBuffer
+	url = https://github.com/michaeltyson/TPCircularBuffer.git
 	branch = master
 [submodule "third-party/tray"]
 	path = third-party/tray
-	url = https://github.com/LizardByte/tray
+	url = https://github.com/LizardByte/tray.git
 	branch = master
 [submodule "third-party/ViGEmClient"]
 	path = third-party/ViGEmClient
@@ -36,9 +60,9 @@
 	branch = master
 [submodule "third-party/wayland-protocols"]
 	path = third-party/wayland-protocols
-	url = https://gitlab.freedesktop.org/wayland/wayland-protocols
+	url = https://github.com/LizardByte-infrastructure/wayland-protocols.git
 	branch = main
 [submodule "third-party/wlr-protocols"]
 	path = third-party/wlr-protocols
-	url = https://gitlab.freedesktop.org/wlroots/wlr-protocols
+	url = https://github.com/LizardByte-infrastructure/wlr-protocols.git
 	branch = master

.readthedocs.yaml

@@ -3,37 +3,28 @@
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
-# Required
 version: 2
 
-# Set the version of Python
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    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
+    python: "miniconda-latest"
+  commands:
+    - |
+      if [ -f readthedocs_build.sh ]; then
+        doxyconfig_dir="."
+      else
+        doxyconfig_dir="./third-party/doxyconfig"
+      fi
+      chmod +x "${doxyconfig_dir}/readthedocs_build.sh"
+      export DOXYCONFIG_DIR="${doxyconfig_dir}"
+      "${doxyconfig_dir}/readthedocs_build.sh"
+
+# using conda, we can get newer doxygen and graphviz than ubuntu provide
+# https://github.com/readthedocs/readthedocs.org/issues/8151#issuecomment-890359661
+conda:
+  environment: third-party/doxyconfig/environment.yml
 
-# submodules required for include statements
 submodules:
   include: all
   recursive: true
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  builder: html
-  configuration: docs/source/conf.py
-  fail_on_warning: true
-
-# Using Sphinx, build docs in additional formats
-formats: all
-
-python:
-  install:
-    - requirements: ./docs/requirements.txt

CHANGELOG.md

@@ -1,722 +0,0 @@
-# Changelog
-
-## [0.22.0] - 2024-03-03
-**Breaking**
-- (Network) Clients must now be paired with the host before they can use Wake-on-LAN
-- (Build/Linux) Drop Fedora 37 support
-
-**Added**
-- (Input/Linux) Add native/pen touch support for Linux
-- (Capture/Linux) Add HDR streaming support for Linux using KMS capture backend
-- (Capture/Linux) Add KMS capture support for Nvidia GPUs running Wayland
-- (Network) Add support for full E2E stream encryption, configurable for LAN and WAN independently
-- (Process) Add process group tracking to automatically handle launchers that spawn other child processes
-- (Capture/Windows) Add setting for controlling GPU power saving and encoding latency tradeoff for NVENC
-- (Capture/Windows) Add additional encoding settings for NVENC
-- (Process/Windows) Add experimental support for launching URLs and other non-exe files
-- (Capture/Windows) Add setting to allow use of slower HEVC encoding on older Intel GPUs
-- (Input/Windows) Add settings to control automatic gamepad type selection heuristics
-- (Input/Windows) Add setting to allow DS4 back/select button to trigger touchpad click
-- (Input) Add setting to disable high resolution scrolling and native pen/touch support
-- (Network) Add support for certificates types other than RSA-2048
-- (Build/Linux) Add Fedora 39 docker image and rpm package
-- (Capture/Linux) Display monitor indexes in logs for wlroots and KMS capture backends
-- (UI) Add link to logs inside fatal error container
-- (UI) Add hash handler and ids for all configuration categories and settings
-
-**Changed**
-- (UI) Several configuration options have been moved to more suitable locations
-- (Network) Client-selected bitrate is now adjusted for FEC percentage and other stream overhead
-- (Capture/Linux) Improve VAAPI encoding performance on Intel GPUs
-- (Capture) Connection establishment delay is reduced by eliminating many encoder probing operations
-- (Process) Graceful termination of running processes is attempted first when stopping apps
-- (Capture) Improve software encoding performance by enabling multi-threaded color conversion
-- (Capture) Adjust default CPU thread count for software encoding from 1 to 2 for improved performance
-- (Steam/Windows) Modernized the default Steam app shortcut to avoid depending on Steam's install location and support app termination
-- (Linux) Updated desktop files
-- (Config) Add 2560x1440 to default resolutions
-- (Network) Use the configured ping timeout for the initial launch event timeout
-- (UI) Migrate UI to Vite and Vue3, and various UX improvements
-- (Logging) Adjust wording and severity of some log messages
-- (Build) Use a single submodule for ffmpeg
-- (Install/Windows) Skip ViGEmBus installation if a supported version is already installed
-- (Build/Linux) Optionally, allow using the system installation of wayland-protocols
-- (Build/Linux) Make vaapi optional
-- (Windows) Replace boost::json with nlohmann/json
-
-**Fixed**
-- (Network/Windows) Fix auto-discovery of hosts by iOS/tvOS clients
-- (Network) Fix immediate connection termination when streaming over some Internet connections
-- (Capture/Linux) Fix missing mouse cursor when using KMS capture on a GPU with hardware cursor support
-- (Capture/Windows) Add workaround for Nvidia driver bug causing Sunshine to crash when RTX HDR is globally enabled
-- (Capture/Windows) Add workaround for AMD driver bug on pre-RDNA GPUs causing hardware encoding failure
-- (Capture/Windows) Reintroduce support for NVENC on older Nvidia GPU drivers (v456.71-v522.25)
-- (Capture/Windows) Fix encoding on old Intel GPUs that don't support low-power H.264 encoding
-- (Capture/Linux) Fix GL errors or corrupt video output on GPUs that use aux planes such as Intel Arc
-- (Capture/Linux) Fix GL errors or corrupt video output on GPUs that use DRM modifiers on YUV buffers
-- (Input/Windows) Fix non-functional duplicate controllers appearing in rare cases
-- (Input/Windows) Avoid triggering crash in ViGEmBus when the system goes to sleep
-- (Input/Linux) Fix scrolling in applications that don't support high-resolution scrolling
-- (Input/Linux) Fix absolute mouse input being interpreted as touch input
-- (Capture/Linux) Fix wlroots capture causing GL errors and crashes
-- (Capture/Linux) Fix wlroots capture failing when the display scale factor was not 1
-- (Capture/Linux) Fix excessive CPU usage when using wlroots capture backend
-- (Capture/Linux) Fix capture of virtual displays created by the amdgpu kernel driver
-- (Audio/Windows) Fix audio capture failures on Insider Preview versions of Windows 11
-- (Capture/Windows) Fix incorrect portrait mode rotation
-- (Capture/Windows) Fix capture recovery when a driver update/crash occurs while streaming
-- (Capture/Windows) Fix delay displaying UAC dialogs when the mouse cursor is not moving
-- (Capture/Linux) Fix corrupt video output or stream disconnections if the display resolution changes while streaming
-- (Capture/Linux) Fix color of aspect ratio padding in the capture image with VAAPI
-- (Capture/Linux) Fix NVENC initialization error when using X11 capture with some GPUs
-- (Tray/Linux) Fix random crash when the tray icon is updating
-- (Network) Fix QoS tagging when running in IPv4+IPv6 mode
-- (Process) Fix termination of child processes upon app quit when the parent has already terminated
-- (Process) Fix notification of graceful termination to connected clients when Sunshine quits
-- (Capture) Fix corrupt output or green aspect-ratio padding when using software encoding with some video resolutions
-- (Windows) Fix crashes when processing file paths or other strings with certain non-ASCII characters
-- (Capture) Ensure user supplied framerates are used exclusively in place of pre-defined framerates
-- (CMake/Linux) Skip including unnecessary headers
-- (Capture/Linux) Replace vaTerminate method with dl handle
-- (Capture/Linux) Fix capture when DRM is enabled and x11 is disabled
-- (Tray) Use PROJECT_NAME definition for tooltip
-- (CMake) Use GNUInstallDirs to install data and lib directories
-- (macOS) Replace deprecated code
-- (API) Allow trailing slashes in on API endpoints
-- (API) Add additional pin validation
-- (Linux) Use XDG spec for fetching config directory
-- (CMake) Properly find evdev
-- (Config) Properly save global_prep_cmd and fps settings
-
-**Dependencies**
-- Bump third-party/wayland-protocols from 681c33c to 46f201b
-- Bump third-party/nv-codec-headers from 9402b5a to 22441b5
-- Bump third-party/nanors from 395e5ad to e9e242e
-- Bump third-party/Simple-Web-Server from 2f29926 to 27b41f5
-- Bump ffmpeg
-- Bump third-party/tray from 2664388 to 2bf1c61
-- Bump actions/setup-python from 4 to 5
-- Bump actions/upload-artifact from 3 to 4
-- Bump @fortawesome/fontawesome-free from 6.4.2 to 6.5.1
-- Bump babel from 2.13.0 to 2.14.0
-- Move miniupnpc from submodule to system installed package
-- Bump furo from 2023.9.10 to 2024.1.29
-- Bump third-party/moonlight-common-c from f78f213 to cbd0ec1
-- Bump third-party/ViGEmClient from 1920260 to 8d71f67
-- Bump peter-evans/create-pull-request from 5 to 6
-- Bump bootstrap from 5.3.2 to 5.3.3
-
-**Misc**
-- (Build) Update global workflows
-- (Docs/Linux) Add example for setting custom resolution with NVIDIA
-- (Docs) Fix broken links
-- (Docs/Windows) Add information about disk permissions
-- (Docs) Fix failing images
-- (Docs) Use glob pattern to match source code docs
-- (CI/macOS) Install boost from source
-- (Docs) Add reset credentials examples for unique packages
-- (Docs) Refactor and general cleanup
-- (Docs) Cross-reference config settings to the UI
-- (Docs/Docker) Add podman notes
-- (Build) Use CMAKE_SOURCE_DIR property everywhere
-- (Build/Docker) Add docker toolchain file for CLion
-- (macOS) Various code style fixes
-- (Deps) Alphabetize git submodules
-- (Docs/Examples) Update URI examples
-- (Refactor) Refactored some code in preparation for unit testing implementation
-- (CMake) Add option to skip cuda inheriting compile options
-- (CMake) Add option to error build on warnings
-
-## [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**
-- (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**
-- (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**
-- (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
-- (Windows) Automatically delete start menu entry upon uninstall
-- (Windows) Automatically delete program install directory upon uninstall, with user prompt
-- (Linux) Handle the case of no default audio sink
-- (Windows/Linux/MacOS) Fix default image paths
-- (Linux) Fix CUDA RGBA to NV12 conversion
-
-## [0.14.1] - 2022-08-09
-**Added**
-- (Linux) Flatpak package added
-- (Linux) AUR package automated updates
-- (Windows) Winget package automated updates
-
-**Changed**
-- (General) Moved repo to @LizardByte GitHub org
-- (WebUI) Fixed button spacing on home page
-- (WebUI) Added Discord WidgetBot Crate
-
-**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**
-- (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
-- (Windows) Add DwmFlush() call  to improve capture
-- (Windows) Add Windows installer
-
-**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
-- (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)
-
-## [0.12.0] - 2022-02-13
-**Added**
-- New command line argument `--version`
-- Custom png poster support
-
-**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**
-- (Linux) Fix search path for config file and assets
-
-## [0.11.0] - 2021-10-04
-**Added**
-- (Linux) Added support for wlroots based compositors on Wayland.
-- (Windows) Added an icon for the executable
-
-**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**
-- (Linux) Re-enabled KMS
-
-## [0.10.0] - 2021-08-20
-**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**
-- 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
-- (Linux) VAAPI hardware encoding now works on Intel i7-6700 at least. <-- For the best experience, using ffmpeg version 4.3 or higher is recommended.
-- (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 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**
-- 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 mDNS support: Moonlight will automatically find Sunshine.
-- Added UPnP support. It's off by default.
-
-## [0.7.7] - 2021-06-24
-**Added**
-- (Linux) Added installation package for Debian
-
-**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**
-- (Linux) Fixed an issue where it was impossible to start sunshine on ubuntu 20.04
-
-## [0.7.0] - 2021-06-16
-**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**
-- (Linux) Moved certificates and saved pairings generated during runtime to .config/sunshine on Linux
-
-## [0.6.0] - 2021-05-26
-**Added**
-- Added support for surround audio
-
-**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 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**
-- prep-cmd is now optional in apps.json
-- Fixed bug causing video artifacts
-- Fixed bug preventing Moonlight from closing app on exit
-- Fixed bug causing preventing keyboard keys from repeating on latest version of Moonlight
-- Fixed bug causing segfault when another session of sunshine was already running
-- Fixed bug causing crash when monitor has resolution 1366x768
-
-## [0.3.1] - 2020-04-24
-**Changed**
-- Fix a memory leak.
-
-## [0.3.0] - 2020-04-23
-**Changed**
-- Hardware acceleration on NVidia GPU's for Video encoding on Windows
-
-## [0.2.0] - 2020-03-21
-**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**
-- (Linux) Added deb package and service for Linux
-
-## [0.1.0] - 2020-01-27
-**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
-[0.22.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.22.0

CMakeLists.txt

@@ -1,13 +1,18 @@
-cmake_minimum_required(VERSION 3.18)
+cmake_minimum_required(VERSION 3.20)
 # `CMAKE_CUDA_ARCHITECTURES` requires 3.18
+# `set_source_files_properties` requires 3.18
+# `cmake_path(CONVERT ... TO_NATIVE_PATH_LIST ...)` requires 3.20
 # todo - set this conditionally
 
-# todo - set version to 0.0.0 once confident in automated versioning
-project(Sunshine VERSION 0.22.0
-        DESCRIPTION "Sunshine is a self-hosted game stream host for Moonlight."
+project(Sunshine VERSION 0.0.0
+        DESCRIPTION "Self-hosted game stream host for Moonlight"
         HOMEPAGE_URL "https://app.lizardbyte.dev/Sunshine")
 
-set(PROJECT_LICENSE "GPL-3.0")
+set(PROJECT_LICENSE "GPL-3.0-only")
+
+set(PROJECT_FQDN "dev.lizardbyte.app.Sunshine")
+
+set(PROJECT_BRIEF_DESCRIPTION "GameStream host for Moonlight")  # must be <= 35 characters
 
 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 \
@@ -22,12 +27,18 @@ endif()
 # set the module path, used for includes
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
+# export compile_commands.json
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
 # set version info for this build
 include(${CMAKE_MODULE_PATH}/prep/build_version.cmake)
 
 # cmake build flags
 include(${CMAKE_MODULE_PATH}/prep/options.cmake)
 
+# initial prep
+include(${CMAKE_MODULE_PATH}/prep/init.cmake)
+
 # configure special package files, such as sunshine.desktop, Flatpak manifest, Portfile , etc.
 include(${CMAKE_MODULE_PATH}/prep/special_package_configuration.cmake)
 

DOCKER_README.md

@@ -19,22 +19,19 @@ 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`
+- `debian-bookworm`
 - `ubuntu-22.04`
+- `ubuntu-24.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`.
+`<SUNSHINE_VERSION>-<SUNSHINE_OS>`. For example, `latest-ubuntu-24.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.
@@ -55,6 +52,7 @@ docker run -d \
   --device /dev/dri/ \
   --name=<image_name> \
   --restart=unless-stopped \
+  --ipc=host \
   -e PUID=<uid> \
   -e PGID=<gid> \
   -e TZ=<timezone> \
@@ -81,6 +79,7 @@ services:
       - PUID=<uid>
       - PGID=<gid>
       - TZ=<timezone>
+    ipc: host
     ports:
       - "47984-47990:47984-47990/tcp"
       - "48010:48010"
@@ -126,6 +125,9 @@ port `47990` (e.g. `http://<host_ip>:47990`). The internal port must be `47990`,
 | `-e PGID=<gid>`             | Group ID             | `1001`             | False    |
 | `-e TZ=<timezone>`          | Lookup [TZ value][1] | `America/New_York` | False    |
 
+For additional configuration, it is recommended to reference the *Games on Whales*
+[sunshine config](https://github.com/games-on-whales/gow/blob/2e442292d79b9d996f886b8a03d22b6eb6bddf7b/compose/streamers/sunshine.yml).
+
 [1]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 
 #### User / Group Identifiers:
@@ -153,8 +155,18 @@ The architectures supported by these images are shown in the table below.
 |-----------------|--------------|---------------|
 | archlinux       | ✅            | ❌             |
 | debian-bookworm | ✅            | ✅             |
-| debian-bullseye | ✅            | ✅             |
-| fedora-38       | ✅            | ✅             |
-| fedora-39       | ✅            | ✅             |
-| ubuntu-20.04    | ✅            | ✅             |
 | ubuntu-22.04    | ✅            | ✅             |
+| ubuntu-24.04    | ✅            | ✅             |
+
+<div class="section_buttons">
+
+| Previous                       |                                                 Next |
+|:-------------------------------|-----------------------------------------------------:|
+| [Changelog](docs/changelog.md) | [Third-Party Packages](docs/third_party_packages.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

README.md

@@ -0,0 +1,206 @@
+<div align="center">
+  <img src="sunshine.png" />
+  <h1 align="center">Sunshine</h1>
+  <h4 align="center">Self-hosted game stream host for Moonlight.</h4>
+</div>
+
+<div align="center">
+  <a href="https://github.com/LizardByte/Sunshine"><img src="https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge" alt="GitHub stars"></a>
+  <a href="https://github.com/LizardByte/Sunshine/releases/latest"><img src="https://img.shields.io/github/downloads/lizardbyte/sunshine/total.svg?style=for-the-badge&logo=github" alt="GitHub Releases"></a>
+  <a href="https://hub.docker.com/r/lizardbyte/sunshine"><img src="https://img.shields.io/docker/pulls/lizardbyte/sunshine.svg?style=for-the-badge&logo=docker" alt="Docker"></a>
+  <a href="https://github.com/LizardByte/Sunshine/pkgs/container/sunshine"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2FLizardByte%2FSunshine%2Fsunshine.json&query=%24.downloads&label=ghcr%20pulls&style=for-the-badge&logo=github" alt="GHCR"></a>
+  <a href="https://flathub.org/apps/dev.lizardbyte.app.Sunshine"><img src="https://img.shields.io/flathub/downloads/dev.lizardbyte.app.Sunshine?style=for-the-badge&logo=flathub" alt="Flathub installs"></a>
+  <a href="https://flathub.org/apps/dev.lizardbyte.app.Sunshine"><img src="https://img.shields.io/flathub/v/dev.lizardbyte.app.Sunshine?style=for-the-badge&logo=flathub" alt="Flathub Version"></a>
+  <a href="https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine"><img src="https://img.shields.io/winget/v/LizardByte.Sunshine?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAHuSURBVFhH7ZfNTtRQGIYZiMDwN/IrCAqIhMSNKxcmymVwG+5dcDVsWHgDrtxwCYQVl+BChzDEwSnPY+eQ0sxoOz1mQuBNnpyvTdvz9jun5/SrjfxnJUkyQbMEz2ELduF1l0YUA3QyTrMAa2AnPtyOXsELeAYNyKtV2EC3k3lYgTOwg09ghy/BTp7CKBRV844BOpmmMV2+ySb4BmInG7AKY7AHH+EYqqhZo9PPBG/BVDlOizAD/XQFmnoPXzxRQX8M/CCYS48L6RIc4ygGHK9WGg9HZSZMUNRPVwNJGg5Hg2Qgqh4N3FsDsb6EmgYm07iwwvUxstdxJTwgmILf4CfZ6bb5OHANX8GN5x20IVxnG8ge94pt2xpwU3GnCwayF4Q2G2vgFLzHndFzQdk4q77nNfCdwL28qNyMtmEf3A1/QV5FjDiPWo5jrwf8TWZChTlgJvL4F9QL50/A43qVidTvLcuoM2wDQ1+IkgefgUpLcYwMVBqCKNJA2b0gKNocOIITOIef8C/F/CdMbh/GklynsSawKLHS8d9/B1x2LUqsfFyy3TMsWj5A1cLkotDbYO4JjWWZlZEGv8EbOIR1CAVN2eG8W5oNKgxaeC6DmTJjZs7ixUxpznLPLT+v4sXpoMLcLI3mzFSonDXIEI/M3QCIO4YuimBJ/gAAAABJRU5ErkJggg==" alt="Winget Version"></a>
+  <a href="https://gurubase.io/g/sunshine"><img src="https://img.shields.io/badge/Gurubase-Ask%20Guru-ef1a1b?style=for-the-badge&logo=data:image/jpeg;base64,/9j/2wCEAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDIBCQkJDAsMGA0NGDIhHCEyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMv/AABEIABgAGAMBIgACEQEDEQH/xAGiAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgsQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+gEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoLEQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/AOLqSO3mlilljido4QGkYDIQEgAn05IH41seFo7aS+uRKlrJci2Y2cd2QImlyOGyQPu7sA8ZxXapAlvpThbPRkv7nTQWhDoIZZRc/XaSAOmcZGOnFfP06XMr3P17F5iqE+Tl1uuvf9Lde55dRW74pit4r61EcdtFdG2U3kVqQY0lyeBgkD5duQOASawqykuV2O6jV9rTU0rXLNjf3Om3QubSXy5QCudoYEEYIIOQR7GnahqV3qk6zXk3mOqhFAUKqqOyqAAByeAKqUUXdrFezhz89lfv1+8KKKKRZ//Z" alt="Gurubase"></a>
+  <a href="https://github.com/LizardByte/Sunshine/actions/workflows/ci.yml?query=branch%3Amaster"><img src="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)"></a>
+  <a href="https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Amaster"><img src="https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/localize.yml.svg?branch=master&label=localize%20build&logo=github&style=for-the-badge" alt="GitHub Workflow Status (localize)"></a>
+  <a href="https://docs.lizardbyte.dev/projects/sunshine"><img src="https://img.shields.io/readthedocs/sunshinestream.svg?label=Docs&style=for-the-badge&logo=readthedocs" alt="Read the Docs"></a>
+  <a href="https://codecov.io/gh/LizardByte/Sunshine"><img src="https://img.shields.io/codecov/c/gh/LizardByte/Sunshine?token=SMGXQ5NVMJ&style=for-the-badge&logo=codecov&label=codecov" alt="Codecov"></a>
+</div>
+
+## ℹ️ About
+
+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.
+
+LizardByte has the full documentation hosted on [Read the Docs](https://docs.lizardbyte.dev/projects/sunshine)
+
+* [Stable](https://docs.lizardbyte.dev/projects/sunshine/latest/)
+* [Beta](https://docs.lizardbyte.dev/projects/sunshine/master/)
+
+## 🖥️ System Requirements
+
+@warning{These tables are a work in progress. Do not purchase hardware based on this information.}
+
+<table>
+    <caption id="minimum_requirements">Minimum Requirements</caption>
+    <tr>
+        <th>Component</th>
+        <th>Requirement</th>
+    </tr>
+    <tr>
+        <td rowspan="3">GPU</td>
+        <td>AMD: VCE 1.0 or higher, see: <a href="https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support">obs-amd hardware support</a></td>
+    </tr>
+    <tr>
+        <td>
+            Intel:<br>
+            &nbsp;&nbsp;Linux: VAAPI-compatible, see: <a href="https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html">VAAPI hardware support</a><br>
+            &nbsp;&nbsp;Windows: Skylake or newer with QuickSync encoding support
+        </td>
+    </tr>
+    <tr>
+        <td>Nvidia: NVENC enabled cards, see: <a href="https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new">nvenc support matrix</a></td>
+    </tr>
+    <tr>
+        <td rowspan="2">CPU</td>
+        <td>AMD: Ryzen 3 or higher</td>
+    </tr>
+    <tr>
+        <td>Intel: Core i3 or higher</td>
+    </tr>
+    <tr>
+        <td>RAM</td>
+        <td>4GB or more</td>
+    </tr>
+    <tr>
+        <td rowspan="5">OS</td>
+        <td>Windows: 10+ (Windows Server does not support virtual gamepads)</td>
+    </tr>
+    <tr>
+        <td>macOS: 13+</td>
+    </tr>
+    <tr>
+        <td>Linux/Debian: 12+ (bookworm)</td>
+    </tr>
+    <tr>
+        <td>Linux/Fedora: 40+</td>
+    </tr>
+    <tr>
+        <td>Linux/Ubuntu: 22.04+ (jammy)</td>
+    </tr>
+    <tr>
+        <td rowspan="2">Network</td>
+        <td>Host: 5GHz, 802.11ac</td>
+    </tr>
+    <tr>
+        <td>Client: 5GHz, 802.11ac</td>
+    </tr>
+</table>
+
+<table>
+    <caption id="4k_suggestions">4k Suggestions</caption>
+    <tr>
+        <th>Component</th>
+        <th>Requirement</th>
+    </tr>
+    <tr>
+        <td rowspan="3">GPU</td>
+        <td>AMD: Video Coding Engine 3.1 or higher</td>
+    </tr>
+    <tr>
+        <td>
+            Intel:<br>
+            &nbsp;&nbsp;Linux: HD Graphics 510 or higher<br>
+            &nbsp;&nbsp;Windows: Skylake or newer with QuickSync encoding support
+        </td>
+    </tr>
+    <tr>
+        <td>Nvidia: GeForce GTX 1080 or higher</td>
+    </tr>
+    <tr>
+        <td rowspan="2">CPU</td>
+        <td>AMD: Ryzen 5 or higher</td>
+    </tr>
+    <tr>
+        <td>Intel: Core i5 or higher</td>
+    </tr>
+    <tr>
+        <td rowspan="2">Network</td>
+        <td>Host: CAT5e ethernet or better</td>
+    </tr>
+    <tr>
+        <td>Client: CAT5e ethernet or better</td>
+    </tr>
+</table>
+
+<table>
+    <caption id="hdr_suggestions">HDR Suggestions</caption>
+    <tr>
+        <th>Component</th>
+        <th>Requirement</th>
+    </tr>
+    <tr>
+        <td rowspan="3">GPU</td>
+        <td>AMD: Video Coding Engine 3.4 or higher</td>
+    </tr>
+    <tr>
+        <td>Intel: HD Graphics 730 or higher</td>
+    </tr>
+    <tr>
+        <td>Nvidia: Pascal-based GPU (GTX 10-series) or higher</td>
+    </tr>
+    <tr>
+        <td rowspan="2">CPU</td>
+        <td>AMD: Ryzen 5 or higher</td>
+    </tr>
+    <tr>
+        <td>Intel: Core i5 or higher</td>
+    </tr>
+    <tr>
+        <td rowspan="2">Network</td>
+        <td>Host: CAT5e ethernet or better</td>
+    </tr>
+    <tr>
+        <td>Client: CAT5e ethernet or better</td>
+    </tr>
+</table>
+
+## ❓ Support
+
+Our support methods are listed in our [LizardByte Docs](https://docs.lizardbyte.dev/latest/about/support.html).
+
+## 💲 Sponsors and Supporters
+
+<p align="center">
+  <a href="https://app.lizardbyte.dev" aria-label="Sponsor LizardByte">
+    <img src='https://raw.githubusercontent.com/LizardByte/contributors/refs/heads/dist/sponsors.svg'/>
+  </a>
+</p>
+
+## 👥 Contributors
+
+Thank you to all the contributors who have helped make Sunshine better!
+
+### GitHub
+
+<p align="center">
+  <a href="https://github.com/LizardByte/Sunshine" aria-label="GitHub">
+    <img src='https://raw.githubusercontent.com/LizardByte/contributors/refs/heads/dist/github.Sunshine.svg'/>
+  </a>
+</p>
+
+### CrowdIn
+
+<p align="center">
+  <a href="https://translate.lizardbyte.dev" aria-label="CrowdIn">
+    <img src='https://raw.githubusercontent.com/LizardByte/contributors/refs/heads/dist/crowdin.606145.svg'/>
+  </a>
+</p>
+
+<div class="section_buttons">
+
+| Previous |                                       Next |
+|:---------|-------------------------------------------:|
+|          | [Getting Started](docs/getting_started.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

README.rst

@@ -1,128 +0,0 @@
-Overview
-========
-LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`__.
-
-About
------
-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.
-
-System Requirements
--------------------
-
-.. warning:: This table is a work in progress. Do not purchase hardware based on this.
-
-**Minimum Requirements**
-
-+------------+------------------------------------------------------------+
-| 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: 37+                                          |
-|            +------------------------------------------------------------+
-|            | 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/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/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.svg?label=Docs&style=for-the-badge&logo=readthedocs
-   :alt: Read the Docs
-   :target: http://sunshinestream.readthedocs.io/
-
-Support
--------
-
-Our support methods are listed in our
-`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`__.
-
-Downloads
----------
-
-.. 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.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.svg?logo=github&style=for-the-badge
-   :alt: GitHub stars
-   :target: https://github.com/LizardByte/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/compile_definitions/common.cmake

@@ -6,12 +6,19 @@ list(APPEND SUNSHINE_COMPILE_OPTIONS -Wall -Wno-sign-compare)
 # Werror - treat warnings as errors
 # Wno-maybe-uninitialized/Wno-uninitialized - disable warnings for maybe uninitialized variables
 # Wno-sign-compare - disable warnings for signed/unsigned comparisons
+# Wno-restrict - disable warnings for memory overlap
 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     # GCC specific compile options
 
     # GCC 12 and higher will complain about maybe-uninitialized
     if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 12)
         list(APPEND SUNSHINE_COMPILE_OPTIONS -Wno-maybe-uninitialized)
+
+        # Disable the bogus warning that may prevent compilation (only for GCC 12).
+        # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105651.
+        if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 13)
+            list(APPEND SUNSHINE_COMPILE_OPTIONS -Wno-restrict)
+        endif()
     endif()
 elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
     # Clang specific compile options
@@ -41,21 +48,16 @@ elseif(UNIX)
     endif()
 endif()
 
-include_directories(SYSTEM "${CMAKE_SOURCE_DIR}/third-party/nv-codec-headers/include")
+include_directories(BEFORE SYSTEM "${CMAKE_SOURCE_DIR}/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("${CMAKE_SOURCE_DIR}/src/version.h.in" version.h @ONLY)
-include_directories("${CMAKE_CURRENT_BINARY_DIR}")  # required for importing version.h
-
 set(SUNSHINE_TARGET_FILES
-        "${CMAKE_SOURCE_DIR}/third-party/nanors/rs.c"
-        "${CMAKE_SOURCE_DIR}/third-party/nanors/rs.h"
         "${CMAKE_SOURCE_DIR}/third-party/moonlight-common-c/src/Input.h"
         "${CMAKE_SOURCE_DIR}/third-party/moonlight-common-c/src/Rtsp.h"
         "${CMAKE_SOURCE_DIR}/third-party/moonlight-common-c/src/RtspParser.c"
         "${CMAKE_SOURCE_DIR}/third-party/moonlight-common-c/src/Video.h"
-        "${CMAKE_SOURCE_DIR}/third-party/tray/tray.h"
+        "${CMAKE_SOURCE_DIR}/third-party/tray/src/tray.h"
         "${CMAKE_SOURCE_DIR}/src/upnp.cpp"
         "${CMAKE_SOURCE_DIR}/src/upnp.h"
         "${CMAKE_SOURCE_DIR}/src/cbs.cpp"
@@ -63,6 +65,8 @@ set(SUNSHINE_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/src/uuid.h"
         "${CMAKE_SOURCE_DIR}/src/config.h"
         "${CMAKE_SOURCE_DIR}/src/config.cpp"
+        "${CMAKE_SOURCE_DIR}/src/display_device.h"
+        "${CMAKE_SOURCE_DIR}/src/display_device.cpp"
         "${CMAKE_SOURCE_DIR}/src/entry_handler.cpp"
         "${CMAKE_SOURCE_DIR}/src/entry_handler.h"
         "${CMAKE_SOURCE_DIR}/src/file_handler.cpp"
@@ -108,13 +112,10 @@ set(SUNSHINE_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/src/round_robin.h"
         "${CMAKE_SOURCE_DIR}/src/stat_trackers.h"
         "${CMAKE_SOURCE_DIR}/src/stat_trackers.cpp"
+        "${CMAKE_SOURCE_DIR}/src/rswrapper.h"
+        "${CMAKE_SOURCE_DIR}/src/rswrapper.c"
         ${PLATFORM_TARGET_FILES})
 
-set_source_files_properties("${CMAKE_SOURCE_DIR}/src/upnp.cpp" PROPERTIES COMPILE_FLAGS -Wno-pedantic)
-
-set_source_files_properties("${CMAKE_SOURCE_DIR}/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()
@@ -122,34 +123,32 @@ list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_ASSETS_DIR="${SUNSHINE_ASSETS_DIR_DEF}
 
 list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_TRAY=${SUNSHINE_TRAY})
 
-include_directories("${CMAKE_SOURCE_DIR}")
+# Publisher metadata
+list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_PUBLISHER_NAME="${SUNSHINE_PUBLISHER_NAME}")
+list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_PUBLISHER_WEBSITE="${SUNSHINE_PUBLISHER_WEBSITE}")
+list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_PUBLISHER_ISSUE_URL="${SUNSHINE_PUBLISHER_ISSUE_URL}")
+
+include_directories(BEFORE "${CMAKE_SOURCE_DIR}")
 
 include_directories(
+        BEFORE
         SYSTEM
         "${CMAKE_SOURCE_DIR}/third-party"
         "${CMAKE_SOURCE_DIR}/third-party/moonlight-common-c/enet/include"
         "${CMAKE_SOURCE_DIR}/third-party/nanors"
         "${CMAKE_SOURCE_DIR}/third-party/nanors/deps/obl"
         ${FFMPEG_INCLUDE_DIRS}
-        ${PLATFORM_INCLUDE_DIRS}
+        ${Boost_INCLUDE_DIRS}  # has to be the last, or we get runtime error on macOS ffmpeg encoder
 )
 
-string(TOUPPER "x${CMAKE_BUILD_TYPE}" BUILD_TYPE)
-if("${BUILD_TYPE}" STREQUAL "XDEBUG")
-    if(WIN32)
-        set_source_files_properties("${CMAKE_SOURCE_DIR}/src/nvhttp.cpp" PROPERTIES COMPILE_FLAGS -O2)
-    endif()
-else()
-    add_definitions(-DNDEBUG)
-endif()
-
 list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
         ${MINIUPNP_LIBRARIES}
         ${CMAKE_THREAD_LIBS_INIT}
         enet
+        libdisplaydevice::display_device
+        nlohmann_json::nlohmann_json
         opus
         ${FFMPEG_LIBRARIES}
         ${Boost_LIBRARIES}
         ${OPENSSL_LIBRARIES}
-        ${CURL_LIBRARIES}
         ${PLATFORM_LIBRARIES})

cmake/compile_definitions/linux.cmake

@@ -8,10 +8,6 @@ if(${SUNSHINE_BUILD_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})
@@ -28,57 +24,42 @@ if(${SUNSHINE_ENABLE_CUDA})
         # 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()
 
+        # https://docs.nvidia.com/cuda/archive/9.2/cuda-compiler-driver-nvcc/index.html
         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()
 
+        # https://docs.nvidia.com/cuda/archive/10.0/cuda-compiler-driver-nvcc/index.html
         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")
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 72 75)
         endif()
 
+        # https://docs.nvidia.com/cuda/archive/11.0/cuda-compiler-driver-nvcc/index.html
         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()
 
+        # https://docs.nvidia.com/cuda/archive/11.8.0/cuda-compiler-driver-nvcc/index.html
         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")
+            list(APPEND CMAKE_CUDA_ARCHITECTURES 86 87 89 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
@@ -86,6 +67,11 @@ if(${SUNSHINE_ENABLE_CUDA})
 
         # message(STATUS "CUDA NVCC Flags: ${CUDA_NVCC_FLAGS}")
         message(STATUS "CUDA Architectures: ${CMAKE_CUDA_ARCHITECTURES}")
+    elseif(${CUDA_FAIL_ON_MISSING})
+        message(FATAL_ERROR
+                "CUDA not found.
+                If this is intentional, set '-DSUNSHINE_ENABLE_CUDA=OFF' or '-DCUDA_FAIL_ON_MISSING=OFF'"
+        )
     endif()
 endif()
 if(CUDA_FOUND)
@@ -99,41 +85,38 @@ if(CUDA_FOUND)
     add_compile_definitions(SUNSHINE_BUILD_CUDA)
 endif()
 
-# drm
-if(${SUNSHINE_ENABLE_DRM})
-    find_package(LIBDRM)
-    find_package(LIBCAP)
+# libdrm is required for both DRM (KMS) and Wayland
+if(${SUNSHINE_ENABLE_DRM} OR ${SUNSHINE_ENABLE_WAYLAND})
+    find_package(LIBDRM REQUIRED)
 else()
     set(LIBDRM_FOUND OFF)
+endif()
+if(LIBDRM_FOUND)
+    include_directories(SYSTEM ${LIBDRM_INCLUDE_DIRS})
+    list(APPEND PLATFORM_LIBRARIES ${LIBDRM_LIBRARIES})
+endif()
+
+# drm
+if(${SUNSHINE_ENABLE_DRM})
+    find_package(LIBCAP REQUIRED)
+else()
     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})
+    include_directories(SYSTEM ${LIBCAP_INCLUDE_DIRS})
+    list(APPEND PLATFORM_LIBRARIES ${LIBCAP_LIBRARIES})
     list(APPEND PLATFORM_TARGET_FILES
             "${CMAKE_SOURCE_DIR}/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()
 
 # evdev
-pkg_check_modules(PC_EVDEV libevdev REQUIRED)
-find_path(EVDEV_INCLUDE_DIR libevdev/libevdev.h
-        HINTS ${PC_EVDEV_INCLUDE_DIRS} ${PC_EVDEV_INCLUDEDIR})
-find_library(EVDEV_LIBRARY
-        NAMES evdev libevdev)
-if(EVDEV_INCLUDE_DIR AND EVDEV_LIBRARY)
-    include_directories(SYSTEM ${EVDEV_INCLUDE_DIR})
-    list(APPEND PLATFORM_LIBRARIES ${EVDEV_LIBRARY})
-endif()
+include(dependencies/libevdev_Sunshine)
 
 # vaapi
 if(${SUNSHINE_ENABLE_VAAPI})
-    find_package(Libva)
+    find_package(Libva REQUIRED)
 else()
     set(LIBVA_FOUND OFF)
 endif()
@@ -148,7 +131,7 @@ endif()
 
 # wayland
 if(${SUNSHINE_ENABLE_WAYLAND})
-    find_package(Wayland)
+    find_package(Wayland REQUIRED)
 else()
     set(WAYLAND_FOUND OFF)
 endif()
@@ -163,7 +146,8 @@ if(WAYLAND_FOUND)
     endif()
 
     GEN_WAYLAND("${WAYLAND_PROTOCOLS_DIR}" "unstable/xdg-output" xdg-output-unstable-v1)
-    GEN_WAYLAND("${CMAKE_SOURCE_DIR}/third-party/wlr-protocols" "unstable" wlr-export-dmabuf-unstable-v1)
+    GEN_WAYLAND("${WAYLAND_PROTOCOLS_DIR}" "unstable/linux-dmabuf" linux-dmabuf-unstable-v1)
+    GEN_WAYLAND("${CMAKE_SOURCE_DIR}/third-party/wlr-protocols" "unstable" wlr-screencopy-unstable-v1)
 
     include_directories(
             SYSTEM
@@ -171,7 +155,7 @@ if(WAYLAND_FOUND)
             ${CMAKE_BINARY_DIR}/generated-src
     )
 
-    list(APPEND PLATFORM_LIBRARIES ${WAYLAND_LIBRARIES})
+    list(APPEND PLATFORM_LIBRARIES ${WAYLAND_LIBRARIES} gbm)
     list(APPEND PLATFORM_TARGET_FILES
             "${CMAKE_SOURCE_DIR}/src/platform/linux/wlgrab.cpp"
             "${CMAKE_SOURCE_DIR}/src/platform/linux/wayland.h"
@@ -180,7 +164,7 @@ endif()
 
 # x11
 if(${SUNSHINE_ENABLE_X11})
-    find_package(X11)
+    find_package(X11 REQUIRED)
 else()
     set(X11_FOUND OFF)
 endif()
@@ -203,37 +187,64 @@ endif()
 
 # tray icon
 if(${SUNSHINE_ENABLE_TRAY})
-    pkg_check_modules(APPINDICATOR appindicator3-0.1)
+    pkg_check_modules(APPINDICATOR ayatana-appindicator3-0.1)
     if(APPINDICATOR_FOUND)
-        list(APPEND SUNSHINE_DEFINITIONS TRAY_LEGACY_APPINDICATOR=1)
+        list(APPEND SUNSHINE_DEFINITIONS TRAY_AYATANA_APPINDICATOR=1)
     else()
-        pkg_check_modules(APPINDICATOR ayatana-appindicator3-0.1)
+        pkg_check_modules(APPINDICATOR appindicator3-0.1)
         if(APPINDICATOR_FOUND)
-            list(APPEND SUNSHINE_DEFINITIONS TRAY_AYATANA_APPINDICATOR=1)
+            list(APPEND SUNSHINE_DEFINITIONS TRAY_LEGACY_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}")
+        message(FATAL_ERROR "Couldn't find either appindicator or libnotify")
     else()
         include_directories(SYSTEM ${APPINDICATOR_INCLUDE_DIRS} ${LIBNOTIFY_INCLUDE_DIRS})
         link_directories(${APPINDICATOR_LIBRARY_DIRS} ${LIBNOTIFY_LIBRARY_DIRS})
 
-        list(APPEND PLATFORM_TARGET_FILES "${CMAKE_SOURCE_DIR}/third-party/tray/tray_linux.c")
+        list(APPEND PLATFORM_TARGET_FILES "${CMAKE_SOURCE_DIR}/third-party/tray/src/tray_linux.c")
         list(APPEND SUNSHINE_EXTERNAL_LIBRARIES ${APPINDICATOR_LIBRARIES} ${LIBNOTIFY_LIBRARIES})
     endif()
+
+    # flatpak icons must be prefixed with the app id or they will not be included in the flatpak
+    if(${SUNSHINE_BUILD_FLATPAK})
+        set(SUNSHINE_TRAY_PREFIX "${PROJECT_FQDN}")
+    else()
+        set(SUNSHINE_TRAY_PREFIX "sunshine")
+    endif()
+    list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_TRAY_PREFIX="${SUNSHINE_TRAY_PREFIX}")
 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")
+# These need to be set before adding the inputtino subdirectory in order for them to be picked up
+set(LIBEVDEV_CUSTOM_INCLUDE_DIR "${EVDEV_INCLUDE_DIR}")
+set(LIBEVDEV_CUSTOM_LIBRARY "${EVDEV_LIBRARY}")
+
+add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/inputtino")
+list(APPEND SUNSHINE_EXTERNAL_LIBRARIES inputtino::libinputtino)
+file(GLOB_RECURSE INPUTTINO_SOURCES
+        ${CMAKE_SOURCE_DIR}/src/platform/linux/input/inputtino*.h
+        ${CMAKE_SOURCE_DIR}/src/platform/linux/input/inputtino*.cpp)
+list(APPEND PLATFORM_TARGET_FILES ${INPUTTINO_SOURCES})
+
+# build libevdev before the libinputtino target
+if(EXTERNAL_PROJECT_LIBEVDEV_USED)
+    add_dependencies(libinputtino libevdev)
 endif()
 
+# AppImage and Flatpak
+if (${SUNSHINE_BUILD_APPIMAGE})
+    list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_BUILD_APPIMAGE=1)
+endif ()
+if (${SUNSHINE_BUILD_FLATPAK})
+    list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_BUILD_FLATPAK=1)
+endif ()
+
 list(APPEND PLATFORM_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/src/platform/linux/publish.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/linux/graphics.h"
@@ -241,7 +252,6 @@ list(APPEND PLATFORM_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/src/platform/linux/misc.h"
         "${CMAKE_SOURCE_DIR}/src/platform/linux/misc.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/linux/audio.cpp"
-        "${CMAKE_SOURCE_DIR}/src/platform/linux/input.cpp"
         "${CMAKE_SOURCE_DIR}/third-party/glad/src/egl.c"
         "${CMAKE_SOURCE_DIR}/third-party/glad/src/gl.c"
         "${CMAKE_SOURCE_DIR}/third-party/glad/include/EGL/eglplatform.h"
@@ -250,13 +260,10 @@ list(APPEND PLATFORM_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/third-party/glad/include/glad/egl.h")
 
 list(APPEND PLATFORM_LIBRARIES
-        Boost::dynamic_linking
         dl
-        numa
         pulse
         pulse-simple)
 
 include_directories(
         SYSTEM
-        "${CMAKE_SOURCE_DIR}/third-party/nv-codec-headers/include"
         "${CMAKE_SOURCE_DIR}/third-party/glad/include")

cmake/compile_definitions/macos.cmake

@@ -2,21 +2,29 @@
 
 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)
+set(MACOS_LINK_DIRECTORIES
+        /opt/homebrew/lib
+        /opt/local/lib
+        /usr/local/lib)
+
+foreach(dir ${MACOS_LINK_DIRECTORIES})
+    if(EXISTS ${dir})
+        link_directories(${dir})
+    endif()
+endforeach()
+
+if(NOT BOOST_USE_STATIC AND NOT FETCH_CONTENT_BOOST_USED)
+    ADD_DEFINITIONS(-DBOOST_LOG_DYN_LINK)
+endif()
 
 list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
+        ${APP_KIT_LIBRARY}
         ${APP_SERVICES_LIBRARY}
         ${AV_FOUNDATION_LIBRARY}
         ${CORE_MEDIA_LIBRARY}
         ${CORE_VIDEO_LIBRARY}
-        ${VIDEO_TOOLBOX_LIBRARY}
-        ${FOUNDATION_LIBRARY})
-
-set(PLATFORM_INCLUDE_DIRS
-        ${Boost_INCLUDE_DIR})
+        ${FOUNDATION_LIBRARY}
+        ${VIDEO_TOOLBOX_LIBRARY})
 
 set(APPLE_PLIST_FILE "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/Info.plist")
 
@@ -45,5 +53,5 @@ if(SUNSHINE_ENABLE_TRAY)
     list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
             ${COCOA})
     list(APPEND PLATFORM_TARGET_FILES
-            "${CMAKE_SOURCE_DIR}/third-party/tray/tray_darwin.m")
+            "${CMAKE_SOURCE_DIR}/third-party/tray/src/tray_darwin.m")
 endif()

cmake/compile_definitions/unix.cmake

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

cmake/compile_definitions/windows.cmake

@@ -9,6 +9,9 @@ set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
 # gcc complains about misleading indentation in some mingw includes
 list(APPEND SUNSHINE_COMPILE_OPTIONS -Wno-misleading-indentation)
 
+# see gcc bug 98723
+add_definitions(-DUSE_BOOST_REGEX)
+
 # curl
 add_definitions(-DCURL_STATICLIB)
 include_directories(SYSTEM ${CURL_STATIC_INCLUDE_DIRS})
@@ -29,26 +32,23 @@ file(GLOB NVPREFS_FILES CONFIGURE_DEPENDS
 
 # vigem
 include_directories(SYSTEM "${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/include")
-set_source_files_properties("${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/src/ViGEmClient.cpp"
-        PROPERTIES COMPILE_DEFINITIONS "UNICODE=1;ERROR_INVALID_DEVICE_OBJECT_PARAMETER=650")
-set(VIGEM_COMPILE_FLAGS "")
-string(APPEND VIGEM_COMPILE_FLAGS "-Wno-unknown-pragmas ")
-string(APPEND VIGEM_COMPILE_FLAGS "-Wno-misleading-indentation ")
-string(APPEND VIGEM_COMPILE_FLAGS "-Wno-class-memaccess ")
-string(APPEND VIGEM_COMPILE_FLAGS "-Wno-unused-function ")
-string(APPEND VIGEM_COMPILE_FLAGS "-Wno-unused-variable ")
-set_source_files_properties("${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/src/ViGEmClient.cpp"
-        PROPERTIES COMPILE_FLAGS ${VIGEM_COMPILE_FLAGS})
 
 # sunshine icon
 if(NOT DEFINED SUNSHINE_ICON_PATH)
     set(SUNSHINE_ICON_PATH "${CMAKE_SOURCE_DIR}/sunshine.ico")
 endif()
 
-configure_file("${CMAKE_SOURCE_DIR}/src/platform/windows/windows.rs.in" windows.rc @ONLY)
+# Create a separate object library for the RC file with minimal includes
+add_library(sunshine_rc_object OBJECT "${CMAKE_SOURCE_DIR}/src/platform/windows/windows.rc")
+
+# Set minimal properties for RC compilation - only what's needed for the resource file
+# Otherwise compilation can fail due to "line too long" errors
+set_target_properties(sunshine_rc_object PROPERTIES
+    COMPILE_DEFINITIONS "PROJECT_ICON_PATH=${SUNSHINE_ICON_PATH};PROJECT_NAME=${PROJECT_NAME};PROJECT_VENDOR=${SUNSHINE_PUBLISHER_NAME};PROJECT_VERSION=${PROJECT_VERSION};PROJECT_VERSION_MAJOR=${PROJECT_VERSION_MAJOR};PROJECT_VERSION_MINOR=${PROJECT_VERSION_MINOR};PROJECT_VERSION_PATCH=${PROJECT_VERSION_PATCH}"  # cmake-lint: disable=C0301
+    INCLUDE_DIRECTORIES ""
+)
 
 set(PLATFORM_TARGET_FILES
-        "${CMAKE_CURRENT_BINARY_DIR}/windows.rc"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/publish.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/misc.h"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/misc.cpp"
@@ -57,7 +57,10 @@ set(PLATFORM_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_base.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_vram.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_ram.cpp"
+        "${CMAKE_SOURCE_DIR}/src/platform/windows/display_wgc.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/audio.cpp"
+        "${CMAKE_SOURCE_DIR}/src/platform/windows/utf_utils.cpp"
+        "${CMAKE_SOURCE_DIR}/src/platform/windows/utf_utils.h"
         "${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/src/ViGEmClient.cpp"
         "${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/include/ViGEm/Client.h"
         "${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/include/ViGEm/Common.h"
@@ -70,24 +73,28 @@ set(OPENSSL_LIBRARIES
         libcrypto.a)
 
 list(PREPEND PLATFORM_LIBRARIES
+        ${CURL_STATIC_LIBRARIES}
+        avrt
+        d3d11
+        D3DCompiler
+        dwmapi
+        dxgi
+        iphlpapi
+        ksuser
+        libssp.a
         libstdc++.a
         libwinpthread.a
-        libssp.a
-        ksuser
-        wsock32
-        ws2_32
-        d3d11 dxgi D3DCompiler
+        minhook::minhook
+        ntdll
         setupapi
-        dwmapi
-        userenv
-        synchronization.lib
-        avrt
-        iphlpapi
         shlwapi
-        PkgConfig::NLOHMANN_JSON
-        ${CURL_STATIC_LIBRARIES})
+        synchronization.lib
+        userenv
+        ws2_32
+        wsock32
+)
 
 if(SUNSHINE_ENABLE_TRAY)
     list(APPEND PLATFORM_TARGET_FILES
-            "${CMAKE_SOURCE_DIR}/third-party/tray/tray_windows.c")
+            "${CMAKE_SOURCE_DIR}/third-party/tray/src/tray_windows.c")
 endif()

cmake/dependencies/Boost_Sunshine.cmake

@@ -0,0 +1,103 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback to FetchContent.
+#
+include_guard(GLOBAL)
+
+set(BOOST_VERSION "1.87.0")
+set(BOOST_COMPONENTS
+        filesystem
+        locale
+        log
+        program_options
+        system
+)
+# system is not used by Sunshine, but by Simple-Web-Server, added here for convenience
+
+# algorithm, preprocessor, scope, and uuid are not used by Sunshine, but by libdisplaydevice, added here for convenience
+if(WIN32)
+    list(APPEND BOOST_COMPONENTS
+            algorithm
+            preprocessor
+            scope
+            uuid
+    )
+endif()
+
+if(BOOST_USE_STATIC)
+    set(Boost_USE_STATIC_LIBS ON)  # cmake-lint: disable=C0103
+endif()
+
+if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.30")
+    cmake_policy(SET CMP0167 NEW)  # Get BoostConfig.cmake from upstream
+endif()
+find_package(Boost CONFIG ${BOOST_VERSION} EXACT COMPONENTS ${BOOST_COMPONENTS})
+if(NOT Boost_FOUND)
+    message(STATUS "Boost v${BOOST_VERSION} package not found in the system. Falling back to FetchContent.")
+    include(FetchContent)
+
+    if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+        cmake_policy(SET CMP0135 NEW)  # Avoid warning about DOWNLOAD_EXTRACT_TIMESTAMP in CMake 3.24
+    endif()
+    if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.31.0")
+        cmake_policy(SET CMP0174 NEW)  # Handle empty variables
+    endif()
+
+    # more components required for compiling boost targets
+    list(APPEND BOOST_COMPONENTS
+            asio
+            crc
+            format
+            process
+            property_tree)
+
+    set(BOOST_ENABLE_CMAKE ON)
+
+    # Limit boost to the required libraries only
+    set(BOOST_INCLUDE_LIBRARIES ${BOOST_COMPONENTS})
+    set(BOOST_URL "https://github.com/boostorg/boost/releases/download/boost-${BOOST_VERSION}/boost-${BOOST_VERSION}-cmake.tar.xz")  # cmake-lint: disable=C0301
+    set(BOOST_HASH "SHA256=7da75f171837577a52bbf217e17f8ea576c7c246e4594d617bfde7fafd408be5")
+
+    if(CMAKE_VERSION VERSION_LESS "3.24.0")
+        FetchContent_Declare(
+                Boost
+                URL ${BOOST_URL}
+                URL_HASH ${BOOST_HASH}
+        )
+    elseif(APPLE AND CMAKE_VERSION VERSION_GREATER_EQUAL "3.25.0")
+        # add SYSTEM to FetchContent_Declare, this fails on debian bookworm
+        FetchContent_Declare(
+                Boost
+                URL ${BOOST_URL}
+                URL_HASH ${BOOST_HASH}
+                SYSTEM  # requires CMake 3.25+
+                OVERRIDE_FIND_PACKAGE  # requires CMake 3.24+, but we have a macro to handle it for other versions
+        )
+    elseif(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+        FetchContent_Declare(
+                Boost
+                URL ${BOOST_URL}
+                URL_HASH ${BOOST_HASH}
+                OVERRIDE_FIND_PACKAGE  # requires CMake 3.24+, but we have a macro to handle it for other versions
+        )
+    endif()
+
+    FetchContent_MakeAvailable(Boost)
+    set(FETCH_CONTENT_BOOST_USED TRUE)
+
+    set(Boost_FOUND TRUE)  # cmake-lint: disable=C0103
+    set(Boost_INCLUDE_DIRS  # cmake-lint: disable=C0103
+            "$<BUILD_INTERFACE:${Boost_SOURCE_DIR}/libs/headers/include>")
+
+    if(WIN32)
+        # Windows build is failing to create .h file in this directory
+        file(MAKE_DIRECTORY ${Boost_BINARY_DIR}/libs/log/src/windows)
+    endif()
+
+    set(Boost_LIBRARIES "")  # cmake-lint: disable=C0103
+    foreach(component ${BOOST_COMPONENTS})
+        list(APPEND Boost_LIBRARIES "Boost::${component}")
+    endforeach()
+endif()
+
+message(STATUS "Boost include dirs: ${Boost_INCLUDE_DIRS}")
+message(STATUS "Boost libraries: ${Boost_LIBRARIES}")

cmake/dependencies/common.cmake

@@ -1,15 +1,22 @@
 # load common dependencies
 # this file will also load platform specific dependencies
 
+# boost, this should be before Simple-Web-Server as it also depends on boost
+include(dependencies/Boost_Sunshine)
+
 # submodules
 # moonlight common library
-set(ENET_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for enet")
+set(ENET_NO_INSTALL ON CACHE BOOL "Don't install any libraries built for enet")
 add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/moonlight-common-c/enet")
 
 # web server
 add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/Simple-Web-Server")
 
+# libdisplaydevice
+add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/libdisplaydevice")
+
 # common dependencies
+include("${CMAKE_MODULE_PATH}/dependencies/nlohmann_json.cmake")
 find_package(OpenSSL REQUIRED)
 find_package(PkgConfig REQUIRED)
 find_package(Threads REQUIRED)
@@ -20,53 +27,49 @@ pkg_check_modules(MINIUPNP miniupnpc REQUIRED)
 include_directories(SYSTEM ${MINIUPNP_INCLUDE_DIRS})
 
 # ffmpeg pre-compiled binaries
-if(WIN32)
-    if(NOT CMAKE_SYSTEM_PROCESSOR STREQUAL "AMD64")
-        message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR})
+if(NOT DEFINED FFMPEG_PREPARED_BINARIES)
+    if(WIN32)
+        set(FFMPEG_PLATFORM_LIBRARIES mfplat ole32 strmiids mfuuid vpl)
+    elseif(UNIX AND NOT APPLE)
+        set(FFMPEG_PLATFORM_LIBRARIES numa va va-drm va-x11 X11)
     endif()
-    set(FFMPEG_PLATFORM_LIBRARIES mfplat ole32 strmiids mfuuid vpl)
-    set(FFMPEG_PREPARED_BINARIES "${CMAKE_SOURCE_DIR}/third-party/build-deps/ffmpeg/windows-x86_64")
-elseif(APPLE)
-    if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
-        set(FFMPEG_PREPARED_BINARIES "${CMAKE_SOURCE_DIR}/third-party/build-deps/ffmpeg/macos-x86_64")
-    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64")
-        set(FFMPEG_PREPARED_BINARIES "${CMAKE_SOURCE_DIR}/third-party/build-deps/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})
+    set(FFMPEG_PREPARED_BINARIES
+            "${CMAKE_SOURCE_DIR}/third-party/build-deps/dist/${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
+
+    # check if the directory exists
+    if(NOT EXISTS "${FFMPEG_PREPARED_BINARIES}")
+        message(FATAL_ERROR
+                "FFmpeg pre-compiled binaries not found at ${FFMPEG_PREPARED_BINARIES}. \
+                Please consider contributing to the LizardByte/build-deps repository. \
+                Optionally, you can use the FFMPEG_PREPARED_BINARIES option to specify the path to the \
+                system-installed FFmpeg libraries")
     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_SOURCE_DIR}/third-party/build-deps/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_SOURCE_DIR}/third-party/build-deps/ffmpeg/linux-aarch64")
-    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "ppc64le" OR CMAKE_SYSTEM_PROCESSOR STREQUAL "ppc64")
-        set(FFMPEG_PREPARED_BINARIES "${CMAKE_SOURCE_DIR}/third-party/build-deps/ffmpeg/linux-powerpc64le")
-    else()
-        message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR})
+
+    if(EXISTS "${FFMPEG_PREPARED_BINARIES}/lib/libhdr10plus.a")
+        set(HDR10_PLUS_LIBRARY
+                "${FFMPEG_PREPARED_BINARIES}/lib/libhdr10plus.a")
     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
+    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})
+else()
+    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})
+endif()
+
+set(FFMPEG_INCLUDE_DIRS
+        "${FFMPEG_PREPARED_BINARIES}/include")
 
 # platform specific dependencies
 if(WIN32)

cmake/dependencies/libevdev_Sunshine.cmake

@@ -0,0 +1,47 @@
+#
+# Loads the libevdev library giving the priority to the system package first, with a fallback to ExternalProject
+#
+include_guard(GLOBAL)
+
+set(LIBEVDEV_VERSION libevdev-1.13.2)
+
+pkg_check_modules(PC_EVDEV libevdev)
+if(PC_EVDEV_FOUND)
+    find_path(EVDEV_INCLUDE_DIR libevdev/libevdev.h
+            HINTS ${PC_EVDEV_INCLUDE_DIRS} ${PC_EVDEV_INCLUDEDIR})
+    find_library(EVDEV_LIBRARY
+            NAMES evdev libevdev)
+else()
+    include(ExternalProject)
+
+    ExternalProject_Add(libevdev
+            URL http://www.freedesktop.org/software/libevdev/${LIBEVDEV_VERSION}.tar.xz
+            PREFIX ${LIBEVDEV_VERSION}
+            CONFIGURE_COMMAND <SOURCE_DIR>/configure --prefix=<INSTALL_DIR>
+            BUILD_COMMAND "make"
+            INSTALL_COMMAND ""
+    )
+
+    ExternalProject_Get_Property(libevdev SOURCE_DIR)
+    message(STATUS "libevdev source dir: ${SOURCE_DIR}")
+    set(EVDEV_INCLUDE_DIR "${SOURCE_DIR}")
+
+    ExternalProject_Get_Property(libevdev BINARY_DIR)
+    message(STATUS "libevdev binary dir: ${BINARY_DIR}")
+    set(EVDEV_LIBRARY "${BINARY_DIR}/libevdev/.libs/libevdev.a")
+
+    # compile libevdev before sunshine
+    set(SUNSHINE_TARGET_DEPENDENCIES ${SUNSHINE_TARGET_DEPENDENCIES} libevdev)
+
+    set(EXTERNAL_PROJECT_LIBEVDEV_USED TRUE)
+endif()
+
+if(EVDEV_INCLUDE_DIR AND EVDEV_LIBRARY)
+    message(STATUS "Found libevdev library: ${EVDEV_LIBRARY}")
+    message(STATUS "Found libevdev include directory: ${EVDEV_INCLUDE_DIR}")
+
+    include_directories(SYSTEM ${EVDEV_INCLUDE_DIR})
+    list(APPEND PLATFORM_LIBRARIES ${EVDEV_LIBRARY})
+else()
+    message(FATAL_ERROR "Couldn't find or fetch libevdev")
+endif()

cmake/dependencies/macos.cmake

@@ -1,5 +1,6 @@
 # macos specific dependencies
 
+FIND_LIBRARY(APP_KIT_LIBRARY AppKit)
 FIND_LIBRARY(APP_SERVICES_LIBRARY ApplicationServices)
 FIND_LIBRARY(AV_FOUNDATION_LIBRARY AVFoundation)
 FIND_LIBRARY(CORE_MEDIA_LIBRARY CoreMedia)

cmake/dependencies/nlohmann_json.cmake

@@ -0,0 +1,25 @@
+#
+# Loads the nlohmann_json library giving the priority to the system package first, with a fallback to FetchContent.
+#
+include_guard(GLOBAL)
+
+find_package(nlohmann_json 3.11 QUIET GLOBAL)
+if(NOT nlohmann_json_FOUND)
+    message(STATUS "nlohmann_json v3.11.x package not found in the system. Falling back to FetchContent.")
+    include(FetchContent)
+
+    if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+        cmake_policy(SET CMP0135 NEW)  # Avoid warning about DOWNLOAD_EXTRACT_TIMESTAMP in CMake 3.24
+    endif()
+    if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.31.0")
+        cmake_policy(SET CMP0174 NEW)  # Handle empty variables
+    endif()
+
+    FetchContent_Declare(
+            json
+            URL      https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz
+            URL_HASH MD5=c23a33f04786d85c29fda8d16b5f0efd
+            DOWNLOAD_EXTRACT_TIMESTAMP
+    )
+    FetchContent_MakeAvailable(json)
+endif()

cmake/dependencies/unix.cmake

@@ -1,4 +1,2 @@
 # 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

@@ -1,7 +1,9 @@
 # windows specific dependencies
 
-set(Boost_USE_STATIC_LIBS ON)  # cmake-lint: disable=C0103
-find_package(Boost 1.71.0 COMPONENTS locale log filesystem program_options REQUIRED)
+# Make sure MinHook is installed
+find_library(MINHOOK_LIBRARY libMinHook.a REQUIRED)
+find_path(MINHOOK_INCLUDE_DIR MinHook.h PATH_SUFFIXES include REQUIRED)
 
-# nlohmann_json
-pkg_check_modules(NLOHMANN_JSON nlohmann_json REQUIRED IMPORTED_TARGET)
+add_library(minhook::minhook STATIC IMPORTED)
+set_property(TARGET minhook::minhook PROPERTY IMPORTED_LOCATION ${MINHOOK_LIBRARY})
+target_include_directories(minhook::minhook INTERFACE ${MINHOOK_INCLUDE_DIR})

cmake/macros/common.cmake

@@ -13,3 +13,17 @@ elseif(UNIX)
         include(${CMAKE_MODULE_PATH}/macros/linux.cmake)
     endif()
 endif()
+
+# override find_package function
+macro(find_package)  # cmake-lint: disable=C0103
+    string(TOLOWER "${ARGV0}" ARGV0_LOWER)
+    if(
+        (("${ARGV0_LOWER}" STREQUAL "boost") AND DEFINED FETCH_CONTENT_BOOST_USED) OR
+        (("${ARGV0_LOWER}" STREQUAL "libevdev") AND DEFINED EXTERNAL_PROJECT_LIBEVDEV_USED)
+    )
+        # Do nothing, as the package has already been fetched
+    else()
+        # Call the original find_package function
+        _find_package(${ARGV})
+    endif()
+endmacro()

cmake/packaging/common.cmake

@@ -3,6 +3,10 @@
 # common cpack options
 set(CPACK_PACKAGE_NAME ${CMAKE_PROJECT_NAME})
 set(CPACK_PACKAGE_VENDOR "LizardByte")
+set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
+set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
+set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR})
+set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH})
 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})
@@ -12,10 +16,18 @@ set(CPACK_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/sunshine.png)
 set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}")
 set(CPACK_STRIP_FILES YES)
 
-#install common assets
+# install common assets
 install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/"
         DESTINATION "${SUNSHINE_ASSETS_DIR}"
         PATTERN "web" EXCLUDE)
+# copy assets to build directory, for running without install
+file(GLOB_RECURSE ALL_ASSETS
+        RELATIVE "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/*")
+list(FILTER ALL_ASSETS EXCLUDE REGEX "^web/.*$")  # Filter out the web directory
+foreach(asset ${ALL_ASSETS})  # Copy assets to build directory, excluding the web directory
+    file(COPY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/${asset}"
+            DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/assets")
+endforeach()
 
 # install built vite assets
 install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/assets/web"

cmake/packaging/linux.cmake

@@ -2,8 +2,17 @@
 
 install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/assets/"
         DESTINATION "${SUNSHINE_ASSETS_DIR}")
+
+# copy assets (excluding shaders) to build directory, for running without install
+file(COPY "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/assets/"
+        DESTINATION "${CMAKE_BINARY_DIR}/assets"
+        PATTERN "shaders" EXCLUDE)
+# use symbolic link for shaders directory
+file(CREATE_LINK "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/assets/shaders"
+        "${CMAKE_BINARY_DIR}/assets/shaders" COPY_ON_ERROR SYMBOLIC)
+
 if(${SUNSHINE_BUILD_APPIMAGE} OR ${SUNSHINE_BUILD_FLATPAK})
-    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules"
+    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/60-sunshine.rules"
             DESTINATION "${SUNSHINE_ASSETS_DIR}/udev/rules.d")
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service"
             DESTINATION "${SUNSHINE_ASSETS_DIR}/systemd/user")
@@ -11,24 +20,28 @@ else()
     find_package(Systemd)
     find_package(Udev)
 
-    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules"
-            DESTINATION "${UDEV_RULES_INSTALL_DIR}")
-    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service"
-            DESTINATION "${SYSTEMD_USER_UNIT_INSTALL_DIR}")
+    if(UDEV_FOUND)
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/60-sunshine.rules"
+                DESTINATION "${UDEV_RULES_INSTALL_DIR}")
+    endif()
+    if(SYSTEMD_FOUND)
+        install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service"
+                DESTINATION "${SYSTEMD_USER_UNIT_INSTALL_DIR}")
+    endif()
 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")
 
+# Apply setcap for RPM
+# https://github.com/coreos/rpm-ostree/discussions/5036#discussioncomment-10291071
+set(CPACK_RPM_USER_FILELIST "%caps(cap_sys_admin+p) ${SUNSHINE_EXECUTABLE_PATH}")
+
 # 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, \
@@ -38,24 +51,18 @@ set(CPACK_DEBIAN_PACKAGE_DEPENDS "\
             libpulse0, \
             libva2, \
             libva-drm2, \
-            libvdpau1, \
             libwayland-client0, \
             libx11-6, \
             miniupnpc, \
             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, \
             miniupnpc >= 2.2.4, \
@@ -63,24 +70,61 @@ set(CPACK_RPM_PACKAGE_REQUIRES "\
             openssl >= 3.0.2, \
             pulseaudio-libs >= 10.0")
 
+if(NOT BOOST_USE_STATIC)
+    set(CPACK_DEBIAN_PACKAGE_DEPENDS "\
+                ${CPACK_DEBIAN_PACKAGE_DEPENDS}, \
+                libboost-filesystem${Boost_VERSION}, \
+                libboost-locale${Boost_VERSION}, \
+                libboost-log${Boost_VERSION}, \
+                libboost-program-options${Boost_VERSION}")
+    set(CPACK_RPM_PACKAGE_REQUIRES "\
+                ${CPACK_RPM_PACKAGE_REQUIRES}, \
+                boost-filesystem >= ${Boost_VERSION}, \
+                boost-locale >= ${Boost_VERSION}, \
+                boost-log >= ${Boost_VERSION}, \
+                boost-program-options >= ${Boost_VERSION}")
+endif()
+
 # 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_DATAROOTDIR}/icons/hicolor/scalable/apps")
+if(NOT ${SUNSHINE_BUILD_FLATPAK})
+    install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
+            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/apps")
+else()
+    install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
+            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/apps"
+            RENAME "${PROJECT_FQDN}.svg")
+endif()
 
 # tray icon
 if(${SUNSHINE_TRAY} STREQUAL 1)
-    install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
-            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status"
-            RENAME "sunshine-tray.svg")
-    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-playing.svg"
-            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status")
-    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-pausing.svg"
-            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status")
-    install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-locked.svg"
-            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status")
+    if(NOT ${SUNSHINE_BUILD_FLATPAK})
+        install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status"
+                RENAME "sunshine-tray.svg")
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-playing.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status")
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-pausing.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status")
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-locked.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status")
+    else()
+        # flatpak icons must be prefixed with the app id or they will not be included in the flatpak
+        install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status"
+                RENAME "${PROJECT_FQDN}-tray.svg")
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-playing.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status"
+                RENAME "${PROJECT_FQDN}-playing.svg")
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-pausing.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status"
+                RENAME "${PROJECT_FQDN}-pausing.svg")
+        install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-locked.svg"
+                DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status"
+                RENAME "${PROJECT_FQDN}-locked.svg")
+    endif()
 
     set(CPACK_DEBIAN_PACKAGE_DEPENDS "\
                     ${CPACK_DEBIAN_PACKAGE_DEPENDS}, \
@@ -92,19 +136,13 @@ if(${SUNSHINE_TRAY} STREQUAL 1)
 endif()
 
 # desktop file
-# todo - validate desktop files with `desktop-file-validate`
-install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.desktop"
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_FQDN}.desktop"
         DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications")
-if(NOT ${SUNSHINE_BUILD_APPIMAGE})
-    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_terminal.desktop"
-            DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications")
-endif()
-if(${SUNSHINE_BUILD_FLATPAK})
-    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_kms.desktop"
+if(NOT ${SUNSHINE_BUILD_APPIMAGE} AND NOT ${SUNSHINE_BUILD_FLATPAK})
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_FQDN}.terminal.desktop"
             DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications")
 endif()
 
 # metadata file
-# todo - validate file with `appstream-util validate-relax`
-install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.appdata.xml"
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_FQDN}.metainfo.xml"
         DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/metainfo")

cmake/packaging/macos.cmake

@@ -10,15 +10,16 @@ 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}/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()
+
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/"
+        DESTINATION "${SUNSHINE_ASSETS_DIR}")
+# copy assets to build directory, for running without install
+file(COPY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/"
+        DESTINATION "${CMAKE_BINARY_DIR}/assets")

cmake/packaging/unix.cmake

@@ -1,8 +1,6 @@
 # unix specific packaging
 # put anything here that applies to both linux and macos
 
-include(GNUInstallDirs)
-
 # return here if building a macos package
 if(SUNSHINE_PACKAGE_MACOS)
     return()

cmake/packaging/windows.cmake

@@ -1,17 +1,28 @@
 # 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)
 
+# ViGEmBus installer
+set(VIGEMBUS_INSTALLER "${CMAKE_BINARY_DIR}/vigembus_installer.exe")
+file(DOWNLOAD
+        "https://github.com/nefarius/ViGEmBus/releases/download/v1.21.442.0/ViGEmBus_1.21.442_x64_x86_arm64.exe"
+        ${VIGEMBUS_INSTALLER}
+        SHOW_PROGRESS
+        EXPECTED_HASH SHA256=155c50f1eec07bdc28d2f61a3e3c2c6c132fee7328412de224695f89143316bc
+        TIMEOUT 60
+)
+install(FILES ${VIGEMBUS_INSTALLER}
+        DESTINATION "scripts"
+        RENAME "vigembus_installer.exe"
+        COMPONENT gamepad)
+
 # 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
@@ -21,6 +32,9 @@ install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/service/"
 install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/migration/"
         DESTINATION "scripts"
         COMPONENT assets)
+install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/path/"
+        DESTINATION "scripts"
+        COMPONENT assets)
 
 # Configurable options for the service
 install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/autostart/"
@@ -40,76 +54,21 @@ 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
+# copy assets (excluding shaders) to build directory, for running without install
+file(COPY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/assets/"
+        DESTINATION "${CMAKE_BINARY_DIR}/assets"
+        PATTERN "shaders" EXCLUDE)
+# use junction for shaders directory
+cmake_path(CONVERT "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/assets/shaders"
+        TO_NATIVE_PATH_LIST shaders_in_build_src_native)
+cmake_path(CONVERT "${CMAKE_BINARY_DIR}/assets/shaders" TO_NATIVE_PATH_LIST shaders_in_build_dest_native)
+execute_process(COMMAND cmd.exe /c mklink /J "${shaders_in_build_dest_native}" "${shaders_in_build_src_native}")
+
 set(CPACK_PACKAGE_ICON "${CMAKE_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-gamepad.bat\\\"'
-        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-service.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/en/latest/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)
 
@@ -150,3 +109,7 @@ set(CPACK_COMPONENT_FIREWALL_GROUP "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")
+
+# include specific packaging
+include(${CMAKE_MODULE_PATH}/packaging/windows_nsis.cmake)
+include(${CMAKE_MODULE_PATH}/packaging/windows_wix.cmake)

cmake/packaging/windows_nsis.cmake

@@ -0,0 +1,74 @@
+# NSIS Packaging
+# see options at: https://cmake.org/cmake/help/latest/cpack_gen/nsis.html
+
+set(CPACK_NSIS_INSTALLED_ICON_NAME "${PROJECT__DIR}\\\\${PROJECT_EXE}")
+
+# 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://docs.lizardbyte.dev/projects/sunshine'
+        nsExec::ExecToLog 'icacls \\\"$INSTDIR\\\" /reset'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\update-path.bat\\\" add'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\migrate-config.bat\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\add-firewall-rule.bat\\\"'
+        nsExec::ExecToLog \
+          'powershell.exe -ExecutionPolicy Bypass -File \\\"$INSTDIR\\\\scripts\\\\install-gamepad.ps1\\\"'
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-service.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\\\\${CMAKE_PROJECT_NAME}.exe\\\" --restore-nvprefs-undo'
+        MessageBox MB_YESNO|MB_ICONQUESTION \
+            'Do you want to remove Virtual Gamepad?' \
+            /SD IDNO IDNO NoGamepad
+            nsExec::ExecToLog \
+              'powershell.exe -ExecutionPolicy Bypass -File \\\"$INSTDIR\\\\scripts\\\\uninstall-gamepad.ps1\\\"'; \
+              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
+        nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\update-path.bat\\\" remove'
+        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}
+        SetOutPath '\$INSTDIR'
+        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://docs.lizardbyte.dev/projects/sunshine/latest/md_docs_2getting__started.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://docs.lizardbyte.dev/projects/sunshine" "Sunshine documentation"
+        "https://app.lizardbyte.dev" "LizardByte Web Site"
+        "https://app.lizardbyte.dev/support" "LizardByte Support")
+set(CPACK_NSIS_MANIFEST_DPI_AWARE true)

cmake/packaging/windows_wix.cmake

@@ -0,0 +1,4 @@
+# WIX Packaging
+# see options at: https://cmake.org/cmake/help/latest/cpack_gen/wix.html
+
+# TODO: Replace nsis with wix

cmake/prep/build_version.cmake

@@ -1,17 +1,34 @@
+# Set build variables if env variables are defined
+# These are used in configured files such as manifests for different packages
+if(DEFINED ENV{BRANCH})  # cmake-lint: disable=W0106
+    set(GITHUB_BRANCH $ENV{BRANCH})
+endif()
+if(DEFINED ENV{BUILD_VERSION})  # cmake-lint: disable=W0106
+    set(BUILD_VERSION $ENV{BUILD_VERSION})
+endif()
+if(DEFINED ENV{CLONE_URL})  # cmake-lint: disable=W0106
+    set(GITHUB_CLONE_URL $ENV{CLONE_URL})
+endif()
+if(DEFINED ENV{COMMIT})  # cmake-lint: disable=W0106
+    set(GITHUB_COMMIT $ENV{COMMIT})
+endif()
+if(DEFINED ENV{TAG})  # cmake-lint: disable=W0106
+    set(GITHUB_TAG $ENV{TAG})
+endif()
+
 # 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}")
+if((DEFINED ENV{BRANCH}) AND (DEFINED ENV{BUILD_VERSION}))  # cmake-lint: disable=W0106
+    if((DEFINED ENV{BRANCH}) AND (NOT $ENV{BUILD_VERSION} STREQUAL ""))
+        # If BRANCH is defined and BUILD_VERSION is not empty, then we are building from CI
+        # If BRANCH is master we are building a push/release build
+        MESSAGE("Got from CI '$ENV{BRANCH}' 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})
+        string(REGEX REPLACE "^v" "" PROJECT_VERSION ${PROJECT_VERSION})  # remove the v prefix if it exists
+        set(CMAKE_PROJECT_VERSION ${PROJECT_VERSION})  # cpack will use this to set the binary versions
     endif()
+else()
     # 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_SOURCE_DIR}")
@@ -19,7 +36,6 @@ else()
         #Get current Branch
         execute_process(
                 COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
-                #WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
                 OUTPUT_VARIABLE GIT_DESCRIBE_BRANCH
                 RESULT_VARIABLE GIT_DESCRIBE_ERROR_CODE
                 OUTPUT_STRIP_TRAILING_WHITESPACE
@@ -27,7 +43,6 @@ else()
         # Gather current commit
         execute_process(
                 COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
-                #WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
                 OUTPUT_VARIABLE GIT_DESCRIBE_VERSION
                 RESULT_VARIABLE GIT_DESCRIBE_ERROR_CODE
                 OUTPUT_STRIP_TRAILING_WHITESPACE
@@ -35,7 +50,6 @@ else()
         # Check if Dirty
         execute_process(
                 COMMAND ${GIT_EXECUTABLE} diff --quiet --exit-code
-                #WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
                 RESULT_VARIABLE GIT_IS_DIRTY
                 OUTPUT_STRIP_TRAILING_WHITESPACE
         )
@@ -56,3 +70,72 @@ else()
         MESSAGE(WARNING ": Git not found, cannot find git version")
     endif()
 endif()
+
+# set date variables
+set(PROJECT_YEAR "1990")
+set(PROJECT_MONTH "01")
+set(PROJECT_DAY "01")
+
+# Extract year, month, and day (do this AFTER version parsing)
+# Note: Cmake doesn't support "{}" regex syntax
+if(PROJECT_VERSION MATCHES "^([0-9][0-9][0-9][0-9])\\.([0-9][0-9][0-9][0-9]?)\\.([0-9]+)$")
+    message("Extracting year and month/day from PROJECT_VERSION: ${PROJECT_VERSION}")
+    # First capture group is the year
+    set(PROJECT_YEAR "${CMAKE_MATCH_1}")
+
+    # Second capture group contains month and day
+    set(MONTH_DAY "${CMAKE_MATCH_2}")
+
+    # Extract month (first 1-2 digits) and day (last 2 digits)
+    string(LENGTH "${MONTH_DAY}" MONTH_DAY_LENGTH)
+    if(MONTH_DAY_LENGTH EQUAL 3)
+        # Format: MDD (e.g., 703 = month 7, day 03)
+        string(SUBSTRING "${MONTH_DAY}" 0 1 PROJECT_MONTH)
+        string(SUBSTRING "${MONTH_DAY}" 1 2 PROJECT_DAY)
+    elseif(MONTH_DAY_LENGTH EQUAL 4)
+        # Format: MMDD (e.g., 1203 = month 12, day 03)
+        string(SUBSTRING "${MONTH_DAY}" 0 2 PROJECT_MONTH)
+        string(SUBSTRING "${MONTH_DAY}" 2 2 PROJECT_DAY)
+    endif()
+
+    # Ensure month is two digits
+    if(PROJECT_MONTH LESS 10 AND NOT PROJECT_MONTH MATCHES "^0")
+        set(PROJECT_MONTH "0${PROJECT_MONTH}")
+    endif()
+    # Ensure day is two digits
+    if(PROJECT_DAY LESS 10 AND NOT PROJECT_DAY MATCHES "^0")
+        set(PROJECT_DAY "0${PROJECT_DAY}")
+    endif()
+endif()
+
+# Parse PROJECT_VERSION to extract major, minor, and patch components
+if(PROJECT_VERSION MATCHES "([0-9]+)\\.([0-9]+)\\.([0-9]+)")
+    set(PROJECT_VERSION_MAJOR "${CMAKE_MATCH_1}")
+    set(CMAKE_PROJECT_VERSION_MAJOR "${CMAKE_MATCH_1}")
+
+    set(PROJECT_VERSION_MINOR "${CMAKE_MATCH_2}")
+    set(CMAKE_PROJECT_VERSION_MINOR "${CMAKE_MATCH_2}")
+
+    set(PROJECT_VERSION_PATCH "${CMAKE_MATCH_3}")
+    set(CMAKE_PROJECT_VERSION_PATCH "${CMAKE_MATCH_3}")
+endif()
+
+message("PROJECT_NAME: ${PROJECT_NAME}")
+message("PROJECT_VERSION: ${PROJECT_VERSION}")
+message("PROJECT_VERSION_MAJOR: ${PROJECT_VERSION_MAJOR}")
+message("PROJECT_VERSION_MINOR: ${PROJECT_VERSION_MINOR}")
+message("PROJECT_VERSION_PATCH: ${PROJECT_VERSION_PATCH}")
+message("CMAKE_PROJECT_VERSION: ${CMAKE_PROJECT_VERSION}")
+message("CMAKE_PROJECT_VERSION_MAJOR: ${CMAKE_PROJECT_VERSION_MAJOR}")
+message("CMAKE_PROJECT_VERSION_MINOR: ${CMAKE_PROJECT_VERSION_MINOR}")
+message("CMAKE_PROJECT_VERSION_PATCH: ${CMAKE_PROJECT_VERSION_PATCH}")
+message("PROJECT_YEAR: ${PROJECT_YEAR}")
+message("PROJECT_MONTH: ${PROJECT_MONTH}")
+message("PROJECT_DAY: ${PROJECT_DAY}")
+
+list(APPEND SUNSHINE_DEFINITIONS PROJECT_NAME="${PROJECT_NAME}")
+list(APPEND SUNSHINE_DEFINITIONS PROJECT_VERSION="${PROJECT_VERSION}")
+list(APPEND SUNSHINE_DEFINITIONS PROJECT_VERSION_MAJOR="${PROJECT_VERSION_MAJOR}")
+list(APPEND SUNSHINE_DEFINITIONS PROJECT_VERSION_MINOR="${PROJECT_VERSION_MINOR}")
+list(APPEND SUNSHINE_DEFINITIONS PROJECT_VERSION_PATCH="${PROJECT_VERSION_PATCH}")
+list(APPEND SUNSHINE_DEFINITIONS PROJECT_VERSION_COMMIT="${GITHUB_COMMIT}")

cmake/prep/init.cmake

@@ -0,0 +1,17 @@
+if (WIN32)
+elseif (APPLE)
+elseif (UNIX)
+    include(GNUInstallDirs)
+
+    if(NOT DEFINED SUNSHINE_EXECUTABLE_PATH)
+        set(SUNSHINE_EXECUTABLE_PATH "sunshine")
+    endif()
+
+    if(SUNSHINE_BUILD_FLATPAK)
+        set(SUNSHINE_SERVICE_START_COMMAND "ExecStart=flatpak run --command=sunshine ${PROJECT_FQDN}")
+        set(SUNSHINE_SERVICE_STOP_COMMAND "ExecStop=flatpak kill ${PROJECT_FQDN}")
+    else()
+        set(SUNSHINE_SERVICE_START_COMMAND "ExecStart=${SUNSHINE_EXECUTABLE_PATH}")
+        set(SUNSHINE_SERVICE_STOP_COMMAND "")
+    endif()
+endif()

cmake/prep/options.cmake

@@ -1,17 +1,43 @@
+# Publisher Metadata
+set(SUNSHINE_PUBLISHER_NAME "Third Party Publisher"
+        CACHE STRING "The name of the publisher (not developer) of the application.")
+set(SUNSHINE_PUBLISHER_WEBSITE ""
+        CACHE STRING "The URL of the publisher's website.")
+set(SUNSHINE_PUBLISHER_ISSUE_URL "https://app.lizardbyte.dev/support"
+        CACHE STRING "The URL of the publisher's support site or issue tracker.
+        If you provide a modified version of Sunshine, we kindly request that you use your own url.")
+
+option(BUILD_DOCS "Build documentation" ON)
+option(BUILD_TESTS "Build tests" ON)
+option(NPM_OFFLINE "Use offline npm packages. You must ensure packages are in your npm cache." OFF)
+
 option(BUILD_WERROR "Enable -Werror flag." OFF)
 
 # 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)
 
 option(SUNSHINE_SYSTEM_WAYLAND_PROTOCOLS "Use system installation of wayland-protocols rather than the submodule." OFF)
 
+if(APPLE)
+    option(BOOST_USE_STATIC "Use static boost libraries." OFF)
+else()
+    option(BOOST_USE_STATIC "Use static boost libraries." ON)
+endif()
+
+option(CUDA_FAIL_ON_MISSING "Fail the build if CUDA is not found." ON)
 option(CUDA_INHERIT_COMPILE_OPTIONS
         "When building CUDA code, inherit compile options from the the main project. You may want to disable this if
         your IDE throws errors about unknown flags after running cmake." ON)
 
+if(UNIX)
+    option(SUNSHINE_BUILD_HOMEBREW
+            "Enable a Homebrew build." OFF)
+    option(SUNSHINE_CONFIGURE_HOMEBREW
+            "Configure Homebrew formula. Recommended to use with SUNSHINE_CONFIGURE_ONLY" OFF)
+endif()
+
 if(APPLE)
     option(SUNSHINE_CONFIGURE_PORTFILE
             "Configure macOS Portfile. Recommended to use with SUNSHINE_CONFIGURE_ONLY" OFF)

cmake/prep/special_package_configuration.cmake

@@ -1,22 +1,28 @@
-if (APPLE)
+if(UNIX)
+    if(${SUNSHINE_CONFIGURE_HOMEBREW})
+        configure_file(packaging/sunshine.rb sunshine.rb @ONLY)
+    endif()
+endif()
+
+if(APPLE)
     if(${SUNSHINE_CONFIGURE_PORTFILE})
         configure_file(packaging/macos/Portfile Portfile @ONLY)
     endif()
-elseif (UNIX)
+elseif(UNIX)
     # configure the .desktop file
+    set(SUNSHINE_DESKTOP_ICON "sunshine")
     if(${SUNSHINE_BUILD_APPIMAGE})
-        configure_file(packaging/linux/AppImage/sunshine.desktop sunshine.desktop @ONLY)
+        configure_file(packaging/linux/AppImage/${PROJECT_FQDN}.desktop ${PROJECT_FQDN}.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)
+        set(SUNSHINE_DESKTOP_ICON "${PROJECT_FQDN}")
+        configure_file(packaging/linux/flatpak/${PROJECT_FQDN}.desktop ${PROJECT_FQDN}.desktop @ONLY)
     else()
-        configure_file(packaging/linux/sunshine.desktop sunshine.desktop @ONLY)
-        configure_file(packaging/linux/sunshine_terminal.desktop sunshine_terminal.desktop @ONLY)
+        configure_file(packaging/linux/${PROJECT_FQDN}.desktop ${PROJECT_FQDN}.desktop @ONLY)
+        configure_file(packaging/linux/${PROJECT_FQDN}.terminal.desktop ${PROJECT_FQDN}.terminal.desktop @ONLY)
     endif()
 
     # configure metadata file
-    configure_file(packaging/linux/sunshine.appdata.xml sunshine.appdata.xml @ONLY)
+    configure_file(packaging/linux/${PROJECT_FQDN}.metainfo.xml ${PROJECT_FQDN}.metainfo.xml @ONLY)
 
     # configure service
     configure_file(packaging/linux/sunshine.service.in sunshine.service @ONLY)
@@ -24,11 +30,16 @@ elseif (UNIX)
     # configure the arch linux pkgbuild
     if(${SUNSHINE_CONFIGURE_PKGBUILD})
         configure_file(packaging/linux/Arch/PKGBUILD PKGBUILD @ONLY)
+        configure_file(packaging/linux/Arch/sunshine.install sunshine.install @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)
+        configure_file(packaging/linux/flatpak/${PROJECT_FQDN}.yml ${PROJECT_FQDN}.yml @ONLY)
+        file(COPY packaging/linux/flatpak/deps/ DESTINATION ${CMAKE_BINARY_DIR})
+        file(COPY packaging/linux/flatpak/modules DESTINATION ${CMAKE_BINARY_DIR})
+        file(COPY generated-sources.json DESTINATION ${CMAKE_BINARY_DIR})
+        file(COPY package-lock.json DESTINATION ${CMAKE_BINARY_DIR})
     endif()
 endif()
 

cmake/targets/common.cmake

@@ -2,6 +2,9 @@
 # this file will also load platform specific macros
 
 add_executable(sunshine ${SUNSHINE_TARGET_FILES})
+foreach(dep ${SUNSHINE_TARGET_DEPENDENCIES})
+    add_dependencies(sunshine ${dep})  # compile these before sunshine
+endforeach()
 
 # platform specific target definitions
 if(WIN32)
@@ -24,7 +27,7 @@ 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
+set_target_properties(sunshine PROPERTIES CXX_STANDARD 23
         VERSION ${PROJECT_VERSION}
         SOVERSION ${PROJECT_VERSION_MAJOR})
 
@@ -37,8 +40,89 @@ endif()
 
 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
 
+# Homebrew build fails the vite build if we set these environment variables
+if(${SUNSHINE_BUILD_HOMEBREW})
+    set(NPM_SOURCE_ASSETS_DIR "")
+    set(NPM_ASSETS_DIR "")
+    set(NPM_BUILD_HOMEBREW "true")
+else()
+    set(NPM_SOURCE_ASSETS_DIR ${SUNSHINE_SOURCE_ASSETS_DIR})
+    set(NPM_ASSETS_DIR ${CMAKE_BINARY_DIR})
+    set(NPM_BUILD_HOMEBREW "")
+endif()
+
 #WebUI build
+find_program(NPM npm REQUIRED)
+
+if (NPM_OFFLINE)
+    set(NPM_INSTALL_FLAGS "--offline")
+else()
+    set(NPM_INSTALL_FLAGS "")
+endif()
+
 add_custom_target(web-ui ALL
         WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
         COMMENT "Installing NPM Dependencies and Building the Web UI"
-        COMMAND bash -c \"npm install && SUNSHINE_SOURCE_ASSETS_DIR=${SUNSHINE_SOURCE_ASSETS_DIR} SUNSHINE_ASSETS_DIR=${CMAKE_BINARY_DIR} npm run build\") # cmake-lint: disable=C0301
+        COMMAND "$<$<BOOL:${WIN32}>:cmd;/C>" "${NPM}" install ${NPM_INSTALL_FLAGS}
+        COMMAND "${CMAKE_COMMAND}" -E env "SUNSHINE_BUILD_HOMEBREW=${NPM_BUILD_HOMEBREW}" "SUNSHINE_SOURCE_ASSETS_DIR=${NPM_SOURCE_ASSETS_DIR}" "SUNSHINE_ASSETS_DIR=${NPM_ASSETS_DIR}" "$<$<BOOL:${WIN32}>:cmd;/C>" "${NPM}" run build  # cmake-lint: disable=C0301
+        COMMAND_EXPAND_LISTS
+        VERBATIM)
+
+# docs
+if(BUILD_DOCS)
+    add_subdirectory(third-party/doxyconfig docs)
+endif()
+
+# tests
+if(BUILD_TESTS)
+    add_subdirectory(tests)
+endif()
+
+# custom compile flags, must be after adding tests
+
+if (NOT BUILD_TESTS)
+    set(TEST_DIR "")
+else()
+    set(TEST_DIR "${CMAKE_SOURCE_DIR}/tests")
+endif()
+
+# src/upnp
+set_source_files_properties("${CMAKE_SOURCE_DIR}/src/upnp.cpp"
+        DIRECTORY "${CMAKE_SOURCE_DIR}" "${TEST_DIR}"
+        PROPERTIES COMPILE_FLAGS -Wno-pedantic)
+
+# third-party/nanors
+set_source_files_properties("${CMAKE_SOURCE_DIR}/src/rswrapper.c"
+        DIRECTORY "${CMAKE_SOURCE_DIR}" "${TEST_DIR}"
+        PROPERTIES COMPILE_FLAGS "-ftree-vectorize -funroll-loops")
+
+# third-party/ViGEmClient
+set(VIGEM_COMPILE_FLAGS "")
+string(APPEND VIGEM_COMPILE_FLAGS "-Wno-unknown-pragmas ")
+string(APPEND VIGEM_COMPILE_FLAGS "-Wno-misleading-indentation ")
+string(APPEND VIGEM_COMPILE_FLAGS "-Wno-class-memaccess ")
+string(APPEND VIGEM_COMPILE_FLAGS "-Wno-unused-function ")
+string(APPEND VIGEM_COMPILE_FLAGS "-Wno-unused-variable ")
+set_source_files_properties("${CMAKE_SOURCE_DIR}/third-party/ViGEmClient/src/ViGEmClient.cpp"
+        DIRECTORY "${CMAKE_SOURCE_DIR}" "${TEST_DIR}"
+        PROPERTIES
+        COMPILE_DEFINITIONS "UNICODE=1;ERROR_INVALID_DEVICE_OBJECT_PARAMETER=650"
+        COMPILE_FLAGS ${VIGEM_COMPILE_FLAGS})
+
+# src/nvhttp
+string(TOUPPER "x${CMAKE_BUILD_TYPE}" BUILD_TYPE)
+if("${BUILD_TYPE}" STREQUAL "XDEBUG")
+    if(WIN32)
+        if (NOT BUILD_TESTS)
+            set_source_files_properties("${CMAKE_SOURCE_DIR}/src/nvhttp.cpp"
+                    DIRECTORY "${CMAKE_SOURCE_DIR}"
+                    PROPERTIES COMPILE_FLAGS -O2)
+        else()
+            set_source_files_properties("${CMAKE_SOURCE_DIR}/src/nvhttp.cpp"
+                    DIRECTORY "${CMAKE_SOURCE_DIR}" "${CMAKE_SOURCE_DIR}/tests"
+                    PROPERTIES COMPILE_FLAGS -O2)
+        endif()
+    endif()
+else()
+    add_definitions(-DNDEBUG)
+endif()

cmake/targets/windows.cmake

@@ -3,4 +3,6 @@ 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
+        $<TARGET_OBJECTS:sunshine_rc_object>
+        Windowsapp.lib
         Wtsapi32.lib)

codecov.yml

@@ -0,0 +1,19 @@
+---
+codecov:
+  branch: master
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 10%
+
+comment:
+  layout: "diff, flags, files"
+  behavior: default
+  require_changes: false  # if true: only post the comment if coverage changes
+
+ignore:
+  - "tests"
+  - "third-party"

crowdin.yml

@@ -1,7 +1,8 @@
 ---
 "base_path": "."
 "base_url": "https://api.crowdin.com"  # optional (for Crowdin Enterprise only)
-"preserve_hierarchy": false  # flatten tree on crowdin
+"preserve_hierarchy": true  # false will flatten tree on crowdin, but doesn't work with dest option
+"pull_request_title": "chore(l10n): update translations"
 "pull_request_labels": [
   "crowdin",
   "l10n"
@@ -10,13 +11,23 @@
 "files": [
   {
     "source": "/locale/*.po",
+    "dest": "/%original_file_name%",
     "translation": "/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%",
     "languages_mapping": {
       "two_letters_code": {
         # map non-two letter codes here, left side is crowdin designation, right side is babel designation
         "en-GB": "en_GB",
-        "en-US": "en_US"
+        "en-US": "en_US",
+        "pt-BR": "pt_BR",
+        "zh-TW": "zh_TW"
       }
-    }
+    },
+    "update_option": "update_as_unapproved"
+  },
+  {
+    "source": "/src_assets/common/assets/web/public/assets/locale/en.json",
+    "dest": "/sunshine.json",
+    "translation": "/src_assets/common/assets/web/public/assets/locale/%two_letters_code%.%file_extension%",
+    "update_option": "update_as_unapproved"
   }
 ]

docker/archlinux.dockerfile

@@ -1,26 +1,23 @@
-# syntax=docker/dockerfile:1.4
+# syntax=docker/dockerfile:1
 # artifacts: true
 # platforms: linux/amd64
 # archlinux does not have an arm64 base image
 # no-cache-filters: artifacts,sunshine
-ARG BASE=archlinux
+ARG BASE=archlinux/archlinux
 ARG TAG=base-devel
 FROM ${BASE}:${TAG} AS sunshine-base
 
-# install dependencies
+# Update keyring to avoid signature errors, and update system
 RUN <<_DEPS
 #!/bin/bash
 set -e
-pacman -Syu --disable-download-timeout --needed --noconfirm \
+pacman -Syy --disable-download-timeout --needed --noconfirm \
   archlinux-keyring
+pacman -Syu --disable-download-timeout --noconfirm
+pacman -Scc --noconfirm
 _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
+FROM sunshine-base AS sunshine-build
 
 ARG BRANCH
 ARG BUILD_VERSION
@@ -31,22 +28,32 @@ ARG CLONE_URL
 ENV BRANCH=${BRANCH}
 ENV BUILD_VERSION=${BUILD_VERSION}
 ENV COMMIT=${COMMIT}
+ENV CLONE_URL=${CLONE_URL}
 
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
-# install dependencies
-# cuda, libcap, and libdrm are optional dependencies for PKGBUILD
-RUN <<_DEPS
+
+# hadolint ignore=SC2016
+RUN <<_SETUP
 #!/bin/bash
 set -e
+
+# Setup builder user, arch prevents running makepkg as root
+useradd -m builder
+echo 'builder ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+# patch the build flags
+sed -i 's,#MAKEFLAGS="-j2",MAKEFLAGS="-j$(nproc)",g' /etc/makepkg.conf
+
+# install dependencies
 pacman -Syu --disable-download-timeout --needed --noconfirm \
   base-devel \
   cmake \
   cuda \
   git \
-  libcap \
-  libdrm \
-  namcap
-_DEPS
+  namcap \
+  xorg-server-xvfb
+pacman -Scc --noconfirm
+_SETUP
 
 # Setup builder user
 USER builder
@@ -62,53 +69,64 @@ WORKDIR /build/sunshine/build
 RUN <<_MAKE
 #!/bin/bash
 set -e
-if [[ "${BUILD_VERSION}" == '' ]]; then
+
+sub_version=""
+if [[ "${BRANCH}" != "master" ]]; then
   sub_version=".r${COMMIT}"
-else
-  sub_version=""
 fi
+
 cmake \
+  -DSUNSHINE_CONFIGURE_ONLY=ON \
   -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 .
+RUN <<_PACKAGE
+mv /build/sunshine/build/PKGBUILD .
+mv /build/sunshine/build/sunshine.install .
+makepkg --printsrcinfo > .SRCINFO
+_PACKAGE
+
+# create a PKGBUILD archive
+USER root
+RUN <<_REPO
+#!/bin/bash
+set -e
+tar -czf /build/sunshine/sunshine.pkg.tar.gz .
+_REPO
 
 # namcap and build PKGBUILD file
+USER builder
 RUN <<_PKGBUILD
 #!/bin/bash
 set -e
+# shellcheck source=/dev/null
+source /etc/profile  # ensure cuda is in the PATH
+export DISPLAY=:1
+Xvfb ${DISPLAY} -screen 0 1024x768x24 &
 namcap -i PKGBUILD
 makepkg -si --noconfirm
+rm -f /build/sunshine/pkg/sunshine-debug*.pkg.tar.zst
 ls -a
 _PKGBUILD
 
-FROM scratch as artifacts
+FROM sunshine-base AS sunshine
 
-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 /
+# artifacts to be extracted in CI
+COPY --link --from=sunshine-build /build/sunshine/pkg/sunshine*.pkg.tar.zst /artifacts/sunshine.pkg.tar.zst
+COPY --link --from=sunshine-build /build/sunshine/sunshine.pkg.tar.gz /artifacts/sunshine.pkg.tar.gz
 
 # 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
+pacman -Scc --noconfirm
 _INSTALL_SUNSHINE
 
 # network setup
@@ -131,10 +149,6 @@ ENV HOME=/home/$UNAME
 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

docker/clion-toolchain.dockerfile

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.4
+# syntax=docker/dockerfile:1
 # artifacts: false
 # platforms: linux/amd64
 # platforms_pr: linux/amd64
@@ -9,13 +9,17 @@ FROM ${BASE}:${TAG} AS toolchain-base
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-FROM toolchain-base as toolchain
+FROM toolchain-base AS toolchain
 
 ARG TARGETPLATFORM
 RUN echo "target_platform: ${TARGETPLATFORM}"
 
+ENV DISPLAY=:0
+
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
 # install dependencies
+# hadolint ignore=SC1091
 RUN <<_DEPS
 #!/bin/bash
 set -e
@@ -24,16 +28,13 @@ apt-get install -y --no-install-recommends \
   build-essential \
   cmake=3.22.* \
   ca-certificates \
+  doxygen \
   gcc=4:11.2.* \
   g++=4:11.2.* \
   gdb \
   git \
+  graphviz \
   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 \
@@ -45,7 +46,6 @@ apt-get install -y --no-install-recommends \
   libpulse-dev \
   libssl-dev \
   libva-dev \
-  libvdpau-dev \
   libwayland-dev \
   libx11-dev \
   libxcb-shm0-dev \
@@ -55,27 +55,19 @@ apt-get install -y --no-install-recommends \
   libxrandr-dev \
   libxtst-dev \
   udev \
-  wget
-if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
-  apt-get install -y --no-install-recommends \
-    libmfx-dev
-fi
+  wget \
+  x11-xserver-utils \
+  xvfb
 apt-get clean
 rm -rf /var/lib/apt/lists/*
-_DEPS
 
-#Install Node
-# hadolint ignore=SC1091
-RUN <<_INSTALL_NODE
-#!/bin/bash
-set -e
-node_version="20.9.0"
-wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
+# Install Node
+wget --max-redirect=0 -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
 source "$HOME/.nvm/nvm.sh"
-nvm install "$node_version"
-nvm use "$node_version"
-nvm alias default "$node_version"
-_INSTALL_NODE
+nvm install node
+nvm use node
+nvm alias default node
+_DEPS
 
 # install cuda
 WORKDIR /build/cuda
@@ -98,3 +90,28 @@ chmod a+x ./cuda.run
 ./cuda.run --silent --toolkit --toolkitpath=/usr/local --no-opengl-libs --no-man-page --no-drm
 rm ./cuda.run
 _INSTALL_CUDA
+
+WORKDIR /
+# Write a shell script that starts Xvfb and then runs a shell
+RUN <<_ENTRYPOINT
+#!/bin/bash
+set -e
+cat <<EOF > /entrypoint.sh
+#!/bin/bash
+Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+if [ "\$#" -eq 0 ]; then
+  exec "/bin/bash"
+else
+  exec "\$@"
+fi
+EOF
+
+# Make the script executable
+chmod +x /entrypoint.sh
+
+# Note about CLion
+echo "ATTENTION: CLion will override the entrypoint, you can disable this in the toolchain settings"
+_ENTRYPOINT
+
+# Use the shell script as the entrypoint
+ENTRYPOINT ["/entrypoint.sh"]

docker/debian-bookworm.dockerfile

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.4
+# syntax=docker/dockerfile:1
 # artifacts: true
 # platforms: linux/amd64,linux/arm64/v8
 # platforms_pr: linux/amd64
@@ -9,10 +9,7 @@ FROM ${BASE}:${TAG} AS sunshine-base
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-FROM sunshine-base as sunshine-build
-
-ARG TARGETPLATFORM
-RUN echo "target_platform: ${TARGETPLATFORM}"
+FROM sunshine-base AS sunshine-build
 
 ARG BRANCH
 ARG BUILD_VERSION
@@ -24,112 +21,47 @@ 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 \
-  libminiupnpc-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 \
-  udev \
-  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 build directory
-WORKDIR /build/sunshine/build
-
 # cmake and cpack
-RUN <<_MAKE
+RUN <<_BUILD
 #!/bin/bash
 set -e
-cmake \
-  -DBUILD_WERROR=ON \
-  -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
+chmod +x ./scripts/linux_build.sh
+./scripts/linux_build.sh \
+  --publisher-name='LizardByte' \
+  --publisher-website='https://app.lizardbyte.dev' \
+  --publisher-issue-url='https://app.lizardbyte.dev/support' \
+  --sudo-off
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_BUILD
+
+# run tests
+WORKDIR /build/sunshine/build/tests
+# hadolint ignore=SC1091
+RUN <<_TEST
+#!/bin/bash
+set -e
+export DISPLAY=:1
+Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+./test_sunshine --gtest_color=yes
+_TEST
+
+FROM sunshine-base AS sunshine
 
-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
+# artifacts to be extracted in CI
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /artifacts/sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
 
 # copy deb from builder
-COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine.deb
 
 # install sunshine
 RUN <<_INSTALL_SUNSHINE

docker/debian-bullseye.dockerfile

@@ -1,189 +0,0 @@
-# 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 \
-  ca-certificates \
-  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 \
-  libminiupnpc-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 \
-  udev \
-  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 Node
-# hadolint ignore=SC1091
-RUN <<_INSTALL_NODE
-#!/bin/bash
-set -e
-wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
-source "$HOME/.nvm/nvm.sh"
-nvm install 20.9.0
-nvm use 20.9.0
-_INSTALL_NODE
-
-# 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 build directory
-WORKDIR /build/sunshine/build
-
-# cmake and cpack
-# hadolint ignore=SC1091
-RUN <<_MAKE
-#!/bin/bash
-set -e
-#Set Node version
-source "$HOME/.nvm/nvm.sh"
-nvm use 20.9.0
-cmake \
-  -DBUILD_WERROR=ON \
-  -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-38.dockerfile

@@ -1,174 +0,0 @@
-# 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 \
-  miniupnpc-devel \
-  nodejs \
-  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 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 \
-  -DBUILD_WERROR=ON \
-  -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/fedora-39.dockerfile

@@ -1,174 +0,0 @@
-# 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=39
-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.81.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 \
-  miniupnpc-devel \
-  nodejs \
-  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 39
-## 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 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 \
-  -DBUILD_WERROR=ON \
-  -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

@@ -1,225 +0,0 @@
-# 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 \
-  ca-certificates \
-  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 \
-  libminiupnpc-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 \
-  udev \
-  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 Node
-# hadolint ignore=SC1091
-RUN <<_INSTALL_NODE
-#!/bin/bash
-set -e
-wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
-source "$HOME/.nvm/nvm.sh"
-nvm install 20.9.0
-nvm use 20.9.0
-_INSTALL_NODE
-
-# 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 build directory
-WORKDIR /build/sunshine/build
-
-# cmake and cpack
-# hadolint ignore=SC1091
-RUN <<_MAKE
-#!/bin/bash
-set -e
-#Set Node version
-source "$HOME/.nvm/nvm.sh"
-nvm use 20.9.0
-cmake \
-  -DBUILD_WERROR=ON \
-  -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

@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.4
+# syntax=docker/dockerfile:1
 # artifacts: true
 # platforms: linux/amd64,linux/arm64/v8
 # platforms_pr: linux/amd64
@@ -9,10 +9,7 @@ FROM ${BASE}:${TAG} AS sunshine-base
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-FROM sunshine-base as sunshine-build
-
-ARG TARGETPLATFORM
-RUN echo "target_platform: ${TARGETPLATFORM}"
+FROM sunshine-base AS sunshine-build
 
 ARG BRANCH
 ARG BUILD_VERSION
@@ -24,127 +21,47 @@ 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.* \
-  ca-certificates \
-  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 \
-  libminiupnpc-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 \
-  udev \
-  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 Node
-# hadolint ignore=SC1091
-RUN <<_INSTALL_NODE
-#!/bin/bash
-set -e
-wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
-source "$HOME/.nvm/nvm.sh"
-nvm install 20.9.0
-nvm use 20.9.0
-_INSTALL_NODE
-
-# 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 build directory
-WORKDIR /build/sunshine/build
-
 # cmake and cpack
-# hadolint ignore=SC1091
-RUN <<_MAKE
+RUN <<_BUILD
 #!/bin/bash
 set -e
-#Set Node version
-source "$HOME/.nvm/nvm.sh"
-nvm use 20.9.0
-#Actually build
-cmake \
-  -DBUILD_WERROR=ON \
-  -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
+chmod +x ./scripts/linux_build.sh
+./scripts/linux_build.sh \
+  --publisher-name='LizardByte' \
+  --publisher-website='https://app.lizardbyte.dev' \
+  --publisher-issue-url='https://app.lizardbyte.dev/support' \
+  --sudo-off
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_BUILD
+
+# run tests
+WORKDIR /build/sunshine/build/tests
+# hadolint ignore=SC1091
+RUN <<_TEST
+#!/bin/bash
+set -e
+export DISPLAY=:1
+Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+./test_sunshine --gtest_color=yes
+_TEST
+
+FROM sunshine-base AS sunshine
 
-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
+# artifacts to be extracted in CI
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /artifacts/sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
 
 # copy deb from builder
-COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine.deb
 
 # install sunshine
 RUN <<_INSTALL_SUNSHINE

docker/ubuntu-24.04.dockerfile

@@ -0,0 +1,107 @@
+# syntax=docker/dockerfile:1
+# artifacts: true
+# platforms: linux/amd64,linux/arm64/v8
+# platforms_pr: linux/amd64
+# no-cache-filters: sunshine-base,artifacts,sunshine
+ARG BASE=ubuntu
+ARG TAG=24.04
+FROM ${BASE}:${TAG} AS sunshine-base
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+FROM sunshine-base AS sunshine-build
+
+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"]
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# cmake and cpack
+RUN <<_BUILD
+#!/bin/bash
+set -e
+chmod +x ./scripts/linux_build.sh
+./scripts/linux_build.sh \
+  --publisher-name='LizardByte' \
+  --publisher-website='https://app.lizardbyte.dev' \
+  --publisher-issue-url='https://app.lizardbyte.dev/support' \
+  --sudo-off
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_BUILD
+
+# run tests
+WORKDIR /build/sunshine/build/tests
+# hadolint ignore=SC1091
+RUN <<_TEST
+#!/bin/bash
+set -e
+export DISPLAY=:1
+Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+./test_sunshine --gtest_color=yes
+_TEST
+
+FROM sunshine-base AS sunshine
+
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+
+# artifacts to be extracted in CI
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /artifacts/sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
+
+# copy deb from builder
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_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=1001
+ENV PGID=${PGID}
+ARG PUID=1001
+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/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.js

@@ -0,0 +1,131 @@
+function generateExamples(endpoint, method, body = null) {
+  let curlBodyString = '';
+  let psBodyString = '';
+
+  if (body) {
+    const curlJsonString = JSON.stringify(body).replace(/"/g, '\\"');
+    curlBodyString = ` -d "${curlJsonString}"`;
+    psBodyString = `-Body (ConvertTo-Json ${JSON.stringify(body)})`;
+  }
+
+  return {
+    cURL: `curl -u user:pass -H "Content-Type: application/json" -X ${method.trim()} -k https://localhost:47990${endpoint.trim()}${curlBodyString}`,
+    Python: `import json
+import requests
+from requests.auth import HTTPBasicAuth
+
+requests.${method.trim().toLowerCase()}(
+    auth=HTTPBasicAuth('user', 'pass'),
+    url='https://localhost:47990${endpoint.trim()}',
+    verify=False,${body ? `\n    json=${JSON.stringify(body)},` : ''}
+).json()`,
+    JavaScript: `fetch('https://localhost:47990${endpoint.trim()}', {
+  method: '${method.trim()}',
+  headers: {
+    'Authorization': 'Basic ' + btoa('user:pass'),
+    'Content-Type': 'application/json',
+  }${body ? `,\n  body: JSON.stringify(${JSON.stringify(body)}),` : ''}
+})
+.then(response => response.json())
+.then(data => console.log(data));`,
+    PowerShell: `Invoke-RestMethod \`
+  -SkipCertificateCheck \`
+  -ContentType 'application/json' \`
+  -Uri 'https://localhost:47990${endpoint.trim()}' \`
+  -Method ${method.trim()} \`
+  -Headers @{Authorization = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes('user:pass'))}
+  ${psBodyString}`
+  };
+}
+
+function hashString(str) {
+  let hash = 0;
+  for (let i = 0; i < str.length; i++) {
+    const char = str.charCodeAt(i);
+    hash = (hash << 5) - hash + char;
+    hash |= 0; // Convert to 32bit integer
+  }
+  return hash;
+}
+
+function createTabs(examples) {
+  const languages = Object.keys(examples);
+  let tabs = '<div class="tabs-overview-container"><div class="tabs-overview">';
+  let content = '<div class="tab-content">';
+
+  languages.forEach((lang, index) => {
+    const hash = hashString(examples[lang]);
+    tabs += `<button class="tab-button ${index === 0 ? 'active' : ''}" onclick="openTab(event, '${lang}')"><b class="tab-title" title=" ${lang} "> ${lang} </b></button>`;
+    content += `<div id="${lang}" class="tabcontent" style="display: ${index === 0 ? 'block' : 'none'};">
+                  <div class="doxygen-awesome-fragment-wrapper">
+                    <div class="fragment">
+                      ${examples[lang].split('\n').map(line => `<div class="line">${line}</div>`).join('')}
+                    </div>
+                    <doxygen-awesome-fragment-copy-button id="copy-button-${lang}-${hash}" title="Copy to clipboard">
+                      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24">
+                        <path d="M0 0h24v24H0V0z" fill="none"></path>
+                        <path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"></path>
+                      </svg>
+                    </doxygen-awesome-fragment-copy-button>
+                  </div>
+                </div>`;
+  });
+
+  tabs += '</div></div>';
+  content += '</div>';
+
+  setTimeout(() => {
+    languages.forEach((lang, index) => {
+      const hash = hashString(examples[lang]);
+      const copyButton = document.getElementById(`copy-button-${lang}-${hash}`);
+      copyButton.addEventListener('click', copyContent);
+    });
+  }, 0);
+
+  return tabs + content;
+}
+
+function copyContent() {
+  const content = this.previousElementSibling.cloneNode(true);
+  if (content instanceof Element) {
+    // filter out line number from file listings
+    content.querySelectorAll(".lineno, .ttc").forEach((node) => {
+      node.remove();
+    });
+    let textContent = Array.from(content.querySelectorAll('.line'))
+      .map(line => line.innerText)
+      .join('\n')
+      .trim(); // Join lines with newline characters and trim leading/trailing whitespace
+    navigator.clipboard.writeText(textContent);
+    this.classList.add("success");
+    this.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`;
+    window.setTimeout(() => {
+      this.classList.remove("success");
+      this.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`;
+    }, 980);
+  } else {
+    console.error('Failed to copy: content is not a DOM element');
+  }
+}
+
+function openTab(evt, lang) {
+  const tabcontent = document.getElementsByClassName("tabcontent");
+  for (const content of tabcontent) {
+    content.style.display = "none";
+  }
+
+  const tablinks = document.getElementsByClassName("tab-button");
+  for (const link of tablinks) {
+    link.className = link.className.replace(" active", "");
+  }
+
+  const selectedTabs = document.querySelectorAll(`#${lang}`);
+  for (const tab of selectedTabs) {
+    tab.style.display = "block";
+  }
+
+  const selectedButtons = document.querySelectorAll(`.tab-button[onclick*="${lang}"]`);
+  for (const button of selectedButtons) {
+    button.className += " active";
+  }
+}

docs/api.md

@@ -0,0 +1,71 @@
+# API
+
+Sunshine has a RESTful API which can be used to interact with the service.
+
+Unless otherwise specified, authentication is required for all API calls. You can authenticate using
+basic authentication with the admin username and password.
+
+@htmlonly
+<script src="api.js"></script>
+@endhtmlonly
+
+## GET /api/apps
+@copydoc confighttp::getApps()
+
+## POST /api/apps
+@copydoc confighttp::saveApp()
+
+## POST /api/apps/close
+@copydoc confighttp::closeApp()
+
+## DELETE /api/apps/{index}
+@copydoc confighttp::deleteApp()
+
+## GET /api/clients/list
+@copydoc confighttp::getClients()
+
+## POST /api/clients/unpair
+@copydoc confighttp::unpair()
+
+## POST /api/clients/unpair-all
+@copydoc confighttp::unpairAll()
+
+## GET /api/config
+@copydoc confighttp::getConfig()
+
+## GET /api/configLocale
+@copydoc confighttp::getLocale()
+
+## POST /api/config
+@copydoc confighttp::saveConfig()
+
+## POST /api/covers/upload
+@copydoc confighttp::uploadCover()
+
+## GET /api/logs
+@copydoc confighttp::getLogs()
+
+## POST /api/password
+@copydoc confighttp::savePassword()
+
+## POST /api/pin
+@copydoc confighttp::savePin()
+
+## POST /api/reset-display-device-persistence
+@copydoc confighttp::resetDisplayDevicePersistence()
+
+## POST /api/restart
+@copydoc confighttp::restart()
+
+<div class="section_buttons">
+
+| Previous                                    |                                  Next |
+|:--------------------------------------------|--------------------------------------:|
+| [Performance Tuning](performance_tuning.md) | [Troubleshooting](troubleshooting.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/app_examples.md

@@ -0,0 +1,350 @@
+# 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).}
+
+@note{When a working directory is not specified, it defaults to the folder where the target application resides.}
+
+
+## Common Examples
+
+### Desktop
+
+| Field            | Value                      |
+|------------------|----------------------------|
+| Application Name | @code{}Desktop@endcode     |
+| Image            | @code{}desktop.png@endcode |
+
+### 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.}
+
+@tabs{
+  @tab{Linux | <!-- -->
+    \| Field                        \| Value                                                \|
+    \|------------------------------\|------------------------------------------------------\|
+    \| Application Name             \| @code{}Steam Big Picture@endcode                     \|
+    \| Command Preporations -> Undo \| @code{}setsid steam steam://close/bigpicture@endcode \|
+    \| Detached Commands            \| @code{}setsid steam steam://open/bigpicture@endcode  \|
+    \| Image                        \| @code{}steam.png@endcode                             \|
+  }
+  @tab{macOS | <!-- -->
+    \| Field                        \| Value                                          \|
+    \|------------------------------\|------------------------------------------------\|
+    \| Application Name             \| @code{}Steam Big Picture@endcode               \|
+    \| Command Preporations -> Undo \| @code{}open steam://close/bigpicture@endcode   \|
+    \| Detached Commands            \| @code{}open steam://open/bigpicture@endcode    \|
+    \| Image                        \| @code{}steam.png@endcode                       \|
+  }
+  @tab{Windows | <!-- -->
+    \| Field                        \| Value                                     \|
+    \|------------------------------\|-------------------------------------------\|
+    \| Application Name             \| @code{}Steam Big Picture@endcode          \|
+    \| Command Preporations -> Undo \| @code{}steam://close/bigpicture@endcode   \|
+    \| Detached Commands            \| @code{}steam://open/bigpicture@endcode    \|
+    \| Image                        \| @code{}steam.png@endcode                  \|
+  }
+}
+
+### Epic Game Store game
+@note{Using URI method will be the most consistent between various games.}
+
+#### URI
+
+@tabs{
+  @tab{Windows | <!-- -->
+    \| Field            \| Value                                                                                                                                                 \|
+    \|------------------\|-------------------------------------------------------------------------------------------------------------------------------------------------------\|
+    \| Application Name \| @code{}Surviving Mars@endcode                                                                                                                         \|
+    \| Commands         \| @code{}com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true@endcode \|
+  }
+}
+
+#### Binary (w/ working directory
+@tabs{
+  @tab{Windows | <!-- -->
+    \| Field             \| Value                                                      \|
+    \|-------------------\|------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                              \|
+    \| Command           \| @code{}MarsEpic.exe@endcode                                \|
+    \| Working Directory \| @code{}"C:\Program Files\Epic Games\SurvivingMars"@endcode \|
+  }
+}
+
+#### Binary (w/o working directory)
+@tabs{
+  @tab{Windows | <!-- -->
+    \| Field             \| Value                                                                   \|
+    \|-------------------\|-------------------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                           \|
+    \| Command           \| @code{}"C:\Program Files\Epic Games\SurvivingMars\MarsEpic.exe"@endcode \|
+  }
+}
+
+### Steam game
+@note{Using URI method will be the most consistent between various games.}
+
+#### URI
+
+@tabs{
+  @tab{Linux | <!-- -->
+    \| Field             \| Value                                                \|
+    \|-------------------\|------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                        \|
+    \| Detached Commands \| @code{}setsid steam steam://rungameid/464920@endcode \|
+  }
+  @tab{macOS | <!-- -->
+    \| Field             \| Value                                        \|
+    \|-------------------\|----------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                \|
+    \| Detached Commands \| @code{}open steam://rungameid/464920@endcode \|
+  }
+  @tab{Windows | <!-- -->
+    \| Field             \| Value                                   \|
+    \|-------------------\|-----------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode           \|
+    \| Detached Commands \| @code{}steam://rungameid/464920@endcode \|
+  }
+}
+
+#### Binary (w/ working directory
+@tabs{
+  @tab{Linux | <!-- -->
+    \| Field             \| Value                                                        \|
+    \|-------------------\|--------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                \|
+    \| Command           \| @code{}MarsSteam@endcode                                     \|
+    \| Working Directory \| @code{}~/.steam/steam/SteamApps/common/Survivng Mars@endcode \|
+  }
+  @tab{macOS | <!-- -->
+    \| Field             \| Value                                                        \|
+    \|-------------------\|--------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                \|
+    \| Command           \| @code{}MarsSteam@endcode                                     \|
+    \| Working Directory \| @code{}~/.steam/steam/SteamApps/common/Survivng Mars@endcode \|
+  }
+  @tab{Windows | <!-- -->
+    \| Field             \| Value                                                                         \|
+    \|-------------------\|-------------------------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                                 \|
+    \| Command           \| @code{}MarsSteam.exe@endcode                                                  \|
+    \| Working Directory \| @code{}"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars"@endcode \|
+  }
+}
+
+#### Binary (w/o working directory)
+@tabs{
+  @tab{Linux | <!-- -->
+    \| Field             \| Value                                                                  \|
+    \|-------------------\|------------------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                          \|
+    \| Command           \| @code{}~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam@endcode \|
+  }
+  @tab{macOS | <!-- -->
+    \| Field             \| Value                                                                  \|
+    \|-------------------\|------------------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                          \|
+    \| Command           \| @code{}~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam@endcode \|
+  }
+  @tab{Windows | <!-- -->
+    \| Field             \| Value                                                                                       \|
+    \|-------------------\|---------------------------------------------------------------------------------------------\|
+    \| Application Name  \| @code{}Surviving Mars@endcode                                                               \|
+    \| Command           \| @code{}"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars\MarsSteam.exe"@endcode \|
+  }
+}
+
+### Prep Commands
+
+#### Changing Resolution and Refresh Rate
+
+##### Linux
+
+###### X11
+
+| Prep Step | Command                                                                                                                               |
+|-----------|---------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "xrandr --output HDMI-1 --mode ${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT} --rate ${SUNSHINE_CLIENT_FPS}"@endcode |
+| Undo      | @code{}xrandr --output HDMI-1 --mode 3840x2160 --rate 120@endcode                                                                     |
+
+@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:
+```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:
+```bash
+#!/bin/bash
+set -e
+
+# 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
+```
+}
+
+###### Wayland (wlroots, e.g. hyprland)
+
+| Prep Step | Command                                                                                                                                  |
+|-----------|------------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "wlr-xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}Hz\""@endcode |
+| Undo      | @code{}wlr-xrandr --output HDMI-1 --mode 3840x2160@120Hz@endcode                                                                         |
+
+@hint{`wlr-xrandr` only works with wlroots-based compositors.}
+
+###### Gnome (X11)
+
+| Prep Step | Command                                                                                                                               |
+|-----------|---------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "xrandr --output HDMI-1 --mode ${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT} --rate ${SUNSHINE_CLIENT_FPS}"@endcode |
+| Undo      | @code{}xrandr --output HDMI-1 --mode 3840x2160 --rate 120@endcode                                                                     |
+
+###### Gnome (Wayland)
+
+| Prep Step | Command                                                                                                                                                                                               |
+|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "displayconfig-mutter set --connector HDMI-1 --resolution ${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT} --refresh-rate ${SUNSHINE_CLIENT_FPS} --hdr ${SUNSHINE_CLIENT_HDR}"@endcode |
+| Undo      | @code{}displayconfig-mutter set --connector HDMI-1 --resolution 3840x2160 --refresh-rate 120 --hdr false@endcode                                                                                      |
+
+Installation instructions for displayconfig-mutter can be [found here](https://github.com/eaglesemanation/displayconfig-mutter). Alternatives include
+[gnome-randr-rust](https://github.com/maxwellainatchi/gnome-randr-rust) and [gnome-randr.py](https://gitlab.com/Oschowa/gnome-randr), but both of those are
+unmaintained and do not support newer Mutter features such as HDR and VRR.
+
+@hint{HDR support has been added to Gnome 48, to check if your display supports it you can run this:
+```
+displayconfig-mutter list
+```
+If it doesn't, then remove ``--hdr`` flag from both ``Do`` and ``Undo`` steps.
+}
+
+###### KDE Plasma (Wayland, X11)
+
+| Prep Step | Command                                                                                                                              |
+|-----------|--------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "kscreen-doctor output.HDMI-A-1.mode.${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}"@endcode |
+| Undo      | @code{}kscreen-doctor output.HDMI-A-1.mode.3840x2160@120@endcode                                                                     |
+
+@attention{The names of your displays will differ between X11 and Wayland.
+Be sure to use the correct name, depending on your session manager.
+e.g. On X11, the monitor may be called ``HDMI-A-0``, but on Wayland, it may be called ``HDMI-A-1``.
+}
+
+@hint{Replace ``HDMI-A-1`` with the display name of the monitor you would like to use for Moonlight.
+You can list the monitors available to you with:
+```
+kscreen-doctor -o
+```
+
+These will also give you the supported display properties for each monitor. You can select them either by
+hard-coding their corresponding number (e.g. ``kscreen-doctor output.HDMI-A1.mode.0``) or using the above
+``do`` command to fetch the resolution requested by your Moonlight client
+(which has a chance of not being supported by your monitor).
+}
+
+###### NVIDIA
+
+| Prep Step | Command                                                                                                                                                                                                                        |
+|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "nvidia-settings -a CurrentMetaMode=\"HDMI-1: nvidia-auto-select { ViewPortIn=${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}, ViewPortOut=${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}+0+0 }\""@endcode |
+| Undo      | @code{}nvidia-settings -a CurrentMetaMode=\"HDMI-1: nvidia-auto-select { ViewPortIn=3840x2160, ViewPortOut=3840x2160+0+0 }"@endcode                                                                                            |
+
+##### macOS
+
+###### displayplacer
+@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)}.
+
+| Prep Step | Command                                                                                                                                                                  |
+|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}sh -c "displayplacer \"id:<screenId> res:${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT} hz:${SUNSHINE_CLIENT_FPS} scaling:on origin:(0,0) degree:0\""@endcode |
+| Undo      | @code{}displayplacer "id:<screenId> res:3840x2160 hz:120 scaling:on origin:(0,0) degree:0"@endcode                                                                       |
+
+##### Windows
+Sunshine has built-in support for changing the resolution and refresh rate on Windows. If you prefer to use a
+third-party tool, you can use *QRes* as an example.
+
+###### QRes
+@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).}
+
+| Prep Step | Command                                                                                                                   |
+|-----------|---------------------------------------------------------------------------------------------------------------------------|
+| Do        | @code{}cmd /C "FullPath\qres.exe /x:%SUNSHINE_CLIENT_WIDTH% /y:%SUNSHINE_CLIENT_HEIGHT% /r:%SUNSHINE_CLIENT_FPS%"@endcode |
+| Undo      | @code{}FullPath\qres.exe /x:3840 /y:2160 /r:120@endcode                                                                   |
+
+### Additional Considerations
+
+#### Linux (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`.}
+
+#### Windows
+**Elevating Commands (Windows)**
+
+If you've installed Sunshine as a service (default), you can specify if a command should be elevated with
+administrative 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.
+
+**Example**
+```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": ""
+}
+```
+
+<div class="section_buttons">
+
+| Previous                          |                                    Next |
+|:----------------------------------|----------------------------------------:|
+| [Configuration](configuration.md) | [Awesome-Sunshine](awesome_sunshine.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/awesome_sunshine.md

@@ -0,0 +1,23 @@
+# Awesome-Sunshine
+
+@htmlonly
+<script type="module" src="https://md-block.verou.me/md-block.js"></script>
+<md-block
+  hlinks=""
+  hmin="2"
+  src="https://raw.githubusercontent.com/LizardByte/awesome-sunshine/master/README.md">
+</md-block>
+@endhtmlonly
+
+<div class="section_buttons">
+
+| Previous                        |                Next |
+|:--------------------------------|--------------------:|
+| [App Examples](app_examples.md) | [Guides](guides.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/building.md

@@ -0,0 +1,169 @@
+# Building
+Sunshine binaries are built using [CMake](https://cmake.org) and requires `cmake` > 3.25.
+
+## Building Locally
+
+### Dependencies
+
+#### Linux
+Dependencies vary depending on the distribution. You can reference our
+[linux_build.sh](https://github.com/LizardByte/Sunshine/blob/master/scripts/linux_build.sh) script for a list of
+dependencies we use in Debian-based and Fedora-based distributions. Please submit a PR if you would like to extend the
+script to support other distributions.
+
+##### CUDA Toolkit
+Sunshine requires CUDA Toolkit for NVFBC capture. There are two caveats to CUDA:
+
+1. The version installed depends on the version of GCC.
+2. The version of CUDA you use will determine compatibility with various GPU generations.
+   At the time of writing, the recommended version to use is CUDA ~11.8.
+   See [CUDA compatibility](https://docs.nvidia.com/deploy/cuda-compatibility/index.html) for more info.
+
+@tip{To install older versions, 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)}
+
+#### macOS
+You can either use [Homebrew](https://brew.sh) or [MacPorts](https://www.macports.org) to install dependencies.
+
+##### Homebrew
+```bash
+dependencies=(
+  "boost"  # Optional
+  "cmake"
+  "doxygen"  # Optional, for docs
+  "graphviz"  # Optional, for docs
+  "icu4c"  # Optional, if boost is not installed
+  "miniupnpc"
+  "ninja"
+  "node"
+  "openssl@3"
+  "opus"
+  "pkg-config"
+)
+brew install "${dependencies[@]}"
+```
+
+If there are issues with an SSL header that is not found:
+
+@tabs{
+  @tab{ Intel | ```bash
+    ln -s /usr/local/opt/openssl/include/openssl /usr/local/include/openssl
+    ```}
+  @tab{ Apple Silicon | ```bash
+    ln -s /opt/homebrew/opt/openssl/include/openssl /opt/homebrew/include/openssl
+    ```
+  }
+}
+
+##### MacPorts
+```bash
+dependencies=(
+  "cmake"
+  "curl"
+  "doxygen"  # Optional, for docs
+  "graphviz"  # Optional, for docs
+  "libopus"
+  "miniupnpc"
+  "ninja"
+  "npm9"
+  "pkgconfig"
+)
+sudo port install "${dependencies[@]}"
+```
+
+#### Windows
+First you need to install [MSYS2](https://www.msys2.org), then startup "MSYS2 UCRT64" and execute the following
+commands.
+
+##### Update all packages
+```bash
+pacman -Syu
+```
+
+##### Install dependencies
+```bash
+dependencies=(
+  "git"
+  "mingw-w64-ucrt-x86_64-boost"  # Optional
+  "mingw-w64-ucrt-x86_64-cmake"
+  "mingw-w64-ucrt-x86_64-cppwinrt"
+  "mingw-w64-ucrt-x86_64-curl-winssl"
+  "mingw-w64-ucrt-x86_64-doxygen"  # Optional, for docs... better to install official Doxygen
+  "mingw-w64-ucrt-x86_64-graphviz"  # Optional, for docs
+  "mingw-w64-ucrt-x86_64-MinHook"
+  "mingw-w64-ucrt-x86_64-miniupnpc"
+  "mingw-w64-ucrt-x86_64-nodejs"
+  "mingw-w64-ucrt-x86_64-nsis"
+  "mingw-w64-ucrt-x86_64-onevpl"
+  "mingw-w64-ucrt-x86_64-openssl"
+  "mingw-w64-ucrt-x86_64-opus"
+  "mingw-w64-ucrt-x86_64-toolchain"
+)
+pacman -S "${dependencies[@]}"
+```
+
+### Clone
+Ensure [git](https://git-scm.com) is installed on your system, then clone the repository using the following command:
+
+```bash
+git clone https://github.com/lizardbyte/sunshine.git --recurse-submodules
+cd sunshine
+mkdir build
+```
+
+### Build
+
+```bash
+cmake -B build -G Ninja -S .
+ninja -C build
+```
+
+@tip{Available build options can be found in
+[options.cmake](https://github.com/LizardByte/Sunshine/blob/master/cmake/prep/options.cmake).}
+
+### Package
+
+@tabs{
+  @tab{Linux | @tabs{
+    @tab{deb | ```bash
+      cpack -G DEB --config ./build/CPackConfig.cmake
+      ```}
+    @tab{rpm | ```bash
+      cpack -G RPM --config ./build/CPackConfig.cmake
+      ```}
+  }}
+  @tab{macOS | @tabs{
+    @tab{DragNDrop | ```bash
+      cpack -G DragNDrop --config ./build/CPackConfig.cmake
+      ```}
+  }}
+  @tab{Windows | @tabs{
+    @tab{Installer | ```bash
+      cpack -G NSIS --config ./build/CPackConfig.cmake
+      ```}
+    @tab{Portable | ```bash
+      cpack -G ZIP --config ./build/CPackConfig.cmake
+      ```}
+  }}
+}
+
+### Remote Build
+It may be beneficial to build remotely in some cases. This will enable easier building on different operating systems.
+
+1. Fork the project
+2. Activate workflows
+3. Trigger the *CI* workflow manually
+4. Download the artifacts/binaries from the workflow run summary
+
+<div class="section_buttons">
+
+| Previous                              |                            Next |
+|:--------------------------------------|--------------------------------:|
+| [Troubleshooting](troubleshooting.md) | [Contributing](contributing.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/changelog.md

@@ -0,0 +1,22 @@
+# Changelog
+
+@htmlonly
+<script type="module" src="https://md-block.verou.me/md-block.js"></script>
+<md-block
+  hmin="2"
+  src="https://raw.githubusercontent.com/LizardByte/Sunshine/changelog/CHANGELOG.md">
+</md-block>
+@endhtmlonly
+
+<div class="section_buttons">
+
+| Previous                              |                          Next |
+|:--------------------------------------|------------------------------:|
+| [Getting Started](getting_started.md) | [Docker](../DOCKER_README.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/configuration.js

@@ -0,0 +1,37 @@
+/**
+ * @brief Add a button to open the configuration option for each table
+ */
+document.addEventListener("DOMContentLoaded", function() {
+  const tables = document.querySelectorAll("table");
+  tables.forEach(table => {
+    if (table.className !== "doxtable") {
+      return;
+    }
+
+    let previousElement = table.previousElementSibling;
+    while (previousElement && previousElement.tagName !== "H2") {
+      previousElement = previousElement.previousElementSibling;
+    }
+    if (previousElement && previousElement.textContent) {
+      const sectionId = previousElement.textContent.trim().toLowerCase();
+      const newRow = document.createElement("tr");
+
+      const newCell = document.createElement("td");
+      newCell.setAttribute("colspan", "3");
+
+      const newCode = document.createElement("code");
+      newCode.className = "open-button";
+      newCode.setAttribute("onclick", `window.open('https://${document.getElementById('host-authority').value}/config/#${sectionId}', '_blank')`);
+      newCode.textContent = "Open";
+
+      newCell.appendChild(newCode);
+      newRow.appendChild(newCell);
+
+      // get the table body
+      const tbody = table.querySelector("tbody");
+
+      // Insert at the beginning of the table
+      tbody.insertBefore(newRow, tbody.firstChild);
+    }
+  });
+});

docs/contributing.md

@@ -0,0 +1,206 @@
+# Contributing
+Read our contribution guide in our organization level
+[docs](https://docs.lizardbyte.dev/latest/developers/contributing.html).
+
+## Recommended Tools
+
+| Tool                                                                                                                                                                           | Description                                                                                                                                                                           |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
+| <a href="https://www.jetbrains.com/clion/"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/CLion_icon.svg" width="30" height="30"></a><br>CLion | Recommended IDE for C and C++ development. Free for non-commercial use. |
+
+## Project Patterns
+
+### Web UI
+* The Web UI uses [Vite](https://vitejs.dev) as its build system.
+* The HTML pages used by the Web UI are found in `./src_assets/common/assets/web`.
+* [EJS](https://www.npmjs.com/package/vite-plugin-ejs) is used as a templating system for the pages
+  (check `template_header.html` and `template_header_main.html`).
+* The Style System is provided by [Bootstrap](https://getbootstrap.com).
+* The JS framework used by the more interactive pages is [Vus.js](https://vuejs.org).
+
+#### Building
+
+@tabs{
+  @tab{CMake | ```bash
+    cmake -B build -G Ninja -S . --target web-ui
+    ninja -C build web-ui
+    ```}
+  @tab{Manual | ```bash
+    npm run dev
+    ```}
+}
+
+### Localization
+Sunshine and related LizardByte projects are being localized into various languages.
+The default language is `en` (English).
+
+![](https://app.lizardbyte.dev/dashboard/crowdin/LizardByte_graph.svg)
+
+@admonition{Community | We are looking for language coordinators to help approve translations.
+The goal is to have the bars above filled with green!
+If you are interesting, please reach out to us on our Discord server.}
+
+#### CrowdIn
+The translations occur on [CrowdIn][crowdin-url].
+Anyone is free to contribute to the localization there.
+
+##### Translation Basics
+* The brand names *LizardByte* and *Sunshine* should never be translated.
+* Other brand names should never be translated. Examples include *AMD*, *Intel*, and *NVIDIA*.
+
+##### CrowdIn Integration
+How does it work?
+
+When a change is made to Sunshine source code, a workflow generates new translation templates
+that get pushed to CrowdIn automatically.
+
+When translations are updated on CrowdIn, a push gets made to the *l10n_master* branch and a PR is made against the
+*master* branch. Once the PR is merged, all updated translations are part of the project and will be included in the
+next release.
+
+#### Extraction
+
+##### Web UI
+Sunshine uses [Vue I18n](https://vue-i18n.intlify.dev) for localizing the UI.
+The following is a simple example of how to use it.
+
+* Add the string to the `./src_assets/common/assets/web/public/assets/locale/en.json` file, in English.
+  ```json
+  {
+   "index": {
+     "welcome": "Hello, Sunshine!"
+   }
+  }
+  ```
+
+  @note{The json keys should be sorted alphabetically. You can use [jsonabc](https://novicelab.org/jsonabc)
+  to sort the keys.}
+
+  @attention{Due to the integration with Crowdin, it is important to only add strings to the *en.json* file,
+  and to not modify any other language files. After the PR is merged, the translations can take place
+  on [CrowdIn][crowdin-url]. Once the translations are complete, a PR will be made
+  to merge the translations into Sunshine.}
+
+* Use the string in the Vue component.
+  ```html
+  <template>
+    <div>
+      <p>{{ $t('index.welcome') }}</p>
+    </div>
+  </template>
+  ```
+
+  @tip{More formatting examples can be found in the
+  [Vue I18n guide](https://kazupon.github.io/vue-i18n/guide/formatting.html).}
+
+##### C++
+
+There should be minimal cases where strings need to be extracted from C++ source code; however it may be necessary in
+some situations. For example the system tray icon could be localized as it is user interfacing.
+
+* Wrap the string to be extracted in a function as shown.
+  ```cpp
+  #include <boost/locale.hpp>
+  #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).}
+
+@warning{The below is for information only. Contributors should never include manually updated template files, or
+manually compiled language files in Pull Requests.}
+
+Strings are automatically extracted from the code to the `locale/sunshine.po` template file. The generated file is
+used by CrowdIn to generate language specific template files. The file is generated using the
+`.github/workflows/localize.yml` workflow and is run on any push event into the `master` branch. Jobs are only run if
+any of the following paths are modified.
+
+```yaml
+- 'src/**'
+```
+
+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.
+
+* Extract, initialize, and update
+  ```bash
+  python ./scripts/_locale.py --extract --init --update
+  ```
+
+* Compile
+  ```bash
+  python ./scripts/_locale.py --compile
+  ```
+
+@attention{Due to the integration with CrowdIn, it is important to not include any extracted or compiled files in
+Pull Requests. The files are automatically generated and updated by the workflow. Once the PR is merged, the
+translations can take place on [CrowdIn][crowdin-url]. Once the translations are
+complete, a PR will be made to merge the translations into Sunshine.}
+
+### Testing
+
+#### Clang Format
+Source code is tested against the `.clang-format` file for linting errors. The workflow file responsible for clang
+format testing is `.github/workflows/cpp-clang-format-lint.yml`.
+
+Option 1:
+```bash
+find ./ -iname *.cpp -o -iname *.h -iname *.m -iname *.mm | xargs clang-format -i
+```
+
+Option 2 (will modify files):
+```bash
+python ./scripts/update_clang_format.py
+```
+
+#### Unit Testing
+Sunshine uses [Google Test](https://github.com/google/googletest) for unit testing. Google Test is included in the
+repo as a submodule. The test sources are located in the `./tests` directory.
+
+The tests need to be compiled into an executable, and then run. The tests are built using the normal build process, but
+can be disabled by setting the `BUILD_TESTS` CMake option to `OFF`.
+
+To run the tests, execute the following command.
+
+```bash
+./build/tests/test_sunshine
+```
+
+To see all available options, run the tests with the `--help` flag.
+
+```bash
+./build/tests/test_sunshine --help
+```
+
+@tip{See the googletest [FAQ](https://google.github.io/googletest/faq.html) for more information on how to use
+Google Test.}
+
+We use [gcovr](https://www.gcovr.com) to generate code coverage reports,
+and [Codecov](https://about.codecov.io) to analyze the reports for all PRs and commits.
+
+Codecov will fail a PR if the total coverage is reduced too much, or if not enough of the diff is covered by tests.
+In some cases, the code cannot be covered when running the tests inside of GitHub runners. For example, any test that
+needs access to the GPU will not be able to run. In these cases, the coverage can be omitted by adding comments to the
+code. See the [gcovr documentation](https://gcovr.com/en/stable/guide/exclusion-markers.html#exclusion-markers) for
+more information.
+
+Even if your changes cannot be covered in the CI, we still encourage you to write the tests for them. This will allow
+maintainers to run the tests locally.
+
+[crowdin-url]: https://translate.lizardbyte.dev
+
+<div class="section_buttons">
+
+| Previous                |                                                         Next |
+|:------------------------|-------------------------------------------------------------:|
+| [Building](building.md) | [Source Code](../third-party/doxyconfig/docs/source_code.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/doc-styles.css

@@ -0,0 +1,6 @@
+/* A fake button as doxygen doesn't allow button elements */
+.open-button {
+    background: var(--primary-color);
+    color: white;
+    cursor: pointer;
+}

docs/gamestream_migration.md

@@ -0,0 +1,36 @@
+# GameStream Migration
+Nvidia announced that their GameStream service for Nvidia Games clients will be discontinued in February 2023.
+Luckily, Sunshine performance is now equal to or better than Nvidia GameStream.
+
+## 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. GSMS offers the ability to migrate your custom and auto-detected 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.
+
+<div class="section_buttons">
+
+| Previous                                        |              Next |
+|:------------------------------------------------|------------------:|
+| [Third-party Packages](third_party_packages.md) | [Legal](legal.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/getting_started.md

@@ -0,0 +1,556 @@
+# Getting Started
+
+The recommended method for running Sunshine is to use the [binaries](#binaries) included in the
+[latest release][latest-release], unless otherwise specified.
+
+[Pre-releases](https://github.com/LizardByte/Sunshine/releases) are also available. These should be considered beta,
+and release artifacts may be missing when merging changes on a faster cadence.
+
+## Binaries
+
+Binaries of Sunshine are created for each release. They are available for Linux, macOS, and Windows.
+Binaries can be found in the [latest release][latest-release].
+
+@tip{Some third party packages also exist.
+See [Third Party Packages](third_party_packages.md) for more information.
+No support will be provided for third party packages!}
+
+## Install
+
+### Docker
+@warning{The Docker images are not recommended for most users.}
+
+Docker images are available on [Dockerhub.io](https://hub.docker.com/repository/docker/lizardbyte/sunshine)
+and [ghcr.io](https://github.com/orgs/LizardByte/packages?repo_name=sunshine).
+
+See [Docker](../DOCKER_README.md) for more information.
+
+### Linux
+**CUDA Compatibility**
+
+CUDA is used for NVFBC capture.
+
+@tip{See [CUDA GPUS](https://developer.nvidia.com/cuda-gpus) to cross-reference Compute Capability to your GPU.
+The table below applies to packages provided by LizardByte. If you use an official LizardByte package then you do not
+need to install CUDA.}
+
+<table>
+    <caption>CUDA Compatibility</caption>
+    <tr>
+        <th>CUDA Version</th>
+        <th>Min Driver</th>
+        <th>CUDA Compute Capabilities</th>
+        <th>Package</th>
+    </tr>
+    <tr>
+        <td rowspan="3">11.8.0</td>
+        <td rowspan="3">450.80.02</td>
+        <td rowspan="3">35;50;52;60;61;62;70;72;75;80;86;87;89;90</td>
+        <td>sunshine.AppImage</td>
+    </tr>
+    <tr>
+        <td>sunshine-ubuntu-22.04-{arch}.deb</td>
+    </tr>
+    <tr>
+        <td>sunshine-ubuntu-24.04-{arch}.deb</td>
+    </tr>
+    <tr>
+        <td rowspan="1">12.0.0</td>
+        <td rowspan="1">525.60.13</td>
+        <td rowspan="5">50;52;60;61;62;70;72;75;80;86;87;89;90</td>
+        <td>sunshine-debian-bookworm-{arch}.deb</td>
+    </tr>
+    <tr>
+        <td rowspan="2">12.6.2</td>
+        <td rowspan="2">560.35.03</td>
+        <td>sunshine_{arch}.flatpak</td>
+    </tr>
+    <tr>
+        <td>Sunshine (copr - Fedora 41)</td>
+    </tr>
+    <tr>
+        <td rowspan="1">12.8.1</td>
+        <td rowspan="1">570.124.06</td>
+        <td>Sunshine (copr - Fedora 42)</td>
+    </tr>
+    <tr>
+        <td rowspan="1">12.9.1</td>
+        <td rowspan="1">575.57.08</td>
+        <td>sunshine.pkg.tar.zst</td>
+    </tr>
+</table>
+
+#### AppImage
+@caution{Use distro-specific packages instead of the AppImage if they are available.}
+
+According to AppImageLint the supported distro matrix of the AppImage is below.
+
+- ✖ Debian bullseye
+- ✔ Debian bookworm
+- ✔ Debian trixie
+- ✔ Debian sid
+- ✔ Ubuntu noble
+- ✔ Ubuntu jammy
+- ✖ Ubuntu focal
+- ✖ Ubuntu bionic
+- ✖ Ubuntu xenial
+- ✖ Ubuntu trusty
+- ✖ CentOS 7
+
+##### Install
+1. Download [sunshine.AppImage](https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.AppImage)
+   into your home directory.
+   ```bash
+   cd ~
+   wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.AppImage
+   ```
+2. Open terminal and run the following command.
+   ```bash
+   ./sunshine.AppImage --install
+   ```
+
+##### Run
+```bash
+./sunshine.AppImage --install && ./sunshine.AppImage
+```
+
+##### Uninstall
+```bash
+./sunshine.AppImage --remove
+```
+
+#### ArchLinux
+@warning{We do not provide support for any AUR packages.}
+
+##### Install Prebuilt Packages
+Follow the instructions at LizardByte's [pacman-repo](https://github.com/LizardByte/pacman-repo) to add
+the repository. Then run the following command.
+```bash
+pacman -S sunshine
+```
+
+##### Install PKGBUILD Archive
+Open terminal and run the following command.
+```bash
+wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.pkg.tar.gz
+tar -xvf sunshine.pkg.tar.gz
+cd sunshine
+
+# install optional dependencies
+pacman -S cuda  # Nvidia GPU encoding support
+pacman -S libva-mesa-driver  # AMD GPU encoding support
+
+makepkg -si
+```
+
+##### Uninstall
+```bash
+pacman -R sunshine
+```
+
+#### Debian/Ubuntu
+##### Install
+Download `sunshine-{distro}-{distro-version}-{arch}.deb` and run the following command.
+```bash
+sudo dpkg -i ./sunshine-{distro}-{distro-version}-{arch}.deb
+```
+
+@note{The `{distro-version}` is the version of the distro we built the package on. The `{arch}` is the
+architecture of your operating system.}
+
+@tip{You can double-click the deb file to see details about the package and begin installation.}
+
+##### Uninstall
+```bash
+sudo apt remove sunshine
+```
+
+#### Fedora
+@tip{The package name is case-sensitive.}
+
+##### Install
+1. Enable copr repository.
+   ```bash
+   sudo dnf copr enable lizardbyte/stable
+   ```
+
+   or
+   ```bash
+   sudo dnf copr enable lizardbyte/beta
+   ```
+
+2. Install the package.
+   ```bash
+   sudo dnf install Sunshine
+   ```
+
+##### Uninstall
+```bash
+sudo dnf remove Sunshine
+```
+
+#### Flatpak
+@caution{Use distro-specific packages instead of the Flatpak if they are available.}
+
+Using this package requires that you have [Flatpak](https://flatpak.org/setup) installed.
+
+##### Download (local option)
+1. Download `sunshine_{arch}.flatpak` and run the following command.
+   @note{Replace `{arch}` with your system architecture.}
+
+##### Install (system level)
+**Flathub**
+```bash
+flatpak install --system flathub dev.lizardbyte.app.Sunshine
+```
+
+**Local**
+```bash
+flatpak install --system ./sunshine_{arch}.flatpak
+```
+
+##### Install (user level)
+**Flathub**
+```bash
+flatpak install --user flathub dev.lizardbyte.app.Sunshine
+```
+
+**Local**
+```bash
+flatpak install --user ./sunshine_{arch}.flatpak
+```
+
+##### Additional installation (required)
+```bash
+flatpak run --command=additional-install.sh dev.lizardbyte.app.Sunshine
+```
+
+##### Run with NVFBC capture (X11 Only)
+```bash
+flatpak run dev.lizardbyte.app.Sunshine
+```
+
+##### Run with KMS capture (Wayland & X11)
+```bash
+sudo -i PULSE_SERVER=unix:/run/user/$(id -u $whoami)/pulse/native flatpak run dev.lizardbyte.app.Sunshine
+```
+
+##### Uninstall
+```bash
+flatpak run --command=remove-additional-install.sh dev.lizardbyte.app.Sunshine
+flatpak uninstall --delete-data dev.lizardbyte.app.Sunshine
+```
+
+#### Homebrew
+@important{The Homebrew package is experimental on Linux.}
+
+This package requires that you have [Homebrew](https://docs.brew.sh/Installation) installed.
+
+##### Install
+```bash
+brew update
+brew upgrade
+brew tap LizardByte/homebrew
+brew install sunshine
+```
+
+##### Uninstall
+```bash
+brew uninstall sunshine
+```
+
+### macOS
+
+@important{Sunshine on macOS is experimental. Gamepads do not work.}
+
+#### Homebrew
+This package requires that you have [Homebrew](https://docs.brew.sh/Installation) installed.
+
+##### Install
+```bash
+brew tap LizardByte/homebrew
+brew install sunshine
+```
+
+##### Uninstall
+```bash
+brew uninstall sunshine
+```
+
+@tip{For beta you can replace `sunshine` with `sunshine-beta` in the above commands.}
+
+### Windows
+
+#### Installer (recommended)
+
+1. Download and install
+   [Sunshine-Windows-AMD64-installer.exe](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-installer.exe)
+
+@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 <a href="ms-settings:installed-apps">here</a> and select "Uninstall" from the
+overflow menu. Different versions of Windows may provide slightly different steps for uninstall.
+
+#### Standalone (lite version)
+
+@warning{By using this package instead of the installer, performance will be reduced. This package is not
+recommended for most users. No support will be provided!}
+
+1. Download and extract
+   [Sunshine-Windows-AMD64-portable.zip](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-portable.zip)
+2. Open command prompt as administrator
+3. Firewall rules
+
+   Install:
+   ```bash
+   cd /d {path to extracted directory}
+   scripts/add-firewall-rule.bat
+   ```
+
+   Uninstall:
+   ```bash
+   cd /d {path to extracted directory}
+   scripts/delete-firewall-rule.bat
+   ```
+
+4. Virtual Gamepad Support
+
+   Install:
+   ```bash
+   cd /d {path to extracted directory}
+   scripts/install-gamepad.bat
+   ```
+
+   Uninstall:
+   ```bash
+   cd /d {path to extracted directory}
+   scripts/uninstall-gamepad.bat
+   ```
+
+5. Windows service
+
+   Install:
+   ```bash
+   cd /d {path to extracted directory}
+   scripts/install-service.bat
+   scripts/autostart-service.bat
+   ```
+
+   Uninstall:
+   ```bash
+   cd /d {path to extracted directory}
+   scripts/uninstall-service.bat
+   ```
+
+## Initial Setup
+After installation, some initial setup is required.
+
+### Linux
+
+#### KMS Capture
+@warning{Capture of most Wayland-based desktop environments will fail unless this step is performed.}
+@note{`cap_sys_admin` may as well be root, except you don't need to be root to run the program. This is necessary to
+allow Sunshine to use KMS capture.}
+
+##### Enable
+```bash
+sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine))
+```
+
+#### X11 Capture
+For X11 capture to work, you may need to disable the capabilities that were set for KMS capture.
+
+```bash
+sudo setcap -r $(readlink -f $(which sunshine))
+```
+
+#### Service
+
+**Start once**
+```bash
+systemctl --user start sunshine
+```
+
+**Start on boot**
+```bash
+systemctl --user enable sunshine
+```
+
+### macOS
+The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone.
+
+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).
+
+@note{Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.}
+@caution{Gamepads are not currently supported.}
+
+## Usage
+
+### Basic usage
+If Sunshine is not installed/running as a service, then start Sunshine with the following command, unless a start
+command is listed in the specified package [install](#install) instructions above.
+
+@note{A service is a process that runs in the background. This is the default when installing Sunshine from the
+Windows installer. Running multiple instances of Sunshine is not advised.}
+
+```bash
+sunshine
+```
+
+### Specify config file
+```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
+
+```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.
+
+```bash
+ssh <user>@<ip_address> 'startx &; export DISPLAY=:0; sunshine'
+```
+
+@tip{You could also utilize the `~/.bash_profile` or `~/.bashrc` files to set up the `DISPLAY` variable.}
+
+@seealso{ See [Remote SSH Headless Setup](https://app.lizardbyte.dev/2023-09-14-remote-ssh-headless-sunshine-setup)
+on how to set up a headless streaming server without autologin and dummy plugs (X11 + NVidia GPUs)}
+
+### Configuration
+
+Sunshine is configured via the web ui, which 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". 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 that you created.}
+
+1. Add games and applications.
+2. Adjust any configuration settings as needed.
+3. In Moonlight, you may need to add the PC manually.
+4. When Moonlight requests for you insert the pin:
+
+   - Login to the web ui
+   - Go to "PIN" in the Navbar
+   - Type in your PIN and press Enter, you should get a Success Message
+   - In Moonlight, select one of the Applications listed
+
+### Arguments
+To get a list of available arguments, run the following command.
+
+@tabs{
+   @tab{ General | @code{.bash}
+      sunshine --help
+      @endcode }
+   @tab{ AppImage | @code{.bash}
+      ./sunshine.AppImage --help
+      @endcode }
+   @tab{ Flatpak | @code{.bash}
+      flatpak run --command=sunshine dev.lizardbyte.app.Sunshine --help
+      @endcode }
+}
+
+### 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/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 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.
+  This can only be changed by modifying the `apps.json` file directly.
+
+### 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.
+* If any of the prep-commands fail, starting the application is aborted.
+* 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.
+  * This does not apply to `detached` applications.
+
+* 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`.
+* If inputs (mouse, keyboard, gamepads...) aren't working after connecting, add the user running sunshine to the `input` group.
+
+### HDR Support
+Streaming HDR content is officially supported on Windows hosts and experimentally supported for Linux hosts.
+
+* General HDR support information and requirements:
+
+  * HDR must be activated in the host OS, which may require an HDR-capable display or EDID emulator dongle
+    connected to your host PC.
+  * You must also enable the HDR option in your Moonlight client settings, otherwise the stream will be SDR
+    (and probably overexposed if your host is HDR).
+  * A good HDR experience relies on proper HDR display calibration both in the OS and in game. HDR calibration can
+    differ significantly between client and host displays.
+  * 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.
+  * Some GPUs video encoders can produce lower image quality or encoding performance when streaming in HDR compared
+    to SDR.
+
+* Additional information:
+
+  @tabs{
+    @tab{ Windows |
+    - HDR streaming is supported for Intel, AMD, and NVIDIA GPUs that support encoding HEVC Main 10 or AV1 10-bit profiles.
+    - 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.
+    - Older games that use NVIDIA-specific NVAPI HDR rather than native Windows HDR support may not display properly in HDR.
+    }
+
+    @tab{ Linux |
+    - HDR streaming is supported for Intel and AMD GPUs that support encoding HEVC Main 10 or AV1 10-bit profiles using VAAPI.
+    - The KMS capture backend is required for HDR capture. Other capture methods, like NvFBC or X11, do not support HDR.
+    - You will need a desktop environment with a compositor that supports HDR rendering, such as Gamescope or KDE Plasma 6.
+
+    @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 [here](guides.md).
+
+@admonition{Community! |
+Tutorials and Guides are community generated. Want to contribute? Reach out to us on our discord server.}
+
+<div class="section_buttons">
+
+| Previous                 |                      Next |
+|:-------------------------|--------------------------:|
+| [Overview](../README.md) | [Changelog](changelog.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>
+
+[latest-release]: https://github.com/LizardByte/Sunshine/releases/latest

docs/guides.md

@@ -0,0 +1,19 @@
+# Guides
+
+@admonition{Community | A collection of guides written by the community is available on our
+[blog](https://app.lizardbyte.dev/blog).
+Feel free to contribute your own tips and trips by making a PR to
+[LizardByte.github.io](https://github.com/LizardByte/LizardByte.github.io).}
+
+<div class="section_buttons">
+
+| Previous                                |                                        Next |
+|:----------------------------------------|--------------------------------------------:|
+| [Awesome-Sunshine](awesome_sunshine.md) | [Performance Tuning](performance_tuning.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>