diff --git a/docs/Images/AddGameInReloaded-OnWine.png b/docs/Images/AddGameInReloaded-OnWine.png new file mode 100644 index 00000000..d410f0f8 Binary files /dev/null and b/docs/Images/AddGameInReloaded-OnWine.png differ diff --git a/docs/Images/DisableLaunchFromWine.png b/docs/Images/DisableLaunchFromWine.png new file mode 100644 index 00000000..a6437838 Binary files /dev/null and b/docs/Images/DisableLaunchFromWine.png differ diff --git a/docs/Images/FlatPak-Discover.png b/docs/Images/FlatPak-Discover.png new file mode 100644 index 00000000..c07d49de Binary files /dev/null and b/docs/Images/FlatPak-Discover.png differ diff --git a/docs/Images/Launch-Flatseal-3.png b/docs/Images/Launch-Flatseal-3.png new file mode 100644 index 00000000..159fb309 Binary files /dev/null and b/docs/Images/Launch-Flatseal-3.png differ diff --git a/docs/Images/Launch-Flatseal.jpg b/docs/Images/Launch-Flatseal.jpg new file mode 100644 index 00000000..bd98755a Binary files /dev/null and b/docs/Images/Launch-Flatseal.jpg differ diff --git a/docs/Images/OnWine-InstallsToDesktop.png b/docs/Images/OnWine-InstallsToDesktop.png new file mode 100644 index 00000000..44e0c8ce Binary files /dev/null and b/docs/Images/OnWine-InstallsToDesktop.png differ diff --git a/docs/Images/OpenWithProtontricks.png b/docs/Images/OpenWithProtontricks.png new file mode 100644 index 00000000..2e645809 Binary files /dev/null and b/docs/Images/OpenWithProtontricks.png differ diff --git a/docs/Images/ProtontricksLaunchGui.png b/docs/Images/ProtontricksLaunchGui.png new file mode 100644 index 00000000..609a087b Binary files /dev/null and b/docs/Images/ProtontricksLaunchGui.png differ diff --git a/docs/LinuxSetupGuide.md b/docs/LinuxSetupGuide.md index ddbdc608..7c198e47 100644 --- a/docs/LinuxSetupGuide.md +++ b/docs/LinuxSetupGuide.md @@ -1,8 +1,11 @@ -# Linux Setup Guide +# Linux Setup Guide (Legacy) !!! info "This is the *legacy* setup guide." - This shows you how to run Reloaded in a setup that involves. + This shows you how to run Reloaded in a setup that involves running the launcher via Wine + and games via Wine/Proton. This is a bit more flexible but can be a hassle to set up. + + For a more streamlined guide, see [Linux Setup Guide (New)](LinuxSetupGuideNew.md). !!! help "Help Needed" diff --git a/docs/LinuxSetupGuideNew.md b/docs/LinuxSetupGuideNew.md new file mode 100644 index 00000000..1a4f1f56 --- /dev/null +++ b/docs/LinuxSetupGuideNew.md @@ -0,0 +1,85 @@ +# Linux Setup Guide + +!!! info "This is a streamlined guide for setting up a single game via Steam." + + This will help you install 1 instance of Reloaded per game. + The steps try to be as minimal as possible. + + This is a generic guide for any game. For more specific info, consider looking up + a ***game specific guide***. + +!!! help "Help Needed" + + This documentation page could be improved, contributions would be very welcome. + +## Install and Run your game via Steam + +If you have a Steam game, install it and run it at least once. + +If you have a non-Steam game, add it to the launcher and launch it from Steam. + +!!! info "This is required for [Protontricks] to discover the game." + +## Install Protontricks + +If you are on a *Steam Deck* or have *FlatPak* pre-installed on your Linux distribution, +use the [Installing Protontricks via FlatPak][protontricks-flatpak] section. + +Otherwise refer to the [Protontricks] documentation for installation info. + +## Install Reloaded-II via Protontricks + +Download [Setup-Linux.exe] (Direct Link) from Reloaded's releases section. + +Then start it via Protontricks. ***Right-click*** the EXE in your file browser and select `Open with Protontricks Launcher` +from the context menu. + +![OpenWithProtontricks](./Images/OpenWithProtontricks.png) + +!!! note "You may need to look into the `Open With` menu." + +And select your game from the list: + +![OpenWithProtontricks](./Images/ProtontricksLaunchGui.png) + +This will install to your desktop: + +![OnWine-InstallsToDesktop](./Images/OnWine-InstallsToDesktop.png) + +!!! note "The Linux installer does not have a GUI" + + Installation may take a minute, please be patient. + + As an approximation, the installer will download 140MB of files, install 4 runtimes and Reloaded. + This usually takes 10-30 seconds and is mostly dependent on internet speed. + +## Add a Game + +!!! info "Add your game to Steam" + +- For most Steam installs this will be `Z:\home\\.local\share\Steam\steamapps\common\`. +- For ***Steam Deck*** users with game installed in SDCard this may be `E:\steamapps\common\`. + +![AddGameInReloaded](./Images/AddGameInReloaded-OnWine.png) + +## Launching Reloaded-II + +Installing via `Protontricks` should have created a shortcut on your desktop. +Provided you don't move the game folder or Reloaded folder, this shortcut should 'just work'. + +You are done. + +## [Optional] Starting Reloaded with your Game via Steam + +If you wish to auto-inject Reloaded while starting your game via Steam without +having to go through the launcher, try using the [Using ASI Loader](./LinuxSetupGuide.md#using-asi-loader) step of the legacy setup guide. + +----------------------------- + +## Credits + +- `Deck Screenshots`: rudiger + +[Protontricks]: https://github.com/Matoking/protontricks +[Setup-Linux.exe]: https://github.com/Reloaded-Project/Reloaded-II/releases/latest/download/Setup-Linux.exe +[protontricks-flatpak]: ./LinuxSetupGuideNewExtra.md#installing-protontricks-via-flatpak diff --git a/docs/LinuxSetupGuideNewExtra.md b/docs/LinuxSetupGuideNewExtra.md new file mode 100644 index 00000000..fc6c6a9c --- /dev/null +++ b/docs/LinuxSetupGuideNewExtra.md @@ -0,0 +1,50 @@ +# Extra + +!!! info "This guide contains extra tips for setting up Reloaded on Linux." + +## Installing Protontricks via FlatPak + +!!! info "Includes any distribution where FlatPak is available." + +To insall Protontricks via FlatPak, we will need [Flatseal] and [Protontricks]. + +- [Flatseal] will allow the sandboxed [Protontricks] to see alternative Steam library locations. +- [Protontricks] will let you run Reloaded inside the game's sandbox. + +These can be installed via a FlatPak supporting Package Manager such as [Discover]: + +![Discover](./Images/FlatPak-Discover.png) + +After installing, first launch [Flatseal]: + +![Flatseal](./Images/Launch-Flatseal.jpg) + +Scroll through the left column of apps in [Flatseal] until you're able to find and click on "[Protontricks]". This will display a configuration list in the right pane: + +![Flatseal](./Images/Launch-Flatseal-3.png) + +Scroll down to the "Filesystem" section: + +1. Enable `All user files`. +2. Under `Other files`, add a new entry for "/run/media". + - And any other locations you may have Steam titles installed. + +Close Flatseal. + +Lastly add an alias so `protontricks` can be executed from the terminal: + +```bash +echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc +echo "alias protontricks-launch='flatpak run --command=protontricks-launch com.github.Matoking.protontricks'" >> ~/.bashrc +``` + +Paste these lines into a `terminal` window, and press `enter`. + +## Credits + +- `Deck Screenshots`: rudiger + +[Discover]: https://apps.kde.org/en-gb/discover/ +[Flatseal]: https://github.com/tchx84/Flatseal +[Protontricks]: https://github.com/Matoking/protontricks +[Setup-Linux.exe]: https://github.com/Reloaded-Project/Reloaded-II/releases/latest/download/Setup-Linux.exe diff --git a/mkdocs.yml b/mkdocs.yml index 5b0f3032..bdddf27f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -79,7 +79,10 @@ nav: - For Users: - Quick Start: QuickStart.md - Frequently Asked Questions: FAQ.md - - Linux Setup Guide: LinuxSetupGuide.md + - Linux Guides: + - Linux Setup Guide: LinuxSetupGuideNew.md + - Linux Setup Guide (Extra): LinuxSetupGuideNewExtra.md + - Linux Setup Guide (Legacy): LinuxSetupGuide.md - Installing Mod Packs: InstallingModPacks.md - Advanced: - NuGet Sources: NuGetSources.md