diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 0ee1f558..3328e816 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -23,6 +23,16 @@ export default defineConfig({ }, ], sidebar: [ + { + label: "Users", + items: [ + { slug: "user" }, + { + label: "Install", + autogenerate: { directory: "user/install" }, + }, + ], + }, { label: "Admin", items: [ diff --git a/docs/src/content/docs/user/index.md b/docs/src/content/docs/user/index.md new file mode 100644 index 00000000..d68a220a --- /dev/null +++ b/docs/src/content/docs/user/index.md @@ -0,0 +1,7 @@ +--- +title: Getting Started +--- + +Drop clients are available for download from [our website](https://droposs.org/download), or follow one of our installation guides on the sidebar. Download the correct version for your platform, and open it up. + +The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart](/admin/quickstart/) guide to set up your own. diff --git a/docs/src/content/docs/user/install/archlinux.md b/docs/src/content/docs/user/install/archlinux.md new file mode 100644 index 00000000..8e15dce8 --- /dev/null +++ b/docs/src/content/docs/user/install/archlinux.md @@ -0,0 +1,21 @@ +--- +title: Arch Linux +--- + +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/src/content/docs/user/install/bazzite.md b/docs/src/content/docs/user/install/bazzite.md new file mode 100644 index 00000000..1d3722e2 --- /dev/null +++ b/docs/src/content/docs/user/install/bazzite.md @@ -0,0 +1,84 @@ +--- +title: 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/src/content/docs/user/install/debian.md b/docs/src/content/docs/user/install/debian.md new file mode 100644 index 00000000..74c1f069 --- /dev/null +++ b/docs/src/content/docs/user/install/debian.md @@ -0,0 +1,42 @@ +--- +title: 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) + +--- + +You can also choose to install it via apt: +```bash +sudo apt install ./ +``` + +## 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/src/content/docs/user/install/fedora.md b/docs/src/content/docs/user/install/fedora.md new file mode 100644 index 00000000..2b31b951 --- /dev/null +++ b/docs/src/content/docs/user/install/fedora.md @@ -0,0 +1,40 @@ +--- +title: 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) + +--- + +You can also choose to install it via `dnf`: +```bash +sudo dnf install ./ +``` + +## 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/src/content/docs/user/install/installing-drop-app-on-debian-software.png b/docs/src/content/docs/user/install/installing-drop-app-on-debian-software.png new file mode 100644 index 00000000..5e2b6070 Binary files /dev/null and b/docs/src/content/docs/user/install/installing-drop-app-on-debian-software.png differ diff --git a/docs/src/content/docs/user/install/installing-drop-app-on-fedora-software.png b/docs/src/content/docs/user/install/installing-drop-app-on-fedora-software.png new file mode 100644 index 00000000..943e2e06 Binary files /dev/null and b/docs/src/content/docs/user/install/installing-drop-app-on-fedora-software.png differ diff --git a/docs/src/content/docs/user/install/installing-drop-app-on-ubuntu-app-center.png b/docs/src/content/docs/user/install/installing-drop-app-on-ubuntu-app-center.png new file mode 100644 index 00000000..083d42c8 Binary files /dev/null and b/docs/src/content/docs/user/install/installing-drop-app-on-ubuntu-app-center.png differ diff --git a/docs/src/content/docs/user/install/macos.md b/docs/src/content/docs/user/install/macos.md new file mode 100644 index 00000000..4ebd2ede --- /dev/null +++ b/docs/src/content/docs/user/install/macos.md @@ -0,0 +1,9 @@ +--- +title: macOS +--- + +To install on macOS, download the `.dmg` image for your device from [our website](https://droposs.org/download). M-chips are ARM, Intel chips are x86. + +Open the `.dmg` file. If macOS shows that the `.dmg` is unsigned, follow the macOS method to allow it on your system. + +Then, copy "Drop Desktop Client" to your Applications folder. diff --git a/docs/src/content/docs/user/install/steamdeck.md b/docs/src/content/docs/user/install/steamdeck.md new file mode 100644 index 00000000..f4fe8463 --- /dev/null +++ b/docs/src/content/docs/user/install/steamdeck.md @@ -0,0 +1,76 @@ +--- +title: 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/src/content/docs/user/install/ubuntu.md b/docs/src/content/docs/user/install/ubuntu.md new file mode 100644 index 00000000..303ffdb1 --- /dev/null +++ b/docs/src/content/docs/user/install/ubuntu.md @@ -0,0 +1,16 @@ +--- +title: 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/src/content/docs/user/install/windows.md b/docs/src/content/docs/user/install/windows.md new file mode 100644 index 00000000..6467eed5 --- /dev/null +++ b/docs/src/content/docs/user/install/windows.md @@ -0,0 +1,13 @@ +--- +title: Windows +--- + +To install drop-app on Windows, simply download the setup executable [from our website](https://droposs.org/download) 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`.