Sunshine-AIO

An all-in-one tool to setup Sunshine with all needed tools (Windows 10/11).
It includes: (Official) Sunshine Installation, Virtual Display Driver, Sunshine Virtual Monitor, Playnite and Playnite Watcher.

> [!WARNING] > :construction: This Tool is under development. Bugs can appear. :construction:

Current/Upcoming Features

- [x] (Official) [Sunshine](https://github.com/LizardByte/Sunshine) Installation - [x] [Virtual Display Driver](https://github.com/itsmikethetech/Virtual-Display-Driver) - A dedicated display for your game stream will be created. > [!NOTE] > No need to copy the file `option.txt` anymore to set the correct resolution/frame rate. > > The process is now **automatic** and done directly by the **Sunshine Virtual Monitor** tool. - [x] [Sunshine Virtual Monitor](https://github.com/Cynary/sunshine-virtual-monitor) - An automated script to: 1. Automatically adjust the Resolution, HDR, and Frame Rate of the Virtual Display based on Moonlight client settings. 2. Deactivate all your physical monitors and enable the dedicated Virtual Display to stream your games. - [x] [Playnite](https://github.com/JosefNemec/Playnite) - A Universal Launcher to launch all your favorites games from one place. - [x] [Playnite Watcher](https://github.com/Nonary/PlayNiteWatcher) - An automated script to: 1. Import all your favorite games into Sunshine effortlessly. 2. Gracefully stop the stream when you close a game. - [ ] *Have more flexibility with Sunshine Virtual Monitor to manage different setups.* [#13](https://github.com/LeGeRyChEeSe/Sunshine-AIO/issues/13) - [ ] *Automate the Playnite Watcher script/Add an option to execute it from the AIO tool.* - [ ] *Clean Uninstaller* [#12](https://github.com/LeGeRyChEeSe/Sunshine-AIO/issues/12) # Table of Contents - [Sunshine-AIO](#sunshine-aio) - [Troubleshooting](#troubleshooting) - [Build The Executable](#build-the-executable) - [Contributing](#contributing) - [Git Installation](#git-installation) - [Python3 Installation](#python3-installation) - [License](#license) - [Acknowledgements](#acknowledgements) - [Star History](#star-history) ## Sunshine-AIO - Download the [Latest Release](https://github.com/LeGeRyChEeSe/Sunshine-AIO/releases/latest) and execute `Sunshine-AIO.exe`. > [!WARNING] > The file might be flagged as Trojan/Malware, but it's a false positive. (It is due to **Nuitka** build) > > To prevent the file being deleted by your anti-virus, make sure to temporarily disable your anti-virus, or add an exception to the folder you want to download the file. > [!NOTE] > Playnite and Playnite Watcher are optional, but they are installed by default within the `everything` command. ## Troubleshooting > [!CAUTION] > Please keep in mind this AIO tool is still in development and you may encounter bugs or issues when using it. > > Some features mentioned in the first lines of this readme aren't yet implemented such as *clean uninstaller* feature. > > I'm working on it but it could take some times to implement. Please check the [opened issues](https://github.com/LeGeRyChEeSe/Sunshine-AIO/issues) before opening a new issue. Make sure to configure your Moonlight client to connect to Sunshine and enjoy optimized streaming! 🌞 ## Build The Executable - If you are afraid of the potential viruses in the `Sunshine-AIO.exe` (I 100% certify there are no viruses), you can build the executable yourself from this repo. - Clone the repo with the `git clone https://github.com/LeGeRyChEeSe/Sunshine-AIO.git` command somewhere in a safe location and execute these commands: > [!WARNING] > Before trying to build the executable, make sure you have [Python](#python3-installation) and [Git](#git-installation) installed. ```batch cd Sunshine-AIO py -m venv venv venv\Script\activate pip install -r requirements cd compile compile_executable.bat ``` - The executable should then appear in the `produced` folder next to the `compile_executable.bat` file. ## Contributing Any contributions you make are **greatly appreciated**. 1. Fork the Project. 2. Create your Feature Branch. (`git checkout -b feature/NewFeature`) 3. Commit your Changes. (`git commit -m 'Add some NewFeature'`) 4. Push to the Branch. (`git push origin feature/NewFeature`) 5. Open a Pull Request. Thanks to every [contributors](https://github.com/LeGeRyChEeSe/Sunshine-AIO/graphs/contributors) who have contributed in this project. - You will need some pre-requisites: ### Git Installation - Download [Git for Windows](https://git-scm.com/download/win) and install it on your computer. ### Python3 Installation - Download [Latest Python3](https://www.python.org/downloads/) and install it on your computer. >[!IMPORTANT] > Add python to the Path when asked during the installation. - Install all the packages required to build the project: ```py cd Sunshine-AIO py -m venv venv venv\Script\activate pip install -r requirements ``` ## License Distributed under the MIT License. See [LICENSE](https://github.com/LeGeRyChEeSe/Sunshine-AIO/blob/main/LICENSE) for more information. ## Acknowledgements Shoutout to LizardByte for the Sunshine repo: https://github.com/LizardByte/Sunshine Shoutout to itsmikethetech for the Virtual Display Driver repo: https://github.com/itsmikethetech/Virtual-Display-Driver Thanks to Cynary for the Sunshine Virtual Monitor scripts: https://github.com/Cynary/sunshine-virtual-monitor Shoutout to JosefNemec for Playnite: https://github.com/JosefNemec/Playnite Shoutout to Nonary for the PlayNiteWatcher script: https://github.com/Nonary/PlayNiteWatcher ## Star History [](https://star-history.com/#LeGeRyChEeSe/Sunshine-AIO&Date) ---- Author/Maintainer: [Garoh](https://github.com/LeGeRyChEeSe/) | Discord: garohrl