diff --git a/docs/installing-drop-app/archlinux.md b/docs/installing-drop-app/archlinux.md new file mode 100644 index 0000000..b9d42ac --- /dev/null +++ b/docs/installing-drop-app/archlinux.md @@ -0,0 +1,24 @@ +# Installing the drop-app client on Archlinux + +To install the client application on your system, +you will need to be able to install packages from the [AUR](https://aur.archlinux.org/). +This is usually done using `yay` or `paru` package managers. +These extend the default package manager `pacman` with the ability +to download and install packages from the AUR. +If you do not have one installed, you can [install yay](https://github.com/Jguer/yay). + +## Installing drop-app + +```bash +yay -S drop-oss-app-bin +``` + +## Updating drop-app + +To update drop-app, run `yay`. If an update is available, `yay` will prompt you to update it. + +## Uninstalling drop-app + +```bash +yay -R drop-oss-app-bin +``` diff --git a/docs/installing-drop-app/bazzite.md b/docs/installing-drop-app/bazzite.md new file mode 100644 index 0000000..6d556e6 --- /dev/null +++ b/docs/installing-drop-app/bazzite.md @@ -0,0 +1,82 @@ +# Installing the drop-app client on Bazzite + +To install the client app, you will need to use distrobox which allows +us to install packages from other distributions inside a container. + +The first thing you'll need to do is open a terminal application. +In the terminal, you need to create a distrobox container. +This container will be created using the archlinux image. + +```bash +# Create the distrobox container called drop-app +distrobox create --image archlinux drop-app +distrobox enter drop-app +``` + +It will take a few seconds to prepare the container. +Once ready, you need to install the `yay` package manager to be able to install packages from the [AUR](https://aur.archlinux.org/). + +```bash +# This enables the multilib repository which is needed to install umu-launcher and drop-app +sudo sh -c 'printf "\n\n[multilib]\nInclude = /etc/pacman.d/mirrorlist\n" >> /etc/pacman.conf' +# Updates repositories and system +sudo pacman -Syu --noconfirm +sudo pacman -S --needed --noconfirm base-devel git +git clone https://aur.archlinux.org/yay.git +cd yay +# This will build and install yay +makepkg -si --noconfirm +# We can now delete the yay folder +cd .. && rm -rf ./yay +``` + +Next, you can install dependencies: + +```bash +yay -S --noconfirm gnu-free-fonts +``` + +Then you will need to install a vulkan driver. +If you are using an Intel GPU, you can run: + +```bash +yay -S --noconfirm lib32-vulkan-intel +``` + +If you are using an AMD GPU, you can run: + +```bash +yay -S --noconfirm lib32-vulkan-radeon +``` + +Then you can install drop-app: + +```bash +yay -S --noconfirm drop-oss-app-bin +``` + +```bash +distrobox-export --app drop-app +# Go back to Bazzite +exit +``` + +The drop-app application should be appear in your application menu. + +## Update drop-app + +In the terminal, you need to enter the drop-app container and update system packages within in. + +```bash +distrobox enter drop-app +yay +exit +``` + +## Uninstall the drop-app client + +The following command will delete the distrobox container and delete the drop-app application from your system. + +```bash +distrobox rm drop-app --force +``` diff --git a/docs/installing-drop-app/debian.md b/docs/installing-drop-app/debian.md new file mode 100644 index 0000000..f37f31e --- /dev/null +++ b/docs/installing-drop-app/debian.md @@ -0,0 +1,32 @@ +# Installing drop-app on Debian + +## Installing `libayatana-appindicator3-1` + +This library is dependency of drop-app. Without it, drop-app will crash on start up. + +```bash +sudo apt install libayatana-appindicator3-1 + +``` + +## Installing drop-app + +To install drop-app on Debian, simply download the `amd64.deb` or `arm64.deb` package [from this page](https://github.com/Drop-OSS/drop-app/releases/latest) and open the downloaded file. +It will open it in the Software app. You can click Install on this page. + +![Installing drop-app on the Debian Software app](installing-drop-app-on-debian-software.png) + +## Uninstalling drop-app + +You can uninstall `libayatana-appindicator3-1` if no other applications depend on it, +or if you simply want to get rid of it, you can do so with the following: + +```bash +sudo apt remove libayatana-appindicator3-1 +``` + +You can then uninstall drop with the following command: + +```bash +sudo apt remove drop-desktop-client +``` diff --git a/docs/installing-drop-app/fedora.md b/docs/installing-drop-app/fedora.md new file mode 100644 index 0000000..57f0418 --- /dev/null +++ b/docs/installing-drop-app/fedora.md @@ -0,0 +1,31 @@ +# Installing drop-app on Fedora + +## Installing `libayatana-appindicator-gtk3` + +This library is dependency of drop-app. Without it, drop-app will crash on start up. + +```bash +sudo dnf install libayatana-appindicator-gtk3 +``` + +## Installing drop-app + +To install drop-app on Fedora, simply download the rpm package [from this page](https://github.com/Drop-OSS/drop-app/releases/latest) and open the downloaded file. +It will open it in the Software app. You can click Install on this page. + +![Installing drop-app on the Fedora Software app](installing-drop-app-on-fedora-software.png) + +## Uninstalling drop-app + +You can uninstall `libayatana-appindicator-gtk3` if no other applications depend on it, +or if you simply want to get rid of it, you can do so with the following: + +```bash +sudo dnf remove libayatana-appindicator-gtk3 +``` + +You can then uninstall drop with the following command: + +```bash +sudo dnf remove drop-desktop-client +``` diff --git a/docs/installing-drop-app/index.md b/docs/installing-drop-app/index.md new file mode 100644 index 0000000..8ed5b69 --- /dev/null +++ b/docs/installing-drop-app/index.md @@ -0,0 +1,14 @@ +# Install the drop-app client on your platform + +Available platforms: + +| Platform | Guide | +| -------------------- | ----------------- | +| Archlinux | [link](archlinux) | +| Bazzite | [link](bazzite) | +| Debian | [link](debian) | +| Fedora | [link](fedora) | +| MacOs | [link](macos) | +| SteamOS (Steam Deck) | [link](steamdeck) | +| Ubuntu | [link](ubuntu) | +| Windows | [link](windows) | diff --git a/docs/installing-drop-app/installing-drop-app-on-debian-software.png b/docs/installing-drop-app/installing-drop-app-on-debian-software.png new file mode 100644 index 0000000..5e2b607 Binary files /dev/null and b/docs/installing-drop-app/installing-drop-app-on-debian-software.png differ diff --git a/docs/installing-drop-app/installing-drop-app-on-fedora-software.png b/docs/installing-drop-app/installing-drop-app-on-fedora-software.png new file mode 100644 index 0000000..943e2e0 Binary files /dev/null and b/docs/installing-drop-app/installing-drop-app-on-fedora-software.png differ diff --git a/docs/installing-drop-app/installing-drop-app-on-ubuntu-app-center.png b/docs/installing-drop-app/installing-drop-app-on-ubuntu-app-center.png new file mode 100644 index 0000000..083d42c Binary files /dev/null and b/docs/installing-drop-app/installing-drop-app-on-ubuntu-app-center.png differ diff --git a/docs/installing-drop-app/macos.md b/docs/installing-drop-app/macos.md new file mode 100644 index 0000000..37da863 --- /dev/null +++ b/docs/installing-drop-app/macos.md @@ -0,0 +1,3 @@ +# Installing the drop-app client on MacOS + +TODO diff --git a/docs/installing-drop-app/steamdeck.md b/docs/installing-drop-app/steamdeck.md new file mode 100644 index 0000000..47225c5 --- /dev/null +++ b/docs/installing-drop-app/steamdeck.md @@ -0,0 +1,74 @@ +# Installing the drop-app client on SteamOS (Steam Deck) + +To install the client app, you will need to use distrobox which allows +us to install packages from other distributions inside a container. + +The first thing you'll need to do is open a terminal application. +In the terminal, you need to create a distrobox container. +This container will be created using the archlinux image. + +```bash +# Create the distrobox container called drop-app +distrobox create --image archlinux drop-app +distrobox enter drop-app +``` + +It will take a few seconds to prepare the container. +Once ready, you need to install the `yay` package manager to be able to install packages from the [AUR](https://aur.archlinux.org/). + +```bash +# This enables the multilib repository which is needed to install umu-launcher and drop-app +sudo sh -c 'printf "\n\n[multilib]\nInclude = /etc/pacman.d/mirrorlist\n" >> /etc/pacman.conf' +# Updates repositories and system +sudo pacman -Syu --noconfirm +sudo pacman -S --needed --noconfirm base-devel git +git clone https://aur.archlinux.org/yay.git +cd yay +# This will build and install yay +makepkg -si --noconfirm +# We can now delete the yay folder +cd .. && rm -rf ./yay +``` + +Next, you can install drop and its dependencies: + +```bash +yay -S --noconfirm gnu-free-fonts +yay -S --noconfirm drop-oss-app-bin +``` + +Once the installation is complete, you will need to export `drop-app` to SteamOS. + +```bash +distrobox-export --app drop-app +# Go back to SteamOS +exit +``` + +The drop-app application should be appear in your application menu. + +## Run games + +You can start games while in Desktop Mode, but the controller will not be fully working. +It is recommended to add Drop app as a "Non Steam Game" in Steam in Desktop Mode. +Once added, you can go to Gaming Mode and start Drop App from the "Non Steam Games" tab in the library. +It might take a few seconds to startup. +Once loaded, you can use the touch screen to find the game you want to play and then tap "Run". + +## Update drop-app + +In the terminal, you need to enter the drop-app container and update system packages within in. + +```bash +distrobox enter drop-app +yay +exit +``` + +## Uninstall the drop-app client + +The following command will delete the distrobox container and delete the drop-app application from your system. + +```bash +distrobox rm drop-app --force +``` diff --git a/docs/installing-drop-app/ubuntu.md b/docs/installing-drop-app/ubuntu.md new file mode 100644 index 0000000..9707819 --- /dev/null +++ b/docs/installing-drop-app/ubuntu.md @@ -0,0 +1,14 @@ +# Installing drop-app on Ubuntu + +To install drop-app on Ubuntu, simply download the deb package and open the downloaded file. +It will open it in the App Center. You can click Install on this page. + +![Installing drop-app on the Ubuntu App Center](installing-drop-app-on-ubuntu-app-center.png) + +## Uninstalling drop-app + +To uninstall drop-app, you will need to open a terminal and run the following command: + +```bash +sudo apt remove drop-desktop-client +``` diff --git a/docs/installing-drop-app/windows.md b/docs/installing-drop-app/windows.md new file mode 100644 index 0000000..37d46cb --- /dev/null +++ b/docs/installing-drop-app/windows.md @@ -0,0 +1,11 @@ +# Installing drop-app on Windows + +To install drop-app on Windows, simply download the `setup.exe` file [from this page](https://github.com/Drop-OSS/drop-app/releases/latest) and run it. + +## Uninstalling drop-app + +To uninstall drop-app, you can either open the start menu, +find drop and right click on it, then select `Uninstall`. +If you can't find it in the start menu, you can open the `Control Panel`, +then select `Uninstall a programs` under `Programs`. +Find drop-app in the list of programs and click `Uninstall`. diff --git a/sidebars.ts b/sidebars.ts index e5b4a05..6afe2bc 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -29,6 +29,21 @@ const sidebars: SidebarsConfig = { label: "User Guides", items: ["guides/getting-started", "guides/client-troubleshooting"], }, + { + type: "category", + label: "Installing Drop-app", + items: [ + "installing-drop-app/index", + "installing-drop-app/archlinux", + "installing-drop-app/bazzite", + "installing-drop-app/debian", + "installing-drop-app/fedora", + "installing-drop-app/macos", + "installing-drop-app/steamdeck", + "installing-drop-app/ubuntu", + "installing-drop-app/windows", + ], + }, { type: "category", label: "Metadata", diff --git a/versioned_docs/version-0.3.0/installing-drop-app/archlinux.md b/versioned_docs/version-0.3.0/installing-drop-app/archlinux.md new file mode 100644 index 0000000..b9d42ac --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/archlinux.md @@ -0,0 +1,24 @@ +# Installing the drop-app client on Archlinux + +To install the client application on your system, +you will need to be able to install packages from the [AUR](https://aur.archlinux.org/). +This is usually done using `yay` or `paru` package managers. +These extend the default package manager `pacman` with the ability +to download and install packages from the AUR. +If you do not have one installed, you can [install yay](https://github.com/Jguer/yay). + +## Installing drop-app + +```bash +yay -S drop-oss-app-bin +``` + +## Updating drop-app + +To update drop-app, run `yay`. If an update is available, `yay` will prompt you to update it. + +## Uninstalling drop-app + +```bash +yay -R drop-oss-app-bin +``` diff --git a/versioned_docs/version-0.3.0/installing-drop-app/bazzite.md b/versioned_docs/version-0.3.0/installing-drop-app/bazzite.md new file mode 100644 index 0000000..6d556e6 --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/bazzite.md @@ -0,0 +1,82 @@ +# Installing the drop-app client on Bazzite + +To install the client app, you will need to use distrobox which allows +us to install packages from other distributions inside a container. + +The first thing you'll need to do is open a terminal application. +In the terminal, you need to create a distrobox container. +This container will be created using the archlinux image. + +```bash +# Create the distrobox container called drop-app +distrobox create --image archlinux drop-app +distrobox enter drop-app +``` + +It will take a few seconds to prepare the container. +Once ready, you need to install the `yay` package manager to be able to install packages from the [AUR](https://aur.archlinux.org/). + +```bash +# This enables the multilib repository which is needed to install umu-launcher and drop-app +sudo sh -c 'printf "\n\n[multilib]\nInclude = /etc/pacman.d/mirrorlist\n" >> /etc/pacman.conf' +# Updates repositories and system +sudo pacman -Syu --noconfirm +sudo pacman -S --needed --noconfirm base-devel git +git clone https://aur.archlinux.org/yay.git +cd yay +# This will build and install yay +makepkg -si --noconfirm +# We can now delete the yay folder +cd .. && rm -rf ./yay +``` + +Next, you can install dependencies: + +```bash +yay -S --noconfirm gnu-free-fonts +``` + +Then you will need to install a vulkan driver. +If you are using an Intel GPU, you can run: + +```bash +yay -S --noconfirm lib32-vulkan-intel +``` + +If you are using an AMD GPU, you can run: + +```bash +yay -S --noconfirm lib32-vulkan-radeon +``` + +Then you can install drop-app: + +```bash +yay -S --noconfirm drop-oss-app-bin +``` + +```bash +distrobox-export --app drop-app +# Go back to Bazzite +exit +``` + +The drop-app application should be appear in your application menu. + +## Update drop-app + +In the terminal, you need to enter the drop-app container and update system packages within in. + +```bash +distrobox enter drop-app +yay +exit +``` + +## Uninstall the drop-app client + +The following command will delete the distrobox container and delete the drop-app application from your system. + +```bash +distrobox rm drop-app --force +``` diff --git a/versioned_docs/version-0.3.0/installing-drop-app/debian.md b/versioned_docs/version-0.3.0/installing-drop-app/debian.md new file mode 100644 index 0000000..f37f31e --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/debian.md @@ -0,0 +1,32 @@ +# Installing drop-app on Debian + +## Installing `libayatana-appindicator3-1` + +This library is dependency of drop-app. Without it, drop-app will crash on start up. + +```bash +sudo apt install libayatana-appindicator3-1 + +``` + +## Installing drop-app + +To install drop-app on Debian, simply download the `amd64.deb` or `arm64.deb` package [from this page](https://github.com/Drop-OSS/drop-app/releases/latest) and open the downloaded file. +It will open it in the Software app. You can click Install on this page. + +![Installing drop-app on the Debian Software app](installing-drop-app-on-debian-software.png) + +## Uninstalling drop-app + +You can uninstall `libayatana-appindicator3-1` if no other applications depend on it, +or if you simply want to get rid of it, you can do so with the following: + +```bash +sudo apt remove libayatana-appindicator3-1 +``` + +You can then uninstall drop with the following command: + +```bash +sudo apt remove drop-desktop-client +``` diff --git a/versioned_docs/version-0.3.0/installing-drop-app/fedora.md b/versioned_docs/version-0.3.0/installing-drop-app/fedora.md new file mode 100644 index 0000000..57f0418 --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/fedora.md @@ -0,0 +1,31 @@ +# Installing drop-app on Fedora + +## Installing `libayatana-appindicator-gtk3` + +This library is dependency of drop-app. Without it, drop-app will crash on start up. + +```bash +sudo dnf install libayatana-appindicator-gtk3 +``` + +## Installing drop-app + +To install drop-app on Fedora, simply download the rpm package [from this page](https://github.com/Drop-OSS/drop-app/releases/latest) and open the downloaded file. +It will open it in the Software app. You can click Install on this page. + +![Installing drop-app on the Fedora Software app](installing-drop-app-on-fedora-software.png) + +## Uninstalling drop-app + +You can uninstall `libayatana-appindicator-gtk3` if no other applications depend on it, +or if you simply want to get rid of it, you can do so with the following: + +```bash +sudo dnf remove libayatana-appindicator-gtk3 +``` + +You can then uninstall drop with the following command: + +```bash +sudo dnf remove drop-desktop-client +``` diff --git a/versioned_docs/version-0.3.0/installing-drop-app/index.md b/versioned_docs/version-0.3.0/installing-drop-app/index.md new file mode 100644 index 0000000..8ed5b69 --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/index.md @@ -0,0 +1,14 @@ +# Install the drop-app client on your platform + +Available platforms: + +| Platform | Guide | +| -------------------- | ----------------- | +| Archlinux | [link](archlinux) | +| Bazzite | [link](bazzite) | +| Debian | [link](debian) | +| Fedora | [link](fedora) | +| MacOs | [link](macos) | +| SteamOS (Steam Deck) | [link](steamdeck) | +| Ubuntu | [link](ubuntu) | +| Windows | [link](windows) | diff --git a/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-debian-software.png b/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-debian-software.png new file mode 100644 index 0000000..5e2b607 Binary files /dev/null and b/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-debian-software.png differ diff --git a/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-fedora-software.png b/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-fedora-software.png new file mode 100644 index 0000000..943e2e0 Binary files /dev/null and b/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-fedora-software.png differ diff --git a/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-ubuntu-app-center.png b/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-ubuntu-app-center.png new file mode 100644 index 0000000..083d42c Binary files /dev/null and b/versioned_docs/version-0.3.0/installing-drop-app/installing-drop-app-on-ubuntu-app-center.png differ diff --git a/versioned_docs/version-0.3.0/installing-drop-app/macos.md b/versioned_docs/version-0.3.0/installing-drop-app/macos.md new file mode 100644 index 0000000..37da863 --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/macos.md @@ -0,0 +1,3 @@ +# Installing the drop-app client on MacOS + +TODO diff --git a/versioned_docs/version-0.3.0/installing-drop-app/steamdeck.md b/versioned_docs/version-0.3.0/installing-drop-app/steamdeck.md new file mode 100644 index 0000000..47225c5 --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/steamdeck.md @@ -0,0 +1,74 @@ +# Installing the drop-app client on SteamOS (Steam Deck) + +To install the client app, you will need to use distrobox which allows +us to install packages from other distributions inside a container. + +The first thing you'll need to do is open a terminal application. +In the terminal, you need to create a distrobox container. +This container will be created using the archlinux image. + +```bash +# Create the distrobox container called drop-app +distrobox create --image archlinux drop-app +distrobox enter drop-app +``` + +It will take a few seconds to prepare the container. +Once ready, you need to install the `yay` package manager to be able to install packages from the [AUR](https://aur.archlinux.org/). + +```bash +# This enables the multilib repository which is needed to install umu-launcher and drop-app +sudo sh -c 'printf "\n\n[multilib]\nInclude = /etc/pacman.d/mirrorlist\n" >> /etc/pacman.conf' +# Updates repositories and system +sudo pacman -Syu --noconfirm +sudo pacman -S --needed --noconfirm base-devel git +git clone https://aur.archlinux.org/yay.git +cd yay +# This will build and install yay +makepkg -si --noconfirm +# We can now delete the yay folder +cd .. && rm -rf ./yay +``` + +Next, you can install drop and its dependencies: + +```bash +yay -S --noconfirm gnu-free-fonts +yay -S --noconfirm drop-oss-app-bin +``` + +Once the installation is complete, you will need to export `drop-app` to SteamOS. + +```bash +distrobox-export --app drop-app +# Go back to SteamOS +exit +``` + +The drop-app application should be appear in your application menu. + +## Run games + +You can start games while in Desktop Mode, but the controller will not be fully working. +It is recommended to add Drop app as a "Non Steam Game" in Steam in Desktop Mode. +Once added, you can go to Gaming Mode and start Drop App from the "Non Steam Games" tab in the library. +It might take a few seconds to startup. +Once loaded, you can use the touch screen to find the game you want to play and then tap "Run". + +## Update drop-app + +In the terminal, you need to enter the drop-app container and update system packages within in. + +```bash +distrobox enter drop-app +yay +exit +``` + +## Uninstall the drop-app client + +The following command will delete the distrobox container and delete the drop-app application from your system. + +```bash +distrobox rm drop-app --force +``` diff --git a/versioned_docs/version-0.3.0/installing-drop-app/ubuntu.md b/versioned_docs/version-0.3.0/installing-drop-app/ubuntu.md new file mode 100644 index 0000000..9707819 --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/ubuntu.md @@ -0,0 +1,14 @@ +# Installing drop-app on Ubuntu + +To install drop-app on Ubuntu, simply download the deb package and open the downloaded file. +It will open it in the App Center. You can click Install on this page. + +![Installing drop-app on the Ubuntu App Center](installing-drop-app-on-ubuntu-app-center.png) + +## Uninstalling drop-app + +To uninstall drop-app, you will need to open a terminal and run the following command: + +```bash +sudo apt remove drop-desktop-client +``` diff --git a/versioned_docs/version-0.3.0/installing-drop-app/windows.md b/versioned_docs/version-0.3.0/installing-drop-app/windows.md new file mode 100644 index 0000000..37d46cb --- /dev/null +++ b/versioned_docs/version-0.3.0/installing-drop-app/windows.md @@ -0,0 +1,11 @@ +# Installing drop-app on Windows + +To install drop-app on Windows, simply download the `setup.exe` file [from this page](https://github.com/Drop-OSS/drop-app/releases/latest) and run it. + +## Uninstalling drop-app + +To uninstall drop-app, you can either open the start menu, +find drop and right click on it, then select `Uninstall`. +If you can't find it in the start menu, you can open the `Control Panel`, +then select `Uninstall a programs` under `Programs`. +Find drop-app in the list of programs and click `Uninstall`. diff --git a/versioned_sidebars/version-0.3.0-sidebars.json b/versioned_sidebars/version-0.3.0-sidebars.json index 52e03ff..76c7546 100644 --- a/versioned_sidebars/version-0.3.0-sidebars.json +++ b/versioned_sidebars/version-0.3.0-sidebars.json @@ -14,6 +14,21 @@ "label": "User Guides", "items": ["guides/getting-started", "guides/client-troubleshooting"] }, + { + "type": "category", + "label": "Installing Drop-app", + "items": [ + "installing-drop-app/index", + "installing-drop-app/archlinux", + "installing-drop-app/bazzite", + "installing-drop-app/debian", + "installing-drop-app/fedora", + "installing-drop-app/macos", + "installing-drop-app/steamdeck", + "installing-drop-app/ubuntu", + "installing-drop-app/windows" + ] + }, { "type": "category", "label": "Metadata",