Skip to content

Commit

Permalink
feat: Add instructions on how to rebase to a different... (ublue-os#649)
Browse files Browse the repository at this point in the history
* feat: Add instructions on how to rebase to a different...

...Bazzite branch

* chore: Remove traces of bazzite-arch

It's not preinstalled anymore.

* chore: remove traces of bazzite-arch

Not used anymore.

* chore: some fixes

* chore: remove timestamp in install guide
  • Loading branch information
nicknamenamenick authored Nov 10, 2023
1 parent bdf51ef commit f99ceca
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 35 deletions.
56 changes: 27 additions & 29 deletions docs/images/bazzite/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,12 @@ Make sure you are connected to the internet if you are using an online ISO. If
Images are split up between **2 types of images**:
### Desktop
_AMD/Intel Desktop Images_: Steam and other gaming utilities are installed in a [customized Arch Linux](https://github.com/ublue-os/bazzite-arch) [Distrobox container](https://github.com/89luca89/distrobox). No "Game Mode" on these images, but is similar to SteamOS's "Desktop Mode" from an end user point of view.
_AMD/Intel Desktop Images_: Steam and other gaming utilities are layered to the image. **No "Game Mode" on these images**, but is similar to SteamOS's "Desktop Mode" from an end user point of view.
_Nvidia Desktop Images_: Very similar to their AMD/Intel desktop counterparts, but Steam and other gaming utilities are part of the image itself and are missing certain features like Waydroid.
_Nvidia Desktop Images_: Very similar to their AMD/Intel desktop counterparts, but preinstalls Nvidia's proprietary graphic drivers to the image, and there are features like Waydroid out of the box.
### Steam Deck / HTPC / Handheld PC
Mimics SteamOS with "Game Mode" with most of the features fully functional. Can be used on most devices using a modern AMD/Intel GPU.
Mimics SteamOS with "Game Mode" with most of the features fully functional. Can be used on most devices using a modern AMD/Intel GPU. **Nvidia is currently not supported.**
### Desktop Environments & Specific Hardware
Expand Down Expand Up @@ -128,8 +128,6 @@ Distrobox containers are running subsystems of other popular Linux distributions
Distrobox containers can be made with the host terminal following this [documentation](https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-create.md).
AMD/Intel Bazzite Desktop images have the `bazzite-arch` container preinstalled that can use the `pacman` package manager and has access to the [AUR](https://aur.archlinux.org/).
There are pre-made `ujust` commands to create a container of operating systems. Ex: `ujust distrobox-fedora` to create a Fedora Linux Distrobox container to have access to `dnf`. Keep in mind that this is still a container, so dependencies and libraries from anything you install are not part of your host.
[Full list of other distributions that work in Distrobox](https://github.com/89luca89/distrobox/blob/main/docs/compatibility.md#containers-distros).
Expand Down Expand Up @@ -211,7 +209,7 @@ Open a host terminal and enter: `systemctl disable ublue-update`.
Open a host terminal and enter `rpm -qa` and an output of every system package will be listed.
## SteamOS is based on Arch Linux, so why use Fedora Linux as the base?
SteamOS is based on Arch Linux, but the base packages and drivers get updates at a much slower pace than using vanilla Arch and updating yourself. Bazzite will follow Fedora's updates which means it will always be ahead of SteamOS in terms of newer software and drivers. Also Fedora currently is the only Linux distribution that supports OCI custom images that this whole project is built around. The end user typically shouldn't notice too much of a difference between Bazzite and SteamOS.
SteamOS is based on Arch Linux, but the base packages and drivers get updates at a much slower pace than using vanilla Arch and updating yourself. Bazzite will follow Fedora's updates which means it will always be ahead of SteamOS in terms of newer software and drivers. Also Fedora Linux currently is the only Linux distribution that supports OCI custom images that this whole project is built around. The end user typically shouldn't notice too much of a difference between Bazzite and SteamOS in terms of losing features.
## How does Bazzite differ from other Linux distributions?
Like SteamOS, Bazzite makes use of read-only root files for stability purposes.
Expand Down Expand Up @@ -246,6 +244,20 @@ You can also rebase to a stock Fedora imaged-based desktop image by entering in
!!! note
Rebasing from KDE Plasma images to GNOME images may have major issues. Rebasing from GNOME to KDE Plasma is usually fine however.
## How do I change the Bazzite branch? (Latest, Testing, and Unstable)
There are 3 branches you can switch to:
- Latest (default, stable)
- Testing
- Unstable (Not recommended)
Steam Deck/HTPC/Handheld PCs can switch branches inside of Settings > System > OS Update Channel.
Other images, or a manual command-line method is adding `:testing` or `:unstable` to the end of the rebase command for your Bazzite image.
**Ex**: `rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/bazzite:testing` for the testing branch on a AMD/Intel desktop image.
## How similar is Bazzite to SteamOS on Steam Deck hardware?
It should nearly be identical to the end user. Bazzite Steam Deck images include the latest Gamescope and packages, which means we are always ahead of SteamOS in terms of Game Mode and Desktop Mode features. The Quick Access Menu (Accessed with the <kbd>...</kbd> button) is functional for TDP, framerate caps, scaling, etc. Performance should be on par or better than SteamOS, and every game SteamOS can play should play well on Bazzite.
Expand All @@ -254,33 +266,21 @@ Third-party software like Decky Loader, Emudeck, RetroDeck, etc. work and can be
Desktop Mode still has access to all of the applications in Discover that SteamOS has.
The only missing feature that SteamOS has over Bazzite currently is HDR support, but this should change once Fedora Linux supports it.
**The only missing feature that SteamOS has over Bazzite currently is HDR support, but this should change once Fedora Linux supports it.**
## Does the Steam Deck image recieve BIOS updates like SteamOS?
Yes it does. If a BIOS update is available then it will install when you update Bazzite normally. We even included a special command to **disable** these BIOS updates **at your own risk:** `ujust disable-bios-updates`.
**Yes it does**. If a BIOS update is available then it will install when you update Bazzite normally. We even included a **special command to disable BIOS updates at your own risk**: `ujust disable-bios-updates`.
## What is Wayland and X11?
In short, Wayland and X11 (also known as Xorg or the X Window System) are windowing systems for desktop Linux.
* Wayland is the default for most of the images and the recommended option for Bazzite.
* X11 is a legacy windowing system. While we recommend to stick with Wayland, there may be scenarios where X11 would have to be used. Nvidia GPUs may have issues with Wayland, so X11 is the default for the Nvidia images.
## Why does the stock 64GB Steam Deck not supported on Bazzite?
You can swap between the two in the login screen for desktop images, and enter `ujust _toggle_wayland` in a host terminal for Steam Deck/HTPC/Handheld PC images.
It has filesystem corruptions. You will have booting issues, freezes, and will not be able to update the image. Upgrade the storage to resolve this if you feel comfortable doing so.
## Why are there no Nvidia images that include Game Mode and Waydroid?
Nvidia's proprietary drivers currently do not work with any of this. AMD and Intel have open source drivers on Linux and are usaully the far better option to use.
Hopefully this changes in the future thanks to the upcoming [NVK](https://www.collabora.com/news-and-blog/news-and-events/introducing-nvk.html) project. Then most desktop Linux users would not have to bother with Nvidia's closed source driver philosophy and all of the downsides that come with that.
## For the AMD/Intel desktop images, why run Steam in an Arch Linux Distrobox container as opposed to Flatpak?
Steam is not built with flatpak in mind. Valve does not contribute to it, and as a result there are many workarounds that the Arch package does not have to worry about it. The Steam Deck uses the Arch package, and to stay consistent with SteamOS so do we.
Running Steam in Distrobox has the advantage of using [LatencyFleX](https://github.com/ishitatsuyuki/LatencyFleX) and other packages added to the container. It can also utilize the latest GPU driver releases without the end user having to worry about ABI considerations or a broken driver on the host.
A user can still install the Flatpak Steam at any time and use both verisons of Steam if they desire.
## How do I disable update notifications for desktop images?
Open the directory `/etc/ublue-update/` and open `ublue-update.toml` with a text editor.
Expand Down Expand Up @@ -316,15 +316,13 @@ Save the file. Steam should now launch.

Read more about this issue [here](https://github.com/ValveSoftware/steam-for-linux/issues/9940).

## Bluetooth controller not connecting

Currently a [known issue](https://github.com/ublue-os/bazzite/issues/456#issuecomment-1778188420). Open a host terminal and enter these commands:
## What is Wayland and X11?
In short, Wayland and X11 (also known as Xorg or the X Window System) are windowing systems for desktop Linux.

1. `ls -l /sys/class/bluetooth`
2. Spit results from the output from step 1: `sudo chmod 755 [output from command in the first step]`
3. Restart the bluetooth service: `sudo systemctl daemon-reload && sudo systemctl restart bluetooth.service`
* Wayland is the default for most of the images and the recommended option for Bazzite.
* X11 is a legacy windowing system. While we recommend to stick with Wayland, there may be scenarios where X11 would have to be used. Nvidia GPUs may have issues with Wayland, so X11 is the default for the Nvidia images.

It should work now.
You can swap between the two in the login screen for desktop images, and enter `ujust _toggle_wayland` in a host terminal for Steam Deck/HTPC/Handheld PC images.

## I am experiencing a bug or want to request a feature! Help!
In order to troubleshoot the issue properly, you should add a log or terminal output of the issue.
Expand Down
3 changes: 1 addition & 2 deletions docs/images/bazzite/gaming_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,8 @@ Non-Steam games can have the prefix folder anywhere you specify, but by default

## Extras

* It is recommended to use ProtonUp-Qt or ProtonPlus (included on Bazzite) to update the latest [GE-Proton](https://github.com/GloriousEggroll/proton-ge-custom) and [Luxtorpeda](https://github.com/luxtorpeda-dev/luxtorpeda) for Steam.
* It is recommended to use ProtonUp-Qt or ProtonPlus (included on Bazzite) to update the latest [GE-Proton](https://github.com/GloriousEggroll/proton-ge-custom) and [Luxtorpeda](https://github.com/luxtorpeda-dev/luxtorpeda) for Steam, and it also includes other useful SteamPlay tools.
* Some games require Protontricks (included) or Winetricks (for non-Steam games, included with Lutris) to function properly.
* You can install [pacman](https://archlinux.org/packages/) and [AUR](https://aur.archlinux.org/) packages inside of the `bazzite-arch` container on AMD/Intel desktop images.
* You can overlay [RPM](https://packages.fedoraproject.org/) packages to the host by using `rpm-ostree install <package>` in your host terminal **at your own risk.**


Expand Down
6 changes: 2 additions & 4 deletions docs/images/bazzite/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,17 @@ This is a visual guide for installing Bazzite.

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/aaeRk8_i1Ds?si=GopDcKXcCUCxdie8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Installation tutorial begins at [1:37](https://youtu.be/aaeRk8_i1Ds?feature=shared&t=97).

## Pre-Requisites

* Make sure you meet the [system requirements](https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/welcome/Hardware_Overview/) for Fedora Linux.
* Make sure you meet the [system requirements](https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/welcome/Hardware_Overview/) for Fedora Linux.
* A graphics card that can utilize Vulkan 1.3 or later. Most modern AMD, Nvidia, and Intel GPUs should be fine.
* The drive that Bazzite is installed to must have at least 32GB unallocated drive space.
* A USB flash drive, external drive, or microSD card with at least 5GB of free space on it. **(This will remove existing data on it!)**
* A working and stable wired or wireless internet connection.
* Download the latest ISO release [here](https://github.com/ublue-os/bazzite/releases).
* Software to flash the image to your flash drive, external drive, or microSD card. We recommend using [Fedora Media Writer,](https://www.fedoraproject.org/en/workstation/download/) [Balena Etcher,](https://etcher.balena.io/) or [Rufus.](https://rufus.ie/en/) **Ventoy is unsupported.**
* Bazzite requires a physical wired keyboard to install properly.
* Manual partitioning is unsupported.
* See [Fedora Kinoite documentation](https://docs.fedoraproject.org/en-US/fedora-kinoite/installation/) and [Fedora Silverblue documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/) for more information.

## Boot into your installation medium.
Expand Down Expand Up @@ -62,7 +60,7 @@ When you boot into the installer, you will be presented a list of Bazzite images

* **bazzite-nvidia** is _bazzite_ but for PCs running Nvidia GPUs as they include their proprietary drivers in the image.

* **bazzite-deck** is a special Steam Deck image of Bazzite. More details on that [here.](https://github.com/ublue-os/bazzite#steam-deckhome-theater-pcs-htpcs)
* **bazzite-deck** is a special Steam Deck/HTPC/Handheld PC image of Bazzite. More details on that [here.](https://github.com/ublue-os/bazzite#steam-deckhome-theater-pcs-htpcs)

* **bazzite-gnome** is _bazzite_, but instead of using KDE Plasma as the desktop environment, it uses GNOME.

Expand Down

0 comments on commit f99ceca

Please sign in to comment.