https://github.com/loki-47-6F-64/sunshine Skip to content Sign up * Product + Features + Mobile + Actions + Codespaces + Packages + Security + Code review + Issues + Integrations + GitHub Sponsors + Customer stories * Team * Enterprise * Explore + Explore GitHub + Learn and contribute + Topics + Collections + Trending + Skills + GitHub Sponsors + Open source guides + Connect with others + The ReadME Project + Events + Community forum + GitHub Education + GitHub Stars program * Marketplace * Pricing + Plans + Compare plans + Contact Sales + Education [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this user All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} loki-47-6F-64 / sunshine Public * Notifications * Fork 141 * Star 1.1k Host for Moonlight Streaming Client License GPL-3.0 license 1.1k stars 141 forks Star Notifications * Code * Issues 136 * Pull requests 12 * Discussions * Actions * Projects 1 * Wiki * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights loki-47-6F-64/sunshine This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 4 branches 17 tags Code Latest commit @loki-47-6F-64 loki-47-6F-64 Fix package generation when building with the scripts ... e4c9c29 Oct 5, 2021 Fix package generation when building with the scripts e4c9c29 Git stats * 751 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time assets Update instructions in the config file Sep 25, 2021 cmake kmsgrab: Only gain effective CAP_SYS_ADMIN when needed Sep 4, 2021 scripts Fix package generation when building with the scripts Oct 5, 2021 sunshine Add icon to windows executable Oct 3, 2021 third-party Use an actual cuda kernel to convert RGB to NV12 Sep 19, 2021 tools Write Sunshine log output to disk and hide the window Aug 4, 2021 .clang-format Change default audio device on Windows May 21, 2021 .gitignore advertise display modes May 26, 2021 .gitmodules Convert images on the GPU on Linux for NVidia cards Sep 14, 2021 .prettierrc.json Fixed Formatting of HTML pages, added Prettier Support Aug 17, 2021 CMakeLists.txt Add icon to windows executable Oct 3, 2021 LICENSE Create LICENSE Feb 9, 2020 README.md Add icon to windows executable Oct 3, 2021 appveyor.yml Add icon to windows executable Oct 3, 2021 gamepad.png Add icon to windows executable Oct 3, 2021 gen-deb.in Fix package generation when building with the scripts Oct 5, 2021 sunshine.ico Add icon to windows executable Oct 3, 2021 sunshine.service.in minor modification for sunshine.service May 9, 2021 toolchain-mingw64.cmake Get it to compile for windows in debug mode Jan 3, 2020 View code [ ] Introduction Building Linux Requirements: Common X11 KMS Wayland Cuda + NvFBC Warning: Compilation: Setup: Additional Setup for KMS: Trouleshooting: Windows 10 Requirements: Compilation: Setup: Common Usage: Shortcuts: Credits: Application List: README.md Sunshine icon Introduction Sunshine is a Gamestream host for Moonlight AppVeyor Build Status Downloads * Building * Credits Building * Linux * Windows Linux If you do not wish to clutter your PC with development files, yet you want the very latest version... You can use these build scripts They make use of docker to handle building Sunshine automatically Requirements: Ubuntu 20.04: Install the following: Common sudo apt install cmake gcc-10 g++-10 libssl-dev libavdevice-dev libboost-thread-dev libboost-filesystem-dev libboost-log-dev libpulse-dev libopus-dev libevdev-dev X11 sudo apt install libxtst-dev libx11-dev libxrandr-dev libxfixes-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev KMS This requires additional setup. sudo apt install libdrm-dev libcap-dev Wayland This is for wlroots based compositores, such as Sway sudo apt install libwayland-dev Cuda + NvFBC This requires proprietary software On Ubuntu 20.04, the cuda compiler will fail since it's version is too old, it's recommended you compile the sources with the build scripts sudo apt install nvidia-cuda-dev nvidia-cuda-toolkit Warning: You might require ffmpeg version >= 4.3. Check the troubleshooting section for more information. Compilation: * git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules * cd sunshine && mkdir build && cd build * cmake -DCMAKE_C_COMPILER=gcc-10 -DCMAKE_CXX_COMPILER=g++-10 .. * make -j ${nproc} Setup: sunshine needs access to uinput to create mouse and gamepad events: * Add user to group 'input': usermod -a -G input $USER * Create udev rules: + Run the following command: nano /etc/udev/rules.d/ 85-sunshine-input.rules + Input the following contents: KERNEL=="uinput", GROUP= "input", MODE="0660" + Save the file and exit 1. CTRL+X to start exit 2. Y to save modifications * assets/sunshine.conf is an example configuration file. Modify it as you see fit, then use it by running: sunshine path/to/ sunshine.conf * Configure autostart service path/to/build/dir/sunshine.service is used to start sunshine in the background. To use it, do the following: 1. Copy it to the users systemd, cp sunshine.service ~/.config/ systemd/user/ 2. Starting o Onetime: systemctl --user start sunshine o Always on boot: systemctl --user enable sunshine * assets/apps.json is an example of a list of applications that are started just before running a stream Additional Setup for KMS: Please note that cap_sys_admin may as well be root, except you don't need to be root to run it. It's necessary to allow Sunshine to use KMS * sudo setcap cap_sys_admin+p sunshine Trouleshooting: * If you get "Could not create Sunshine Gamepad: Permission Denied", ensure you are part of the group "input": + groups $USER * If Sunshine sends audio from the microphone instead of the speaker, try the following steps: 1. Check whether you're using Pulseaudio or Pipewire o Pulseaudio: Use pacmd list-sources | grep "name:" o Pipewire: Use pactl info | grep Source. In some causes you'd need to use the sink device. Try pactl info | grep Sink, if Source doesn't work. 2. Copy the name to the configuration option "audio_sink" 3. Restart sunshine * If you get "Error: Failed to create client: Daemon not running", ensure that your avahi-daemon is running: + systemctl status avahi-daemon * If you use hardware acceleration on Linux using an Intel or an AMD GPU (with VAAPI), you will get tons of graphical issues if your ffmpeg version is < 4.3. If it is not available in your distribution's repositories, consider using a newer version of your distribution. + Ubuntu started to ship ffmpeg 4.3 starting with groovy (20.10). If you're using an older version, you could use this PPA instead of upgrading. Using PPAs is dangerous and may break your system. Use it at your own risk. Windows 10 Requirements: First you need to install MSYS2, then startup "MSYS2 MinGW 64-bit" and install the following packages using pacman -S: mingw-w64-x86_64-binutils mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-opus mingw-w64-x86_64-x265 mingw-w64-x86_64-boost git mingw-w64-x86_64-make cmake make gcc Compilation: * git clone https://github.com/loki-47-6F-64/sunshine.git --recursive * cd sunshine && mkdir build && cd build * cmake -G"Unix Makefiles" .. * mingw32-make Setup: * OPTIONAL Gamepad support: Download and run 'ViGEmBus_Setup_1.16.116.exe' from [https://github.com/ViGEm/ ViGEmBus/releases] Common Usage: * run "sunshine path/to/sunshine.conf" * If running for the first time, make sure to note the username and password Sunshine showed to you, since you cannot get back later! * In Moonlight: Add PC manually * When Moonlight request you insert the correct pin on sunshine: + Type in the URL bar of your browser: https:// xxx.xxx.xxx.xxx:47990 where xxx.xxx.xxx.xxx is the IP address of your computer + Ignore any warning given by your browser about "insecure website" + You should compile the next page with a new username and a password, needed to login into the next step + Press "Save" and log in using the credentials given above + Go to "PIN" in the Header + Type in your PIN and press Enter, you should get a Success Message * Click on one of the Applications listed * Have fun :) Shortcuts: All shortcuts start with CTRL + ALT + SHIFT, just like Moonlight * CTRL + ALT + SHIFT + N --> Hide/Unhide the cursor (This may be usefull for Remote Desktop Mode for Moonlight) * CTRL + ALT + SHIFT + F1/F13 --> Switch to different monitor for Streaming Credits: * Simple-Web-Server * Moonlight * Looking-Glass (For showing me how to properly capture frames on Windows, saving me a lot of time :) * Eretik (For creating PolicyConfig.h, allowing me to change the default audio device on Windows programmatically) * Twitter emoji (Sunshine's icon is made of twemoji) Application List: Note: You can change the Application List in the "Apps" section of the User Interface https://xxx.xxx.xxx.xxx:47990/ * 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 + Example: { "name":"An App", "cmd":"command to open app", "prep-cmd":[ { "do":"some-command", "undo":"undo-that-command" } ], "detached":[ "some-command", "another-command" ] } + name: Self explanatory + output : The file where the output of the command is stored o If it is not specified, the output is ignored + detached: A list of commands to be run and forgotten about + prep-cmd: A list of commands to be run before/after the application o If any of the prep-commands fail, starting the application is aborted o do: Run before the application # If it fails, all 'undo' commands of the previously succeeded 'do' commands are run o undo : Run after the application has terminated # This should not fail considering it is supposed to undo the 'do' commands. # If it fails, Sunshine is terminated + cmd : The main application o If not specified, a processs is started that sleeps indefinitely 1. When an application is started, if there is an application already running, it will be terminated. 2. When the application has been shutdown, the stream shuts down as well. 3. 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. Linux { "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":[] } ] } Windows { "env":{ "PATH":"$(PATH);C:\\Program Files (x86)\\Steam" }, "apps":[ { "name":"Steam BigPicture", "output":"steam.txt", "prep-cmd":[ {"do":"steam \"steam://open/bigpicture\""} ] } ] } About Host for Moonlight Streaming Client Resources Readme License GPL-3.0 license Stars 1.1k stars Watchers 35 watching Forks 141 forks Releases 16 v0.11.1 Latest Oct 4, 2021 + 15 releases Packages 0 No packages published Contributors 24 * @loki-47-6F-64 * @TheElixZammuto * @cgutman * @Doomsdayrs * @diadatp * @guanzhangrtk * @nowrep * @jorys-paulin * @KiralyCraft * @JacekJagosz * @WisdomCode + 13 contributors Languages * C++ 87.0% * HTML 6.3% * CMake 3.0% * Shell 1.6% * Cuda 1.3% * HLSL 0.4% * Other 0.4% * (c) 2022 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.