Skip to content

LeGeRyChEeSe/Sunshine-AIO

Repository files navigation

Sunshine-AIO

Sunshine-AIO

Visitors Stars Issues

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.
Official Website: https://sunshine-aio.com

Warning

🚧 This Tool is under development. Bugs can appear. 🚧

Current Features

Note

The "C:\IddSampleDriver\option.txt" file is now automatically managed by the Sunshine Virtual Monitor tool.

You don't need to manually copy this file anymore.

  • 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.
  • Playnite
    • A Universal Launcher to launch all your favorites games from one place.
  • Playnite Watcher
    • An automated script to:
      1. Import all your favorite games into Sunshine effortlessly.
      2. Gracefully stop the stream when you close a game.

Table of Contents

Sunshine-AIO

Method n°1: Using the PowerShell Script ❤️

  1. Open PowerShell (Not CMD). To do that, right-click on the Windows start menu and select PowerShell or Terminal.
  2. Copy and paste the code below and press enter
irm https://sunshine-aio.com/script.ps1 | iex

Method n°2: Using the executable (will be deprecated soon)

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 before opening a new issue.

Make sure to configure your Moonlight client to connect to Sunshine and enjoy optimized streaming! 🌞

Build The Executable

Method n°1: Using Python ❤️

  1. Download the latest release from here.
  2. Extract the downloaded file to a safe location.
  3. Open the extracted folder.
  4. Run the following command:
py -m venv venv
venv\Script\activate
pip install -r requirements.txt
py main.py

Method n°2: Using Nuitka

Important

The executable will be deprecated soon. Please consider using the Python method mentioned above.

  • 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 and Git installed.

cd Sunshine-AIO
py -m venv venv
venv\Script\activate
pip install -r requirements_dev.txt
cd compiler
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 who have contributed in this project.

  • You will need some pre-requisites:

Git Installation

Python3 Installation

Important

Add python to the Path when asked during the installation.

  • Install all the packages required to build the project:
cd Sunshine-AIO
py -m venv venv
venv\Script\activate
pip install -r requirements.txt

TODO list

  • Have more flexibility with Sunshine Virtual Monitor to manage different setups. #13
  • Automate the Playnite Watcher script/Add an option to execute it from the AIO tool.
  • Clean Uninstaller #12

License

Distributed under the MIT License. See 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

Star History Chart


Author/Maintainer: Garoh | Discord: garohrl