Merge pull request #969 from LizardByte/nightly

v0.19.0

.clang-format

@@ -0,0 +1,74 @@
+---
+# 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.
+
+# Generated from CLion C/C++ Code Style settings
+BasedOnStyle: LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: DontAlign
+AlignConsecutiveAssignments: false
+AlignOperands: Align
+AllowAllArgumentsOnNextLine: false
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: Always
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: true
+AlignTrailingComments: false
+AlwaysBreakAfterReturnType: All
+AlwaysBreakTemplateDeclarations: MultiLine
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterUnion: false
+  BeforeCatch: true
+  BeforeElse: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: true
+BreakBeforeBinaryOperators: None
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
+ColumnLimit: 0
+CompactNamespaces: false
+ContinuationIndentWidth: 2
+IndentCaseLabels: true
+IndentPPDirectives: BeforeHash
+IndentWidth: 2
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: true
+PointerAlignment: Right
+ReflowComments: false
+SpaceAfterCStyleCast: true
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeCtorInitializerColon: false
+SpaceBeforeInheritanceColon: false
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles: Never
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth: 2
+Cpp11BracedListStyle: false
+UseTab: Never

.dockerignore

@@ -0,0 +1,18 @@
+# ignore hidden files
+.*
+
+# do not ignore .git, needed for versioning
+!/.git
+
+# ignore repo directories and files
+docs/
+scripts/
+tools/
+crowdin.yml
+
+# ignore dev directories
+build/
+venv/
+
+# ignore artifacts
+artifacts/

.flake8

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

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,179 @@
+---
+name: Bug Report
+description: Create a bug report to help us improve.
+body:
+  - type: markdown
+    attributes:
+      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!
+  - 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
+    attributes:
+      label: Is your issue present in the nightly release?
+      description: Please test the [nightly](https://github.com/LizardByte/Sunshine/releases/tag/nightly-dev) release
+      options:
+        - label: This issue is present in the nightly release
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other context about the bug here.
+  - type: dropdown
+    id: os
+    attributes:
+      label: Host Operating System
+      description: What version operating system are you running the software on?
+      options:
+        - Docker
+        - Linux
+        - macOS
+        - Windows
+        - other, n/a
+    validations:
+      required: true
+  - type: input
+    id: os-version
+    attributes:
+      label: Operating System Version
+      description: Provide the version of the operating system. Additionally a build number would be helpful.
+    validations:
+      required: true
+  - type: dropdown
+    id: os-architecture
+    attributes:
+      label: Architecture
+      options:
+        - 32 bit
+        - 64 bit
+        - arm
+        - other, n/a
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Sunshine commit or version
+      placeholder: eg. 0.18.0
+    validations:
+      required: true
+  - type: dropdown
+    id: package_type
+    attributes:
+      label: Package
+      description: The package you installed
+      options:
+        - Linux - AppImage
+        - Linux - AUR (Third Party)
+        - Linux - deb
+        - Linux - Docker
+        - Linux - flatpak
+        - Linux - nixpkgs (Third Party)
+        - Linux - PKGBUILD
+        - Linux - pkg.tar.zst
+        - Linux - rpm
+        - Linux - solus (Third Party)
+        - macOS - dmg
+        - macOS - Portfile
+        - macOS - pkg
+        - Windows - Chocolatey (Third Party)
+        - Windows - installer
+        - Windows - portable
+        - Windows - Scoop (Third Party)
+        - Windows - Winget (Third Party)
+        - other (not listed)
+        - other (self built)
+        - other (fork of this repo)
+    validations:
+      required: true
+  - type: dropdown
+    id: graphics_type
+    attributes:
+      label: GPU Type
+      description: The type of the installed graphics card.
+      options:
+        - AMD
+        - Intel
+        - Nvidia
+        - none (software encoding)
+    validations:
+      required: true
+  - type: input
+    id: graphics_model
+    attributes:
+      label: GPU Model
+      description: The model of the installed graphics card.
+      placeholder: e.g. GeForce RTX 2080 SUPER
+    validations:
+      required: true
+  - type: input
+    id: graphics_driver
+    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
+    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
+    validations:
+      required: false
+  - type: textarea
+    id: config
+    attributes:
+      label: Config
+      description: |
+        Please copy and paste your config (`sunshine.conf`) file.
+      render: Shell
+    validations:
+      required: true
+  - type: textarea
+    id: apps
+    attributes:
+      label: Apps
+      description: |
+        If this is an issue with launching a game or app, please copy and paste your `apps.json` file.
+      render: json
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code,
+        so no need for backticks.
+      render: shell
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,13 @@
+---
+# 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.
+
+blank_issues_enabled: false
+contact_links:
+  - 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

@@ -0,0 +1,54 @@
+---
+# 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.
+
+version: 2
+updates:
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    target-branch: "nightly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:30"
+    target-branch: "nightly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+    target-branch: "nightly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "09:30"
+    target-branch: "nightly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "10:00"
+    target-branch: "nightly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "10:30"
+    target-branch: "nightly"
+    open-pull-requests-limit: 10

.github/label-actions.yml

@@ -0,0 +1,49 @@
+---
+# 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

@@ -0,0 +1,28 @@
+## 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/workflows/CI.yml

@@ -0,0 +1,868 @@
+---
+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@v3
+
+      - 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@v3
+
+      - 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: Checkout
+        uses: actions/checkout@v3
+
+      - 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} \
+            "
+
+      - 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@v3
+        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
+    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_CONFIGURE_APPIMAGE=ON'
+            dist: 20.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        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-thread1.71-dev \
+              libboost-program-options1.71-dev
+
+            # Install cmake
+            wget https://cmake.org/files/v3.22/cmake-3.22.2-linux-x86_64.sh
+            chmod +x cmake-3.22.2-linux-x86_64.sh
+            mkdir /opt/cmake
+            ./cmake-3.22.2-linux-x86_64.sh --prefix=/opt/cmake --skip-license
+            ln --force --symbolic /opt/cmake/bin/cmake /usr/local/bin/cmake
+            cmake --version
+
+            # install newer tar from focal... appimagelint fails on 18.04 without this
+            echo "original tar version"
+            tar --version
+            wget -O tar.deb http://security.ubuntu.com/ubuntu/pool/main/t/tar/tar_1.30+dfsg-7ubuntu0.20.04.2_amd64.deb
+            sudo apt-get -y install -f ./tar.deb
+            echo "new tar version"
+            tar --version
+          else
+            # Ubuntu 20.04+ packages
+            sudo apt-get update -y
+            sudo apt-get install -y \
+              cmake \
+              libboost-filesystem-dev \
+              libboost-locale-dev \
+              libboost-log-dev \
+              libboost-thread-dev \
+              libboost-program-options-dev
+          fi
+
+          sudo apt-get install -y \
+            build-essential \
+            gcc-10 \
+            g++-10 \
+            libappindicator3-dev \
+            libavdevice-dev \
+            libcap-dev \
+            libcurl4-openssl-dev \
+            libdrm-dev \
+            libevdev-dev \
+            libmfx-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
+
+          npm install
+
+          cd build
+          cmake -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=/usr \
+            -DSUNSHINE_ASSETS_DIR=share/sunshine \
+            -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+            -DSUNSHINE_ENABLE_WAYLAND=ON \
+            -DSUNSHINE_ENABLE_X11=ON \
+            -DSUNSHINE_ENABLE_DRM=ON \
+            -DSUNSHINE_ENABLE_CUDA=ON \
+            ${{ matrix.EXTRA_ARGS }} \
+            ..
+          make -j ${nproc}
+
+      - name: Package Linux - CPACK
+        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 ) }}  # yamllint disable-line rule:line-length
+        run: |
+          version=${{ needs.check_changelog.outputs.next_version_bare }}
+          echo "VERSION=${version}" >> $GITHUB_ENV
+
+      - name: Package Linux - AppImage
+        if: ${{ matrix.type == 'appimage' }}
+        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
+
+          ./linuxdeploy-x86_64.AppImage \
+            --appdir ./AppDir \
+            --executable ./sunshine \
+            --icon-file "../$ICON_FILE" \
+            --desktop-file "./$DESKTOP_FILE" \
+            --library /usr/lib/x86_64-linux-gnu/libpango-1.0.so.0 \
+            --library /usr/lib/x86_64-linux-gnu/libpangocairo-1.0.so.0 \
+            --library /usr/lib/x86_64-linux-gnu/libpangoft2-1.0.so.0 \
+            --output appimage
+
+          # move
+          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@v3
+        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: setup_release
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Setup Dependencies MacOS
+        run: |
+          # install dependencies using homebrew
+          brew install boost cmake curl node opus pkg-config
+
+          # fix openssl header not found
+          ln -sf /usr/local/opt/openssl/include/openssl /usr/local/include/openssl
+
+      - name: Build MacOS
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }}
+          COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
+        run: |
+          npm install
+
+          mkdir build
+          cd build
+          cmake -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=/usr \
+            -DSUNSHINE_ASSETS_DIR=local/sunshine/assets \
+            -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+            ..
+          make -j ${nproc}
+
+      - name: Package MacOS
+        run: |
+          mkdir -p artifacts
+          cd build
+
+          # package
+          cpack -G DragNDrop
+          mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-macos-experimental-dragndrop.dmg
+
+          cpack -G Bundle
+          mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-macos-experimental-bundle.dmg
+
+          cpack -G ZIP
+          mv ./cpack_artifacts/Sunshine.zip ../artifacts/sunshine-macos-experimental-archive.zip
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: sunshine-macos
+          path: artifacts/
+
+      # this step can be removed after packages are fixed
+      - name: Delete experimental packages
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        working-directory: artifacts
+        run: |
+          rm -f ./sunshine-macos-experimental-dragndrop.dmg
+          rm -f ./sunshine-macos-experimental-bundle.dmg
+          rm -f ./sunshine-macos-experimental-archive.zip
+
+#      #  no artifacts to release currently
+#      - name: Create/Update GitHub Release
+#        if: ${{ needs.setup_release.outputs.create_release == 'true' }}
+#        uses: ncipollo/release-action@v1
+#        with:
+#          name: ${{ needs.setup_release.outputs.release_name }}
+#          tag: ${{ needs.setup_release.outputs.release_tag }}
+#          commit: ${{ needs.setup_release.outputs.release_commit }}
+#          artifacts: "*artifacts/*"
+#          token: ${{ secrets.GH_BOT_TOKEN }}
+#          allowUpdates: true
+#          body: ${{ needs.setup_release.outputs.release_body }}
+#          discussionCategory: announcements
+#          prerelease: ${{ needs.setup_release.outputs.pre_release }}
+
+  build_mac_port:
+    name: Macports
+    needs: setup_release
+    runs-on: macos-11
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Checkout ports
+        uses: actions/checkout@v3
+        with:
+          repository: macports/macports-ports
+          fetch-depth: 64
+          path: ports
+
+      - name: Checkout mpbb
+        uses: actions/checkout@v3
+        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: Determine list of subports
+        id: subportlist
+        run: |
+          set -eu
+          port=Sunshine
+          subportlist=""
+
+          echo "Listing subports for Sunshine"
+          new_subports=$(mpbb \
+            --work-dir /tmp/mpbb \
+            list-subports \
+            --archive-site= \
+            --archive-site-private= \
+            --include-deps=no \
+            "$port" \
+            | tr '\n' ' ')
+          for subport in $new_subports; do
+            echo "$subport"
+            subportlist="$subportlist $subport"
+          done
+          echo "subportlist=${subportlist}" >> $GITHUB_OUTPUT
+
+      - name: Run port lint for all subports
+        env:
+          subportlist: ${{ steps.subportlist.outputs.subportlist }}
+        run: |
+          set -eu
+          fail=0
+          for subport in $subportlist; do
+            echo "::group::${subport}"
+            path=$(port file "$subport")
+            messagetype="warning"
+            if ! messages=$(port -q lint "$subport" 2>&1); then
+              messagetype="error"
+              fail=1
+            fi
+            if [ -n "$messages" ]; then
+              echo "$messages"
+              # See https://github.com/actions/toolkit/issues/193#issuecomment-605394935
+              encoded_messages="port lint ${subport}:%0A"
+              encoded_messages+="$(echo "${messages}" | sed -E 's/$/%0A/g' | tr -d '\n')"
+              echo "::${messagetype} file=${path#${PWD}/ports/},line=1,col=1::${encoded_messages}"
+            fi
+            echo "::endgroup::"
+          done
+          exit "$fail"
+
+      - name: Build subports
+        env:
+          subportlist: ${{ steps.subportlist.outputs.subportlist }}
+        run: |
+          set -eu
+          fail=0
+          for subport in $subportlist; do
+            workdir="/tmp/mpbb/$subport"
+            mkdir -p "$workdir/logs"
+            touch "$workdir/logs/dependencies-progress.txt"
+            echo "::group::Cleaning up between ports"
+            sudo mpbb --work-dir "$workdir" cleanup
+            echo "::endgroup::"
+            echo "::group::Installing dependencies for ${subport}"
+            sudo mpbb \
+              --work-dir "$workdir" \
+              install-dependencies \
+              "$subport" >"$workdir/logs/install-dependencies.log" 2>&1 &
+            deps_pid=$!
+            tail -f "$workdir/logs/dependencies-progress.txt" 2>/dev/null &
+            tail_pid=$!
+            set +e
+            wait "$deps_pid"
+            deps_exit=$?
+            set -e
+            kill "$tail_pid" || true
+            if [ "$deps_exit" -ne 0 ]; then
+              echo "::endgroup::"
+              echo "::error::Failed to install dependencies for ${subport}"
+              fail=1
+              continue
+            fi
+            echo "::endgroup::"
+            echo "::group::Installing ${subport}"
+            set +e
+            sudo mpbb \
+              --work-dir "$workdir" \
+              install-port \
+              --source \
+              "$subport"
+            install_exit=$?
+            set -e
+            if [ "$install_exit" -ne 0 ]; then
+              echo "::endgroup::"
+              echo "::error::Failed to install ${subport}"
+              fail=1
+              continue
+            fi
+            echo "::endgroup::"
+          done
+          exit "$fail"
+
+      - name: Package
+        run: |
+          # create packages
+          sudo port pkg sunshine
+          sudo port dmg sunshine
+
+          work=$(port work sunshine)
+          echo "Sunshine port work directory: ${work}"
+
+          # move components out of port work directory
+          sudo mv ${work}/Sunshine*component.pkg /tmp/
+
+          # copy artifacts
+          sudo mv ${work}/Sunshine*.pkg ./artifacts/sunshine.pkg
+          sudo mv ${work}/Sunshine*.dmg ./artifacts/sunshine.dmg
+
+          # move components back
+          # sudo mv /tmp/Sunshine*component.pkg ${work}/
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        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: setup_release
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        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-libmfx
+            mingw-w64-x86_64-nsis
+            mingw-w64-x86_64-openssl
+            mingw-w64-x86_64-opus
+            mingw-w64-x86_64-toolchain
+            nasm
+            wget
+            yasm
+
+      - name: Install npm packages
+        run: |
+          npm install
+
+      - name: Build Windows
+        shell: msys2 {0}
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }}
+          COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
+        run: |
+          mkdir build
+          cd build
+          cmake -DCMAKE_BUILD_TYPE=Release \
+            -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: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        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: ${{ needs.setup_release.outputs.create_release == 'true' && github.ref == 'refs/heads/master' }}
+    runs-on: windows-latest  # the required action can only be run on Windows
+    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/auto-create-pr.yml

@@ -0,0 +1,35 @@
+---
+# 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@v3
+
+      - 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

@@ -0,0 +1,64 @@
+---
+# 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@v6
+        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.5
+        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/autoupdate-labeler.yml

@@ -0,0 +1,72 @@
+---
+# 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 PRs with `autoupdate` if various conditions are met, otherwise, remove the label.
+
+name: Label PR autoupdate
+
+on:
+  pull_request_target:
+    types:
+      - edited
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  label_pr:
+    if: >-
+      startsWith(github.repository, 'LizardByte/') &&
+      contains(github.event.pull_request.body, fromJSON('"] I want maintainers to keep my branch updated"'))
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ github.token }}
+    steps:
+      - name: Check if member
+        id: org_member
+        run: |
+          status="true"
+          gh api \
+            -H "Accept: application/vnd.github+json" \
+            /orgs/${{ github.repository_owner }}/members/${{ github.actor }} || status="false"
+
+          echo "result=${status}" >> $GITHUB_OUTPUT
+
+      - name: Label autoupdate
+        if: >-
+          steps.org_member.outputs.result == 'true' &&
+          contains(github.event.pull_request.labels.*.name, 'autoupdate') == false &&
+          contains(github.event.pull_request.body,
+            fromJSON('"\n- [x] I want maintainers to keep my branch updated"')) == true
+        uses: actions/github-script@v6
+        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: ['autoupdate']
+            })
+
+      - name: Unlabel autoupdate
+        if: >-
+          contains(github.event.pull_request.labels.*.name, 'autoupdate') &&
+          (
+            (github.event.action == 'synchronize' && steps.org_member.outputs.result == 'false') ||
+            (contains(github.event.pull_request.body,
+              fromJSON('"\n- [x] I want maintainers to keep my branch updated"')) == false
+            )
+          )
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GH_BOT_TOKEN }}
+          script: |
+            github.rest.issues.removeLabel({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              name: ['autoupdate']
+            })

.github/workflows/autoupdate.yml

@@ -0,0 +1,51 @@
+---
+# This action is centrally managed in https://github.com/<organization>/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
+# the above-mentioned repo.
+
+# This workflow is designed to work with the following workflows:
+# - automerge
+# - autoupdate-labeler
+
+# It uses an action that auto-updates pull requests branches, when changes are pushed to their destination branch.
+# Auto-updating to the latest destination branch works only in the context of upstream repo and not forks.
+# Dependabot PRs are updated by an action that comments `@depdenabot rebase` on dependabot PRs. (disabled)
+
+name: autoupdate
+
+on:
+  push:
+    branches:
+      - 'nightly'
+
+jobs:
+  autoupdate:
+    name: Autoupdate autoapproved PR created in the upstream
+    if: startsWith(github.repository, 'LizardByte/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Update
+        uses: docker://chinthakagodawita/autoupdate-action:v1
+        env:
+          EXCLUDED_LABELS: "central_dependency,dependencies"
+          GITHUB_TOKEN: '${{ secrets.GH_BOT_TOKEN }}'
+          PR_FILTER: "labelled"
+          PR_LABELS: "autoupdate"
+          PR_READY_STATE: "all"
+          MERGE_CONFLICT_ACTION: "fail"
+
+# Disabled due to:
+# - no major version tag, resulting in constant nagging to update this action
+# - additionally, the code is sketchy, 16k+ lines of code?
+# https://github.com/bbeesley/gha-auto-dependabot-rebase/blob/main/dist/main.cjs
+#
+#  dependabot-rebase:
+#    name: Dependabot Rebase
+#    if: >-
+#      startsWith(github.repository, 'LizardByte/')
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: rebase
+#        uses: "bbeesley/gha-auto-dependabot-rebase@v1.3.18"
+#        env:
+#          GITHUB_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/ci-docker.yml

@@ -0,0 +1,415 @@
+---
+# 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@v3
+
+      - 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@v3
+
+      - 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@v3
+
+      - 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: Checkout
+        uses: actions/checkout@v3
+        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@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        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@v2
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Log in to the Container registry
+        if: ${{ steps.prepare.outputs.push == 'true' }}  # PRs do not have access to secrets
+        uses: docker/login-action@v2
+        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@v4
+        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@v4
+        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@v3
+        with:
+          name: Docker${{ matrix.tag }}
+          path: artifacts/
+
+      - name: Create/Update GitHub Release
+        if: ${{ needs.setup_release.outputs.create_release == 'true' && steps.prepare.outputs.artifacts == 'true' }}
+        uses: ncipollo/release-action@v1
+        with:
+          name: ${{ needs.setup_release.outputs.release_name }}
+          tag: ${{ needs.setup_release.outputs.release_tag }}
+          commit: ${{ needs.setup_release.outputs.release_commit }}
+          artifacts: "*artifacts/*"
+          token: ${{ secrets.GH_BOT_TOKEN }}
+          allowUpdates: true
+          body: ${{ needs.setup_release.outputs.release_body }}
+          discussionCategory: announcements
+          prerelease: ${{ needs.setup_release.outputs.pre_release }}
+
+      - name: Update Docker Hub Description
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        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-qodana.yml

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

.github/workflows/cpp-lint.yml

@@ -0,0 +1,84 @@
+---
+# 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@v3
+
+      - name: Find cpp files
+        id: cpp_files
+        run: |
+          cpp_files=$(find . -type f -iname "*.cpp" -o -iname "*.h" -o -iname "*.m" -o -iname "*.mm")
+
+          echo "found cpp files: ${cpp_files}"
+
+          # do not quote to keep this as a single line
+          echo cpp_files=${cpp_files} >> $GITHUB_OUTPUT
+
+      - name: Clang format lint
+        if: ${{ steps.cpp_files.outputs.cpp_files }}
+        uses: DoozyX/clang-format-lint-action@v0.15
+        with:
+          source: ${{ steps.cpp_files.outputs.cpp_files }}
+          extensions: 'cpp,h,m,mm'
+          clangFormatVersion: 15
+          style: file
+          inplace: false
+
+      - name: Upload Artifacts
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: clang-format-fixes
+          path: ${{ steps.cpp_files.outputs.cpp_files }}
+
+  cmake-lint:
+    name: CMake Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools cmakelang
+
+      - name: Find cmake files
+        id: cmake_files
+        run: |
+          cmake_files=$(find . -type f -iname "CMakeLists.txt" -o -iname "*.cmake")
+
+          echo "found cmake files: ${cmake_files}"
+
+          # do not quote to keep this as a single line
+          echo cmake_files=${cmake_files} >> $GITHUB_OUTPUT
+
+      - name: Test with cmake-lint
+        run: |
+          cmake-lint --line-width 120 --tab-size 4 ${{ steps.cmake_files.outputs.cmake_files }}

.github/workflows/dispatcher.yml

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

.github/workflows/issues-stale.yml

@@ -0,0 +1,59 @@
+---
+# 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@v7
+        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: >
+            This issue is stale because it has been open for 90 days with no activity.
+            Comment or remove the stale label, otherwise this will be closed in 10 days.
+          stale-pr-label: 'stale'
+          stale-pr-message: >
+            This PR is stale because it has been open for 90 days with no activity.
+            Comment or remove the stale label, otherwise this will be closed in 10 days.
+          repo-token: ${{ secrets.GH_BOT_TOKEN }}
+
+      - name: Invalid Template
+        uses: actions/stale@v7
+        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
+          exempt-pr-labels: 'dependencies,l10n'
+          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

@@ -0,0 +1,25 @@
+---
+# 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@v3
+        with:
+          github-token: ${{ secrets.GH_BOT_TOKEN }}

.github/workflows/localize.yml

@@ -0,0 +1,98 @@
+---
+name: localize
+
+on:
+  push:
+    branches: [nightly]
+    paths:  # prevents workflow from running unless these files change
+      - '.github/workflows/localize.yml'
+      - 'src/**'
+      - 'locale/sunshine.po'
+  workflow_dispatch:
+
+env:
+  file: ./locale/sunshine.po
+
+jobs:
+  localize:
+    name: Update Localization
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Python 3.9
+        uses: actions/setup-python@v4  # https://github.com/actions/setup-python
+        with:
+          python-version: '3.9'
+
+      - name: Set up Python 3.9 Dependencies
+        run: |
+          cd ./scripts
+          python -m pip install --upgrade pip setuptools
+          python -m pip install -r requirements.txt
+
+      - name: Set up xgettext
+        run: |
+          sudo apt-get update -y && \
+          sudo apt-get --reinstall install -y \
+          gettext
+
+      - name: Update Strings
+        run: |
+          # first, try to remove existing file as xgettext does not remove unused translations
+          if [ -f "${{ env.file }}" ];
+          then
+              rm ${{ env.file }}
+              echo "new_file=false" >> $GITHUB_ENV
+          else
+              echo "new_file=true" >> $GITHUB_ENV
+          fi
+
+          # extract the new strings
+          python ./scripts/_locale.py --extract
+
+      - name: git diff
+        if: ${{ env.new_file == 'false' }}
+        run: |
+          # disable the pager
+          git config --global pager.diff false
+
+          # print the git diff
+          git diff locale/sunshine.po
+
+          # set the variable with minimal output, replacing `\t` with ` `
+          OUTPUT=$(git diff --numstat locale/sunshine.po | sed -e "s#\t# #g")
+          echo "git_diff=${OUTPUT}" >> $GITHUB_ENV
+
+      - 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' }}
+        run: |
+          git reset --hard
+
+      - name: Get current date
+        id: date
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+
+      - name: Create/Update Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          add-paths: |
+            locale/*.po
+          token: ${{ secrets.GH_BOT_TOKEN }}  # must trigger PR tests
+          commit-message: New localization template
+          branch: localize/update
+          delete-branch: true
+          base: nightly
+          title: New Babel Updates
+          body: |
+            Update report
+            - Updated ${{ steps.date.outputs.date }}
+            - Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          labels: |
+            babel
+            l10n

.github/workflows/pull-requests.yml

@@ -0,0 +1,32 @@
+---
+# 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.
+
+# Ensure PRs are made against `nightly` branch.
+
+name: Pull Requests
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, edited, reopened]
+
+# no concurrency for pull_request_target events
+
+jobs:
+  check-pull-request:
+    name: Check Pull Request
+    if: startsWith(github.repository, 'LizardByte/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Vankka/pr-target-branch-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          target: master
+          exclude: nightly  # Don't prevent going from nightly -> master
+          change-to: nightly
+          comment: |
+            Your PR was set to `master`, PRs should be sent to `nightly`.
+            The base branch of this PR has been automatically changed to `nightly`.
+            Please check that there are no merge conflicts

.github/workflows/python-flake8.yml

@@ -0,0 +1,38 @@
+---
+# 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@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4  # 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

@@ -0,0 +1,22 @@
+---
+name: Release Notifications (Moonlight)
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  discord:
+    runs-on: ubuntu-latest
+    steps:
+      - name: discord
+        uses: sarisia/actions-status-discord@v1  # https://github.com/sarisia/actions-status-discord
+        with:
+          webhook: ${{ secrets.DISCORD_RELEASE_WEBHOOK_MOONLIGHT }}
+          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

.github/workflows/release-notifier.yml

@@ -0,0 +1,88 @@
+---
+# 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/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: discord
+        uses: sarisia/actions-status-discord@v1  # https://github.com/sarisia/actions-status-discord
+        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/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: facebook-post-action
+        uses: ReenigneArcher/facebook-post-action@v1  # https://github.com/ReenigneArcher/facebook-post-action
+        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/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: facebook-post-action
+        uses: ReenigneArcher/facebook-post-action@v1  # https://github.com/ReenigneArcher/facebook-post-action
+        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/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: reddit
+        uses: bluwy/release-for-reddit-action@v2  # https://github.com/bluwy/release-for-reddit-action
+        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/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: twitter
+        uses: ethomson/send-tweet-action@v1  # https://github.com/ethomson/send-tweet-action
+        with:
+          consumer-key: ${{ secrets.TWITTER_API_KEY }}
+          consumer-secret: ${{ secrets.TWITTER_API_SECRET }}
+          access-token: ${{ secrets.TWITTER_ACCESS_TOKEN }}
+          access-token-secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
+          status: ${{ github.event.release.html_url }}

.github/workflows/yaml-lint.yml

@@ -0,0 +1,66 @@
+---
+# 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@v3
+
+      - 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,8 +1,18 @@
 build
-cmake-build-*
+cmake-build*
 .DS_Store
-
+.vscode
+.vs
 *.swp
 *.kdev4
 
+.cache
 .idea
+
+# npm
+node_modules/
+package-lock.json
+
+# Translations
+*.mo
+*.pot

.gitmodules

@@ -1,12 +1,52 @@
-[submodule "moonlight-common-c"]
-	path = moonlight-common-c
+[submodule "third-party/moonlight-common-c"]
+	path = third-party/moonlight-common-c
 	url = https://github.com/moonlight-stream/moonlight-common-c.git
-[submodule "Simple-Web-Server"]
-	path = Simple-Web-Server
-	url = https://github.com/loki-47-6F-64/Simple-Web-Server.git
-[submodule "ViGEmClient"]
-	path = ViGEmClient
+	branch = master
+[submodule "third-party/Simple-Web-Server"]
+	path = third-party/Simple-Web-Server
+	url = https://gitlab.com/eidheim/Simple-Web-Server.git
+	branch = master
+[submodule "third-party/ViGEmClient"]
+	path = third-party/ViGEmClient
 	url = https://github.com/ViGEm/ViGEmClient
-[submodule "pre-compiled"]
-	path = pre-compiled
-	url = https://bitbucket.org/Loki-47-6F-64/pre-compiled.git
+	branch = master
+[submodule "third-party/miniupnp"]
+	path = third-party/miniupnp
+	url = https://github.com/miniupnp/miniupnp
+	branch = master
+[submodule "third-party/nv-codec-headers"]
+	path = third-party/nv-codec-headers
+	url = https://github.com/FFmpeg/nv-codec-headers
+	branch = sdk/11.1
+[submodule "third-party/TPCircularBuffer"]
+	path = third-party/TPCircularBuffer
+	url = https://github.com/michaeltyson/TPCircularBuffer
+	branch = master
+[submodule "third-party/ffmpeg-windows-x86_64"]
+	path = third-party/ffmpeg-windows-x86_64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-windows-x86_64
+[submodule "third-party/ffmpeg-macos-x86_64"]
+	path = third-party/ffmpeg-macos-x86_64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-macos-x86_64
+[submodule "third-party/ffmpeg-linux-x86_64"]
+	path = third-party/ffmpeg-linux-x86_64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-linux-x86_64
+[submodule "third-party/ffmpeg-linux-aarch64"]
+	path = third-party/ffmpeg-linux-aarch64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-linux-aarch64
+[submodule "third-party/ffmpeg-macos-aarch64"]
+	path = third-party/ffmpeg-macos-aarch64
+	url = https://github.com/LizardByte/build-deps
+	branch = ffmpeg-macos-aarch64
+[submodule "third-party/nanors"]
+	path = third-party/nanors
+	url = https://github.com/sleepybishop/nanors.git
+	branch = master
+[submodule "third-party/tray"]
+	path = third-party/tray
+	url = https://github.com/dmikushin/tray
+	branch = master

.prettierrc.json

@@ -0,0 +1 @@
+{}

.readthedocs.yaml

@@ -0,0 +1,44 @@
+---
+# .readthedocs.yaml
+# 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-20.04
+  tools:
+    python: "3.10"
+
+## apt packages required packages to run cmake on sunshine, note that additional packages are required
+#  apt_packages:
+#    - cmake
+#    - libboost-filesystem-dev
+#    - libboost-log-dev
+#    - libboost-thread-dev
+
+## run cmake
+#  jobs:
+#    pre_build:
+#      - cmake .
+
+## Include the submodules, required for cmake
+#  submodules:
+#    include: all
+#    recursive: true
+
+# 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
+  system_packages: true

CHANGELOG.md

@@ -0,0 +1,406 @@
+# Changelog
+
+## [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

DOCKER_README.md

@@ -0,0 +1,139 @@
+# Docker
+
+## Important note
+Starting with v0.18.0, tag names have changed. You may no longer use `latest`, `master`, `vX.X.X`.
+
+## Build your own containers
+This image provides a method for you to easily use the latest Sunshine release in your own docker projects. It is not
+intended to use as a standalone container at this point, and should be considered experimental.
+
+```dockerfile
+ARG SUNSHINE_VERSION=latest
+ARG SUNSHINE_OS=ubuntu-22.04
+FROM lizardbyte/sunshine:${SUNSHINE_VERSION}-${SUNSHINE_OS}
+
+# install Steam, Wayland, etc.
+
+ENTRYPOINT steam && sunshine
+```
+
+### SUNSHINE_VERSION
+- `latest`, `master`, `vX.X.X`
+- `nightly`
+- commit hash
+
+### SUNSHINE_OS
+Sunshine images are available with the following tag suffixes, based on their respective base images.
+
+- `archlinux`
+- `debian-bullseye`
+- `fedora-36`
+- `fedora-37`
+- `ubuntu-20.04`
+- `ubuntu-22.04`
+
+### Tags
+You must combine the `SUNSHINE_VERSION` and `SUNSHINE_OS` to determine the tag to pull. The format should be
+`<SUNSHINE_VERSION>-<SUNSHINE_OS>`. For example, `latest-ubuntu-22.04`.
+
+See all our available tags on [docker hub](https://hub.docker.com/r/lizardbyte/sunshine/tags) or
+[ghcr](https://github.com/LizardByte/Sunshine/pkgs/container/sunshine/versions) for more info.
+
+## Where used
+This is a list of docker projects using Sunshine. Something missing? Let us know about it!
+
+- [Games on Whales](https://games-on-whales.github.io)
+
+## Port and Volume mappings
+Examples are below of the required mappings. The configuration file will be saved to `/config` in the container.
+
+### Using docker run
+Create and run the container (substitute your `<values>`):
+
+```bash
+docker run -d \
+  --name=<image_name> \
+  --restart=unless-stopped
+  -e PUID=<uid> \
+  -e PGID=<gid> \
+  -e TZ=<timezone> \
+  -v <path to data>:/config \
+  -p 47984-47990:47984-47990/tcp \
+  -p 48010:48010 \
+  -p 47998-48000:47998-48000/udp \
+  <image>
+```
+
+### Using docker-compose
+Create a `docker-compose.yml` file with the following contents (substitute your `<values>`):
+
+```yaml
+version: '3'
+services:
+  <image_name>:
+    image: <image>
+    container_name: sunshine
+    restart: unless-stopped
+    volumes:
+      - <path to data>:/config
+    environment:
+      - PUID=<uid>
+      - PGID=<gid>
+      - TZ=<timezone>
+    ports:
+      - "47984-47990:47984-47990/tcp"
+      - "48010:48010"
+      - "47998-48000:47998-48000/udp"
+```
+
+### Parameters
+You must substitute the `<values>` with your own settings.
+
+Parameters are split into two halves separated by a colon. The left side represents the host and the right side the
+container.
+
+**Example:** `-p external:internal` - This shows the port mapping from internal to external of the container.
+Therefore `-p 47990:47990` would expose port `47990` from inside the container to be accessible from the host's IP on
+port `47990` (e.g. `http://<host_ip>:47990`). The internal port must be `47990`, but the external port may be changed
+(e.g. `-p 8080:47990`). All the ports listed in the `docker run` and `docker-compose` examples are required.
+
+
+| Parameter                   | Function             | Example Value      | Required |
+|-----------------------------|----------------------|--------------------|----------|
+| `-p <port>:47990`           | Web UI Port          | `47990`            | True     |
+| `-v <path to data>:/config` | Volume mapping       | `/home/sunshine`   | True     |
+| `-e PUID=<uid>`             | User ID              | `1001`             | False    |
+| `-e PGID=<gid>`             | Group ID             | `1001`             | False    |
+| `-e TZ=<timezone>`          | Lookup [TZ value][1] | `America/New_York` | False    |
+
+[1]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+
+#### User / Group Identifiers:
+When using data volumes (-v flags) permissions issues can arise between the host OS and the container. To avoid this
+issue you can specify the user PUID and group PGID. Ensure the data volume directory on the host is owned by the same
+user you specify.
+
+In this instance `PUID=1001` and `PGID=1001`. To find yours use id user as below:
+
+```bash
+$ id dockeruser
+uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
+```
+
+If you want to change the PUID or PGID after the image has been built, it will require rebuilding the image.
+
+## Supported Architectures
+
+Specifying `lizardbyte/sunshine:latest-<SUNSHINE_OS>` or `ghcr.io/lizardbyte/sunshine:latest-<SUNSHINE_OS>` should
+retrieve the correct image for your architecture.
+
+The architectures supported by these images are shown in the table below.
+
+| tag suffix      | amd64/x86_64 | arm64/aarch64 |
+|-----------------|--------------|---------------|
+| archlinux       | ✅            | ❌             |
+| debian-bullseye | ✅            | ✅             |
+| fedora-36       | ✅            | ✅             |
+| fedora-37       | ✅            | ✅             |
+| ubuntu-20.04    | ✅            | ✅             |
+| ubuntu-22.04    | ✅            | ✅             |

FindFFmpeg.cmake

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

NOTICE

@@ -0,0 +1,3 @@
+©2018 Valve Corporation. Steam and the Steam logo are trademarks and/or
+registered trademarks of Valve Corporation in the U.S. and/or other countries. All
+rights reserved.

README.rst

@@ -0,0 +1,128 @@
+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: 36+                                          |
+|            +------------------------------------------------------------+
+|            | Linux/Ubuntu: 20.04+ (focal)                               |
++------------+------------------------------------------------------------+
+| Network    | Host: 5GHz, 802.11ac                                       |
+|            +------------------------------------------------------------+
+|            | Client: 5GHz, 802.11ac                                     |
++------------+------------------------------------------------------------+
+
+**4k Suggestions**
+
++------------+------------------------------------------------------------+
+| GPU        | AMD: Video Coding Engine 3.1 or higher                     |
+|            +------------------------------------------------------------+
+|            | Intel: HD Graphics 510 or higher                           |
+|            +------------------------------------------------------------+
+|            | Nvidia: GeForce GTX 1080 or higher                         |
++------------+------------------------------------------------------------+
+| CPU        | AMD: Ryzen 5 or higher                                     |
+|            +------------------------------------------------------------+
+|            | Intel: Core i5 or higher                                   |
++------------+------------------------------------------------------------+
+| Network    | Host: CAT5e ethernet or better                             |
+|            +------------------------------------------------------------+
+|            | Client: CAT5e ethernet or better                           |
++------------+------------------------------------------------------------+
+
+**HDR Suggestions**
+
++------------+------------------------------------------------------------+
+| GPU        | AMD: Video Coding Engine 3.4 or higher                     |
+|            +------------------------------------------------------------+
+|            | Intel: UHD Graphics 730 or higher                          |
+|            +------------------------------------------------------------+
+|            | Nvidia: Pascal-based GPU (GTX 10-series) or higher         |
++------------+------------------------------------------------------------+
+| CPU        | AMD: todo                                                  |
+|            +------------------------------------------------------------+
+|            | Intel: todo                                                |
++------------+------------------------------------------------------------+
+| Network    | Host: CAT5e ethernet or better                             |
+|            +------------------------------------------------------------+
+|            | Client: CAT5e ethernet or better                           |
++------------+------------------------------------------------------------+
+
+Integrations
+------------
+
+.. image:: https://img.shields.io/github/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?label=Docs&style=for-the-badge&logo=readthedocs
+   :alt: Read the Docs
+   :target: http://sunshinestream.readthedocs.io/
+
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=localized&style=for-the-badge&query=%24.progress..data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json&logo=crowdin
+   :alt: CrowdIn
+   :target: https://crowdin.com/project/sunshinestream
+
+Support
+-------
+
+Our support methods are listed in our
+`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`_.
+
+Downloads
+---------
+
+.. image:: https://img.shields.io/github/downloads/lizardbyte/sunshine/total?style=for-the-badge&logo=github
+   :alt: GitHub Releases
+   :target: https://github.com/LizardByte/Sunshine/releases/latest
+
+.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine?style=for-the-badge&logo=docker
+   :alt: Docker
+   :target: https://hub.docker.com/r/lizardbyte/sunshine
+
+Stats
+------
+.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine?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

README.txt

@@ -1,117 +0,0 @@
-######### Linux ##############
-
-Requirements:
-	Ubuntu 19.10: cmake libssl-dev libavdevice-dev libboost-thread-dev libboost-filesystem-dev libboost-log-dev libpulse-dev libopus-dev libxtst-dev libx11-dev libxfixes-dev libevdev-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev
-
-Compilation:
-	* git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules
-	* cd sunshine && mkdir build && cd build
-	* cmake ..
-	* make
-
-
-Setup:
-	* sunshine needs access to uinput to create mouse and gamepad events:
-		* Add user to group 'input': "usermod -a -G input username
-		* Create a file: "/etc/udev/rules.d/85-sunshine-input.rules"
-		* The contents of the file is as follows:
-			KERNEL=="uinput", GROUP="input", mode="0660"
-	* assets/sunshine.conf is an example configuration file. Modify it as you see fit and use it by running: "sunshine path/to/sunshine.conf"
-	* path/to/build/dir/sunshine.service is used to start sunshine in the background:
-		* cp sunshine.service $HOME/.config/systemd/user/
-		* Modify $HOME/.config/systemd/user/sunshine.conf to point to the sunshine executable
-		* systemctl --user start sunshine
-
-	* assets/apps.json is an example of a list of applications that are started just before running a stream:
-		* See below for a detailed explanation
-
-Trouleshooting:
-	* If you get "Could not create Sunshine Gamepad: Permission Denied", ensure you are part of the group "input":
-		* groups
-	* If Sunshine sends audio from the microphone instead of the speaker, try the following steps:
-		* pacmd list-sources | grep "name:"
-		* Copy the name to the configuration option "audio_sink"
-		* restart sunshine
-
-
-
-######### Windows 10 ############
-
-Requirements:
-	MSYS2 : mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-ffmpeg mingw-w64-x86_64-boost
-
-Compilation:
-	* git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules
-	* cd sunshine && mkdir build && cd build
-	* cmake -G"Unix Makefiles" ..
-	* make
-
-Setup:
-	* <optional> Gamepad support: Download and run 'ViGEmBus_Setup_1.16.116.exe' from [https://github.com/ViGEm/ViGEmBus/releases]
-
-== Static build ==
-Requirements:
-	MSYS2 : mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-ffmpeg mingw-w64-x86_64-boost git-lfs
-
-Compilation:
-	* git lfs install
-	* git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules
-	* cd sunshine && mkdir build && cd build
-	* cmake -DSUNSHINE_STANDALONE=ON -DSUNSHINE_ASSETS_DIR=assets -G"Unix Makefiles" ..
-	* make
-
-
-
-######### Common #############
-
-Usage:
-	* run "sunshine path/to/sunshine.conf"
-	* In Moonlight: Add PC manually
-	* When Moonlight request you insert the correct pin on sunshine:
-		wget xxx.xxx.xxx.xxx:47989/pin/xxxx -- where the first few x's are substituted by the ip of Sunshine and the final 4 x'es are substituted by the pin
-			or
-		Type in the URL bar of your browser: xxx.xxx.xxx.xxx:47989/pin/xxxx -- where the first few x's are substituted by the ip of the final 4 x'es are subsituted by the pin
-	* Click on one of the Applications listed
-	* Have fun :)
-
-
-Note:
-	* The Windows key is not passed through by Moonlight, therefore Sunshine maps Right-Alt key to the Windows key
-	* If you set Video Bitrate to 0.5Mb/s:
-		* Sunshine will use CRF or QP to controll the quality of the stream. (See example configuration file for more details)
-		* This is less CPU intensive and it has lower average bandwith requirements compared to manually setting bitrate to acceptable quality
-		* However, it has higher peak bitrates, forcing Sunshine to drop entire frames when streaming 1080P due to their size.
-		* When this happens, the video portion of the stream appears to be frozen.
-		* This is rare enough that using this for the desktop environment is tolerable (in my opinion), however for gaming not so much.
-
-
-Credits:
-	* Simple-Web-Server [https://gitlab.com/eidheim/Simple-Web-Server]
-	* Moonlight [https://github.com/moonlight-stream]
-	* Looking-Glass [https://github.com/gnif/LookingGlass] (For showing me how to properly capture frames on Windows, saving me a lot of time :)
-
-
-
-Application List:
-	* You can use Environment variables in place of values
-		* $(HOME) will be replaced by the value of $HOME
-		* $$ will be replaced by $ --> $$(HOME) will be replaced by $(HOME)
-	* env: Adds or overwrites Environment variables for the commands/applications run by Sunshine.
-		* "Variable name":"Variable value"
-	* apps: The list of applications
-		* name: Self explanatory
-		* output <optional>: The file where the output of the command is stored
-			* If it is not specified, the output is ignored
-		* prep-cmd: A list of commands to be run before/after the application
-			* If any of the prep-commands fail, starting the application is aborted
-			* do: Run before the application
-				* If it fails, all 'undo' commands of the previously succeeded 'do' commands are run
-			* undo <optional>: Run after the application has terminated
-				* This should not fail considering it is supposed to undo the 'do' commands.
-				* If it fails, Sunshine is terminated
-		* cmd <optional>: The main application
-			* If not specified, a processs is started that sleeps indefinitely
-
-When an application is started, if there is an application already running, it will be terminated.
-When the application has been shutdown, the stream shuts down as well.
-In addition to the apps listed, one app "Desktop" is hardcoded into Sunshine. It does not start an application, instead it simply starts a stream.

appveyor.yml

@@ -1,48 +0,0 @@
-image:
-  - Ubuntu
-  - Visual Studio 2019
-
-environment:
-  matrix:
-    - BUILD_TYPE: Debug
-    - BUILD_TYPE: Release
-
-install:
-  - sh: sudo add-apt-repository ppa:hnakamur/icu
-  - sh: sudo add-apt-repository ppa:hnakamur/boost
-
-  - sh: sudo add-apt-repository ppa:savoury1/build-tools
-  - sh: sudo add-apt-repository ppa:savoury1/backports
-  - sh: sudo add-apt-repository ppa:savoury1/graphics
-  - sh: sudo add-apt-repository ppa:savoury1/multimedia
-  - sh: sudo add-apt-repository ppa:savoury1/ffmpeg4
-
-  - sh: sudo apt update
-  - sh: sudo apt install -y fakeroot cmake libssl-dev libavdevice-dev libboost-thread1.67-dev libboost-filesystem1.67-dev libboost-log1.67-dev libpulse-dev libopus-dev libxtst-dev libx11-dev libxfixes-dev libevdev-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev
-  - sh: sudo update-alternatives --set gcc /usr/bin/gcc-8
-  - cmd: C:\msys64\usr\bin\bash -lc "pacman --needed --noconfirm -S mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-opus mingw-w64-x86_64-x265 mingw-w64-x86_64-boost git yasm nasm diffutils make"
-
-before_build:
-  - git submodule update --init --recursive
-  - mkdir build
-  - cd build
-
-build_script:
-  - cmd: set OLDPATH=%PATH%
-  - cmd: set PATH=C:\msys64\mingw64\bin
-  - sh: cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DSUNSHINE_EXECUTABLE_PATH=sunshine -DSUNSHINE_ASSETS_DIR=/etc/sunshine ..
-  - cmd: cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DSUNSHINE_STANDALONE=ON -DSUNSHINE_ASSETS_DIR=assets -G "MinGW Makefiles" ..
-  - sh: make -j$(nproc)
-  - cmd: mingw32-make -j2
-  - cmd: set PATH=%OLDPATH%
-
-after_build:
-  - sh: ./gen-deb
-  - cmd: Del ..\assets\apps_linux.json
-  - cmd: 7z a Sunshine-Windows.zip ..\assets
-  - cmd: 7z a Sunshine-Windows.zip sunshine.exe
-  - cmd: 7z a Sunshine-Windows.zip tools\dxgi-info.exe
-  - cmd: 7z a Sunshine-Windows.zip tools\audio-info.exe
-  - cmd: appveyor PushArtifact Sunshine-Windows.zip
-  - sh: appveyor PushArtifact package-deb/sunshine.deb
-  - sh: appveyor PushArtifact sunshine.service

assets/apps_linux.json

@@ -1,23 +0,0 @@
-{
-	"env":{ 
-		"DISPLAY":":0",
-		"DRI_PRIME":"1",
-		"XAUTHORITY":"$(HOME)/.Xauthority",
-		"PATH":"$(PATH):$(HOME)/.local/bin"
-	},
-	"apps":[
-	{
-		"name":"Low Res Desktop",
-		"prep-cmd":[
-		{ "do":"xrandr --output HDMI-1 --mode 1920x1080", "undo":"xrandr --output HDMI-1 --mode 1920x1200" }
-		]
-	},
-	{
-		"name":"Steam BigPicture",
-
-		"output":"steam.txt",
-		"cmd":"steam -bigpicture",
-		"prep-cmd":[]
-	}
-	]
-}

assets/apps_windows.json

@@ -1,15 +0,0 @@
-{
-	"env":{
-		"PATH":"$(PATH);C:\\Program Files (x86)\\Steam"
-	},
-	"apps":[
-	{
-		"name":"Steam BigPicture",
-
-		"output":"steam.txt",
-		"prep-cmd":[
-			{"do":"steam \"steam://open/bigpicture\""}
-		]
-	}
-	]
-}

assets/sunshine.conf

@@ -1,130 +0,0 @@
-# If no external IP address is given, the local IP address is used
-# external_ip = 123.456.789.12
-
-# The private key must be 2048 bits
-# pkey = /dir/pkey.pem
-
-# The certificate must be signed with a 2048 bit key
-# cert = /dir/cert.pem
-
-# The name displayed by Moonlight
-# If not specified, the PC's hostname is used
-# sunshine_name = Sunshine
-
-# The minimum log level printed to standard out
-#
-# none -> no logs are printed to standard out
-#
-# verbose = [0]
-# debug   = [1]
-# info    = [2]
-# warning = [3]
-# error   = [4]
-# fatal   = [5]
-# none    = [6]
-#
-# min_log_level = info
-
-# The origin of the remote endpoint address that is not denied for HTTP method /pin
-# Could be any of the following values:
-#   pc|lan|wan
-#     pc: Only localhost may access /pin
-#     lan: Only those in LAN may access /pin
-#     wan: Anyone may access /pin
-#
-# origin_pin_allowed = lan
-
-# The file where current state of Sunshine is stored
-# file_state = sunshine_state.json
-
-# How long to wait in milliseconds for data from moonlight before shutting down the stream
-# ping_timeout = 2000
-
-# The file where configuration for the different applications that Sunshine can run during a stream
-# file_apps = apps.json
-
-# How much error correcting packets must be send for every video
-# This is just some random number, don't know the optimal value
-# The higher fec_percentage, the lower space for the actual data to send per frame there is
-#
-# The value must be greater than 0 and lower than or equal to 100
-# fec_percentage = 10
-
-# When multicasting, it could be usefull to have different configurations for each connected Client.
-# For example:
-# 	Clients connected through WAN and LAN have different bitrate contstraints.
-# 	Decoders may require different settings for color
-#
-# Unlike simply broadcasting to multiple Client, this will generate distinct video streams.
-# Note, CPU usage increases for each distinct video stream generated
-# channels = 1
-
-# The back/select button on the controller
-# On the Shield, the home and powerbutton are not passed to Moonlight
-# If, after the timeout, the back button is still pressed down, Home/Guide button press is emulated.
-# If back_button_timeout < 0, then the Home/Guide button will not be emulated
-# back_button_timeout = 2000
-
-
-# The name of the audio sink used for Audio Loopback
-# If you do not specify this variable, pulseaudio will select the default monitor device.
-#
-# You can find the name of the audio sink using the following command:
-# !! Linux only !!
-# pacmd list-sources | grep "name:"
-# audio_sink = alsa_output.pci-0000_09_00.3.analog-stereo.monitor
-#
-# !! Windows only !!
-# tools\audio-info.exe
-# audio_sink = {0.0.0.00000000}.{FD47D9CC-4218-4135-9CE2-0C195C87405B}
-
-# !! Windows only !!
-# You can select the video card you want to stream:
-# The appropriate values can be found using the following command:
-# tools\dxgi-info.exe
-# adapter_name = Radeon RX 580 Series
-# output_name  = \\.\DISPLAY1
-
-
-###############################################
-# FFmpeg software encoding parameters
-# Honestly, I have no idea what the optimal values would be.
-# Play around with this :)
-
-# Constant Rate Factor. Between 1 and 52. It allows QP to go up during motion and down with still image, resulting in constant perceived quality
-# Higher value means more compression, but less quality
-# If crf == 0, then use QP directly instead
-# crf = 0
-
-# Quantitization Parameter
-# Higher value means more compression, but less quality
-# If crf != 0, then this parameter is ignored
-# qp = 28
-
-# Minimum number of threads used by ffmpeg to encode the video.
-# Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually
-# worth it to gain the use of more CPU cores for encoding. The ideal value is the lowest
-# value that can reliably encode at your desired streaming settings on your hardware.
-# min_threads = 2
-
-# Allows the client to request HEVC Main or HEVC Main10 video streams.
-# HEVC is more CPU-intensive to encode, so enabling this may reduce performance.
-# If set to 0 (default), Sunshine will not advertise support for HEVC
-# If set to 1, Sunshine will advertise support for HEVC Main profile
-# If set to 2, Sunshine will advertise support for HEVC Main and Main10 (HDR) profiles
-# hevc_mode = 2
-
-# See x264 --fullhelp for the different presets
-# preset  = superfast
-# tune    = zerolatency
-#
-#
-##############################################
-# Some configurable parameters, are merely toggles for specific features
-# The first occurrence turns it on, the second occurence turns it off, the third occurence turns it on again, etc, etc
-# Here, you change the default state of any flag
-#
-# To set the initial state of flags -0 and -1 to on, set the following flags:
-# flags = 01
-#
-# See: sunshine --help for all options under the header: flags

cmake/FindLIBCAP.cmake

@@ -0,0 +1,21 @@
+# - Try to find Libcap
+# Once done this will define
+#
+#  LIBCAP_FOUND - system has Libcap
+#  LIBCAP_INCLUDE_DIRS - the Libcap include directory
+#  LIBCAP_LIBRARIES - the libraries needed to use Libcap
+#  LIBCAP_DEFINITIONS - Compiler switches required for using Libcap
+
+# Use pkg-config to get the directories and then use these values
+# in the find_path() and find_library() calls
+find_package(PkgConfig)
+pkg_check_modules(PC_LIBCAP libcap)
+
+set(LIBCAP_DEFINITIONS ${PC_LIBCAP_CFLAGS})
+
+find_path(LIBCAP_INCLUDE_DIRS sys/capability.h PATHS ${PC_LIBCAP_INCLUDEDIR} ${PC_LIBCAP_INCLUDE_DIRS})
+find_library(LIBCAP_LIBRARIES NAMES libcap.so PATHS ${PC_LIBCAP_LIBDIR} ${PC_LIBCAP_LIBRARY_DIRS})
+mark_as_advanced(LIBCAP_INCLUDE_DIRS LIBCAP_LIBRARIES)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(LIBCAP REQUIRED_VARS LIBCAP_LIBRARIES LIBCAP_INCLUDE_DIRS)

cmake/FindLIBDRM.cmake

@@ -0,0 +1,21 @@
+# - Try to find Libdrm
+# Once done this will define
+#
+#  LIBDRM_FOUND - system has Libdrm
+#  LIBDRM_INCLUDE_DIRS - the Libdrm include directory
+#  LIBDRM_LIBRARIES - the libraries needed to use Libdrm
+#  LIBDRM_DEFINITIONS - Compiler switches required for using Libdrm
+
+# Use pkg-config to get the directories and then use these values
+# in the find_path() and find_library() calls
+find_package(PkgConfig)
+pkg_check_modules(PC_LIBDRM libdrm)
+
+set(LIBDRM_DEFINITIONS ${PC_LIBDRM_CFLAGS})
+
+find_path(LIBDRM_INCLUDE_DIRS drm.h PATHS ${PC_LIBDRM_INCLUDEDIR} ${PC_LIBDRM_INCLUDE_DIRS} PATH_SUFFIXES libdrm)
+find_library(LIBDRM_LIBRARIES NAMES libdrm.so PATHS ${PC_LIBDRM_LIBDIR} ${PC_LIBDRM_LIBRARY_DIRS})
+mark_as_advanced(LIBDRM_INCLUDE_DIRS LIBDRM_LIBRARIES)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(LIBDRM REQUIRED_VARS LIBDRM_LIBRARIES LIBDRM_INCLUDE_DIRS)

cmake/FindWayland.cmake

@@ -0,0 +1,80 @@
+# Try to find Wayland on a Unix system
+#
+# This will define:
+#
+#   WAYLAND_FOUND        - True if Wayland is found
+#   WAYLAND_LIBRARIES    - Link these to use Wayland
+#   WAYLAND_INCLUDE_DIRS - Include directory for Wayland
+#   WAYLAND_DEFINITIONS  - Compiler flags for using Wayland
+#
+# In addition the following more fine grained variables will be defined:
+#
+#   Wayland_Client_FOUND  WAYLAND_CLIENT_INCLUDE_DIRS  WAYLAND_CLIENT_LIBRARIES
+#   Wayland_Server_FOUND  WAYLAND_SERVER_INCLUDE_DIRS  WAYLAND_SERVER_LIBRARIES
+#   Wayland_EGL_FOUND     WAYLAND_EGL_INCLUDE_DIRS     WAYLAND_EGL_LIBRARIES
+#   Wayland_Cursor_FOUND  WAYLAND_CURSOR_INCLUDE_DIRS  WAYLAND_CURSOR_LIBRARIES
+#
+# Copyright (c) 2013 Martin Gräßlin <mgraesslin@kde.org>
+#               2020 Georges Basile Stavracas Neto <georges.stavracas@gmail.com>
+#
+# Redistribution and use is allowed according to the terms of the BSD license.
+# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
+
+IF (NOT WIN32)
+
+    # Use pkg-config to get the directories and then use these values
+    # in the find_path() and find_library() calls
+    find_package(PkgConfig)
+    PKG_CHECK_MODULES(PKG_WAYLAND QUIET wayland-client wayland-server wayland-egl wayland-cursor)
+
+    set(WAYLAND_DEFINITIONS ${PKG_WAYLAND_CFLAGS})
+
+    find_path(WAYLAND_CLIENT_INCLUDE_DIRS NAMES wayland-client.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_CLIENT_LIBRARIES NAMES wayland-client   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_CLIENT_INCLUDE_DIRS AND WAYLAND_CLIENT_LIBRARIES)
+        set(Wayland_Client_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_Client_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_CLIENT_INCLUDE_DIRS WAYLAND_CLIENT_LIBRARIES)
+
+    find_path(WAYLAND_CURSOR_INCLUDE_DIRS NAMES wayland-cursor.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_CURSOR_LIBRARIES NAMES wayland-cursor   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_CURSOR_INCLUDE_DIRS AND WAYLAND_CURSOR_LIBRARIES)
+        set(Wayland_Cursor_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_Cursor_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_CURSOR_INCLUDE_DIRS WAYLAND_CURSOR_LIBRARIES)
+
+    find_path(WAYLAND_EGL_INCLUDE_DIRS    NAMES wayland-egl.h    HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_EGL_LIBRARIES    NAMES wayland-egl      HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_EGL_INCLUDE_DIRS AND WAYLAND_EGL_LIBRARIES)
+        set(Wayland_EGL_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_EGL_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_EGL_INCLUDE_DIRS WAYLAND_EGL_LIBRARIES)
+
+    find_path(WAYLAND_SERVER_INCLUDE_DIRS NAMES wayland-server.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS})
+    find_library(WAYLAND_SERVER_LIBRARIES NAMES wayland-server   HINTS ${PKG_WAYLAND_LIBRARY_DIRS})
+    if(WAYLAND_SERVER_INCLUDE_DIRS AND WAYLAND_SERVER_LIBRARIES)
+        set(Wayland_Server_FOUND TRUE)  # cmake-lint: disable=C0103
+    else()
+        set(Wayland_Server_FOUND FALSE)  # cmake-lint: disable=C0103
+    endif()
+    mark_as_advanced(WAYLAND_SERVER_INCLUDE_DIRS WAYLAND_SERVER_LIBRARIES)
+
+    set(WAYLAND_INCLUDE_DIRS ${WAYLAND_CLIENT_INCLUDE_DIRS} ${WAYLAND_SERVER_INCLUDE_DIRS}
+            ${WAYLAND_EGL_INCLUDE_DIRS} ${WAYLAND_CURSOR_INCLUDE_DIRS})
+    set(WAYLAND_LIBRARIES ${WAYLAND_CLIENT_LIBRARIES} ${WAYLAND_SERVER_LIBRARIES}
+            ${WAYLAND_EGL_LIBRARIES} ${WAYLAND_CURSOR_LIBRARIES})
+    mark_as_advanced(WAYLAND_INCLUDE_DIRS WAYLAND_LIBRARIES)
+
+    list(REMOVE_DUPLICATES WAYLAND_INCLUDE_DIRS)
+
+    include(FindPackageHandleStandardArgs)
+
+    find_package_handle_standard_args(Wayland REQUIRED_VARS WAYLAND_LIBRARIES WAYLAND_INCLUDE_DIRS HANDLE_COMPONENTS)
+
+ENDIF ()

crowdin.yml

@@ -0,0 +1,22 @@
+---
+"base_path": "."
+"base_url": "https://api.crowdin.com"  # optional (for Crowdin Enterprise only)
+"preserve_hierarchy": false  # flatten tree on crowdin
+"pull_request_labels": [
+  "crowdin",
+  "l10n"
+]
+
+"files": [
+  {
+    "source": "/locale/*.po",
+    "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"
+      }
+    }
+  }
+]

docker/archlinux.dockerfile

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

docker/debian-bullseye.dockerfile

@@ -0,0 +1,174 @@
+# 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=12.9* \
+  cmake=3.18.4* \
+  git=1:2.30.2* \
+  libavdevice-dev=7:4.3.* \
+  libboost-filesystem-dev=1.74.0* \
+  libboost-locale-dev=1.74.0* \
+  libboost-log-dev=1.74.0* \
+  libboost-program-options-dev=1.74.0* \
+  libboost-thread-dev=1.74.0* \
+  libcap-dev=1:2.44* \
+  libcurl4-openssl-dev=7.74.0* \
+  libdrm-dev=2.4.104* \
+  libevdev-dev=1.11.0* \
+  libnuma-dev=2.0.12* \
+  libopus-dev=1.3.1* \
+  libpulse-dev=14.2* \
+  libssl-dev=1.1.1* \
+  libva-dev=2.10.0* \
+  libvdpau-dev=1.4* \
+  libwayland-dev=1.18.0* \
+  libx11-dev=2:1.7.2* \
+  libxcb-shm0-dev=1.14* \
+  libxcb-xfixes0-dev=1.14* \
+  libxcb1-dev=1.14* \
+  libxfixes-dev=1:5.0.3* \
+  libxrandr-dev=2:1.5.1* \
+  libxtst-dev=2:1.2.3* \
+  nodejs=12.22* \
+  npm=7.5.2* \
+  wget=1.21*
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  apt-get install -y --no-install-recommends \
+    libmfx-dev=21.1.0*
+fi
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_DEPS
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="11.8.0"
+ENV CUDA_BUILD="520.61.05"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G DEB
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.deb /sunshine-${BASE}-${TAG}-${TARGETARCH}.deb
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.deb /sunshine.deb
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+apt-get update -y
+apt-get install -y --no-install-recommends /sunshine.deb
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -G input -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-36.dockerfile

@@ -0,0 +1,172 @@
+# 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=36
+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.76.0* \
+  cmake-3.22.2* \
+  gcc-12.0.1* \
+  gcc-c++-12.0.1* \
+  git-2.39.2* \
+  libappindicator-gtk3-devel-12.10.0* \
+  libcap-devel-2.48* \
+  libcurl-devel-7.82.0* \
+  libdrm-devel-2.4.110* \
+  libevdev-devel-1.12.0* \
+  libva-devel-2.14.0* \
+  libvdpau-devel-1.5* \
+  libX11-devel-1.7.3* \
+  libxcb-devel-1.13.1* \
+  libXcursor-devel-1.2.0* \
+  libXfixes-devel-6.0.0* \
+  libXi-devel-1.8* \
+  libXinerama-devel-1.1.4* \
+  libXrandr-devel-1.5.2* \
+  libXtst-devel-1.2.3* \
+  mesa-libGL-devel-22.0.1* \
+  npm-8.3.1* \
+  numactl-devel-2.0.14* \
+  openssl-devel-3.0.2* \
+  opus-devel-1.3.1* \
+  pulseaudio-libs-devel-15.0* \
+  rpm-build-4.17.0* \
+  wget-1.21.3* \
+  which-2.21*
+if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then
+  dnf -y install intel-mediasdk-devel-22.3.0*
+fi
+dnf clean all
+rm -rf /var/cache/yum
+_DEPS
+
+# install cuda
+WORKDIR /build/cuda
+# versions: https://developer.nvidia.com/cuda-toolkit-archive
+ENV CUDA_VERSION="12.0.0"
+ENV CUDA_BUILD="525.60.13"
+# hadolint ignore=SC3010
+RUN <<_INSTALL_CUDA
+#!/bin/bash
+set -e
+cuda_prefix="https://developer.download.nvidia.com/compute/cuda/"
+cuda_suffix=""
+if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then
+  cuda_suffix="_sbsa"
+fi
+url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run"
+echo "cuda url: ${url}"
+wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+chmod a+x ./cuda.run
+./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm
+rm ./cuda.run
+_INSTALL_CUDA
+
+# copy repository
+WORKDIR /build/sunshine/
+COPY --link .. .
+
+# setup npm dependencies
+RUN npm install
+
+# setup build directory
+WORKDIR /build/sunshine/build
+
+# cmake and cpack
+RUN <<_MAKE
+#!/bin/bash
+set -e
+cmake \
+  -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DSUNSHINE_ASSETS_DIR=share/sunshine \
+  -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \
+  -DSUNSHINE_ENABLE_WAYLAND=ON \
+  -DSUNSHINE_ENABLE_X11=ON \
+  -DSUNSHINE_ENABLE_DRM=ON \
+  -DSUNSHINE_ENABLE_CUDA=ON \
+  /build/sunshine
+make -j "$(nproc)"
+cpack -G RPM
+_MAKE
+
+FROM scratch AS artifacts
+ARG BASE
+ARG TAG
+ARG TARGETARCH
+COPY --link --from=sunshine-build /build/sunshine/build/cpack_artifacts/Sunshine.rpm /sunshine-${BASE}-${TAG}-${TARGETARCH}.rpm
+
+FROM sunshine-base as sunshine
+
+# copy deb from builder
+COPY --link --from=artifacts /sunshine*.rpm /sunshine.rpm
+
+# install sunshine
+RUN <<_INSTALL_SUNSHINE
+#!/bin/bash
+set -e
+dnf -y update
+dnf -y install /sunshine.rpm
+dnf clean all
+rm -rf /var/cache/yum
+_INSTALL_SUNSHINE
+
+# network setup
+EXPOSE 47984-47990/tcp
+EXPOSE 48010
+EXPOSE 47998-48000/udp
+
+# setup user
+ARG PGID=1000
+ENV PGID=${PGID}
+ARG PUID=1000
+ENV PUID=${PUID}
+ENV TZ="UTC"
+ARG UNAME=lizard
+ENV UNAME=${UNAME}
+
+ENV HOME=/home/$UNAME
+
+# setup user
+RUN <<_SETUP_USER
+#!/bin/bash
+set -e
+groupadd -f -g "${PGID}" "${UNAME}"
+useradd -lm -d ${HOME} -s /bin/bash -g "${PGID}" -G input -u "${PUID}" "${UNAME}"
+mkdir -p ${HOME}/.config/sunshine
+ln -s ${HOME}/.config/sunshine /config
+chown -R ${UNAME} ${HOME}
+_SETUP_USER
+
+USER ${UNAME}
+WORKDIR ${HOME}
+
+# entrypoint
+ENTRYPOINT ["/usr/bin/sunshine"]

docker/fedora-37.dockerfile

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

docker/ubuntu-20.04.dockerfile

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

docker/ubuntu-22.04.dockerfile

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

@@ -0,0 +1,20 @@
+# 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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,5 @@
+breathe==4.35.0
+furo==2023.3.27
+m2r2==0.3.3.post2
+Sphinx==6.1.3
+sphinx-copybutton==0.5.1

docs/source/about/app_examples.rst

@@ -0,0 +1,189 @@
+App Examples
+============
+Since not all applications behave the same, we decided to create some examples to help you get started adding games
+and applications to Sunshine.
+
+.. Attention:: Throughout these examples, any fields not shown are left blank. You can enhance your experience by
+   adding an image or a log file (via the ``Output`` field).
+
+Common Examples
+---------------
+
+Desktop
+^^^^^^^
+
++----------------------+-----------------+
+| **Field**            | **Value**       |
++----------------------+-----------------+
+| Application Name     | ``Desktop``     |
++----------------------+-----------------+
+| Image                | ``desktop.png`` |
++----------------------+-----------------+
+
+Steam Big Picture
+^^^^^^^^^^^^^^^^^
+
+.. Note:: Steam is launched as a detached command because Steam starts with a process that self updates itself and the original
+   process is killed. Since the original process ends it will not work as a regular command.
+
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| **Field**            | **Linux**                                | **macOS**                        | **Windows**                       |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| Application Name     | ``Steam Big Picture``                                                                                           |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| Detached Commands    | ``setsid steam steam://open/bigpicture`` | ``open steam://open/bigpicture`` | ``steam steam://open/bigpicture`` |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+| Image                | ``steam.png``                                                                                                   |
++----------------------+------------------------------------------+----------------------------------+-----------------------------------+
+
+Epic Game Store game
+^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched
+   using the "Command" and therefore the stream will not end when the game ends.
+
+URI (Epic)
+""""""""""
+
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Field**            | **Windows**                                                                                                                                               |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                                                        |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Detached Commands    | ``cmd /C "start com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true"`` |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Binary (Epic w/ working directory)
+""""""""""""""""""""""""""""""""""
+
++----------------------+-----------------------------------------------+
+| **Field**            | **Windows**                                   |
++----------------------+-----------------------------------------------+
+| Application Name     | ``Surviving Mars``                            |
++----------------------+-----------------------------------------------+
+| Command              | ``cmd /c "MarsEpic.exe"``                     |
++----------------------+-----------------------------------------------+
+| Working Directory    | ``C:\Program Files\Epic Games\SurvivingMars`` |
++----------------------+-----------------------------------------------+
+
+Binary (Epic w/o working directory)
+"""""""""""""""""""""""""""""""""""
+
++----------------------+--------------------------------------------------------------+
+| **Field**            | **Windows**                                                  |
++----------------------+--------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                           |
++----------------------+--------------------------------------------------------------+
+| Command              | ``"C:\Program Files\Epic Games\SurvivingMars\MarsEpic.exe"`` |
++----------------------+--------------------------------------------------------------+
+
+
+Steam game
+^^^^^^^^^^
+
+.. Note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched
+   using the "Command" and therefore the stream will not end when the game ends.
+
+URI (Steam)
+"""""""""""
+
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+| **Field**            | **Linux**                                 | **macOS**                         | **Windows**                                 |
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                          |
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+| Detached Commands    | ``setsid steam steam://rungameid/464920`` | ``open steam://rungameid/464920`` | ``cmd /C "start steam://rungameid/464920"`` |
++----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+
+
+Binary (Steam w/ working directory)
+"""""""""""""""""""""""""""""""""""
+
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| **Field**            | **Linux**               | **macOS**               | **Windows**                                                      |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                   |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| Command              | ``MarsSteam``                                     | ``cmd /c "MarsSteam.exe"``                                       |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+| Working Directory    | ``~/.steam/steam/SteamApps/common/Survivng Mars`` | ``C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars`` |
++----------------------+-------------------------+-------------------------+------------------------------------------------------------------+
+
+Binary (Steam w/o working directory)
+""""""""""""""""""""""""""""""""""""
+
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+| **Field**            | **Linux**                    | **macOS**                    | **Windows**                                                                      |
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+| Application Name     | ``Surviving Mars``                                                                                                                             |
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+| Command              | ``~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam`` | ``"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars\MarsSteam.exe"`` |
++----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+
+
+Linux
+-----
+
+Changing Resolution and Refresh Rate (Linux - X11)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------------+--------------------------------------------------------------+
+| **Field**            | **Value**                                                    |
++----------------------+--------------------------------------------------------------+
+| Command Preparations | Do: ``xrandr --output HDMI-1 --mode 1920x1080 --rate 60``    |
+|                      +--------------------------------------------------------------+
+|                      | Undo: ``xrandr --output HDMI-1 --mode 3840×2160 --rate 120`` |
++----------------------+--------------------------------------------------------------+
+
+Changing Resolution and Refresh Rate (Linux - Wayland)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------------+-------------------------------------------------------------+
+| **Field**            | **Value**                                                   |
++----------------------+-------------------------------------------------------------+
+| Command Preparations | Do: ``wlr-xrandr --output HDMI-1 --mode 1920x1080@60Hz``    |
+|                      +-------------------------------------------------------------+
+|                      | Undo: ``wlr-xrandr --output HDMI-1 --mode 3840×2160@120Hz`` |
++----------------------+-------------------------------------------------------------+
+
+Flatpak
+^^^^^^^
+
+.. Attention:: Because Flatpak packages run in a sandboxed environment and do not normally have access to the host,
+   the Flatpak of Sunshine requires commands to be prefixed with ``flatpak-spawn --host``.
+
+macOS
+-----
+
+Changing Resolution and Refresh Rate (macOS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: This example uses the `displayplacer` tool to change the resolution.
+   This tool can be installed following instructions in their
+   `GitHub repository <https://github.com/jakehilborn/displayplacer>`_.
+
++----------------------+-----------------------------------------------------------------------------------------------+
+| **Field**            | **Value**                                                                                     |
++----------------------+-----------------------------------------------------------------------------------------------+
+| Command Preparations | Do: ``displayplacer "id:<screenId> res:1920x1080 hz:60 scaling:on origin:(0,0) degree:0"``    |
+|                      +-----------------------------------------------------------------------------------------------+
+|                      | Undo: ``displayplacer "id:<screenId> res:3840x2160 hz:120 scaling:on origin:(0,0) degree:0"`` |
++----------------------+-----------------------------------------------------------------------------------------------+
+
+Windows
+-------
+
+Changing Resolution and Refresh Rate (Windows)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: This example uses the `QRes` tool to change the resolution and refresh rate.
+   This tool can be downloaded from their `SourceForge repository <https://sourceforge.net/projects/qres/>`_.
+
++----------------------+----------------------------------------------------+
+| **Field**            | **Value**                                          |
++----------------------+----------------------------------------------------+
+| Command Preparations | Do: ``FullPath\qres.exe /x:1920 /y:1080 /r:60``    |
+|                      +----------------------------------------------------+
+|                      | Undo: ``FullPath\qres.exe /x:3840 /y:2160 /r:120`` |
++----------------------+----------------------------------------------------+
+
+.. Tip:: You can change your host resolution to match the client resolution automatically using the
+   `Nonary/ResolutionAutomation <https://github.com/Nonary/ResolutionAutomation/>`_ project.

docs/source/about/changelog.rst

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

docs/source/about/docker.rst

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

docs/source/about/installation.rst

@@ -0,0 +1,257 @@
+Installation
+============
+The recommended method for running Sunshine is to use the `binaries`_ bundled with the `latest release`_.
+
+.. Attention:: Additional setup is required after installation. See
+   :ref:`Setup <about/usage:setup>`.
+
+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`_.
+
+.. Tip:: Some third party packages also exist. See
+   :ref:`Third Party Packages <about/third_party_packages:third party packages>`.
+
+Docker
+------
+Docker images are available on `Dockerhub.io`_ and `ghcr.io`_.
+
+See :ref:`Docker <about/docker:docker>` for additional information.
+
+Linux
+-----
+Follow the instructions for your preferred package type below.
+
+**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.
+
+.. table::
+   :widths: auto
+
+   ===========================================  ==============   ==============    ================================
+   Package                                      CUDA Version     Min Driver        CUDA Compute Capabilities
+   ===========================================  ==============   ==============    ================================
+   PKGBUILD                                     User dependent   User dependent    User dependent
+   sunshine.AppImage                            11.8.0           450.80.02         50;52;60;61;62;70;75;80;86;90;35
+   sunshine.pkg.tar.zst                         11.8.0           450.80.02         50;52;60;61;62;70;75;80;86;90;35
+   sunshine_{arch}.flatpak                      12.0.0           525.60.13         50;52;60;61;62;70;75;80;86;90
+   sunshine-debian-bullseye-{arch}.deb          11.8.0           450.80.02         50;52;60;61;62;70;75;80;86;90;35
+   sunshine-fedora-36-{arch}.rpm                12.0.0           525.60.13         50;52;60;61;62;70;75;80;86;90
+   sunshine-fedora-37-{arch}.rpm                12.0.0           525.60.13         50;52;60;61;62;70;75;80;86;90
+   sunshine-ubuntu-20.04-{arch}.deb             11.8.0           450.80.02         50;52;60;61;62;70;75;80;86;90;35
+   sunshine-ubuntu-22.04-{arch}.deb             11.8.0           450.80.02         50;52;60;61;62;70;75;80;86;90;35
+   ===========================================  ==============   ==============    ================================
+
+AppImage
+^^^^^^^^
+According to AppImageLint the supported distro matrix of the AppImage is below.
+
+- [✖] Debian oldstable (buster)
+- [✔] Debian stable (bullseye)
+- [✔] Debian testing (bookworm)
+- [✔] Debian unstable (sid)
+- [✔] Ubuntu kinetic
+- [✔] Ubuntu jammy
+- [✔] Ubuntu focal
+- [✖] Ubuntu bionic
+- [✖] Ubuntu xenial
+- [✖] Ubuntu trusty
+- [✖] CentOS 7
+
+#. Download ``sunshine.AppImage`` to your home directory.
+#. Open terminal and run the following code.
+
+   .. code-block:: bash
+
+      ./sunshine.AppImage --install
+
+Start:
+   .. code-block:: bash
+
+      ./sunshine.AppImage --install && ./sunshine.AppImage
+
+Uninstall:
+   .. code-block:: bash
+
+      ./sunshine.AppImage --remove
+
+Archlinux PKGBUILD
+^^^^^^^^^^^^^^^^^^
+#. Open terminal and run the following code.
+
+   .. code-block:: bash
+
+      wget https://github.com/LizardByte/Sunshine/releases/latest/download/PKGBUILD
+      makepkg -fi
+
+Uninstall:
+   .. code-block:: bash
+
+      pacman -R sunshine
+
+Archlinux pkg
+^^^^^^^^^^^^^
+#. Open terminal and run the following code.
+
+   .. code-block:: bash
+
+      wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.pkg.tar.zst
+      pacman -U --noconfirm sunshine.pkg.tar.zst
+
+Uninstall:
+   .. code-block:: bash
+
+      pacman -R sunshine
+
+Debian Package
+^^^^^^^^^^^^^^
+#. Download ``sunshine-{ubuntu-version}.deb`` and run the following code.
+
+   .. code-block:: bash
+
+      sudo apt install -f ./sunshine-{ubuntu-version}.deb
+
+.. Note:: The ``{ubuntu-version}`` is the version of ubuntu we built the package on. If you are not using Ubuntu and
+   have an issue with one package, you can try another.
+
+.. Tip:: You can double click the deb file to see details about the package and begin installation.
+
+Uninstall:
+   .. code-block:: bash
+
+      sudo apt remove sunshine
+
+Flatpak Package
+^^^^^^^^^^^^^^^
+#. Install `Flatpak <https://flatpak.org/setup/>`_ as required.
+#. Download ``sunshine_{arch}.flatpak`` and run the following code.
+
+   .. Note:: Be sure to replace ``{arch}`` with the architecture for your operating system.
+
+   System level (recommended)
+      .. code-block:: bash
+
+         flatpak install --system ./sunshine_{arch}.flatpak
+
+   User level
+      .. code-block:: bash
+
+         flatpak install --user ./sunshine_{arch}.flatpak
+
+   Additional installation (required)
+      .. code-block:: bash
+
+         flatpak run --command=additional-install.sh dev.lizardbyte.sunshine
+
+Start:
+   X11 and NVFBC capture (X11 Only)
+      .. code-block:: bash
+
+         flatpak run dev.lizardbyte.sunshine
+
+   KMS capture (Wayland & X11)
+      .. code-block:: bash
+
+         sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') flatpak run dev.lizardbyte.sunshine
+
+Uninstall:
+   .. code-block:: bash
+
+      flatpak run --command=remove-additional-install.sh dev.lizardbyte.sunshine
+      flatpak uninstall --delete-data dev.lizardbyte.sunshine
+
+RPM Package
+^^^^^^^^^^^
+#. Add `rpmfusion` repositories by running the following code.
+
+   .. code-block:: bash
+
+      sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \
+      https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
+
+#. Download ``sunshine.rpm`` and run the following code.
+
+   .. code-block:: bash
+
+      sudo dnf install ./sunshine.rpm
+
+.. Tip:: You can double click the rpm file to see details about the package and begin installation.
+
+Uninstall:
+   .. code-block:: bash
+
+      sudo dnf remove sunshine
+
+macOS
+-----
+Sunshine on macOS is experimental. Gamepads do not work. Other features may not work as expected.
+
+pkg
+^^^
+.. Warning:: The `pkg` does not include runtime dependencies.
+
+#. Download the ``sunshine.pkg`` file and install it as normal.
+
+Uninstall:
+   .. code-block:: bash
+
+      cd /etc/sunshine/assets
+      uninstall_pkg.sh
+
+Portfile
+^^^^^^^^
+#. Install `MacPorts <https://www.macports.org>`_
+#. Update the Macports sources.
+
+   .. code-block:: bash
+
+      sudo nano /opt/local/etc/macports/sources.conf
+
+   Add this line, replacing your username, below the line that starts with ``rsync``.
+      ``file:///Users/<username>/ports``
+
+   ``Ctrl+x``, then ``Y`` to exit and save changes.
+
+#. Download the ``Portfile`` to ``~/Downloads`` and run the following code.
+
+   .. code-block:: bash
+
+      mkdir -p ~/ports/multimedia/sunshine
+      mv ~/Downloads/Portfile ~/ports/multimedia/sunshine/
+      cd ~/ports
+      portindex
+      sudo port install sunshine
+
+#. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone.
+
+Uninstall:
+   .. code-block:: bash
+
+      sudo port uninstall sunshine
+
+Windows
+-------
+
+Installer
+^^^^^^^^^
+#. Download and install ``sunshine-windows-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 `here <ms-settings:installed-apps>`_ and select "Uninstall" from the overflow
+menu. Different versions of Windows may provide slightly different steps for uninstall.
+
+Standalone
+^^^^^^^^^^
+#. Download and extract ``sunshine-windows-portable.zip``
+
+To uninstall, delete the extracted directory which contains the ``sunshine.exe`` file.
+
+.. _latest release: https://github.com/LizardByte/Sunshine/releases/latest
+.. _Dockerhub.io: https://hub.docker.com/repository/docker/lizardbyte/sunshine
+.. _ghcr.io: https://github.com/orgs/LizardByte/packages?repo_name=sunshine

docs/source/about/overview.rst

@@ -0,0 +1 @@
+.. include:: ../../../README.rst

docs/source/about/third_party_packages.rst

@@ -0,0 +1,61 @@
+Third Party Packages
+====================
+
+.. Danger:: These packages are not maintained by LizardByte. Use at your own risk.
+
+AUR
+---
+
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=AUR&style=for-the-badge&query=$.results.0.NumVotes&url=https%3A%2F%2Fapp.lizardbyte.dev%2Funo%2Faur%2Fsunshine.json&logo=archlinux
+   :alt: AUR votes
+   :target: https://aur.archlinux.org/packages/sunshine
+
+Chocolatey
+----------
+
+.. image:: https://img.shields.io/chocolatey/v/sunshine?style=for-the-badge&logo=chocolatey
+   :alt: Chocolatey Version
+   :target: https://community.chocolatey.org/packages/sunshine
+
+.. image:: https://img.shields.io/chocolatey/dt/sunshine?style=for-the-badge&logo=chocolatey
+   :alt: Chocolatey
+
+nixpkgs
+-------
+.. image:: https://img.shields.io/badge/dynamic/xml?color=orange&label=nixpkgs&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27nix_unstable%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=nixos
+   :alt: nixpgs Version
+   :target: https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/sunshine/default.nix
+
+Scoop
+-----
+
+.. image:: https://img.shields.io/scoop/v/sunshine?bucket=extras&style=for-the-badge
+   :alt: Scoop Version (extras bucket)
+   :target: https://scoop.sh/#/apps?s=0&d=1&o=true&q=sunshine
+
+Solus
+-----
+.. image:: https://img.shields.io/badge/dynamic/xml?color=orange&label=Solus&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27solus%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=solus
+   :alt: Solus Version
+   :target: https://dev.getsol.us/source/sunshine
+
+Winget
+------
+.. image:: https://img.shields.io/badge/dynamic/xml?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
+
+Legacy GitHub Repo
+------------------
+
+.. Attention:: This repo is not maintained. Thank you to Loki for bringing this amazing project to life!
+
+.. image:: https://img.shields.io/static/v1?label=repo&message=loki-47-6F-64/sunshine&color=blue&style=for-the-badge&logo=github
+   :alt: GitHub Maintainer
+   :target: https://github.com/loki-47-6F-64/sunshine/releases
+
+.. image:: https://img.shields.io/github/last-commit/loki-47-6F-64/sunshine?style=for-the-badge&logo=github
+   :alt: GitHub last commit
+
+.. image:: https://img.shields.io/github/release-date/loki-47-6F-64/sunshine?style=for-the-badge&logo=github
+   :alt: GitHub Release Date

docs/source/about/usage.rst

@@ -0,0 +1,284 @@
+Usage
+=====
+#. See the `setup`_ section for your specific OS.
+#. If you did not install the service, then start sunshine with the following command, unless a start command is listed
+   in the specified package :ref:`installation <about/installation:installation>` instructions.
+
+   .. Note:: A service is a process that runs in the background. Running multiple instances of Sunshine is not
+      advised.
+
+   **Basic usage**
+      .. code-block:: bash
+
+         sunshine
+
+   **Specify config file**
+      .. code-block:: bash
+
+         sunshine <directory of conf file>/sunshine.conf
+
+      .. Note:: You do not need to specify a config file. If no config file is entered the default location will be used.
+
+      .. Attention:: The configuration file specified will be created if it doesn't exist.
+
+#. Configure Sunshine in the web ui
+
+   The web ui is available on `https://localhost:47990 <https://localhost:47990>`_ by default. You may replace
+   `localhost` with your internal ip address.
+
+   .. Attention:: Ignore any warning given by your browser about "insecure website". 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.
+
+   **Add games and applications.**
+         This can be configured in the web ui.
+
+         .. Note:: Additionally, apps can be configured manually. `src_assets/<os>/config/apps.json` is an example of a
+            list of applications that are started just before running a stream. This is the directory within the GitHub
+            repo.
+
+#. In Moonlight, you may need to add the PC manually.
+#. When Moonlight request you insert the correct pin on sunshine:
+
+   - 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
+
+Network
+-------
+The Sunshine user interface will be available on port 47990 by default.
+
+.. Warning:: Exposing ports to the internet can be dangerous. Do this at your own risk.
+
+Arguments
+---------
+To get a list of available arguments run the following:
+   .. code-block:: bash
+
+      sunshine --help
+
+Setup
+-----
+
+Linux
+^^^^^
+The `deb`, `rpm`, `Flatpak` and `AppImage` packages handle these steps automatically. Third party packages may not.
+
+Sunshine needs access to `uinput` to create mouse and gamepad events.
+
+#. Add user to group `input`, if this is the first time installing.
+      .. code-block:: bash
+
+         sudo usermod -a -G input $USER
+
+#. Create `udev` rules.
+      .. code-block::
+
+         echo 'KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"' | \
+         sudo tee /etc/udev/rules.d/85-sunshine-input.rules
+
+#. Optionally, configure autostart service
+
+   - filename: ``~/.config/systemd/user/sunshine.service``
+   - contents:
+         .. code-block::
+
+            [Unit]
+            Description=Sunshine self-hosted game stream host for Moonlight.
+            StartLimitIntervalSec=500
+            StartLimitBurst=5
+
+            [Service]
+            ExecStart=<see table>
+            Restart=on-failure
+            RestartSec=5s
+            #Flatpak Only
+            #ExecStop=flatpak kill dev.lizardbyte.sunshine
+
+            [Install]
+            WantedBy=graphical-session.target
+
+         .. table::
+            :widths: auto
+
+            ========   ==============================================   ===============
+            package    ExecStart                                        Auto Configured
+            ========   ==============================================   ===============
+            aur        /usr/bin/sunshine                                ✔
+            deb        /usr/bin/sunshine                                ✔
+            rpm        /usr/bin/sunshine                                ✔
+            AppImage   ~/sunshine.AppImage                              ✔
+            Flatpak    flatpak run dev.lizardbyte.sunshine              ✔
+            ========   ==============================================   ===============
+
+   **Start once**
+         .. code-block:: bash
+
+            systemctl --user start sunshine
+
+   **Start on boot**
+         .. code-block:: bash
+
+            systemctl --user enable sunshine
+
+#. Additional Setup for KMS
+      .. Note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to
+         allow Sunshine to use KMS.
+
+      **Enable**
+         .. code-block:: bash
+
+            sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine))
+
+      **Disable (for Xorg/X11)**
+         .. code-block:: bash
+
+            sudo setcap -r $(readlink -f $(which sunshine))
+
+#. Reboot
+      .. code-block:: bash
+
+         sudo reboot now
+
+macOS
+^^^^^
+Sunshine can only access microphones on macOS due to system limitations. To stream system audio use
+`Soundflower <https://github.com/mattingalls/Soundflower>`_ or
+`BlackHole <https://github.com/ExistentialAudio/BlackHole>`_.
+
+.. Note:: Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.
+
+.. Caution:: Gamepads are not currently supported.
+
+Configure autostart service
+   **MacPorts**
+      .. code-block:: bash
+
+         sudo port load Sunshine
+
+Windows
+^^^^^^^
+For gamepad support, install `ViGEmBus <https://github.com/ViGEm/ViGEmBus/releases/latest>`_
+
+Sunshine firewall
+   **Add rule**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         add-firewall-rule.bat
+
+   **Remove rule**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         remove-firewall-rule.bat
+
+Sunshine service
+   **Enable**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         install-service.bat
+
+   **Disable**
+      .. code-block:: batch
+
+         cd /d "C:\Program Files\Sunshine\scripts"
+         uninstall-service.bat
+
+Shortcuts
+---------
+All shortcuts start with ``CTRL + ALT + SHIFT``, just like Moonlight
+
+- ``CTRL + ALT + SHIFT + N`` - Hide/Unhide the cursor (This may be useful for Remote Desktop Mode for Moonlight)
+- ``CTRL + ALT + SHIFT + F1/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
+- ``"Variable name":"Variable value"``
+- ``apps`` - The list of applications
+- Advanced users may want to edit the application list manually. The format is ``json``.
+- Example ``json`` application:
+   .. code-block:: json
+
+      {
+          "cmd": "command to open app",
+          "detached": [
+              "some-command",
+              "another-command"
+          ],
+          "image-path": "/full-path/to/png-image",
+          "name": "An App",
+          "output": "/full-path/to/command-log-file",
+          "prep-cmd": [
+              {
+                  "do": "some-command",
+                  "undo": "undo-that-command"
+              }
+          ],
+          "working-dir": "/full-path/to/working-directory"
+      }
+
+   - ``cmd`` - The main application
+   - ``detached`` - A list of commands to be run and forgotten about
+
+     - If not specified, a process is started that sleeps indefinitely
+
+   - ``image-path`` - The full path to the cover art image to use.
+   - ``name`` - The name of the application/game
+   - ``output`` - The file where the output of the command is stored
+   - ``prep-cmd`` - A list of commands to be run before/after the application
+
+     - If any of the prep-commands fail, starting the application is aborted
+     - ``do`` - Run before the application
+
+       - If it fails, all ``undo`` commands of the previously succeeded ``do`` commands are run
+
+     - ``undo`` - Run after the application has terminated
+
+       - Failures of ``undo`` commands are ignored
+
+   - ``working-dir`` - The working directory to use. If not specified, Sunshine will use the application directory.
+
+- For more examples see :ref:`app examples <about/app_examples:app examples>`.
+
+Considerations
+--------------
+- When an application is started, if there is an application already running, it will be terminated.
+- When the application has been shutdown, the stream shuts down as well.
+
+  - For example, if you attempt to run ``steam`` as a ``cmd`` instead of ``detached`` the stream will immediately fail.
+    This is due to the method in which the steam process is executed. Other applications may behave similarly.
+
+- The "Desktop" app works the same as any other application except it has no commands. It does not start an application,
+  instead it simply starts a stream. If you removed it and would like to get it back, just add a new application with
+  the name "Desktop" and "desktop.png" as the image path.
+- For the Linux flatpak you must prepend commands with ``flatpak-spawn --host``.
+
+HDR Support
+-----------
+Streaming HDR content is supported for Windows hosts with NVIDIA, AMD, or Intel GPUs that support encoding HEVC Main 10.
+You must have an HDR-capable display or EDID emulator dongle connected to your host PC to activate HDR in Windows.
+
+- Ensure you enable the HDR option in your Moonlight client settings, otherwise the stream will be SDR.
+- A good HDR experience relies on proper HDR display calibration both in Windows and in game. HDR calibration can differ significantly between client and host displays.
+- We recommend calibrating the display by streaming the Windows HDR Calibration app to your client device and saving an HDR calibration profile to use while streaming.
+- You may also need to tune the brightness slider or HDR calibration options in game to the different HDR brightness capabilities of your client's display.
+- Older games that use NVIDIA-specific NVAPI HDR rather than native Windows 10 OS HDR support may not display in HDR.
+- Some GPUs can produce lower image quality or encoding performance when streaming in HDR compared to SDR.
+
+Tutorials
+---------
+Tutorial videos are available `here <https://www.youtube.com/playlist?list=PLMYr5_xSeuXAbhxYHz86hA1eCDugoxXY0>`_.
+
+.. admonition:: Community!
+
+   Tutorials are community generated. Want to contribute? Reach out to us on our discord server.

docs/source/building/build.rst

@@ -0,0 +1,32 @@
+Build
+=====
+Sunshine binaries are built using `CMake <https://cmake.org/>`_. Cross compilation is not
+supported. That means the binaries must be built on the target operating system and architecture.
+
+Building Locally
+----------------
+
+Clone
+^^^^^
+Ensure `git <https://git-scm.com/>`_ is installed and run the following:
+   .. code-block:: bash
+
+      git clone https://github.com/lizardbyte/sunshine.git --recurse-submodules
+      cd sunshine && mkdir build && cd build
+
+Compile
+^^^^^^^
+See the section specific to your OS.
+
+- :ref:`Linux <building/linux:linux>`
+- :ref:`macOS <building/macos:macos>`
+- :ref:`Windows <building/windows:windows>`
+
+Remote Build
+------------
+It may be beneficial to build remotely in some cases. This will enable easier building on different operating systems.
+
+#. Fork the project
+#. Activate workflows
+#. Trigger the `CI` workflow manually
+#. Download the artifacts/binaries from the workflow run summary

docs/source/building/linux.rst

@@ -0,0 +1,210 @@
+Linux
+=====
+
+Requirements
+------------
+
+Debian Bullseye
+^^^^^^^^^^^^^^^
+End of Life: TBD
+
+Install Requirements
+   .. code-block:: bash
+
+      sudo apt update && sudo apt install \
+          build-essential \
+          cmake \
+          libavdevice-dev \
+          libboost-filesystem-dev \
+          libboost-locale-dev \
+          libboost-log-dev \
+          libboost-program-options-dev \
+          libboost-thread-dev \
+          libcap-dev \  # KMS
+          libcurl4-openssl-dev \
+          libdrm-dev \  # KMS
+          libevdev-dev \
+          libmfx-dev \  # x86_64 only
+          libnuma-dev \
+          libopus-dev \
+          libpulse-dev \
+          libssl-dev \
+          libva-dev \
+          libvdpau-dev \
+          libwayland-dev \  # Wayland
+          libx11-dev \  # X11
+          libxcb-shm0-dev \  # X11
+          libxcb-xfixes0-dev \  # X11
+          libxcb1-dev \  # X11
+          libxfixes-dev \  # X11
+          libxrandr-dev \  # X11
+          libxtst-dev \  # X11
+          nodejs \
+          npm \
+          nvidia-cuda-dev \  # Cuda, NvFBC
+          nvidia-cuda-toolkit  # Cuda, NvFBC
+
+Fedora 36, 37
+^^^^^^^^^^^^^
+End of Life: TBD
+
+Install Requirements
+   .. code-block:: bash
+
+      sudo dnf update && \
+      sudo dnf group install "Development Tools" && \
+      sudo dnf install \
+          boost-devel \
+          cmake \
+          gcc \
+          gcc-c++ \
+          intel-mediasdk-devel \ # x86_64 only
+          libappindicator-gtk3-devel \
+          libcap-devel \
+          libcurl-devel \
+          libdrm-devel \
+          libevdev-devel \
+          libva-devel \
+          libvdpau-devel \
+          libX11-devel \  # X11
+          libxcb-devel \  # X11
+          libXcursor-devel \  # X11
+          libXfixes-devel \  # X11
+          libXi-devel \  # X11
+          libXinerama-devel \  # X11
+          libXrandr-devel \  # X11
+          libXtst-devel \  # X11
+          mesa-libGL-devel \
+          npm \
+          numactl-devel \
+          openssl-devel \
+          opus-devel \
+          pulseaudio-libs-devel \
+          rpm-build \  # if you want to build an RPM binary package
+          wget \  # necessary for cuda install with `run` file
+          which   # necessary for cuda install with `run` file
+
+Ubuntu 20.04
+^^^^^^^^^^^^
+End of Life: April 2030
+
+Install Requirements
+   .. code-block:: bash
+
+      sudo apt update && sudo apt install \
+          build-essential \
+          cmake \
+          g++-10 \
+          libappindicator3-dev \
+          libavdevice-dev \
+          libboost-filesystem-dev \
+          libboost-locale-dev \
+          libboost-log-dev \
+          libboost-thread-dev \
+          libboost-program-options-dev \
+          libcap-dev \  # KMS
+          libdrm-dev \  # KMS
+          libevdev-dev \
+          libmfx-dev \  # x86_64 only
+          libnuma-dev \
+          libopus-dev \
+          libpulse-dev \
+          libssl-dev \
+          libva-dev \
+          libvdpau-dev \
+          libwayland-dev \  # Wayland
+          libx11-dev \  # X11
+          libxcb-shm0-dev \  # X11
+          libxcb-xfixes0-dev \  # X11
+          libxcb1-dev \  # X11
+          libxfixes-dev \  # X11
+          libxrandr-dev \  # X11
+          libxtst-dev \  # X11
+          nodejs \
+          npm \
+          wget  # necessary for cuda install with `run` file
+
+Update gcc alias
+   .. code-block:: bash
+
+      update-alternatives --install \
+        /usr/bin/gcc gcc /usr/bin/gcc-10 100 \
+        --slave /usr/bin/g++ g++ /usr/bin/g++-10 \
+        --slave /usr/bin/gcov gcov /usr/bin/gcov-10 \
+        --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-10 \
+        --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-10
+
+Ubuntu 22.04
+^^^^^^^^^^^^
+End of Life: April 2027
+
+Install Requirements
+   .. code-block:: bash
+
+      sudo apt update && sudo apt install \
+          build-essential \
+          cmake \
+          libappindicator3-dev \
+          libavdevice-dev \
+          libboost-filesystem-dev \
+          libboost-locale-dev \
+          libboost-log-dev \
+          libboost-thread-dev \
+          libboost-program-options-dev \
+          libcap-dev \  # KMS
+          libdrm-dev \  # KMS
+          libevdev-dev \
+          libmfx-dev \  # x86_64 only
+          libnuma-dev \
+          libopus-dev \
+          libpulse-dev \
+          libssl-dev \
+          libwayland-dev \  # Wayland
+          libx11-dev \  # X11
+          libxcb-shm0-dev \  # X11
+          libxcb-xfixes0-dev \  # X11
+          libxcb1-dev \  # X11
+          libxfixes-dev \  # X11
+          libxrandr-dev \  # X11
+          libxtst-dev \  # X11
+          nodejs \
+          npm \
+          nvidia-cuda-dev \  # CUDA, NvFBC
+          nvidia-cuda-toolkit  # CUDA, NvFBC
+
+CUDA
+----
+If the version of CUDA available from your distro is not adequate, manually install CUDA.
+
+.. Tip:: The version of CUDA you use will determine compatibility with various GPU generations.
+   See `CUDA compatibility <https://docs.nvidia.com/deploy/cuda-compatibility/index.html>`_ for more info.
+
+   Select the appropriate run file based on your desired CUDA version and architecture according to
+   `CUDA Toolkit Archive <https://developer.nvidia.com/cuda-toolkit-archive>`_.
+
+.. code-block:: bash
+
+   wget https://developer.download.nvidia.com/compute/cuda/11.4.2/local_installers/cuda_11.4.2_470.57.02_linux.run \
+     --progress=bar:force:noscroll -q --show-progress -O ./cuda.run
+   chmod a+x ./cuda.run
+   ./cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm
+   rm ./cuda.run
+
+npm dependencies
+----------------
+Install npm dependencies.
+   .. code-block:: bash
+
+      npm install
+
+Build
+-----
+.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
+
+.. code-block:: bash
+
+   cmake ..
+   make -j ${nproc}
+
+   cpack -G DEB  # optionally, create a deb package
+   cpack -G RPM  # optionally, create a rpm package

docs/source/building/macos.rst

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

docs/source/building/windows.rst

@@ -0,0 +1,41 @@
+Windows
+=======
+
+Requirements
+------------
+First you need to install `MSYS2 <https://www.msys2.org>`_, then startup "MSYS2 MinGW 64-bit" and execute the following
+codes.
+
+Update all packages:
+   .. code-block:: bash
+
+      pacman -Suy
+
+Install dependencies:
+   .. code-block:: bash
+
+      pacman -S base-devel cmake diffutils gcc git make mingw-w64-x86_64-binutils \
+      mingw-w64-x86_64-boost mingw-w64-x86_64-cmake mingw-w64-x86_64-curl \
+      mingw-w64-x86_64-libmfx mingw-w64-x86_64-openssl mingw-w64-x86_64-opus \
+      mingw-w64-x86_64-toolchain
+
+npm dependencies
+----------------
+Install nodejs and npm. Downloads available `here <https://nodejs.org/en/download/>`_.
+
+Install npm dependencies.
+   .. code-block:: bash
+
+      npm install
+
+Build
+-----
+.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing.
+
+.. code-block:: bash
+
+   cmake -G "MinGW Makefiles" ..
+   mingw32-make -j$(nproc)
+
+   cpack -G NSIS  # optionally, create a windows installer
+   cpack -G ZIP  # optionally, create a windows standalone package

docs/source/conf.py

@@ -0,0 +1,102 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# standard imports
+from datetime import datetime
+import os
+import re
+import subprocess
+
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+script_dir = os.path.dirname(os.path.abspath(__file__))  # the directory of this file
+source_dir = os.path.dirname(script_dir)  # the source folder directory
+root_dir = os.path.dirname(source_dir)  # the root folder directory
+
+# -- Project information -----------------------------------------------------
+project = 'Sunshine'
+copyright = f'{datetime.now ().year}, {project}'
+author = 'ReenigneArcher'
+
+# The full version, including alpha/beta/rc tags
+with open(os.path.join(root_dir, 'CMakeLists.txt'), 'r') as f:
+    version = re.search(r"project\(Sunshine VERSION ((\d+)\.(\d+)\.(\d+))", str(f.read())).group(1)
+"""
+To use cmake method for obtaining version instead of regex,
+1. Within CMakeLists.txt add the following line without backticks:
+   ``configure_file(docs/source/conf.py.in "${CMAKE_CURRENT_SOURCE_DIR}/docs/source/conf.py" @ONLY)``
+2. Rename this file to ``conf.py.in``
+3. Uncomment the next line
+"""
+# version = '@PROJECT_VERSION@'  # use this for cmake configure_file method
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'breathe',  # c++ support for sphinx with doxygen
+    'm2r2',  # enable markdown files
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.todo',  # enable to-do sections
+    'sphinx.ext.graphviz',  # enable graphs for breathe
+    'sphinx.ext.viewcode',  # add links to view source code
+    'sphinx_copybutton',  # add a copy button to code blocks
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['toc.rst']
+
+# Extensions to include.
+source_suffix = ['.rst', '.md']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# images
+html_favicon = os.path.join(root_dir, 'src_assets', 'common', 'assets', 'web', 'images', 'favicon.ico')
+html_logo = os.path.join(root_dir, 'sunshine.png')
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'furo'
+
+html_theme_options = {
+    "top_of_page_button": "edit",
+    "source_edit_link": "https://github.com/lizardbyte/sunshine/tree/nightly/docs/source/{filename}",
+}
+
+# extension config options
+autosectionlabel_prefix_document = True  # Make sure the target is unique
+breathe_default_project = 'src'
+breathe_implementation_filename_extensions = ['.c', '.cc', '.cpp', '.mm']
+breathe_order_parameters_first = False
+breathe_projects = dict(
+    src="../build/doxyxml"
+)
+todo_include_todos = True
+
+subprocess.run('doxygen', shell=True, cwd=source_dir)
+
+# disable epub mimetype warnings
+# https://github.com/readthedocs/readthedocs.org/blob/eadf6ac6dc6abc760a91e1cb147cc3c5f37d1ea8/docs/conf.py#L235-L236
+suppress_warnings = ["epub.unknown_project_files"]

docs/source/contributing/contributing.rst

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

docs/source/contributing/localization.rst

@@ -0,0 +1,81 @@
+Localization
+============
+Sunshine is being localized into various languages. The default language is `en` (English) and is highlighted green.
+
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=de&style=for-the-badge&query=%24.progress.0.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=green&label=en&style=for-the-badge&query=%24.progress.1.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=en-GB&style=for-the-badge&query=%24.progress.2.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=en-US&style=for-the-badge&query=%24.progress.3.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=es-ES&style=for-the-badge&query=%24.progress.4.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=fr&style=for-the-badge&query=%24.progress.5.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=it&style=for-the-badge&query=%24.progress.6.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=ru&style=for-the-badge&query=%24.progress.7.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json
+
+Graph
+   .. image:: https://badges.awesome-crowdin.com/translation-15178612-503956.png
+
+CrowdIn
+-------
+The translations occur on
+`CrowdIn <https://crowdin.com/project/sunshinestream>`_. Feel free to contribute to localization there.
+Only elements of the API are planned to be translated.
+
+.. Attention:: The rest API has not yet been implemented.
+
+**Translations Basics**
+   - The brand names `LizardByte` and `Sunshine` should never be translated.
+   - Other brand names should never be translated.
+     Examples:
+
+     - AMD
+     - 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_nightly` branch and a PR is made against the
+   `nightly` branch. Once PR is merged, all updated translations are part of the project and will be included in the
+   next release.
+
+Extraction
+----------
+There should be minimal cases where strings need to be extracted from source code; however it may be necessary in some
+situations. For example if a system tray icon is added it should be localized as it is user interfacing.
+
+- Wrap the string to be extracted in a function as shown.
+   .. code-block:: cpp
+
+      #include <boost/locale.hpp>
+      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:: This 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 `nightly` branch. Jobs are only run if
+any of the following paths are modified.
+
+.. code-block:: 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**
+   .. code-block:: bash
+
+      python ./scripts/_locale.py --extract --init --update
+
+**Compile**
+   .. code-block:: bash
+
+      python ./scripts/_locale.py --compile

docs/source/contributing/testing.rst

@@ -0,0 +1,43 @@
+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`.
+
+Test clang-format locally.
+   .. code-block:: bash
+
+      find ./ -iname *.cpp -o -iname *.h -iname *.m -iname *.mm | xargs clang-format -i
+
+Sphinx
+------
+Sunshine uses `Sphinx <https://www.sphinx-doc.org/en/master/>`_ for documentation building. Sphinx, along with other
+required python dependencies are included in the `./docs/requirements.txt` file. Python is required to build
+sphinx docs. Installation and setup of python will not be covered here.
+
+Doxygen is used to generate the XML files required by Sphinx. Doxygen can be obtained from
+`Doxygen downloads <https://www.doxygen.nl/download.html>`_. Ensure that the `doxygen` executable is in your path.
+
+The config file for Sphinx is `docs/source/conf.py`. This is already included in the repo and should not be modified.
+
+The config file for Doxygen is `docs/Doxyfile`. This is already included in the repo and should not be modified.
+
+Test with Sphinx
+   .. code-block:: bash
+
+      cd docs
+      make html
+
+   Alternatively
+
+   .. code-block:: bash
+
+      cd docs
+      sphinx-build -b html source build
+
+Unit Testing
+------------
+.. Todo:: Sunshine does not currently have any unit tests. If you would like to help us improve please get in contact
+   with us, or make a PR with suggested changes.

docs/source/gamestream/gamestream.rst

@@ -0,0 +1,20 @@
+GameStream
+==========
+Nvidia announced that their GameStream service for Nvidia Games clients will be discontinued in February 2023.
+Luckily, Sunshine performance is now on par with Nvidia GameStream. Many users have even reported that Sunshine
+outperforms GameStream, so rest assured that Sunshine will be equally performant moving forward.
+
+Migration
+---------
+We have developed a simple migration tool to help you migrate your GameStream games and apps to Sunshine automatically.
+Please check out our `GSMS <https://github.com/LizardByte/GSMS>`_ project if you're interested in an automated
+migration option. At the time of writing this GSMS offers the ability to migrate your custom games and apps. The
+working directory, command, and image are all set in Sunshine's ``apps.json`` file. The box-art image is also copied
+to a specified directory.
+
+Limitations
+-----------
+Sunshine does have some limitations, as compared to Nvidia GameStream.
+
+- Automatic game/application list.
+- Changing game settings automatically, to optimize streaming.

docs/source/index.rst

@@ -0,0 +1,3 @@
+Table of Contents
+=================
+.. include:: toc.rst

docs/source/legal/legal.rst

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

docs/source/source/src.rst

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

docs/source/source/src/audio.rst

@@ -0,0 +1,4 @@
+audio
+=====
+
+.. doxygenfile:: audio.h

docs/source/source/src/cbs.rst

@@ -0,0 +1,4 @@
+cbs
+===
+
+.. doxygenfile:: cbs.h

docs/source/source/src/config.rst

@@ -0,0 +1,4 @@
+config
+======
+
+.. doxygenfile:: config.h

docs/source/source/src/confighttp.rst

@@ -0,0 +1,4 @@
+confighttp
+==========
+
+.. doxygenfile:: confighttp.h

docs/source/source/src/crypto.rst

@@ -0,0 +1,4 @@
+crypto
+======
+
+.. doxygenfile:: crypto.h

docs/source/source/src/httpcommon.rst

@@ -0,0 +1,4 @@
+httpcommon
+==========
+
+.. doxygenfile:: httpcommon.h

docs/source/source/src/input.rst

@@ -0,0 +1,4 @@
+input
+=====
+
+.. doxygenfile:: input.h

docs/source/source/src/main.rst

@@ -0,0 +1,4 @@
+main
+====
+
+.. doxygenfile:: main.h

docs/source/source/src/move_by_copy.rst

@@ -0,0 +1,4 @@
+move_by_copy
+============
+
+.. doxygenfile:: move_by_copy.h

docs/source/source/src/network.rst

@@ -0,0 +1,4 @@
+network
+=======
+
+.. doxygenfile:: network.h

docs/source/source/src/nvhttp.rst

@@ -0,0 +1,4 @@
+nvhttp
+======
+
+.. doxygenfile:: nvhttp.h

docs/source/source/src/platform.rst

@@ -0,0 +1,10 @@
+platform
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   platform/common
+   platform/linux
+   platform/macos
+   platform/windows

docs/source/source/src/platform/common.rst

@@ -0,0 +1,4 @@
+common
+======
+
+.. Todo:: Add common.h

docs/source/source/src/platform/linux.rst

@@ -0,0 +1,12 @@
+linux
+=====
+
+.. toctree::
+   :maxdepth: 1
+
+   linux/cuda
+   linux/graphics
+   linux/misc
+   linux/vaapi
+   linux/wayland
+   linux/x11grab

docs/source/source/src/platform/linux/cuda.rst

@@ -0,0 +1,4 @@
+cuda
+====
+
+.. doxygenfile:: platform/linux/cuda.h

docs/source/source/src/platform/linux/graphics.rst

@@ -0,0 +1,4 @@
+graphics
+========
+
+.. Todo:: Add graphics.h

docs/source/source/src/platform/linux/misc.rst

@@ -0,0 +1,4 @@
+misc
+====
+
+.. Todo:: Add misc.h

docs/source/source/src/platform/linux/vaapi.rst

@@ -0,0 +1,4 @@
+vaapi
+=====
+
+.. doxygenfile:: platform/linux/vaapi.h

docs/source/source/src/platform/linux/wayland.rst

@@ -0,0 +1,4 @@
+wayland
+=======
+
+.. doxygenfile:: platform/linux/wayland.h

docs/source/source/src/platform/linux/x11grab.rst

@@ -0,0 +1,4 @@
+x11grab
+=======
+
+.. Todo:: Add x11grab.h

docs/source/source/src/platform/macos.rst

@@ -0,0 +1,11 @@
+macos
+=====
+
+.. toctree::
+   :maxdepth: 1
+
+   macos/av_audio
+   macos/av_img_t
+   macos/av_video
+   macos/misc
+   macos/nv12_zero_device

docs/source/source/src/platform/macos/av_audio.rst

@@ -0,0 +1,4 @@
+av_audio
+========
+
+.. Todo:: Add av_audio.h

docs/source/source/src/platform/macos/av_img_t.rst

@@ -0,0 +1,4 @@
+av_img_t
+========
+
+.. Todo:: Add av_img_t.h

docs/source/source/src/platform/macos/av_video.rst

@@ -0,0 +1,4 @@
+av_video
+========
+
+.. Todo:: Add av_video.h