diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8f2eea3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 moraroy + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index b1425da..a114a10 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,40 @@ -# NonSteamLaunchers -Installs the latest GE-Proton and Installs Non Steam Launchers under 1 Proton prefix folder in your compatdata folder path called "NonSteamLaunchers" and adds them to your Steam Library. Use on Desktop or in Game Mode. +# NonSteamLaunchers 🚀 +This script installs the latest GE-Proton, installs Non-Steam-Launchers under one unique Proton prefix folder in your compatdata folder path called "NonSteamLaunchers" and adds them to your Steam Library. +So you can use them on Desktop or in Game Mode. +# Installation 🔧 +Go to desktop mode, right click [HERE](https://github.com/moraroy/NonSteamLaunchers-On-Steam-Deck/blob/main/NonSteamLaunchers.desktop) and save the .desktop file to your Steam Deck desktop. +# Usage 🎮 +Go to your desktop, click the NonSteamLaunchers icon, it will download and run the latest NonSteamLaunchers.sh from this repository and run it. +You will simply have to choose which launcher to install and let the script handle the rest. 💻 No files are left in your "Downloads" they are deleted after installation. -No files are left in your "Downloads" they are deleted after installation. - -Currently Installs and adds to your Library... 👀 +After running the script, launch Steam on your Steam Deck. You'll find the new launchers in your library under the non-steam tab. Click a launcher to see your installed games from that store, and launch them directly from Steam! Even in gamemode 🥳 - ~Battle.net ✔️ - - ~Epic Games ✔️ - - ~Gog ✔️ - - ~Origin (only working way) ✔️ - - ~Ubisoft ✔️ +# Supported Stores 🛍 +- Battle.net ✔️ +- Epic Games ✔️ +- GOG Galaxy ✔️ +- Origin (only working way) ✔️ +- Ubisoft ✔️ +- EA App ✔️ +- Amazon Games Launcher ✔️ +- Itch.io ✔️ +- Legacy Games ✔️ +- Humble Games Collection ✔️ +- IndieGala ✔️ +- Rockstar Games Launcher ✔️ - ~The EA App ✔️ - - ~Amazon Games Launcher ✔️ - - ~Itch.io ✔️ +# MicroSD Support 💾 +This script supports moving the entire prefix to a microSD. +The script will install launchers and games to your SD card, and the launchers in Steam will point to the SD card installation. This allows you to save internal storage space on your Steam Deck! - ~Legacy Games ✔️ - - ~Humble Games Collection ✔️ - - ~IndieGala ✔️ - - ~Rockstar Games Launcher ✔️ - - --------------------------- - - ~SD CARD SUPPORT ✔️ +# Currently Working On 👷‍♂️ +- Decky Loader Plugin ❌ +## Contributing 🤝 +If you have any suggestions or improvements for this script, feel free to open an issue or submit a pull request. -Currently Working On These Things 👷‍♂️ +## 📝 License - Decky Loader Plugin - - -INSTRUCTIONS FOR GAME MODE 📝 -In order to run it, grab the "NonSteamLaunchers.sh" file and download it. - -Please right click and go to properties > permissions and check mark "Is Executable". Then right click the file again and "Add to Steam". - -Then Restart your Steam Deck and "NonSteamLaunchers.sh" will now be in your library in Game Mode. MAKE SURE YOU FORCE COMPATABILTY IN GAME MODE WITH THE LAUNCHERS ONCE THEY ARE IN YOUR LIBRARY. DO NOT FORCE COMPATABILITY ON THE SCRIPT ITSELF, IT DOES NOT NEED IT. - - - -INSTRUCTIONS FOR DESKTOP 📝 -In order to run it, grab the "NonSteamLaunchers.sh" file and download it. Or grab the .desktop file and throw it on the Desktop! - -Please right click and go to properties > permissions and check mark "Is Executable". Double Click it and it should run. - -MAKE SURE YOU FORCE COMPATABILTY IN DESKTOP MODE WITH THE LAUNCHERS ONCE THEY ARE IN YOUR LIBRARY. DO NOT FORCE COMPATABILITY ON THE SCRIPT ITSELF, IT DOES NOT NEED IT. +This project is licensed under the MIT License. See the `LICENSE` file for more information.