mirror/bazzite
1
0
Fork 0
mirror of https://github.com/ublue-os/bazzite.git synced 2025-03-01 07:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix several pages with broken headers and other fixes (#1659)

Browse Source 
* chore(docs): Add fmt command to Justfile

* chore(docs): Format markdown files

* chore(docs): Minor tweaks to Justfile

* chore(docs): Fix headers in handheld wiki

* chore(docs): Fix headers in Steam Gaming Mode page

* chore(docs): Fix headers in FAQ page

* chore(docs): Fix italic text in Installation Guide index

* chore(docs): Fix headers in Installation Guide pages

* chore(docs): Fix headers in Desktop Environment Tweaks page

* chore(docs): Fix headers in Reporting Bugs  page

* chore(docs): Remove duplicated contributing page

* chore(docs): Fix headers in Contributing to Bazzite page

* chore(docs): Combine multiple blockquotes in one in Automounting page

* chore(docs): Fix broken ordered list

* chore(docs): Remove unnecesary announcement bar

* chore(docs): Fix headers in Gaming pages

* chore(docs): Add missing headers in Framework laptops install guides

* chore(docs): Add author metadata

Adresses issue #1661 regarding lacking authors section

* chore(docs): Add authors list to pages
This commit is contained in:
Zeglius 2024-09-11 23:49:06 +02:00 committed by GitHub
parent f150e417fd
commit a6e1eec678
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
53 changed files with 1412 additions and 1088 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Justfile
View File

@ -1,4 +1,6 @@
export PATH := justfile_directory() + "/utils:" + env("PATH")
export GITHUB_REPOSITORY := "ublue-os/bazzite"
export MKDOCS_REPO_URL := "https://github.com/" + GITHUB_REPOSITORY
MKDOCS_DIR := justfile_directory()
_default:
@ -14,3 +16,7 @@ mkdocs +ARGS="":
mkdocs_clean:
rm -rf {{ MKDOCS_DIR }}/.cache
# Format all markdown files with prettier
fmt:
prettier --check --write $(find src -type f -name '*.md')

2
docs/mkdocs.yml
View File

@ -149,4 +149,4 @@ nav:
- Advanced:
- "Reset Forgotten User Password": Advanced/Reset_Forgotten_User_Password.md
- "Creating A Custom Bazzite Image": Advanced/creating_custom_image.md
- "Contributing to Bazzite": General/Contributing_to_Bazzite.md
- "Contributing to Bazzite": Advanced/Contributing_to_bazzite.md

47
docs/src/Advanced/Auto-Mounting_Secondary_Drives.md
View File

@ -1,65 +1,71 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=970", "fetched_at": "2024-09-03 16:43:14.005694+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# WARNING!
>**Attention**: You may lose data on the drive(s) or result in an unbootable system if configured improperly.
>**Note:** MicroSD cards automatically mount without any manual intervention required on Bazzite.
>**Important**: Do **not** use the NTFS, exFAT, or FAT32 filesystems for game library storage.
Follow this guide **at your own discretion** and make sure to read the entire document relevant to your method, so you do not miss anything!
> # WARNING!
>
> **Attention**: You may lose data on the drive(s) or result in an unbootable system if configured improperly.
>
> **Note:** MicroSD cards automatically mount without any manual intervention required on Bazzite.
>
> **Important**: Do **not** use the NTFS, exFAT, or FAT32 filesystems for game library storage.
>
> Follow this guide **at your own discretion** and make sure to read the entire document relevant to your method, so you do not miss anything!
<hr>
# Formatting a disk
>**Warning**: This will wipe all existing data on it
> **Warning**: This will wipe all existing data on it
## Note when formatting in **KDE Partition Manager**
Make sure you set permissions to **everyone**.
Use a disk graphical user interface like KDE Plasma or GNOME Disks to format your drive. We recommend formatting secondary drives to **BTRFS** or **Ext4**. BTRFS is our recommended filesystem, but Ext4 may be better for older spinning mechanical HDDs as secondary drives.
Use a disk graphical user interface like KDE Plasma or GNOME Disks to format your drive. We recommend formatting secondary drives to **BTRFS** or **Ext4**. BTRFS is our recommended filesystem, but Ext4 may be better for older spinning mechanical HDDs as secondary drives.
## Creating a secondary drive directory and where to mount drives?
>**Note**: Drive directories should be **lowercase** with **no spaces** for best practice.
>**Attention**: `/var/mnt` should NOT be the path, but create a new **directory** in either `/var/mnt` or `/var/run/media/`.
> **Note**: Drive directories should be **lowercase** with **no spaces** for best practice.
> **Attention**: `/var/mnt` should NOT be the path, but create a new **directory** in either `/var/mnt` or `/var/run/media/`.
- `/var/mnt/...` for **permanent** drives
- `/var/run/media/...` for **removable** drives
You can make a directory in `/var/mnt/` by opening a host terminal and **entering this command in a host terminal**:
```command
cd /var/mnt
```
```command
sudo mkdir /var/mnt/games
```
The drive will now be mounted in a directory known as `games`.
>**Note**: `games` can be named anything you desire that fits best practices.
> **Note**: `games` can be named anything you desire that fits best practices.
### Permissions for the drive
```command
sudo chown $USER:$USER /var/mnt/games
```
>**Note**: If you plan to reformat the partition, remember to edit the mount point and "Remove" the mount path before you reformat! If not you will have to manually edit `/etc/fstab`.
> **Note**: If you plan to reformat the partition, remember to edit the mount point and "Remove" the mount path before you reformat! If not you will have to manually edit `/etc/fstab`.
# Graphical User Interface (GUI) Methods for Auto-Mounting
>**Warning**: Do not set up auto-mount, unmount then format a drive! It can confuse the software you are configuring drives with. Instead, **remove the auto-mount first before formatting the drive**.
> **Warning**: Do not set up auto-mount, unmount then format a drive! It can confuse the software you are configuring drives with. Instead, **remove the auto-mount first before formatting the drive**.
* [**KDE Partition Manager**](./KDE_Partition_Manager_Auto_Mount_Guide.md)
* [**GNOME Disks**](./GNOME_Disks_Auto-Mount_Guide.md)
- [**KDE Partition Manager**](./KDE_Partition_Manager_Auto_Mount_Guide.md)
- [**GNOME Disks**](./GNOME_Disks_Auto-Mount_Guide.md)
# Alternative Methods (CLI)
@ -69,7 +75,6 @@ There are also two command-line interface (CLI) methods.
2. Editing the `/etc/fstab` file
Command Line Interface methods are intended for advanced users, and it is recommended to research one of the two methods outside of this documentation.
<hr>

36
docs/src/Advanced/Contributing_to_bazzite.md
View File

@ -1,43 +1,47 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=38", "fetched_at": "2024-09-03 16:43:12.863190+00:00"}-->
<!-- ANCHOR_END: METADATA -->
## **Preliminary Reading**:
# **Preliminary Reading**:
- [**Universal Blue Project Governance**](https://universal-blue.discourse.group/docs?topic=51)
- [**Universal Blue Project Governance**](https://universal-blue.discourse.group/docs?topic=51)
- [**Contributing Guide**](https://universal-blue.discourse.group/docs?topic=81)
<hr>
# Overview
## Overview
Bazzite is an image from [Universal Blue](https://universal-blue.org/) and you should follow Universal Blue's [contribution guidelines](https://universal-blue.org/CONTRIBUTING) before proceeding. Also read our [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) if contributing to documentation.
Bazzite is an image from [Universal Blue](https://universal-blue.org/) and you should follow Universal Blue's [contribution guidelines](https://universal-blue.org/CONTRIBUTING) before proceeding. Also read our [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) if contributing to documentation.
Check out the Bazzite's [issue tracker](https://github.com/ublue-os/bazzite/issues) to see what issues users are currently experiencing. Also check out the current [roadmap](https://github.com/orgs/ublue-os/projects/1/views/1) for Universal Blue. There is also a [forum](https://universal-blue.discourse.group/c/contributing/7) for general Universal Blue contributions.
Check out the Bazzite's [issue tracker](https://github.com/ublue-os/bazzite/issues) to see what issues users are currently experiencing. Also check out the current [roadmap](https://github.com/orgs/ublue-os/projects/1/views/1) for Universal Blue. There is also a [forum](https://universal-blue.discourse.group/c/contributing/7) for general Universal Blue contributions.
# Contributing to Bazzite
- Adding features or fixing bugs by submitting a [pull request](https://github.com/ublue-os/bazzite/pulls).
## Contributing to Bazzite
- Adding features or fixing bugs by submitting a [pull request](https://github.com/ublue-os/bazzite/pulls).
- Reporting issues you experience on our [issue tracker](https://github.com/ublue-os/bazzite/issues).
- Adding and contributing to [documentation](https://docs.bazzite.gg).
- Language translations are encouraged for documentation and the [README](https://github.com/ublue-os/bazzite/blob/main/README.md).
- Testing Bazzite on unique hardware configurations.
- Troubleshooting issues with handheld hardware is appreciated.
- Reporting issues with [HHD](https://github.com/hhd-dev/hhd) directly is also helpful on handhelds.
- Troubleshooting issues with handheld hardware is appreciated.
- Reporting issues with [HHD](https://github.com/hhd-dev/hhd) directly is also helpful on handhelds.
# Building Your Own Bazzite for Testing
## Building Your Own Bazzite for Testing
>**[Bazzite Template](https://github.com/ublue-os/image-template)**
> **[Bazzite Template](https://github.com/ublue-os/image-template)**
Read about forking your own Bazzite image [here](https://ublue-os.github.io/bazzite/Advanced/creating_custom_image/).
If you feel comfortable with bash scripting, programming, working with containers, or anything upstream (Fedora, Flatpak, etc.) then feel free to contribute to Bazzite if you have want to add a feature or bug fix.
If you feel comfortable with bash scripting, programming, working with containers, or anything upstream (Fedora, Flatpak, etc.) then feel free to contribute to Bazzite if you have want to add a feature or bug fix.
Building your own Bazzite will give you a sandbox to play in with your own personal changes to it. Also, this can be your own version of Bazzite to daily drive. This is useful to receive the same updates upstream, but with your spin on it with differences that we cannot or will not include regarding specific packages, drivers, etc.
Building your own Bazzite will give you a sandbox to play in with your own personal changes to it. Also, this can be your own version of Bazzite to daily drive. This is useful to receive the same updates upstream, but with your spin on it with differences that we cannot or will not include regarding specific packages, drivers, etc.
## Alternative Method
### Alternative Method
Using the unaffiliated [BlueBuild](https://blue-build.org/learn/universal-blue/) project to build your own Bazzite.

46
docs/src/Advanced/GNOME_Disks_Auto-Mount_Guide.md
View File

@ -1,9 +1,14 @@
# GNOME Disks Auto-Mount Guide
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=3781", "fetched_at": "2024-09-03 16:43:10.816923+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# GNOME Disks Auto-Mount Guide
![GNOME|120x120, 50%](../img/GNOME_Disks_icon.png)
**This comes pre-installed on GNOME images.**
@ -17,59 +22,66 @@
3. Click the cog icon on the partition
4. Select "Edit Mount Options"
5. Turn off "User Session Default"
6. Check: "**Mount at system startup**" and "**Show in user interface**"
7. In the space where this is no label: `nosuid,nodev,nofail,x-gvfs-show,` (refer to the correct filesystem below for more options)
6. Check: "**Mount at system startup**" and "**Show in user interface**"
7. In the space where this is no label: `nosuid,nodev,nofail,x-gvfs-show,` (refer to the correct filesystem below for more options)
8. `/var/mnt/games` (or whatever directory you made)
9. `auto`
10. Select "Take Ownership"
11. Open the terminal to test the mounts by running the **command**:
```command
sudo systemctl daemon-reload && sudo mount -a
```
11. Open the terminal to test the mounts by running the **command**:
```command
sudo systemctl daemon-reload && sudo mount -a
```
12. **If no errors appeared then it should be safe to reboot.**
>**Note**: If errors occur, then research the error and undo what you did and try again. Redo the previous two steps in the terminal as GNOME Disks might not give a good error to search for if the test mount fails.
> **Note**: If errors occur, then research the error and undo what you did and try again. Redo the previous two steps in the terminal as GNOME Disks might not give a good error to search for if the test mount fails.
Display Name should be added too. Name it whatever you want it to be identified as.
Display Name should be added too. Name it whatever you want it to be identified as.
## Filesystem Arguments
>**Warning**: If a drive is formatted, then do not remove it from `/etc/fstab`, so the "nofail" option is a must to avoid issues with booting.
> **Warning**: If a drive is formatted, then do not remove it from `/etc/fstab`, so the "nofail" option is a must to avoid issues with booting.
![GNOME_Edit_Mount_Options|690x465, 75%](../img/GNOME_Edit_Mount_Options.png)
![GNOME_Mount_Options|549x500, 75%](../img/GNOME_Mount_Options.png)
### **BTRFS**:
### **BTRFS**:
```command
defaults,compress-force=zstd:3,noatime,lazytime,commit=120,space_cache=v2,nofail
```
### **Ext4**:
### **Ext4**:
```command
defaults,noatime,errors=remount-ro,nofail,rw,users,exec
```
### **NTFS**:
### **NTFS**:
```command
defaults,noatime,nofail,rw,users,exec
```
>**Note**: Do not use the NTFS filesystem for game library storage in Bazzite, and it is not supported and you will get lots of issues with it. NTFS is **not** intended as a game drive for Bazzite.
> **Note**: Do not use the NTFS filesystem for game library storage in Bazzite, and it is not supported and you will get lots of issues with it. NTFS is **not** intended as a game drive for Bazzite.
## Permissions for the drive
```command
sudo chown $USER:$USER /mnt/games
```
### Advanced Options (Not required for most setups)
>Change at your own risk!
> Change at your own risk!
### Information about compression:
### Information about compression:
**3** is a good balance, older CPUs should use **1**.
### Information about subvolumes:
### Information about subvolumes:
use `subvol=name` as an option, KDE and GNOME Disks let you only mount 1 subvolume through the GUI, you can mount the root with `subvol=/` if a default subvolume is configured in the filesystem

53
docs/src/Advanced/KDE_Partition_Manager_Auto_Mount_Guide.md
View File

@ -1,9 +1,14 @@
# KDE Partition Manager Auto-Mount Guide
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=3780", "fetched_at": "2024-09-03 16:43:09.824214+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# KDE Partition Manager Auto-Mount Guide
![KDE|48x48](../img/KDE_Partition_Manager_icon.png)
**This is pre-installed on KDE images.**
@ -21,56 +26,64 @@
6. **Untick all the boxes in the graphical application if they are checked**
7. Click "More..." and add extra options depending on what filesystem is on the partition (read the "Filesystem Arguments" section)
8. Click OK on both windows to save the mount points.
9. A message will appear that the actions will edit `/etc/fstab` (Click "OK" to continue)
9. A message will appear that the actions will edit `/etc/fstab` (Click "OK" to continue)
10. Mount the disk manually in KDE Partition Manager and enter your sudo password
11. Open the terminal to test the mounts by running the **command**:
```command
sudo systemctl daemon-reload && sudo mount -a
```
12. **If no errors appeared then it should be safe to reboot.**
>**Note**: If errors occur, then research the error and undo what you did and try again. Redo the previous two steps in the terminal (see CLI method down below and research how to use fstab) as KDE Partition Manager might not give a good error to search for if the test mount fails.
11. Open the terminal to test the mounts by running the **command**:
Display Name should be added too. Name it whatever you want it to be identified as.
```command
sudo systemctl daemon-reload && sudo mount -a
```
12. **If no errors appeared then it should be safe to reboot.**
> **Note**: If errors occur, then research the error and undo what you did and try again. Redo the previous two steps in the terminal (see CLI method down below and research how to use fstab) as KDE Partition Manager might not give a good error to search for if the test mount fails.
Display Name should be added too. Name it whatever you want it to be identified as.
## Required additional options depending on **filesystem**
Use the below generic options depending on your filesystem (these are just good defaults)
You can copy+paste these into the "More.." dialog and they will be valid
>**Note**: "Users can mount and unmount" is an **optional** setting.
> **Note**: "Users can mount and unmount" is an **optional** setting.
## Filesystem arguments
>**Warning**: If a drive is formatted, then do not remove it from `/etc/fstab`, so the "nofail" option is a must to avoid issues with booting.
> **Warning**: If a drive is formatted, then do not remove it from `/etc/fstab`, so the "nofail" option is a must to avoid issues with booting.
![btrfs example|290x317](../img/btrfs_example.png)
>**Example: btrfs requires these additional options.**
> **Example: btrfs requires these additional options.**
### **BTRFS**:
### **BTRFS**:
```command
defaults,compress-force=zstd:3,noatime,lazytime,commit=120,space_cache=v2,nofail
```
### **Ext4**:
### **Ext4**:
```command
defaults,noatime,errors=remount-ro,nofail,rw,users,exec
```
### **NTFS**:
### **NTFS**:
```command
defaults,noatime,nofail,rw,users,exec
```
>**Note**: Do not use the NTFS filesystem for game library storage in Bazzite, and it is not supported and you will get lots of issues with it. NTFS is **not** intended as a game drive for Bazzite.
> **Note**: Do not use the NTFS filesystem for game library storage in Bazzite, and it is not supported and you will get lots of issues with it. NTFS is **not** intended as a game drive for Bazzite.
## Advanced Options (Not required for most setups)
>Change at your own risk!
### Information about compression:
> Change at your own risk!
### Information about compression:
**3** is a good balance, older CPUs should use **1**.
### Information about subvolumes:
### Information about subvolumes:
use `subvol=name` as an option, KDE and GNOME Disks let you only mount 1 subvolume through the GUI, you can mount the root with `subvol=/` if a default subvolume is configured in the filesystem.

49
docs/src/Advanced/Reset_Forgotten_User_Password.md
View File

@ -1,10 +1,15 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=161", "fetched_at": "2024-09-03 16:43:11.636024+00:00"}-->
<!-- ANCHOR_END: METADATA -->
>This method is only if you forgot your current user password! Changing your current password should be done through the desktop environment.
> This method is only if you forgot your current user password! Changing your current password should be done through the desktop environment.
>Follow this guide **at your own discretion** because you can break your system attempting any of this.
> Follow this guide **at your own discretion** because you can break your system attempting any of this.
![Edit the command for the latest boot entry|690x351](../img/Edit_the_command_for_the_latest_boot_entry.png)
@ -19,26 +24,36 @@ Boot with `init=/bin/bash` on the kernel command line (e.g. edit GRUB prompt.)
Continue boot process with <kbd>Ctrl</kbd>+<kbd>X</kbd>
Once you are in the GRUB command line:
1. Temporarily mount SELinux
```
mount -t selinuxfs selinuxfs /sys/fs/selinux
```
```
mount -t selinuxfs selinuxfs /sys/fs/selinux
```
2. Load SELinux policy
```
/sbin/load_policy
```
```
/sbin/load_policy
```
3. Enter your new password (i.e. passwd nick)
```
passwd [INSERT USERNAME HERE]
```
```
passwd [INSERT USERNAME HERE]
```
4. Sync
```command
sync
```
```command
sync
```
5. Reboot
```
/sbin/reboot -ff
```
```
/sbin/reboot -ff
```
![Commands|690x334](../img/Reset_Password_Commands.png)

22
docs/src/Advanced/creating_custom_image.md
View File

@ -1,23 +1,27 @@
---
authors:
- "@castrojo"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=43", "fetched_at": "2024-09-03 16:43:11.309087+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Making your own image
Sometimes you don't want to make a whole new image from scratch, you just want to change some things without too much extra work. Sometimes it's nicer to derive from images that more end-user focused like [Bazzite](https://github.com/ublue-os/bazzite), [Bluefin](https://github.com/ublue-os/bluefin), and [Aurora](https://getaurora.dev/).
Sometimes you don't want to make a whole new image from scratch, you just want to change some things without too much extra work. Sometimes it's nicer to derive from images that more end-user focused like [Bazzite](https://github.com/ublue-os/bazzite), [Bluefin](https://github.com/ublue-os/bluefin), and [Aurora](https://getaurora.dev/).
**Use the official [template image](https://github.com/ublue-os/image-template) to build off of to make your own custom Bazzite.**
# Use Cases
- You want to help development by being able to test your contributions prior to submiting to the community.
- Hardware enablement, experimental features, confirming fixes ahead of merge
- Hardware enablement, experimental features, confirming fixes ahead of merge
- You want to change out applications and other default choices but want to stick close to Bazzite/Bluefin to get improvements automatically
- For example, Bluefin DX has Visual Studio baked into the image. If you want the rest of it but don't use vscode you could replace it or remove it.
- You need to layer something like VPN software that has to be on an image but you don't want to maintain your own standalone image. (Deriving off of others is always easier, that's why we made this project)
- You want a personal-use image with config and software changes, but also want to benefit from work being completed upstream.
- For example, Bluefin DX has Visual Studio baked into the image. If you want the rest of it but don't use vscode you could replace it or remove it.
- You need to layer something like VPN software that has to be on an image but you don't want to maintain your own standalone image. (Deriving off of others is always easier, that's why we made this project)
- You want a personal-use image with config and software changes, but also want to benefit from work being completed upstream.
[`ublue-os/main`](https://github.com/ublue-os/main) are used to generate base images of everything, so are usually not good candidates for this unless you are familiar with git, containers, and GitHub Actions.
<hr>

42
docs/src/Gaming/Common_gaming_issues.md
View File

@ -1,34 +1,40 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2658", "fetched_at": "2024-09-03 16:43:04.885968+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Steam Logs
## Steam Logs
If you encounter issues with a game launching on Steam:
1. Open the game's properties and **enter this launch option**:
`PROTON_LOG=1 %command%`
`PROTON_LOG=1 %command%`
2. Launch the game
A log file should appear in your Home directory named after the game's application ID number.
# Native Linux Port Versus Windows Version
Some Linux ports may have missing functionality or worse performance than on the Windows version running through Proton. However, there are scenarios where using the native port exclusively is your only option, and may even be desirable.
## Native Linux Port Versus Windows Version
# Valve/Source Engine Games Problems
Some Linux ports may have missing functionality or worse performance than on the Windows version running through Proton. However, there are scenarios where using the native port exclusively is your only option, and may even be desirable.
>**Note**: This only applies to specific games running on the [Source engine](https://www.pcgamingwiki.com/wiki/Engine:Source).
## Valve/Source Engine Games Problems
## Audio & Custom Content Bugs
> **Note**: This only applies to specific games running on the [Source engine](https://www.pcgamingwiki.com/wiki/Engine:Source).
>**Attention**: Do **not** attempt to follow this workaround until you run into issues with audio or the specific scenario mentioned below regarding *Left 4 Dead 2*.
### Audio & Custom Content Bugs
Missing voice lines or custom content not loading in Source games? SELinux is blocking MP3 decoding and other middleware because it [executes heap memory](https://github.com/ValveSoftware/steam-for-linux/issues/43).
> **Attention**: Do **not** attempt to follow this workaround until you run into issues with audio or the specific scenario mentioned below regarding _Left 4 Dead 2_.
This has also been confirmed to cause issues joining and hosting custom maps in *Left 4 Dead 2*.
Missing voice lines or custom content not loading in Source games? SELinux is blocking MP3 decoding and other middleware because it [executes heap memory](https://github.com/ValveSoftware/steam-for-linux/issues/43).
>**Note**: Configuring SELinux is intended for advanced users and if used irresponsibly can break other components in your system and weaken the security of your device.
This has also been confirmed to cause issues joining and hosting custom maps in _Left 4 Dead 2_.
> **Note**: Configuring SELinux is intended for advanced users and if used irresponsibly can break other components in your system and weaken the security of your device.
**At your own risk**
@ -37,6 +43,7 @@ Open a host terminal and **enter these 4 commands**:
```command
sudo su
```
```command
cd /tmp
```
@ -48,19 +55,20 @@ ausearch -c 'hl2_linux' --raw | audit2allow -M my-hl2linux
```command
semodule -X 300 -i my-hl2linux.pp
```
Reboot your device
### If you want to undo this change eventually:
#### If you want to undo this change eventually:
>Disable **or** remove the module.
> Disable **or** remove the module.
#### Disable it:
##### Disable it:
```command
semodule -X 300 -d my-hl2linux
```
#### Remove and delete it:
##### Remove and delete it:
```command
semodule -X 300 -r my-hl2linux
@ -68,14 +76,16 @@ semodule -X 300 -r my-hl2linux
The `.pp` file should be in `/root` if you want to remove that.
## Source Games Not Launching
### Source Games Not Launching
If a 32-bit Source 1 engine game is not opening due to [tmalloc libraries issues](https://github.com/ValveSoftware/csgo-osx-linux/issues/3229), then open a host terminal and **enter**:
Add the following as a **launch option** to the affected game in Steam:
```command
LD_PRELOAD=/usr/lib/libtcmalloc_and_profiler.so.4 %command%
```
Delete `libtcmalloc_minimal.so.x` in the game's bin folder if present.
If this fails to fix it, then try forcing Proton Experimental in the game's properties.

60
docs/src/Gaming/Game_Launchers.md
View File

@ -1,51 +1,54 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2656", "fetched_at": "2024-09-03 16:43:09.533219+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# **Steam Setup**
## **Steam Setup**
Steam can run Windows games on Linux. It utilizes a wide range of projects and patches all packed into a piece of software built-in to Steam called [Proton](https://github.com/ValveSoftware/Proton) for Windows compatibility.
Steam can run Windows games on Linux. It utilizes a wide range of projects and patches all packed into a piece of software built-in to Steam called [Proton](https://github.com/ValveSoftware/Proton) for Windows compatibility.
## Enabling Proton For All Steam Games
### Enabling Proton For All Steam Games
>**Note**: Skip this section if you're using a [*Handheld/HTPC*](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) image.
* Currently Steam only allows whitelisted games to run by default on the desktop Steam client.
* You can change this by going into the Steam **Settings** > **Compatibility** > Check **Enable Steam Play for all other titles**
> **Note**: Skip this section if you're using a [_Handheld/HTPC_](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) image.
- Currently Steam only allows whitelisted games to run by default on the desktop Steam client.
- You can change this by going into the Steam **Settings** > **Compatibility** > Check **Enable Steam Play for all other titles**
![Steam Settings|256x267, 75%](../img/Steam_Setup_Settings.png)
![Compatibility|589x499, 75%](../img/Steam_Setup_Compatibility.png)
## Forcing A Specific Proton / Steam Play Tool Version
### Forcing A Specific Proton / Steam Play Tool Version
* Games with a Linux port will be used by default on Desktop images.
* Valve selects the default runner on *Handheld/HTPC* images.
* Some games run better with a specific version of Proton or forcing the Linux runtime.
* Run that specific version by going into the game's **Properties** > **Compatibility** > **Force the use of a specific Steam Play compatibility tool**
- Games with a Linux port will be used by default on Desktop images.
- Valve selects the default runner on _Handheld/HTPC_ images.
- Some games run better with a specific version of Proton or forcing the Linux runtime.
- Run that specific version by going into the game's **Properties** > **Compatibility** > **Force the use of a specific Steam Play compatibility tool**
![Cog Icon > Properties|690x284, 75%](../img/Steam_Setup_Cog.png)
![Compatibility tab|690x492, 75%](../img/Steam_Setup_Compat_Tab.png)
# **Non-Steam Games**
## **Non-Steam Games**
* **It is recommended to use [Lutris](https://lutris.net/games?q=&ordering=-popularity&paginate_by=100) for _most_ non-steam games**.
* However, [Heroic Games Launcher](https://heroicgameslauncher.com) is intended as a suitable replacement for the Epic Games Launcher.
* [Bottles](https://usebottles.com/) is an alternative to Lutris and great for non-gaming Windows software.
* Other games and launchers are also available in the software center (_Discover_ or _GNOME Software_) like itch.io.
- **It is recommended to use [Lutris](https://lutris.net/games?q=&ordering=-popularity&paginate_by=100) for _most_ non-steam games**.
- However, [Heroic Games Launcher](https://heroicgameslauncher.com) is intended as a suitable replacement for the Epic Games Launcher.
- [Bottles](https://usebottles.com/) is an alternative to Lutris and great for non-gaming Windows software.
- Other games and launchers are also available in the software center (_Discover_ or _GNOME Software_) like itch.io.
### Lutris Setup
## Lutris Setup
![Lutris|617x500, 75%](../img/Lutris_Setup.png)
![Example of Lutris installers|623x500, 75%](../img/Lutris_Setup_Installers.png)
Lutris is game management software that doubles as a WINE front-end for Windows games. Several games and launchers can be installed by searching for the title and using one of the installer scripts for it.
### Manually adding a Windows game to Lutris
However if your game is not listed or doesn't work with the provided script, then manually add the executable. Add locally installed game and make sure to configure it properly within the game and runner options.
Lutris is game management software that doubles as a WINE front-end for Windows games. Several games and launchers can be installed by searching for the title and using one of the installer scripts for it.
#### Manually adding a Windows game to Lutris
However if your game is not listed or doesn't work with the provided script, then manually add the executable. Add locally installed game and make sure to configure it properly within the game and runner options.
![Add Locally Installed Game|632x496, 75%](../img/Lutris_Setup_Add_Local_Game.png)
@ -53,23 +56,22 @@ However if your game is not listed or doesn't work with the provided script, the
![Lutris manually adding games example 1|690x213](../img/Lutris_Setup_Add_Local_Game_1.png)
**Example 2**:
![Lutris manually adding games example 2|690x342, 100%](../img/Lutris_Setup_Add_Local_Game_2.png)
### Lutris Shortcuts
#### Lutris Shortcuts
![Lutris_Right_Click_Menu|421x447, 75%](../img/Lutris_Setup_Shortcut.png)
Right clicking a game on Lutris gives the option to add it as a non-Steam game (useful for Steam Gaming Mode), create a desktop shortcut, or an application menu shortcut.
## Gamepass / Microsoft Store Games (Cloud Streaming)
### Gamepass / Microsoft Store Games (Cloud Streaming)
Games installed from the Microsoft Store do **not** run on desktop Linux unless you use a xCloud client like [Greenlight](https://github.com/unknownskl/greenlight). Fortnite can also be played via xCloud without a Gamepass subscription using this method.
Games installed from the Microsoft Store do **not** run on desktop Linux unless you use a xCloud client like [Greenlight](https://github.com/unknownskl/greenlight). Fortnite can also be played via xCloud without a Gamepass subscription using this method.
# Auto-Mounting Game Drives
## Auto-Mounting Game Drives
Read the [Auto-Mounting Secondary Drives Guide](../Advanced/Auto-Mounting_Secondary_Drives.md) for more information. It is also recommended to do your own research on drive mounting on Linux.
Read the [Auto-Mounting Secondary Drives Guide](../Advanced/Auto-Mounting_Secondary_Drives.md) for more information. It is also recommended to do your own research on drive mounting on Linux.
<hr>

37
docs/src/Gaming/Hardware_compatibility_for_gaming.md
View File

@ -1,22 +1,29 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2659", "fetched_at": "2024-09-03 16:43:08.896738+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Compatible Handhelds
## Compatible Handhelds
Read the [Handheld Wiki](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) to see what handhelds Bazzite currently supports.
# Desktop/HTPC Hardware: Vulkan Compatible GPU
## Desktop/HTPC Hardware: Vulkan Compatible GPU
Linux gaming is heavily dependent on having compatible hardware with Vulkan.
If you're using a device with an older or weaker GPU that does not support **Vulkan 1.3 or later**, then you need to use older Proton and Wine builds like **Proton/WINE 6** or earlier.
If you're using a device with an older or weaker GPU that does not support **Vulkan 1.3 or later**, then you need to use older Proton and Wine builds like **Proton/WINE 6** or earlier.
Check which Vulkan version your GPU uses, enter this in the terminal:
```command
vulkaninfo | grep 'Instance Version'
```
- If it outputs less than `1.3` in the `Vulkan Instance Version:` or does not work at all, then you will run into issues including unplayable games and worse performance.
- If it outputs less than `1.3` in the `Vulkan Instance Version:` or does not work at all, then you will run into issues including unplayable games and worse performance.
- Really old devices may need to resort to OpenGL translation which performs worse, has graphical issues, etc.
Using insufficient hardware requires utilizing older Proton versions and use this **launch option for most games**:
@ -25,31 +32,31 @@ Using insufficient hardware requires utilizing older Proton versions and use thi
PROTON_USE_WINED3D=1 %command%
```
# Unsupported Filesystems for Secondary Drives
## Unsupported Filesystems for Secondary Drives
>**Warning**: You will lose all of your data reformatting secondary internal/external drives.
> **Warning**: You will lose all of your data reformatting secondary internal/external drives.
See also: [**Auto-Mounting Secondary Drives**](../Advanced/Auto-Mounting_Secondary_Drives.md)
## NTFS
### NTFS
If you are coming from Windows and plan to game on a secondary drive with games already installed on it, then we regret to inform you that the NTFS filesystem is **unsupported** for gaming.
If you are coming from Windows and plan to game on a secondary drive with games already installed on it, then we regret to inform you that the NTFS filesystem is **unsupported** for gaming.
Any secondary drives that you plan to play video games on should be **backed up and reformatted to either Ext4 or BTRFS**. You will lose all of the data on this device.
Any secondary drives that you plan to play video games on should be **backed up and reformatted to either Ext4 or BTRFS**. You will lose all of the data on this device.
You can use KDE Partition Manager (KDE images) or GNOME Disks (GNOME images) to format the drives appropriately **at your own risk**.
You can use KDE Partition Manager (KDE images) or GNOME Disks (GNOME images) to format the drives appropriately **at your own risk**.
There is a [guide](https://github.com/ValveSoftware/Proton/wiki/Using-a-NTFS-disk-with-Linux-and-Windows) for using Proton with NTFS drive, but issues may occur with this setup.
## exFAT and FAT32
### exFAT and FAT32
exFAT and FAT32 are **unsupported** entirely. Both filesystems **do not support symbolic links** which is what Proton prefixes use.
exFAT and FAT32 are **unsupported** entirely. Both filesystems **do not support symbolic links** which is what Proton prefixes use.
>However, scenarios where a microSD card is formatted to exFAT *may work* in some cases, but it is entirely unsupported by Universal Blue if something goes horribly wrong using it.
> However, scenarios where a microSD card is formatted to exFAT _may work_ in some cases, but it is entirely unsupported by Universal Blue if something goes horribly wrong using it.
# Sharing Games w/ Windows Installation
## Sharing Games w/ Windows Installation
Install the unofficial [WinBtrfs](https://github.com/maharmstone/btrfs) driver on your Windows installation at your own risk. Please note that Gamepass games and games installed and launched through the Epic Games Launcher do **not** work with BTRFS under Windows.
Install the unofficial [WinBtrfs](https://github.com/maharmstone/btrfs) driver on your Windows installation at your own risk. Please note that Gamepass games and games installed and launched through the Epic Games Launcher do **not** work with BTRFS under Windows.
<hr>

71
docs/src/Gaming/Managing_and_modding_games.md
View File

@ -1,100 +1,105 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2657", "fetched_at": "2024-09-03 16:43:07.954041+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Compatibility Layers
## Compatibility Layers
Windows games need to run through a **compatibility layer** (like Proton) on Bazzite. KDE Plasma and GNOME images pre-install different, but similar compatibility layer managers.
Windows games need to run through a **compatibility layer** (like Proton) on Bazzite. KDE Plasma and GNOME images pre-install different, but similar compatibility layer managers.
>**KDE Plasma Images**: [**ProtonUp-Qt**](https://davidotek.github.io/protonup-qt/)
> **KDE Plasma Images**: [**ProtonUp-Qt**](https://davidotek.github.io/protonup-qt/)
>**GNOME Images**: [**ProtonPlus**](https://github.com/Vysp3r/protonplus)
> **GNOME Images**: [**ProtonPlus**](https://github.com/Vysp3r/protonplus)
## Using ProtonUp-Qt/ProtonPlus
### Using ProtonUp-Qt/ProtonPlus
![ProtonUp-Qt Interface|690x388](../img/ProtonUp-Qt_Interface.png)
> **KDE Plasma Images**: [**ProtonUp-Qt**](https://davidotek.github.io/protonup-qt/)
>**KDE Plasma Images**: [**ProtonUp-Qt**](https://davidotek.github.io/protonup-qt/)
> **GNOME Images**: [**ProtonPlus**](https://github.com/Vysp3r/protonplus)
>**GNOME Images**: [**ProtonPlus**](https://github.com/Vysp3r/protonplus)
Install and update to the latest [GE-Proton](https://github.com/GloriousEggroll/proton-ge-custom), [Luxtorpeda](https://github.com/luxtorpeda-dev/luxtorpeda), and other useful [SteamPlay tools](https://steamcommunity.com/games/221410/announcements/detail/1696055855739350561).
Install and update to the latest [GE-Proton](https://github.com/GloriousEggroll/proton-ge-custom), [Luxtorpeda](https://github.com/luxtorpeda-dev/luxtorpeda), and other useful [SteamPlay tools](https://steamcommunity.com/games/221410/announcements/detail/1696055855739350561).
### Steamplay Tools
#### Steamplay Tools
> View the tested games with [**GE-Proton**](https://github.com/GloriousEggroll/proton-ge-custom/blob/master/README.md#tested-games).
>View the compatible games with [**Luxtorpeda**](https://luxtorpeda-dev.github.io/packages).
> View the compatible games with [**Luxtorpeda**](https://luxtorpeda-dev.github.io/packages).
## Protontricks / Winetricks
### Protontricks / Winetricks
![Protontricks|660x500](../img/Protontricks.png)
Some games require [Protontricks](https://github.com/Matoking/protontricks) (pre-installed) or [Winetricks](https://github.com/Winetricks/winetricks) (for non-Steam games, included with Lutris) to function properly.
# Hidden Files in File Manager
## Hidden Files in File Manager
Desktop Linux contains hidden files and directories that may include important files related to gaming.
**Show hidden files** by clicking the **hamburger menu** (*3 horizontal lines in the file manager*) and selecting "Show Hidden Files" to see every directory and file that is hidden by default
**Show hidden files** by clicking the **hamburger menu** (_3 horizontal lines in the file manager_) and selecting "Show Hidden Files" to see every directory and file that is hidden by default
These directories and files all start with a `.` before it
# What is a Proton/WINE Prefix?
## What is a Proton/WINE Prefix?
It's the glue that holds everything together when you run a game through Proton and also is responsible for containing any of the files the game would drop outside of the installation folder.
>*This installation folder for Steam games is usually in*:
`.../steamapps/common/<game>`
> _This installation folder for Steam games is usually in_:
> `.../steamapps/common/<game>`
### Equivalent Windows Folders
## Equivalent Windows Folders
Many PC games drop files in Windows folders like "My Documents" or "AppData" and both can be found in your prefix directory. This prefix directory may be useful for modding your games, backing up your saves, or configuration files.
Many PC games drop files in Windows folders like "My Documents" or "AppData" and both can be found in your prefix directory. This prefix directory may be useful for modding your games, backing up your saves, or configuration files.
![AppID|690x482, 75%](../img/Steam_AppID.png)
For games on Steam, they are located in your `~/.steam/root/steamapps/compatdata/` folder, and then the **AppID number of the game**:
- This ID by going into the game's properties on Steam in the games `Properties > Updates > App ID`
- Continue to `.../pfx/drive_c/` and wherever the game drops the file on Windows.
## Broken Proton Prefix?
- This ID by going into the game's properties on Steam in the games `Properties > Updates > App ID`
- Continue to `.../pfx/drive_c/` and wherever the game drops the file on Windows.
### Broken Proton Prefix?
![Delete Proton Prefix|382x341, 75%](../img/Steam_Delete_Prefix.png)
> **Note**: Save files are located in the prefix, so backup the save file in there before deleting especially if the game does not support cloud saving.
1. Steam allows users to delete and reset their prefix only in Big Picture Mode (and Gaming Mode) by going into the game's "Developer" settings (accessed with the 'cog' / game settings icon)
1. Steam allows users to delete and reset their prefix only in Big Picture Mode (and Gaming Mode) by going into the game's "Developer" settings (accessed with the 'cog' / game settings icon)
2. Select **Delete Proton files**
## Non-Steam Games Prefix Management
### Non-Steam Games Prefix Management
Non-Steam games can have the prefix folder anywhere you specify:
- By default Lutris uses `~/.wine` as the main folder.
- However, sometimes it's also in `~/Games`.
- WineZGUI creates a prefix in `~/.var/app/io.github.fastrizwaan.WineZGUI/data/winezgui/Prefixes`.
# Modding Quick-Start
## Modding Quick-Start
Steam Workshop is the easiest way to obtain mods, but is not supported for every title and requires you to own the game on Steam. Some mod managers have Linux ports like [r2modman.](https://github.com/ebkr/r2modmanPlus)
Steam Workshop is the easiest way to obtain mods, but is not supported for every title and requires you to own the game on Steam. Some mod managers have Linux ports like [r2modman.](https://github.com/ebkr/r2modmanPlus)
[Steam Tinker Launch](https://github.com/sonic2kk/steamtinkerlaunch) may have useful settings for modding certain titles. It can be installed via ProtonUp-Qt (for KDE images) or ProtonPlus (for GNOME images).
[Steam Tinker Launch](https://github.com/sonic2kk/steamtinkerlaunch) may have useful settings for modding certain titles. It can be installed via ProtonUp-Qt (for KDE images) or ProtonPlus (for GNOME images).
Replace files and directories is still supported in both the game directory and prefix, but there may be some extra steps involved.
Replace files and directories is still supported in both the game directory and prefix, but there may be some extra steps involved.
Some mods require a "WINE DLL OVERRIDE" environment variable in the Steam launch options.
>**Example for DirectInput8 DLL Override**:
`WINEDLLOVERRIDES="dinput8=n,b" %command%`
> **Example for DirectInput8 DLL Override**:
> `WINEDLLOVERRIDES="dinput8=n,b" %command%`
# Enhancements Pre-Installed on Bazzite
## Enhancements Pre-Installed on Bazzite
- [LatencyFleX](https://github.com/ishitatsuyuki/LatencyFleX) - Vendor agnostic alternative to Nvidia Reflex
- [vkBasalt](https://github.com/DadSchoorse/vkBasalt) - Vulkan post-processing layer with ReShade FX support
- [Mangohud](https://github.com/flightlessmango/Mangohud) - Hardware and frame-rate monitoring overlay
## Configuration Templates for DXVK, MangoHud, & vkBasalt
### Configuration Templates for DXVK, MangoHud, & vkBasalt
![Template|690x334, 50%](../img/DXVK_Mango_VkBasalt_templ.png)

64
docs/src/Gaming/index.md
View File

@ -1,44 +1,52 @@
---
title: Gaming
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=31", "fetched_at": "2024-09-03 16:43:06.311188+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Linux Gaming Introduction
Linux gaming being a viable competitor to Windows is a relatively new paradigm. Most Windows exclusive games can run on Bazzite using modern hardware. There are still some rough edges, but gaming on Linux does offer advantages on the appropriate hardware such as better frame-times than on Windows.
Linux gaming being a viable competitor to Windows is a relatively new paradigm. Most Windows exclusive games can run on Bazzite using modern hardware. There are still some rough edges, but gaming on Linux does offer advantages on the appropriate hardware such as better frame-times than on Windows.
# [Game Launchers](Game_Launchers.md)
- Setting Up Steam
- Non-Steam Games
- Available Options
- Configuring Lutris
- Gamepass Using Xbox Cloud Gaming
## [Game Launchers](Game_Launchers.md)
# [Managing & Modding Games](Managing_and_modding_games.md)
- Compatibility Layers
- Proton Prefix Information
- Hidden Files in File Manager
- Modding Quick-Start
- Pre-Installed Enhancements
# [Common Gaming Issues](Common_gaming_issues.md)
- Proton Logs
- Native Linux Builds vs. Proton
- Issues with Valve/Source Games
# [Hardware Compatibility for Gaming](Hardware_compatibility_for_gaming.md)
- Compatible Handhelds
- Vulkan Capable GPU for Desktop/HTPC Hardware
- Information Regarding Unsupported Filesystems
- Setting Up Steam
- Non-Steam Games
- Available Options
- Configuring Lutris
- Gamepass Using Xbox Cloud Gaming
# Useful External Resources
## [Managing & Modding Games](Managing_and_modding_games.md)
* [**ProtonDB**](https://www.protondb.com/explore) - User reports for game compatibility on Linux
* [**Are We Anti-Cheat Yet?**](https://areweanticheatyet.com/) - List of popular games utilizing anti-cheat software and if the game supports Linux
* [**Linux Gaming Wiki**](https://linux-gaming.kwindu.eu/index.php?title=Main_Page) - Introduction to Linux gaming that includes helpful links
* [**PC Gaming Wiki**](https://www.pcgamingwiki.com/wiki/Home) - General information, workarounds, and enhancements for PC games
* [**General Emulation Wiki**](https://emulation.gametechwiki.com/index.php/Main_Page) - Emulation resources
- Compatibility Layers
- Proton Prefix Information
- Hidden Files in File Manager
- Modding Quick-Start
- Pre-Installed Enhancements
## [Common Gaming Issues](Common_gaming_issues.md)
- Proton Logs
- Native Linux Builds vs. Proton
- Issues with Valve/Source Games
## [Hardware Compatibility for Gaming](Hardware_compatibility_for_gaming.md)
- Compatible Handhelds
- Vulkan Capable GPU for Desktop/HTPC Hardware
- Information Regarding Unsupported Filesystems
## Useful External Resources
- [**ProtonDB**](https://www.protondb.com/explore) - User reports for game compatibility on Linux
- [**Are We Anti-Cheat Yet?**](https://areweanticheatyet.com/) - List of popular games utilizing anti-cheat software and if the game supports Linux
- [**Linux Gaming Wiki**](https://linux-gaming.kwindu.eu/index.php?title=Main_Page) - Introduction to Linux gaming that includes helpful links
- [**PC Gaming Wiki**](https://www.pcgamingwiki.com/wiki/Home) - General information, workarounds, and enhancements for PC games
- [**General Emulation Wiki**](https://emulation.gametechwiki.com/index.php/Main_Page) - Emulation resources
<hr>
@ -46,4 +54,4 @@ Linux gaming being a viable competitor to Windows is a relatively new paradigm.
**See also**: [Steam Deck Gaming Mode Overview](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
<-- [**View all Bazzite documentation**](../index.md)
<-- [**View all Bazzite documentation**](../index.md)

46
docs/src/General/Contributing_to_Bazzite.md
View File

@ -1,46 +0,0 @@
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=38", "fetched_at": "2024-09-03 16:43:18.600333+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# **Preliminary Reading**:
- [**Universal Blue Project Governance**](https://universal-blue.discourse.group/docs?topic=51)
- [**Contributing Guide**](https://universal-blue.discourse.group/docs?topic=81)
<hr>
# Overview
Bazzite is an image from [Universal Blue](https://universal-blue.org/) and you should follow Universal Blue's [contribution guidelines](https://universal-blue.org/CONTRIBUTING) before proceeding. Also read our [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) if contributing to documentation.
Check out the Bazzite's [issue tracker](https://github.com/ublue-os/bazzite/issues) to see what issues users are currently experiencing. Also check out the current [roadmap](https://github.com/orgs/ublue-os/projects/1/views/1) for Universal Blue. There is also a [forum](https://universal-blue.discourse.group/c/contributing/7) for general Universal Blue contributions.
# Contributing to Bazzite
- Adding features or fixing bugs by submitting a [pull request](https://github.com/ublue-os/bazzite/pulls).
- Reporting issues you experience on our [issue tracker](https://github.com/ublue-os/bazzite/issues).
- Adding and contributing to [documentation](https://docs.bazzite.gg).
- Language translations are encouraged for documentation and the [README](https://github.com/ublue-os/bazzite/blob/main/README.md).
- Testing Bazzite on unique hardware configurations.
- Troubleshooting issues with handheld hardware is appreciated.
- Reporting issues with [HHD](https://github.com/hhd-dev/hhd) directly is also helpful on handhelds.
# Building Your Own Bazzite for Testing
>**[Bazzite Template](https://github.com/ublue-os/image-template)**
Read about forking your own Bazzite image [here](https://ublue-os.github.io/bazzite/Advanced/creating_custom_image/).
If you feel comfortable with bash scripting, programming, working with containers, or anything upstream (Fedora, Flatpak, etc.) then feel free to contribute to Bazzite if you have want to add a feature or bug fix.
Building your own Bazzite will give you a sandbox to play in with your own personal changes to it. Also, this can be your own version of Bazzite to daily drive. This is useful to receive the same updates upstream, but with your spin on it with differences that we cannot or will not include regarding specific packages, drivers, etc.
## Alternative Method
Using the unaffiliated [BlueBuild](https://blue-build.org/learn/universal-blue/) project to build your own Bazzite.
<hr>
<-- [**View all Bazzite documentation**](../index.md)

55
docs/src/General/Desktop_Environment_Tweaks.md
View File

@ -1,18 +1,23 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=574", "fetched_at": "2024-09-03 16:43:19.212243+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Customizing KDE Plasma
## Customizing KDE Plasma
>Resource on KDE themes can be found [here](https://itsfoss.com/properly-theme-kde-plasma/) for more information.
> Resource on KDE themes can be found [here](https://itsfoss.com/properly-theme-kde-plasma/) for more information.
KDE Plasma is the default Bazzite desktop environment and is highly customizable. One of the various customization that can be done is installing custom styles, cursors, and icons to your system with custom themes made by the community.
KDE Plasma is the default Bazzite desktop environment and is highly customizable. One of the various customization that can be done is installing custom styles, cursors, and icons to your system with custom themes made by the community.
Do **not** install themes with the built-in KDE system settings installer since it may not install properly because the filesystem is slightly different than most Linux operating systems. Install themes manually into your Home directory and follow instructions from the author if necessary.
Do **not** install themes with the built-in KDE system settings installer since it may not install properly because the filesystem is slightly different than most Linux operating systems. Install themes manually into your Home directory and follow instructions from the author if necessary.
![Directory|401x207, 75%](../img/Directory.png)
## Universal instructions for most custom themes
### Universal instructions for most custom themes
Step-by-step instructions to install custom themes on KDE Plasma.
@ -20,32 +25,35 @@ Step-by-step instructions to install custom themes on KDE Plasma.
2. Extracting the contents to `~/.local/share/plasma/` (you may need to make this directory)
3. Open the system settings and select your theme, style, cursor etc. as it now should appear
### Theme Extraction Locations
#### Theme Extraction Locations
The location where specific KDE Plasma components will be extracted on the desktop.
#### Global Themes
Global themes are placed in `~/.local/share/plasma/look-and-feel/` (*you may need to make this directory*).
##### Global Themes
#### Plasma Themes
"Plasma themes" are placed in `~/.local/share/plasma/desktoptheme/` (*you may need to make this directory*).
Global themes are placed in `~/.local/share/plasma/look-and-feel/` (_you may need to make this directory_).
#### SDDM (Login Manager) Themes
SDDM themes are placed in `/etc/sddm/themes` (*you may need to make this directory*).
##### Plasma Themes
"Plasma themes" are placed in `~/.local/share/plasma/desktoptheme/` (_you may need to make this directory_).
##### SDDM (Login Manager) Themes
SDDM themes are placed in `/etc/sddm/themes` (_you may need to make this directory_).
SDDM themes can also be layered at your own risk if they are available as RPM packages.
#### Icon / Cursor Themes
##### Icon / Cursor Themes
"Icon/Cursor themes" are placed in `~/.icons`
#### Application Permissions to Use Themes
##### Application Permissions to Use Themes
Some Flatpaks need filesystem permissions for applications that have issues with cursor themes.
**Example**: (`~/.icons/:ro` in "Filesystem" in each problematic application or globally in Flatseal).
#### Themes that require `kvantum`
##### Themes that require `kvantum`
Some themes require [`kvantum`](https://github.com/tsujan/Kvantum/blob/master/Kvantum/README.md) to be installed on the host system.
@ -55,9 +63,9 @@ Install it with this **command**:
rpm-ostree install kvantum
```
## Wallpaper Engine Guide (*Only on KDE Images*)
### Wallpaper Engine Guide (_Only on KDE Images_)
>**Note**: Not all wallpapers are compatible and may even cause issues since most are not intended for use on the Linux desktop.
> **Note**: Not all wallpapers are compatible and may even cause issues since most are not intended for use on the Linux desktop.
![KDE Wallpaper Settings|682x500, 75%](../img/KDE_Wallpaper_Settings.jpeg)
@ -65,23 +73,22 @@ rpm-ostree install kvantum
![Wallpaper settings|549x500, 75%](../img/Wallpaper_settings.png)
Read this [guide](https://github.com/catsout/wallpaper-engine-kde-plugin/blob/main/README.md#usage) on how to set it up on KDE Plasma.
<hr>
# Manage GNOME Extensions (`-gnome` Images)
## Manage GNOME Extensions (`-gnome` Images)
View the [Bluefin documentation](https://docs.projectbluefin.io/administration#managing-extensions) since most of the information will be relevant to Bazzite as well.
<hr>
# Steam Gaming Mode Tweaks (`-deck` Images)
## Steam Gaming Mode Tweaks (`-deck` Images)
>Decky Loader will sometimes have issues with new Steam and Gamescope updates, and may need to be uninstalled temporarily.
> Decky Loader will sometimes have issues with new Steam and Gamescope updates, and may need to be uninstalled temporarily.
Install [Decky Loader](https://decky.xyz/) then install [CSS Loader](https://docs.deckthemes.com/) to customize how Steam Gaming Mode looks. Be aware that third-party plugins may cause issues. Read Bazzite's [Steam Gaming Mode documentation](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) to resolve common issues if you run into them after using Decky Loader.
Install [Decky Loader](https://decky.xyz/) then install [CSS Loader](https://docs.deckthemes.com/) to customize how Steam Gaming Mode looks. Be aware that third-party plugins may cause issues. Read Bazzite's [Steam Gaming Mode documentation](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) to resolve common issues if you run into them after using Decky Loader.
<hr>
[**<-- View all Bazzite documentation**](../index.md)
[**<-- View all Bazzite documentation**](../index.md)

154
docs/src/General/FAQ.md
View File

@ -1,70 +1,76 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=33", "fetched_at": "2024-09-03 16:43:17.727110+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Why is it called Bazzite?
[Fedora Linux's Atomic Desktops](https://fedoraproject.org/atomic-desktops/) originally followed a naming scheme based on [minerals.](https://fedoraproject.org/kinoite/) Bazzite is a mineral that is known for being strong, lightweight, and is colored [blue](https://universal-blue.org/).
## Why is it called Bazzite?
# What Bazzite image do I use?
[Fedora Linux's Atomic Desktops](https://fedoraproject.org/atomic-desktops/) originally followed a naming scheme based on [minerals.](https://fedoraproject.org/kinoite/) Bazzite is a mineral that is known for being strong, lightweight, and is colored [blue](https://universal-blue.org/).
## What Bazzite image do I use?
Bazzite's [website](https://bazzite.gg/#image-picker) offers a streamlined way of selecting the correct image which will be chosen based on hardware, desktop environment, and to include Steam Gaming Mode if the hardware supports it.
Bazzite offers multiple images, but most images will be following *one of these two formats*:
Bazzite offers multiple images, but most images will be following _one of these two formats_:
- Bazzite that automatically boots into Steam Gaming Mode with manual updates
- Bazzite that does **not** have Steam Gaming Mode and receives automatic updates daily
**Images are split up between **two** types of Bazzite editions**:
## 1. Desktop Edition
### 1. Desktop Edition
>**Steam Gaming Mode is not on these specific images!**
> **Steam Gaming Mode is not on these specific images!**
Intended specifically for desktops and laptops with a focus on gaming which is influenced by SteamOS's Desktop Mode and the maintenance-free nature of ChromeOS.
Steam and other gaming utilities are part of the base operating system. System rollbacks available with a rock-solid stable Fedora Linux base. **Updates are automatically downloaded in the background and applied on a restart**. Most modern hardware should be compatible outside of specific drivers that do not work well on desktop Linux.
Steam and other gaming utilities are part of the base operating system. System rollbacks available with a rock-solid stable Fedora Linux base. **Updates are automatically downloaded in the background and applied on a restart**. Most modern hardware should be compatible outside of specific drivers that do not work well on desktop Linux.
The choice of KDE Plasma and GNOME for the desktop environment with others planned for the future. [Flathub](https://flathub.org/) is enabled out of the box, so all of the applications that you would find on SteamOS are available on Bazzite.
## [2. Handheld/HTPC Edition (`-deck` Images)](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
The choice of KDE Plasma and GNOME for the desktop environment with others planned for the future. [Flathub](https://flathub.org/) is enabled out of the box, so all of the applications that you would find on SteamOS are available on Bazzite.
Mimics SteamOS with "**Steam Gaming Mode**" and its features fully functional. This version of Bazzite boots directly into the Steam Gaming Mode session and are intended for handheld PCs and home theater setups.
### [2. Handheld/HTPC Edition (`-deck` Images)](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
Images also includes a Desktop Mode session with the choice of GNOME or KDE Plasma and is based on our Desktop images. **Updates are manually installed by the user and applied on a restart**.
Mimics SteamOS with "**Steam Gaming Mode**" and its features fully functional. This version of Bazzite boots directly into the Steam Gaming Mode session and are intended for handheld PCs and home theater setups.
>Steam Gaming Mode **requires** a modern AMD graphics card or an Intel Arc graphics card.
Images also includes a Desktop Mode session with the choice of GNOME or KDE Plasma and is based on our Desktop images. **Updates are manually installed by the user and applied on a restart**.
### Desktop Environments & Specific Hardware Variants
> Steam Gaming Mode **requires** a modern AMD graphics card or an Intel Arc graphics card.
#### Desktop Environments & Specific Hardware Variants
Both types of images also come with the choice of using [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for the desktop environment and certain images are made with specific hardware support.
There is more information about this topic on the [Installation Guide](../General/Installation_Guide/index.md) to help guide users on which image to choose before the installation.
There is more information about this topic on the [Installation Guide](../General/Installation_Guide/index.md) to help guide users on which image to choose before the installation.
### Bazzite Image Chart
## Bazzite Image Chart
| Image | Desktop Environment | Steam Gaming Mode | Hardware | Edition |
| --------------------------- | ------------------- | ----------------- | ---------------------------------------- | ------------- |
| `bazzite` | KDE Plasma | No | AMD/Intel GPUs | Desktop |
| `bazzite-nvidia` | KDE Plasma | No | Nvidia GPUs | Desktop |
| `bazzite-gnome` | GNOME | No | AMD/Intel GPUs | Desktop |
| `bazzite-gnome-nvidia` | GNOME | No | Nvidia GPUs | Desktop |
| `bazzite-deck` | KDE Plasma | Yes | AMD/Intel Arc GPUs | Handheld/HTPC |
| `bazzite-deck-gnome` | GNOME | Yes | AMD/Intel Arc GPUs | Handheld/HTPC |
| `bazzite-asus` | KDE Plasma | No | ASUS Laptops (AMD/Intel GPUs | Desktop |
| `bazzite-asus-gnome` | GNOME | No | ASUS Laptops (AMD/Intel GPUs) | Desktop |
| `bazzite-asus-nvidia` | KDE Plasma | No | ASUS Laptops (Nvidia GPUs) | Desktop |
| `bazzite-gnome-asus-nvidia` | GNOME | No | ASUS Laptops (Nvidia GPUs) | Desktop |
| `bazzite-ally` | KDE Plasma | Yes | ASUS Laptops (Steam Gaming Mode Enabled) | Handheld/HTPC |
| `bazzite-ally-gnome` | GNOME | Yes | ASUS Laptops (Steam Gaming Mode Enabled) | Handheld/HTPC |
|Image | Desktop Environment | Steam Gaming Mode | Hardware | Edition|
|--- | --- | --- | --- | ---|
|`bazzite` | KDE Plasma | No | AMD/Intel GPUs | Desktop|
|`bazzite-nvidia` | KDE Plasma | No | Nvidia GPUs | Desktop|
|`bazzite-gnome` | GNOME | No | AMD/Intel GPUs | Desktop|
|`bazzite-gnome-nvidia` | GNOME | No | Nvidia GPUs | Desktop|
|`bazzite-deck` | KDE Plasma | Yes | AMD/Intel Arc GPUs | Handheld/HTPC|
|`bazzite-deck-gnome` | GNOME | Yes | AMD/Intel Arc GPUs | Handheld/HTPC|
|`bazzite-asus` | KDE Plasma | No | ASUS Laptops (AMD/Intel GPUs | Desktop|
|`bazzite-asus-gnome` | GNOME | No | ASUS Laptops (AMD/Intel GPUs) | Desktop|
|`bazzite-asus-nvidia` | KDE Plasma | No | ASUS Laptops (Nvidia GPUs) | Desktop|
|`bazzite-gnome-asus-nvidia` | GNOME | No | ASUS Laptops (Nvidia GPUs) | Desktop|
|`bazzite-ally` | KDE Plasma | Yes | ASUS Laptops (Steam Gaming Mode Enabled) | Handheld/HTPC|
|`bazzite-ally-gnome` | GNOME | Yes | ASUS Laptops (Steam Gaming Mode Enabled) | Handheld/HTPC|
### Who are the target audiences?
## Who are the target audiences?
- Desktop users who want an operating system designed for gaming with inspiration from SteamOS that has fairly low maintenance.
- Steam Deck users who feel limited by SteamOS and also want newer system packages.
- Home Theater PC setups for a console-like experience.
- [Handheld PC](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) users who would prefer a SteamOS-like experience.
# SteamOS is based on Arch Linux, so why use Fedora Linux?
## SteamOS is based on Arch Linux, so why use Fedora Linux?
SteamOS receives package and driver updates less frequently despite the rolling release base.
@ -74,7 +80,8 @@ Fedora Linux and Universal Blue currently supports a specific "atomic" implement
> The **goal** of Bazzite is to have an operating system ready to game after installing it.
### Any advantages to using Fedora?
#### Any advantages to using Fedora?
Since Bazzite is a custom Fedora Atomic Desktop image, it makes use of read-only root files for stability purposes, and is built with [libostree](https://docs.fedoraproject.org/en-US/fedora-silverblue/technical-information/) which has advantages such as:
- Low risk of an unbootable system
@ -85,99 +92,102 @@ Since Bazzite is a custom Fedora Atomic Desktop image, it makes use of read-only
> Check out the [Universal Blue homepage](https://universal-blue.org) for more information on what this project is capable of.
## How is Fedora Atomic Desktop different than Fedora Workstation?
### How is Fedora Atomic Desktop different than Fedora Workstation?
If you're familiar with [Fedora Workstation](https://www.fedoraproject.org/workstation/) and [Fedora's Spins](https://www.fedoraproject.org/spins/), but not the Fedora Atomic Desktops paradigm, the major difference is with stability between system upgrades. There are read-only root files and an emphasis on installing applications as a Flatpak or inside [containers.](https://distrobox.it/) Read more about [obtaining software on Bazzite](../Installing_and_Managing_Software/index.md).
If you're familiar with [Fedora Workstation](https://www.fedoraproject.org/workstation/) and [Fedora's Spins](https://www.fedoraproject.org/spins/), but not the Fedora Atomic Desktops paradigm, the major difference is with stability between system upgrades. There are read-only root files and an emphasis on installing applications as a Flatpak or inside [containers.](https://distrobox.it/) Read more about [obtaining software on Bazzite](../Installing_and_Managing_Software/index.md).
Users can rollback to a previous deployment if a system update breaks their workflow, or rebase entirely back to a stock Fedora Atomic image, [Aurora](https://getaurora.dev/), [Bluefin](https://projectbluefin.io/), or a [custom image by the community](https://universal-blue.discourse.group/docs?topic=340). Do **not** rebase between different desktop environments. Read more about how [updates, rolling back, and rebasing works on Bazzite](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
Users can rollback to a previous deployment if a system update breaks their workflow, or rebase entirely back to a stock Fedora Atomic image, [Aurora](https://getaurora.dev/), [Bluefin](https://projectbluefin.io/), or a [custom image by the community](https://universal-blue.discourse.group/docs?topic=340). Do **not** rebase between different desktop environments. Read more about how [updates, rolling back, and rebasing works on Bazzite](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
Here's a helpful [cheat sheet](https://docs.fedoraproject.org/en-US/fedora-silverblue/_attachments/silverblue-cheatsheet.pdf) for using **advanced** commands, but gives a glimpse of what this paradigm is capable of. There is also a future planned ahead of this technology. Upcoming additions like [bootc](https://containers.github.io/bootc/) will be a major change when it is ready for production.
Here's a helpful [cheat sheet](https://docs.fedoraproject.org/en-US/fedora-silverblue/_attachments/silverblue-cheatsheet.pdf) for using **advanced** commands, but gives a glimpse of what this paradigm is capable of. There is also a future planned ahead of this technology. Upcoming additions like [bootc](https://containers.github.io/bootc/) will be a major change when it is ready for production.
## Is this another fringe Linux distribution?
Bazzite is **not** a Linux distribution in the traditional sense. It's a custom Fedora Atomic Desktop image with a recipe on top of it. Universal Blue images are a proof of concept of using containerized workflows with transactional and in-place operating system updates, and Bazzite exists by being gaming focused with inspiration from SteamOS.
### Is this another fringe Linux distribution?
>Essentially, Bazzite is a Fedora Atomic Desktop installation, but with the aid of Universal Blue's tooling, adds packages, services, drivers, etc. to the base image of it.
Bazzite is **not** a Linux distribution in the traditional sense. It's a custom Fedora Atomic Desktop image with a recipe on top of it. Universal Blue images are a proof of concept of using containerized workflows with transactional and in-place operating system updates, and Bazzite exists by being gaming focused with inspiration from SteamOS.
### How does Bazzite differ?
> Essentially, Bazzite is a Fedora Atomic Desktop installation, but with the aid of Universal Blue's tooling, adds packages, services, drivers, etc. to the base image of it.
Bazzite is using a new "**container-native**" approach that Fedora has been testing, and we are taking full advantage of it.
#### How does Bazzite differ?
Bazzite is using a new "**container-native**" approach that Fedora has been testing, and we are taking full advantage of it.
We are utilizing the [Open Container Initiative (OCI)](https://opencontainers.org/about/overview/) to build the images, and are simply adding packages, services, kernel modules, and our own spin to existing Fedora operating systems.
Unlike traditional Linux distributions, **most of the maintenance and security updates are done upstream** by Fedora and Universal Blue while Bazzite only has to focus on creating a great experience for PC gaming.
Unlike traditional Linux distributions, **most of the maintenance and security updates are done upstream** by Fedora and Universal Blue while Bazzite only has to focus on creating a great experience for PC gaming.
>The ultimate goal of Bazzite is to be Fedora Linux, but provide a great gaming experience out of the box while also being an alternative operating system for the Steam Deck.
> The ultimate goal of Bazzite is to be Fedora Linux, but provide a great gaming experience out of the box while also being an alternative operating system for the Steam Deck.
#### Image Matrix
##### Image Matrix
We provide several different images that all get the same additions and fixes through updates at the same time unless specified otherwise. Many images are hardware specific for compatibility reasons, yet all of the images will usually receive the same features and fixes at the same time.
We provide several different images that all get the same additions and fixes through updates at the same time unless specified otherwise. Many images are hardware specific for compatibility reasons, yet all of the images will usually receive the same features and fixes at the same time.
There can be a hypothetical scenario where everyone involved with Bazzite could stop maintaining the project at once and it will still continue to receive updates directly from upstream.
# Can this be used as a daily driver?
## Can this be used as a daily driver?
**Yes**.
**Yes**.
Updates are obtained and downloaded straight from upstream which means there is little maintenance to be done with the image on our end since these images are modified Fedora images. Users will receive application and system updates from Bazzite, Universal Blue, and Fedora daily.
Updates are obtained and downloaded straight from upstream which means there is little maintenance to be done with the image on our end since these images are modified Fedora images. Users will receive application and system updates from Bazzite, Universal Blue, and Fedora daily.
>A friendly reminder that this project is still in its early stages and moving at a fast pace with updates and changes nearly daily.
> A friendly reminder that this project is still in its early stages and moving at a fast pace with updates and changes nearly daily.
### What are some of the utilities that Bazzite ships?
(_in alphabetical order_)
## What are some of the utilities that Bazzite ships?
(*in alphabetical order*)
- [Boxkit](https://github.com/ublue-os/boxkit): Tool used for custom OCI Distrobox/Toolbox containers, and anything from [DaVinci Resolve](https://github.com/zelikos/davincibox) to [OBS Studio Portable](https://github.com/ublue-os/obs-studio-portable) can be accessed with this. (The software is in their own special container, so dependencies do not affect your host.)
- [Discover Overlay](https://github.com/trigg/Discover): Discord chat overlay integration for Steam Gaming Mode which has a [special configuration](https://trigg.github.io/Discover/bazzite) for Bazzite where it launches automatically
- [Handheld Daemon](https://github.com/hhd-dev/hhd): Tool for configuring and managing handheld devices from gyro, LEDs, paddles, and TDP.
- [Handheld Daemon](https://github.com/hhd-dev/hhd): Tool for configuring and managing handheld devices from gyro, LEDs, paddles, and TDP.
- [Ptyxis](https://devsuite.app/ptyxis/): Terminal with first-class container support.
- [`ujust`](../Installing_and_Managing_Software/ujust.md): Execute custom commands based on recipes.
- [yafti (Bazzite Portal)](https://github.com/ublue-os/yafti/): First-boot utility for installing additional software.
## Can I use this desktop environment or that standalone window manager?
### Can I use this desktop environment or that standalone window manager?
Make your own [custom image based off Bazzite](https://universal-blue.discourse.group/docs?topic=43) with the DE and WM change that you want.
## Is Secure Boot supported?
### Is Secure Boot supported?
>**WARNING (Steam Deck hardware only):** The Steam Deck does not come with secure boot enabled and does not ship with any keys enrolled by default, so do not enable this on Steam Deck hardware unless you absolutely know what you're doing!
> **WARNING (Steam Deck hardware only):** The Steam Deck does not come with secure boot enabled and does not ship with any keys enrolled by default, so do not enable this on Steam Deck hardware unless you absolutely know what you're doing!
**Yes**, but you will have to enroll our key.
**Yes**, but you will have to enroll our key.
More information on enrolling the key in our [Secure Boot guide](https://universal-blue.discourse.group/docs?topic=2742).
# Are AMD, Intel, and Nvidia graphics card drivers pre-installed?
## Are AMD, Intel, and Nvidia graphics card drivers pre-installed?
Yes and they are updated during a system upgrade when available.
## What if I change hardware?
### What if I change hardware?
Most hardware changes should **not** require any manual intervention outside of the expectations from that particular hardware which would be OS-agnostic.
Most hardware changes should **not** require any manual intervention outside of the expectations from that particular hardware which would be OS-agnostic.
However, if you swap from or to a Nvidia GPU, then [rebasing](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rebase_guide.md) will be necessary as a manual intervention to get the appropriate graphics drivers.
# What is the difference between Bluefin, Aurora, and Bazzite?
## What is the difference between Bluefin, Aurora, and Bazzite?
> **TL;DR**: Bazzite is the gaming-centric version of Bluefin (GNOME) and Aurora (KDE Plasma).
[Bluefin](https://projectbluefin.io/) and [Aurora](https://getaurora.dev) are nearly identical outside of branding and desktop environment, but Bazzite strays away from both. All three are similar for desktop PCs and function similarly and share contributors between projects. Bluefin and Aurora target two audiences---individuals who want a maintenance-free Linux desktop experience and developers (using the `-dx` images).
[Bluefin](https://projectbluefin.io/) and [Aurora](https://getaurora.dev) are nearly identical outside of branding and desktop environment, but Bazzite strays away from both. All three are similar for desktop PCs and function similarly and share contributors between projects. Bluefin and Aurora target two audiences---individuals who want a maintenance-free Linux desktop experience and developers (using the `-dx` images).
Bazzite exclusively focuses on having an out of the box Linux gaming experience for desktop, HTPC hardware, and handhelds. Bazzite can be summed up as Bluefin and Aurora but tuned for PC gaming. All 3 are community-centric custom Fedora Atomic Desktop that is configured for their specific target audience, and for Bazzite specifically: PC gamers who want to use the Linux desktop as the alternative to Windows.
Bazzite exclusively focuses on having an out of the box Linux gaming experience for desktop, HTPC hardware, and handhelds. Bazzite can be summed up as Bluefin and Aurora but tuned for PC gaming. All 3 are community-centric custom Fedora Atomic Desktop that is configured for their specific target audience, and for Bazzite specifically: PC gamers who want to use the Linux desktop as the alternative to Windows.
# How do I change the hostname of my device?
## How do I change the hostname of my device?
Edit the `/etc/hostname` file with a new hostname, save it, and reboot.
Edit the `/etc/hostname` file with a new hostname, save it, and reboot.
```
hostnamectl hostname <hostname>
```
# Questions Regarding Java
## Questions Regarding Java
If its for Minecraft, then install the [Prism Launcher](https://flathub.org/apps/org.prismlauncher.PrismLauncher) for mods that require anything Java related. If its for development use [Distrobox](../Installing_and_Managing_Software/Distrobox.md). You will not be able to change Java on your host.
If its for Minecraft, then install the [Prism Launcher](https://flathub.org/apps/org.prismlauncher.PrismLauncher) for mods that require anything Java related. If its for development use [Distrobox](../Installing_and_Managing_Software/Distrobox.md). You will not be able to change Java on your host.
# Why are builds failing?
## Why are builds failing?
![Builds Failing|178x43](../img/Builds_Failing.png)
Do not be alarmed if you see this on our [Github repository](https://github.com/ublue-os/bazzite/). Builds can fail for a number of reasons, but it's only temporary. You can still install and use Bazzite without any issues. Latest features and fixes may be delayed until the builds are successfully built again however.
Do not be alarmed if you see this on our [Github repository](https://github.com/ublue-os/bazzite/). Builds can fail for a number of reasons, but it's only temporary. You can still install and use Bazzite without any issues. Latest features and fixes may be delayed until the builds are successfully built again however.
<hr>
@ -185,4 +195,4 @@ Do not be alarmed if you see this on our [Github repository](https://github.com/
**See also**: [Upstream Fedora Silverblue FAQ](https://docs.fedoraproject.org/en-US/fedora-silverblue/faq/)
<-- [**View all Bazzite documentation**](../index.md)
<-- [**View all Bazzite documentation**](../index.md)

37
docs/src/General/Installation_Guide/Installing_Bazzite_Framework_Laptop_13.md
View File

@ -1,25 +1,34 @@
---
authors:
- Matt_Hartley
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1818", "fetched_at": "2024-09-03 16:43:26.585334+00:00"}-->
<!-- ANCHOR_END: METADATA -->
1. Download the Framework Laptop image of [Bazzite](https://bazzite.gg/). Make sure you select Intel or AMD depending on the mainboard in your device:
## 1. Download the image
Download the Framework Laptop image of [Bazzite](https://bazzite.gg/). Make sure you select Intel or AMD depending on the mainboard in your device:
![1|690x426](../../img/Framework_bazzite.jpeg)
1. **Create a USB stick** using [Fedora Media Writer](https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_on_windows) ([Windows](https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe) or [Mac](https://fedoraproject.org/fmw/FedoraMediaWriter-osx-latest.dmg) or [Linux](https://flathub.org/apps/org.fedoraproject.MediaWriter))
## 2. Create a USB bootable stick
* Insert your USB drive (8GB or larger). Note that it will be reformatted, so make sure you are ok with erasing any data that is on it.
* After installing Fedora Media Writer, run it. Choose Select .iso file, browse to bazzite-gnome-stable.iso (GNOME) or bazzite-stable.iso (KDE) and select it.
* Click the Write button.
* Once the USB drive creation is complete, you can click Finish, close Fedora Media Writer, eject your USB drive.
**Create a USB stick** using [Fedora Media Writer](https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_on_windows) ([Windows](https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe) or [Mac](https://fedoraproject.org/fmw/FedoraMediaWriter-osx-latest.dmg) or [Linux](https://flathub.org/apps/org.fedoraproject.MediaWriter))
3. **Booting to the Bazzite USB**
- Insert your USB drive (8GB or larger). Note that it will be reformatted, so make sure you are ok with erasing any data that is on it.
- After installing Fedora Media Writer, run it. Choose Select .iso file, browse to bazzite-gnome-stable.iso (GNOME) or bazzite-stable.iso (KDE) and select it.
- Click the Write button.
- Once the USB drive creation is complete, you can click Finish, close Fedora Media Writer, eject your USB drive.
* Insert the USB drive into your powered off Framework Laptop 13, and then power on. If you have an existing OS installed on the Storage drive in your laptop, immediately after the power light comes on begin rapidly tapping (continuously ) the F12 key - you must begin tapping well before you see the Framework logo.
* Select Linpus lite (General UDisk) with your arrow keys. Enter key.
* Next select Install Bazzite. Hit the enter key.
* Select the keyboard language you’d like to use. On the next screen, click on the Installation Destination button to choose the disk.
* If there is an OS already installed on the target drive, you’ll need to follow the guided steps to delete the existing partitions.
* Click Finish Installation and then reboot into your new Bazzite install!
## 3. Booting to the Bazzite USB
- Insert the USB drive into your powered off Framework Laptop 13, and then power on. If you have an existing OS installed on the Storage drive in your laptop, immediately after the power light comes on begin rapidly tapping (continuously ) the F12 key - you must begin tapping well before you see the Framework logo.
- Select Linpus lite (General UDisk) with your arrow keys. Enter key.
- Next select Install Bazzite. Hit the enter key.
- Select the keyboard language you’d like to use. On the next screen, click on the Installation Destination button to choose the disk.
- If there is an OS already installed on the target drive, you’ll need to follow the guided steps to delete the existing partitions.
- Click Finish Installation and then reboot into your new Bazzite install!
![boot1|592x444](../../img/Installing_Framework_1.jpeg)
@ -45,4 +54,4 @@
![12|690x432](../../img/Installing_Framework_12.jpeg)
![13|690x388](../../img/Installing_Framework_13.jpeg)
![13|690x388](../../img/Installing_Framework_13.jpeg)

108
docs/src/General/Installation_Guide/Installing_Bazzite_for_Desktop_or_Laptop_Hardware.md
View File

@ -1,41 +1,47 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1146", "fetched_at": "2024-09-03 16:43:27.199924+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![Desktop|690x448](../../img/Desktop.jpeg)
## Pre-Installation
# Pre-Installation
> Pre-requisites and steps before installing Bazzite.
>Pre-requisites and steps before installing Bazzite.
### Minimum System Requirements
## Minimum System Requirements
- **Architecture**: x86_64
- **Firmware**: UEFI (CSM Support should be **disabled** if available)
- **Processor (CPU)** : 2GHz quad core processor or better
- **System Memory (RAM)**: 4GB
- **Graphics**: A graphics card that can utilize Vulkan 1.3+
- **Graphics**: A graphics card that can utilize Vulkan 1.3+
- **Storage**: 50GB free on an internal solid-state drive
- **Network**: Stable internet connection with no bandwidth caps
- **Additional Notes**: Certain [drivers](https://github.com/morrownr/8812au-20210820) are **not** compatible with Bazzite.
### Installer Requirements
* A USB flash drive with 10GB free space
* **Note**: All data on this drive will be wiped when flashed
* Software to flash the image:
* [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
* Make sure to properly eject the drive after flashing the ISO to it
* Physical keyboard
#### Installer Requirements
## Desktop Environments
- A USB flash drive with 10GB free space
- **Note**: All data on this drive will be wiped when flashed
- Software to flash the image:
- [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
- Make sure to properly eject the drive after flashing the ISO to it
- Physical keyboard
### Desktop Environments
Bazzite comes with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for the desktop environment.
[Steam Gaming Mode](https://github.com/KyleGospo/gamescope-session) is an option and if you opt to use it, then this installation guide no longer applies and it is recommended to read the [HTPC installation guide](./Installing_Bazzite_for_HTPC_Setups.md) instead.
[Steam Gaming Mode](https://github.com/KyleGospo/gamescope-session) is an option and if you opt to use it, then this installation guide no longer applies and it is recommended to read the [HTPC installation guide](./Installing_Bazzite_for_HTPC_Setups.md) instead.
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
@ -44,7 +50,7 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- Qt framework
- Popular Linux distributions like SteamOS use KDE Plasma
### [GNOME (`-gnome` images)](https://www.gnome.org/)
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
@ -53,48 +59,47 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- GTK framework
- Popular Linux distributions like Ubuntu use GNOME
### [Steam Gaming Mode (`-deck` images)](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
#### [Steam Gaming Mode (`-deck` images)](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
>**Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
- **Requires a [Steam](https://store.steampowered.com/) account**
- **Requires a [Steam](https://store.steampowered.com/) account**
- Included in the [Handheld/HTPC images](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
- Interface is designed for handheld and couch gaming
- Controller friendly
- Choice of KDE Plasma or GNOME in Desktop Mode
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
## Dual Boot Preliminary Setup + Post-Setup Guide
### Dual Boot Preliminary Setup + Post-Setup Guide
Read the [Dual Boot Guide](./dual_boot_setup_guide.md) **after** reading this guide before proceeding.
## Installation Guide
# Installation Guide
> The part of the guide that requires the most effort.
>The part of the guide that requires the most effort.
## 1. Download and Flash Bazzite
### 1. Download and Flash Bazzite
- Download [Bazzite](https://download.bazzite.gg) after choosing the correct ISO for your hardware with our Image Picker tool.
- Flash Bazzite to your bootable medium.
- Eject drive.
### Current Fedora Atomic Desktop Users
#### Current Fedora Atomic Desktop Users
Current [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/) users can rebase with the terminal command listed on the website under the "**Existing Fedora Atomic Desktop Users**" section and can skip the next step.
## 2. Boot Bazzite
### 2. Boot Bazzite
- Connect your bootable medium to your device and boot into it.
- After connecting the device, boot into the Bazzite installer.
- This depends on your motherboard hardware, but most of the time it could be a function keys like <kbd>F9</kbd> or similar.
- Sometimes you need to consult the manual, look up your device online, or read any hotkeys that appear when you boot your PC.
- Alternatively change the BIOS settings to boot with your bootable device first before your current storage, but this is **not recommended** to keep enabled after installing Bazzite.
- Sometimes you need to consult the manual, look up your device online, or read any hotkeys that appear when you boot your PC.
- Alternatively change the BIOS settings to boot with your bootable device first before your current storage, but this is **not recommended** to keep enabled after installing Bazzite.
- Verify the media correctly and proceed to the installer.
## 3. Installer
### 3. Installer
![Installer](../../img/anaconda_installer.png)
@ -113,57 +118,58 @@ Current [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/) user
- Begin the installation.
- Reboot device after it has finished installing.
### Important information for users with Secure Boot **enabled**:
#### Important information for users with Secure Boot **enabled**:
Read the [Secure Boot Guide](https://universal-blue.discourse.group/docs?topic=2742) for more information.
<hr>
# Post-Installation
## Post-Installation
>The fine tuning before gaming.
> The fine tuning before gaming.
### GRUB Menu
## GRUB Menu
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
## Configuring System Settings for KDE Plasma and GNOME
### Configuring System Settings for KDE Plasma and GNOME
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
***KDE Plasma's System Settings application***
**_KDE Plasma's System Settings application_**
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
***GNOME's Settings application***
**_GNOME's Settings application_**
It is important to configure the system settings on a first boot to personalize your desktop especially if you notice the scaling is incorrect on first-boot.
## First Boot Setup Utility: Bazzite Portal
### First Boot Setup Utility: Bazzite Portal
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
>**Attention**: Make sure you are connected to the internet.
> **Attention**: Make sure you are connected to the internet.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
>**Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
>**Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
## Installing additional software
### Installing additional software
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
# Ready to Game
## Ready to Game
**You have now installed Bazzite!**
@ -173,13 +179,13 @@ Check out the additional [documentation](https://docs.bazzite.gg) surrounding th
<hr>
# **Video Tutorial - Dual Boot Setup w/ Secure Boot Enabled**:
## **Video Tutorial - Dual Boot Setup w/ Secure Boot Enabled**:
https://www.youtube.com/watch?v=dXBN9OM7mSE
<hr>
# Issues Installing Bazzite?
## Issues Installing Bazzite?
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
@ -189,4 +195,4 @@ View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
**See also:** [Upstream Manual Partitioning Guide](https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/#manual-partition) & [Auto-Mounting Secondary Drives](../../Advanced/Auto-Mounting_Secondary_Drives.md)
<-- [**View all Bazzite documentation**](../../index.md)
<-- [**View all Bazzite documentation**](../../index.md)

49
docs/src/General/Installation_Guide/Installing_Bazzite_for_Framework_Laptop_16.md
View File

@ -1,38 +1,47 @@
---
authors:
- Matt_Hartley
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1819", "fetched_at": "2024-09-03 16:43:25.971719+00:00"}-->
<!-- ANCHOR_END: METADATA -->
1. Download the Framework Laptop image of [Bazzite](https://bazzite.gg/). Make sure you select Intel or AMD depending on the mainboard in your device:
## 1. Download the image
Download the Framework Laptop image of [Bazzite](https://bazzite.gg/). Make sure you select Intel or AMD depending on the mainboard in your device:
![1](../../img/Framework_bazzite.jpeg)
2. **Create a USB stick** using [Fedora Media Writer](https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_on_windows) ([Windows](https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe) or [Mac](https://fedoraproject.org/fmw/FedoraMediaWriter-osx-latest.dmg) or [Linux](https://flathub.org/apps/org.fedoraproject.MediaWriter))
## 2. Create a USB bootable stick
* Insert your USB drive (8GB or larger). Note that it will be reformatted, so make sure you are ok with erasing any data that is on it.
* After installing Fedora Media Writer, run it. Choose Select .iso file, browse to bazzite-gnome-stable.iso (GNOME) or bazzite-stable.iso (KDE) and select it.
* Click the Write button.
* Once the USB drive creation is complete, you can click Finish, close Fedora Media Writer, eject your USB drive.
**Create a USB stick** using [Fedora Media Writer](https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_on_windows) ([Windows](https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe) or [Mac](https://fedoraproject.org/fmw/FedoraMediaWriter-osx-latest.dmg) or [Linux](https://flathub.org/apps/org.fedoraproject.MediaWriter))
3. **Linux Audio Compatibility**
- Insert your USB drive (8GB or larger). Note that it will be reformatted, so make sure you are ok with erasing any data that is on it.
- After installing Fedora Media Writer, run it. Choose Select .iso file, browse to bazzite-gnome-stable.iso (GNOME) or bazzite-stable.iso (KDE) and select it.
- Click the Write button.
- Once the USB drive creation is complete, you can click Finish, close Fedora Media Writer, eject your USB drive.
* Before we begin the installation process with the Live USB, let’s make sure you have your Linux Audio Compatibility set to Linux in the BIOS.
* Power on the laptop, repeatedly tapping F2 in order to get into the BIOS. Note: If you’re having trouble with this, try again, holding down the Fn key while rapidly tapping F2.
* In BIOS mode, arrow key over to Setup Utility. Press the enter key. Arrow down to Advanced. Then arrow right, then arrow down to Linux Audio Compatibility. Press enter.
* A new box for Linux Audio Compatibility will appear, arrow to Linux, then press enter. Now press F10 key to reboot.
* Now we don’t have an OS installed yet. So the reboot won’t get us to a running operating system and we fully expect to see an error to this point. Simply press the power button to shutdown.
## 3. Linux Audio Compatibility
- Before we begin the installation process with the Live USB, let’s make sure you have your Linux Audio Compatibility set to Linux in the BIOS.
- Power on the laptop, repeatedly tapping F2 in order to get into the BIOS. Note: If you’re having trouble with this, try again, holding down the Fn key while rapidly tapping F2.
- In BIOS mode, arrow key over to Setup Utility. Press the enter key. Arrow down to Advanced. Then arrow right, then arrow down to Linux Audio Compatibility. Press enter.
- A new box for Linux Audio Compatibility will appear, arrow to Linux, then press enter. Now press F10 key to reboot.
- Now we don’t have an OS installed yet. So the reboot won’t get us to a running operating system and we fully expect to see an error to this point. Simply press the power button to shutdown.
![audio1|592x444](../../img/Install_Framework_16_audio_1.jpeg)
![audio2|592x444](../../img/Install_Framework_16_audio_2.jpeg)
4. **Booting to the Bazzite USB**
## 4. Booting to the Bazzite USB
* Insert the USB drive into your powered off Framework Laptop 13, and then power on. If you have an existing OS installed on the Storage drive in your laptop, immediately after the power light comes on begin rapidly tapping (continuously ) the F12 key - you must begin tapping well before you see the Framework logo.
* Select Linpus lite (General UDisk) with your arrow keys. Enter key.
* Next select Install Bazzite. Hit the enter key.
* Select the keyboard language you’d like to use. On the next screen, click on the Installation Destination button to choose the disk.
* If there is an OS already installed on the target drive, you’ll need to follow the guided steps to delete the existing partitions.
* Click Finish Installation and then reboot into your new Bazzite install!
- Insert the USB drive into your powered off Framework Laptop 13, and then power on. If you have an existing OS installed on the Storage drive in your laptop, immediately after the power light comes on begin rapidly tapping (continuously ) the F12 key - you must begin tapping well before you see the Framework logo.
- Select Linpus lite (General UDisk) with your arrow keys. Enter key.
- Next select Install Bazzite. Hit the enter key.
- Select the keyboard language you’d like to use. On the next screen, click on the Installation Destination button to choose the disk.
- If there is an OS already installed on the target drive, you’ll need to follow the guided steps to delete the existing partitions.
- Click Finish Installation and then reboot into your new Bazzite install!
![boot1|592x444](../../img/Installing_Framework_1.jpeg)
@ -58,4 +67,4 @@
![12](../../img/Installing_Framework_12.jpeg)
![13](../../img/Installing_Framework_13.jpeg)
![13](../../img/Installing_Framework_13.jpeg)

114
docs/src/General/Installation_Guide/Installing_Bazzite_for_HTPC_Setups.md
View File

@ -1,38 +1,46 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1145", "fetched_at": "2024-09-03 16:43:24.537747+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![HTPC|609x371](../../img/HTPC.png)
# Pre-Installation
## Pre-Installation
>Pre-requisites and steps before installing Bazzite.
> Pre-requisites and steps before installing Bazzite.
### Minimum System Requirements
## Minimum System Requirements
- **Architecture**: x86_64
- **Firmware**: UEFI (CSM Support should be **disabled** if available)
- **Processor (CPU)** : 2GHz quad core processor or better
- **System Memory (RAM)**: 4GB
- **Graphics**: A graphics card that can utilize Vulkan 1.3+
- **Graphics**: A graphics card that can utilize Vulkan 1.3+
- **Storage**: 50GB free on an internal solid-state drive
- **Network**: Stable internet connection with no bandwidth caps
- **Additional Notes**: Certain [drivers](https://github.com/morrownr/8812au-20210820) are **not** compatible with Bazzite.
### Steam Gaming Mode Requirements
#### Steam Gaming Mode Requirements
- A modern AMD GPU
- Intel Arc GPUs may work with **major caveats**
- Nvidia GPUs are **not** supported
- [Steam](https://store.steampowered.com/) account
### Installer Requirements
* A USB flash drive with 10GB free space
* **Note**: All data on this drive will be wiped when flashed
* Software to flash the image:
* [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
* Make sure to properly eject the drive after flashing the ISO to it
* Physical keyboard
#### Installer Requirements
## Desktop Environments
- A USB flash drive with 10GB free space
- **Note**: All data on this drive will be wiped when flashed
- Software to flash the image:
- [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
- Make sure to properly eject the drive after flashing the ISO to it
- Physical keyboard
### Desktop Environments
All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for their desktop environment.
@ -40,7 +48,7 @@ All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-de
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
@ -49,7 +57,7 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- Qt framework
- Popular Linux distributions like SteamOS use KDE Plasma
### [GNOME (`-gnome` images)](https://www.gnome.org/)
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
@ -58,48 +66,47 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- GTK framework
- Popular Linux distributions like Ubuntu use GNOME
### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
#### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
>**Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
- **Requires a [Steam](https://store.steampowered.com/) account**
- **Requires a [Steam](https://store.steampowered.com/) account**
- Included in the [Handheld/HTPC images][Steam_Gaming_Mode]
- Interface is designed for handheld and couch gaming
- Controller friendly
- Choice of KDE Plasma or GNOME in Desktop Mode
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
## Installation Guide
# Installation Guide
> The part of the guide that requires the most effort.
>The part of the guide that requires the most effort.
## 1. Download and Flash Bazzite
### 1. Download and Flash Bazzite
- Download [Bazzite](https://download.bazzite.gg) after choosing the correct ISO for your hardware with our Image Picker tool.
- Flash Bazzite to your bootable medium.
- Eject drive.
### Current Fedora Atomic Desktop Users
#### Current Fedora Atomic Desktop Users
Current [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/) users can rebase with the terminal command listed on the website under the "Existing Fedora Atomic Desktop Users" section and can skip the next step.
## 2. Boot Bazzite
### 2. Boot Bazzite
- Connect your bootable medium to your device and boot into it.
- After connecting the device, boot into the Bazzite installer.
- This depends on your motherboard hardware, but most of the time it could be a function keys like <kbd>F9</kbd> or similar.
- Sometimes you need to consult the manual, look up your device online, or read any hotkeys that appear when you boot your PC.
- Alternatively change the BIOS settings to boot with your bootable device first before your current storage, but this is **not recommended** to keep enabled after installing Bazzite.
- Sometimes you need to consult the manual, look up your device online, or read any hotkeys that appear when you boot your PC.
- Alternatively change the BIOS settings to boot with your bootable device first before your current storage, but this is **not recommended** to keep enabled after installing Bazzite.
- Verify the media correctly and proceed to the installer.
## Dual Boot Preliminary Setup + Post-Setup Guide
### Dual Boot Preliminary Setup + Post-Setup Guide
Read the [Dual Boot Guide](https://universal-blue.discourse.group/docs?topic=2743) **after** reading this guide before proceeding.
## 3. Installer
### 3. Installer
![Installer](../../img/anaconda_installer.png)
@ -118,71 +125,72 @@ Read the [Dual Boot Guide](https://universal-blue.discourse.group/docs?topic=274
- Begin the installation.
- Reboot device after it has finished installing.
### Important information for users with Secure Boot **enabled**:
#### Important information for users with Secure Boot **enabled**:
Read the [Secure Boot Guide](https://universal-blue.discourse.group/docs?topic=2742) for more information.
<hr>
# Post-Installation
## Post-Installation
>The fine tuning before gaming.
> The fine tuning before gaming.
### GRUB Menu
## GRUB Menu
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
## Configuring System Settings for KDE Plasma and GNOME
### Configuring System Settings for KDE Plasma and GNOME
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
***KDE Plasma's System Settings application***
**_KDE Plasma's System Settings application_**
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
***GNOME's Settings application***
**_GNOME's Settings application_**
It is important to configure the system settings on a first boot to personalize your desktop especially if you notice the scaling is incorrect on first-boot.
## First Boot Setup Utility: Bazzite Portal
### First Boot Setup Utility: Bazzite Portal
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
**Attention**: Make sure you are connected to the internet.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
>**Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
>**Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
## Installing additional software
### Installing additional software
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
## Login to Steam & Reboot Device
### Login to Steam & Reboot Device
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
### Setup Steam Gaming Mode
#### Setup Steam Gaming Mode
![Steam Gaming Mode Setup|690x442, 50%](../../img/pLvHB1NAMlb3ghsR72q7l9Auj8B.jpeg)
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
>[Read further information about Steam Gaming Mode][Steam_Gaming_Mode].
> [Read further information about Steam Gaming Mode][Steam_Gaming_Mode].
<hr>
# Issues Installing Bazzite?
## Issues Installing Bazzite?
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
@ -194,4 +202,4 @@ View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
<-- [**View all Bazzite documentation**](../../index.md)
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md

129
docs/src/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs.md
View File

@ -1,47 +1,53 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1144", "fetched_at": "2024-09-03 16:43:22.899176+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![ASUS ROG Ally|690x301](../../img/ASUS_ROG_Ally.jpeg)
# Important Notes on Handheld Hardware
## Important Notes on Handheld Hardware
>**Note**: Bazzite requires a stable internet connection with no bandwidth cap in place.
> **Note**: Bazzite requires a stable internet connection with no bandwidth cap in place.
>**Attention**: Several handhelds require BitLocker to be unlocked (write down your recovery key too), Windows "Fast Startup" disabled, and **not** putting Windows into Hibernation Mode before installing Bazzite.
> **Attention**: Several handhelds require BitLocker to be unlocked (write down your recovery key too), Windows "Fast Startup" disabled, and **not** putting Windows into Hibernation Mode before installing Bazzite.
>[Bazzite's Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) contains information on setting up your handheld after installing Bazzite and workarounds for known issues.
> [Bazzite's Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) contains information on setting up your handheld after installing Bazzite and workarounds for known issues.
<hr>
# Pre-Installation
## Pre-Installation
>Pre-requisites and steps before installing Bazzite.
> Pre-requisites and steps before installing Bazzite.
### Installer Requirements
* A USB flash drive with 10GB free space
* **Note**: All data on this drive will be wiped when flashed
* Software to flash the image:
* [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
* Make sure to properly eject the drive after flashing the ISO to it
* Optional: Physical keyboard (without one, your username will be `bazzite` and the password will be `bazzite`)
#### Installer Requirements
### Steam Gaming Mode Requirements
* Compatible graphics card
* A **modern AMD GPU**
* An **Intel Arc GPU** (Other Intel GPU series will not boot Steam Gaming Mode)
* Intel Arc handhelds will currently have missing functionality (TDP limit, controls, etc.)
- A USB flash drive with 10GB free space
- **Note**: All data on this drive will be wiped when flashed
- Software to flash the image:
- [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
- Make sure to properly eject the drive after flashing the ISO to it
- Optional: Physical keyboard (without one, your username will be `bazzite` and the password will be `bazzite`)
#### Steam Gaming Mode Requirements
- Compatible graphics card
- A **modern AMD GPU**
- An **Intel Arc GPU** (Other Intel GPU series will not boot Steam Gaming Mode)
- Intel Arc handhelds will currently have missing functionality (TDP limit, controls, etc.)
Handheld users will also benefit from also reading the [Steam Gaming Mode documentation][Steam_Gaming_Mode].
## Desktop Environments
### Desktop Environments
All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for their desktop environment.
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
@ -50,7 +56,7 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- Qt framework
- Popular Linux distributions like SteamOS use KDE Plasma
### [GNOME (`-gnome` images)](https://www.gnome.org/)
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
@ -59,12 +65,11 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- GTK framework
- Popular Linux distributions like Ubuntu use GNOME
### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
#### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
>**Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
- **Requires a [Steam](https://store.steampowered.com/) account**
- Included in the [Handheld/HTPC images][Steam_Gaming_Mode]
@ -73,33 +78,31 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- Choice of KDE Plasma or GNOME in Desktop Mode
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
## Dual Boot Preliminary Setup + Post-Setup Guide
### Dual Boot Preliminary Setup + Post-Setup Guide
Read the [Dual Boot Guide](https://universal-blue.discourse.group/docs?topic=2743) **after** reading this guide first before proceeding.
<hr>
# Installation Guide
## Installation Guide
>The part of the guide that requires the most effort.
> The part of the guide that requires the most effort.
## 1. Download and Flash Bazzite
### 1. Download and Flash Bazzite
- Download [Bazzite](https://download.bazzite.gg) after choosing the correct handheld hardware with our Image Picker tool.
- Flash Bazzite to your bootable medium.
- Eject drive.
## 2. Boot Installation Medium
### 2. Boot Installation Medium
You may need to research your handheld on how to boot from removable storage. It may be similar to the Steam Deck with holding down one of the "volume buttons" and pressing another button, but like for other general hardware, it highly dependent on your hardware.
You may need to research your handheld on how to boot from removable storage. It may be similar to the Steam Deck with holding down one of the "volume buttons" and pressing another button, but like for other general hardware, it highly dependent on your hardware.
## 3. Installer Setup
### 3. Installer Setup
> **NOTE**: If you do not have a usb physical keyboard connected, do **NOT** press “*User Creation*”, since it will remove the default username and password, and you will be unable to type a username or password without a physical keyboard.
> **NOTE**: If you do not have a usb physical keyboard connected, do **NOT** press “_User Creation_”, since it will remove the default username and password, and you will be unable to type a username or password without a physical keyboard.
> **default user**: `bazzite`
> **default password**: `bazzite`
> **default user**: `bazzite` > **default password**: `bazzite`
![Installer|690x348](../../img/uHKqd8F4nxZryfP8ebBz1DIbNVv.png)
@ -115,7 +118,7 @@ You may need to research your handheld on how to boot from removable storage. I
- Delete any partitions that you have remaining on the drive **unless [dual booting on the same drive](https://universal-blue.discourse.group/t/dual-boot-preliminary-setup-and-post-setup-guide/2743#p-6361-b-same-drive-method-3)**.
- If **[dual booting on the same drive](https://universal-blue.discourse.group/t/dual-boot-preliminary-setup-and-post-setup-guide/2743#p-6361-b-same-drive-method-3)**, it is **strongly recommended** to do manual partitioning and create a separate EFI partition.
- The separate EFI partition will help prevent Windows Updates from affecting your Bazzite installation later down the line.
- Only use the automatic storage configuration when installing to separate drives
- Only use the automatic storage configuration when installing to separate drives
- Optionally encrypt the drive with a password if desired.
- **If you lose this password, then it cannot be decrypted**.
- Setup a user account and begin the installation. (If you do not have a physical, skip this step and begin the installation)
@ -123,72 +126,72 @@ You may need to research your handheld on how to boot from removable storage. I
- Begin the installation.
- Reboot device after it has finished installing.
### Important information for users with Secure Boot **enabled**:
#### Important information for users with Secure Boot **enabled**:
Read the [Secure Boot Guide](https://universal-blue.discourse.group/docs?topic=2742).
<hr>
# Post-Installation
## Post-Installation
>The fine tuning before gaming.
> The fine tuning before gaming.
### GRUB Menu
## GRUB Menu
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
## Configuring System Settings for KDE Plasma and GNOME
### Configuring System Settings for KDE Plasma and GNOME
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
***KDE Plasma's System Settings application***
**_KDE Plasma's System Settings application_**
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
***GNOME's Settings application***
**_GNOME's Settings application_**
After you have booted into the Desktop for the first-time configuration, then you can should adjust the settings to your liking. The most important setting that may need to be changed is the scaling setting in "Display(s) [and Monitor]" since it can be incorrect for the screen of your hardware on a fresh installation. Monitor orientation should also be corrected if it is rotated improperly.
After you have booted into the Desktop for the first-time configuration, then you can should adjust the settings to your liking. The most important setting that may need to be changed is the scaling setting in "Display(s) [and Monitor]" since it can be incorrect for the screen of your hardware on a fresh installation. Monitor orientation should also be corrected if it is rotated improperly.
## First Boot Setup Utility: Bazzite Portal
### First Boot Setup Utility: Bazzite Portal
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
>**Attention**: This section requires a stable internet connection. Make sure you are connected to a network.
> **Attention**: This section requires a stable internet connection. Make sure you are connected to a network.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
>**Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
>**Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
## Installing additional software
### Installing additional software
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
## Login to Steam & Reboot Device
### Login to Steam & Reboot Device
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
![Steam Gaming Mode Setup|690x442, 50%](../../img/pLvHB1NAMlb3ghsR72q7l9Auj8B.jpeg)
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
### Post-Setup and Known Issues for Handhelds and Steam Gaming Mode
#### Post-Setup and Known Issues for Handhelds and Steam Gaming Mode
Read the [Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) and [Steam Gaming Mode Overview documentation][Steam_Gaming_Mode] for information regarding Bazzite on handheld PCs.
<hr>
# **Video Tutorial**
## **Video Tutorial**
> **Note**: We strongly recommend **manual partitioning + creating a separate EFI partition** for dual-booting, **not** automatic partitioning.
>
@ -198,7 +201,7 @@ https://www.youtube.com/watch?v=H4226yq0ZwY
<hr>
# Issues Installing Bazzite?
## Issues Installing Bazzite?
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
@ -210,4 +213,4 @@ View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
<-- [**View all Bazzite documentation**](../../index.md)
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md

111
docs/src/General/Installation_Guide/Installing_Bazzite_for_Steam_Deck.md
View File

@ -1,39 +1,43 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1143", "fetched_at": "2024-09-03 16:43:25.151999+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![image|690x332](../../img/image.jpeg)
# Bazzite on the Steam Deck
## Bazzite on the Steam Deck
>**Attention**: XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings, and more information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
> **Attention**: XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings, and more information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
## Status
### Status
Bazzite functions properly on the Steam Deck LCD (256GB+) and Steam Deck OLED models.
**Bazzite and SteamOS** comparison:
Read the [Handheld Wiki entry for the Steam Deck](https://universal-blue.discourse.group/docs?topic=1849) for a quick comparison.
>**Note**: Bazzite requires a stable internet connection with no bandwidth cap in place.
> **Note**: Bazzite requires a stable internet connection with no bandwidth cap in place.
<hr>
# Pre-Installation
## Pre-Installation
>Pre-requisites and steps before installing Bazzite.
> Pre-requisites and steps before installing Bazzite.
### Installer Requirements
* A USB flash drive with 10GB free space
* **Note**: All data on this drive will be wiped when flashed
* Software to flash the image:
* [Ventoy](https://www.ventoy.net/en/index.html)
* Make sure to properly eject the drive after flashing the ISO to it
* Optional: Physical keyboard (without one, your username will be `bazzite` and the password will be `bazzite`)
#### Installer Requirements
- A USB flash drive with 10GB free space
- **Note**: All data on this drive will be wiped when flashed
- Software to flash the image:
- [Ventoy](https://www.ventoy.net/en/index.html)
- Make sure to properly eject the drive after flashing the ISO to it
- Optional: Physical keyboard (without one, your username will be `bazzite` and the password will be `bazzite`)
## Desktop Environments
### Desktop Environments
All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for their desktop environment.
@ -41,7 +45,7 @@ All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-de
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
@ -50,7 +54,7 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- Qt framework
- Popular Linux distributions like SteamOS use KDE Plasma
### [GNOME (`-gnome` images)](https://www.gnome.org/)
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
@ -59,12 +63,11 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- GTK framework
- Popular Linux distributions like Ubuntu use GNOME
### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
#### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
>**Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
- **Requires a [Steam](https://store.steampowered.com/) account**
- Included in the [Handheld/HTPC images][Steam_Gaming_Mode]
@ -72,39 +75,38 @@ More information can be found on our [FAQ](https://faq.bazzite.gg) about the dif
- Controller friendly
- Choice of KDE Plasma or GNOME in Desktop Mode
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
- XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings. More information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
- XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings. More information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
- **Steam Deck OLED only**: It must be installed with Basic Graphics Mode.
<hr>
# Installation Guide
## Installation Guide
>The part of the guide that requires the most effort.
> The part of the guide that requires the most effort.
**IMPORTANT**: XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings. More information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
**IMPORTANT**: XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings. More information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
## 1. Download and Flash Bazzite
### 1. Download and Flash Bazzite
- Download [Bazzite](https://download.bazzite.gg) after choosing the Steam Deck ISO with our Image Picker tool.
- Flash Bazzite to your bootable medium.
- Eject drive.
## 2. Boot Installation Medium
### 2. Boot Installation Medium
Hold the 'Volume Down' (<kbd>-</kbd>) button and click the Power Button, and when you hear the chime, let go of both buttons, and you'll be booted into the Boot Manager.
Hold the 'Volume Down' (<kbd>-</kbd>) button and click the Power Button, and when you hear the chime, let go of both buttons, and you'll be booted into the Boot Manager.
When you get to the boot menu, select your bootable device to boot into the Bazzite installer.
>**Warning**: Steam Deck OLED users must use Basic Graphics Mode in the installer!
> **Warning**: Steam Deck OLED users must use Basic Graphics Mode in the installer!
Access this with the "**Troubleshooting**" section when the ISO is booted.
## 3. Installer
### 3. Installer
> **NOTE**: If you do not have a usb physical keyboard connected, do **NOT** press "*User Creation*", since it will remove the default username and password, and you will be unable to type a username or password without a physical keyboard.
> **NOTE**: If you do not have a usb physical keyboard connected, do **NOT** press "_User Creation_", since it will remove the default username and password, and you will be unable to type a username or password without a physical keyboard.
>**default user**: `bazzite`
>**default password**: `bazzite`
> **default user**: `bazzite` >**default password**: `bazzite`
![Installer|690x348](../../img/uHKqd8F4nxZryfP8ebBz1DIbNVv.png)
@ -125,63 +127,64 @@ Access this with the "**Troubleshooting**" section when the ISO is booted.
- Begin the installation.
- Reboot device after it has finished installing.
# Post-Installation
## Post-Installation
>The fine tuning before gaming.
> The fine tuning before gaming.
### GRUB Menu
## GRUB Menu
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
***KDE Plasma's System Settings application***
**_KDE Plasma's System Settings application_**
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
***GNOME's Settings application***
**_GNOME's Settings application_**
It is important to configure the system settings on a first boot to personalize your desktop especially if you notice the scaling is incorrect on first-boot.
## First Boot Setup Utility: Bazzite Portal
### First Boot Setup Utility: Bazzite Portal
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
>**Attention**: Make sure you are connected to the internet.
> **Attention**: Make sure you are connected to the internet.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
- Click "Next" to begin configuring Bazzite.
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
- Installing items from the portal **may take a long time**.
>**Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
>**Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
## Installing additional software
### Installing additional software
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
## Login to Steam & Reboot Device
### Login to Steam & Reboot Device
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
### Setting Up Steam Gaming Mode
#### Setting Up Steam Gaming Mode
![Gaming Mode Setup|690x442, 50%](../../img/pLvHB1NAMlb3ghsR72q7l9Auj8B.jpeg)
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
>[Read further information about Steam Gaming Mode][Steam_Gaming_Mode]
> [Read further information about Steam Gaming Mode][Steam_Gaming_Mode]
<hr>
# Issues Installing Bazzite?
## Issues Installing Bazzite?
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
@ -193,4 +196,4 @@ View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
<-- [**View all Bazzite documentation**](../../index.md)
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md

56
docs/src/General/Installation_Guide/dual_boot_setup_guide.md
View File

@ -1,17 +1,22 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "htthttps://universal-blue.discourse.group/docs?topic=2743", "fetched_at": "2024-09-03 16:43:23.309649+00:00"}-->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2743", "fetched_at": "2024-09-03 16:43:23.309649+00:00"}-->
<!-- ANCHOR_END: METADATA -->
>**Note**: Make sure to read the [**Installation Guide**](./index.md) for your device first before proceeding.
> **Note**: Make sure to read the [**Installation Guide**](./index.md) for your device first before proceeding.
# Two Methods: Method *A* or Method *B*
## Two Methods: Method _A_ or Method _B_
* **A)** Installing Bazzite on a separate drive (Recommended)
* **B)** Manual partitioning on the same drive
- **A)** Installing Bazzite on a separate drive (Recommended)
- **B)** Manual partitioning on the same drive
## **A**) *Separate* Drive Method
### **A**) _Separate_ Drive Method
>**Note**: This method is ideal for desktops and HTPCs, and would be inconvenient for handhelds unless planned to keep stationary.
> **Note**: This method is ideal for desktops and HTPCs, and would be inconvenient for handhelds unless planned to keep stationary.
Install Bazzite on a separate internal or external drive.
@ -21,33 +26,35 @@ Install Bazzite on a separate internal or external drive.
You can also install Windows to an external drive with Windows-to-Go using [Rufus](https://rufus.ie/en/) to dual boot if you do not have an internal drive available.
## **B**) *Same* Drive Method
### **B**) _Same_ Drive Method
> **Note**: This must be done **before installing Bazzite**.
>Recommended for handheld PCs or mobile setups.
> Recommended for handheld PCs or mobile setups.
If you do not have multiple drives or are using a device that will not be stationary, then you will have to manually partition on the same drive.
### Note about dual booting with **Windows** specifically:
#### Note about dual booting with **Windows** specifically:
Dual booting Bazzite with Windows on the same drive works better with **Windows already installed before Bazzite**.
### Bazzite Partition
#### Bazzite Partition
Create space for Bazzite with the Disk Management application in Windows.
<kbd>Win</kbd> + <kbd>R</kbd> to open Windows Run and enter:
<kbd>Win</kbd> + <kbd>R</kbd> to open Windows Run and enter:
```
diskmgmt.msc
```
Then, right-click your Windows partition and select "Shrink Volume" from the drop-down menu. Afterwards, select how much storage you want to allocate for Bazzite.
Then, right-click your Windows partition and select "Shrink Volume" from the drop-down menu. Afterwards, select how much storage you want to allocate for Bazzite.
It is **strongly recommended for to setup a separate EFI partition**. The separate EFI partition will help prevent Windows Updates from affecting your Bazzite installation later down the line.
# Manual Partitioning to the Same Drive for Dual Boot Setups
## Manual Partitioning to the Same Drive for Dual Boot Setups
If you need a tutorial video for manual partitioning, watch this [tutorial]( https://www.youtube.com/watch?v=EDip92Zq-RE).
If you need a tutorial video for manual partitioning, watch this [tutorial](https://www.youtube.com/watch?v=EDip92Zq-RE).
1. Select Installation Destination
2. Select `Advanced Custom(Blivet-GUI)` under Storage Configuration.
@ -56,9 +63,9 @@ If you need a tutorial video for manual partitioning, watch this [tutorial]( htt
```
Manual Partitioning Scheme:
mount point: /boot/efi
mount point: /boot/efi
format: EFI system partition
size: 300MB
size: 300MB
mount point: /boot
format: ext4
@ -78,24 +85,25 @@ If you need a tutorial video for manual partitioning, watch this [tutorial]( htt
format: btrfs (subvolume)
```
>**Note about dual booting other Fedora Atomic Desktop images on the **same** drive**: If you want to dual boot another **Fedora libostree image** (like [Bluefin](https://projectbluefin.io/)) installed alongside Bazzite, then you would have to make an additional EFI partition and switch between them through the BIOS boot menu.
> **Note about dual booting other Fedora Atomic Desktop images on the **same** drive**: If you want to dual boot another **Fedora libostree image** (like [Bluefin](https://projectbluefin.io/)) installed alongside Bazzite, then you would have to make an additional EFI partition and switch between them through the BIOS boot menu.
<hr>
# Dual Boot Post-Configuration Setup
## Dual Boot Post-Configuration Setup
>**Note:** [Handheld/HTPC](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) images hide GRUB by default, but the <kbd>Esc</kbd> key on a keyboard will unhide the GRUB menu without unhiding it with a `ujust` command.
> **Note:** [Handheld/HTPC](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) images hide GRUB by default, but the <kbd>Esc</kbd> key on a keyboard will unhide the GRUB menu without unhiding it with a `ujust` command.
## Regenerate GRUB to show Windows Entry
### Regenerate GRUB to show Windows Entry
If you do **not** see your Windows boot in the GRUB menu, then open a host terminal and **enter**:
If you do **not** see your Windows boot in the GRUB menu, then open a host terminal and **enter**:
```
ujust regenerate-grub
```
## Bazzite as Primary Boot
If the `OS Boot Manager` has set `Windows Boot Manager` to be the first boot priority, then this may result in booting directly into Windows after the install instead of Bazzite. You may have to fix this in your BIOS settings.
### Bazzite as Primary Boot
If the `OS Boot Manager` has set `Windows Boot Manager` to be the first boot priority, then this may result in booting directly into Windows after the install instead of Bazzite. You may have to fix this in your BIOS settings.
<hr>

24
docs/src/General/Installation_Guide/index.md
View File

@ -1,36 +1,40 @@
---
title: Installation Guide
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=30", "fetched_at": "2024-09-03 16:43:25.704918+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# **Important Installation Notes**:
* Use a download manager if the direct download fails or is downloading too slow.
- Use a download manager if the direct download fails or is downloading too slow.
* A physical wired keyboard is **recommended**.
- A physical wired keyboard is **recommended**.
* Create a User Account with a **username** and a **user password** if you have a keyboard.
- Create a User Account with a **username** and a **user password** if you have a keyboard.
* Make sure to only select the appropriate drives to avoid losing data on others, and it is best practice to safely remove any external drives before proceeding.
- Make sure to only select the appropriate drives to avoid losing data on others, and it is best practice to safely remove any external drives before proceeding.
* Secure Boot is supported on most hardware, but you must [**enroll our key**](./secure_boot.md).
- Secure Boot is supported on most hardware, but you must [**enroll our key**](./secure_boot.md).
# Choose Your Hardware:
- [Installing Bazzite for **Desktop/Laptop Hardware**](./Installing_Bazzite_for_Desktop_or_Laptop_Hardware.md)
- [Installing Bazzite for **Framework Laptop 16**](./Installing_Bazzite_for_Framework_Laptop_16.md)
- [Installing Bazzite for **Framework Laptop 13 (AMD/Intel GPU)**](./Installing_Bazzite_Framework_Laptop_13.md)
- [Installing Bazzite for **Home Theater PC (HTPC) Setups**](./Installing_Bazzite_for_HTPC_Setups.md)*
- [Installing Bazzite for **Home Theater PC (HTPC) Setups**](./Installing_Bazzite_for_HTPC_Setups.md)\*
- [Installing Bazzite on the **Steam Deck**](./Installing_Bazzite_for_Steam_Deck.md)*
- [Installing Bazzite on the **Steam Deck**](./Installing_Bazzite_for_Steam_Deck.md)\*
- [Installing Bazzite on **Handheld PCs**](./Installing_Bazzite_for_Handheld_PCs.md)*
- [Installing Bazzite on **Handheld PCs**](./Installing_Bazzite_for_Handheld_PCs.md)\*
**Indicates that [**Steam Gaming Mode**](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) is intended for this device and ships with the ISO.*
\*_Indicates that [**Steam Gaming Mode**](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) is intended for this device and ships with the ISO._
# Issues Installing Bazzite?
@ -40,4 +44,4 @@ View the [**Troubleshooting Guide**](./troubleshoot_guide.md) for installation w
<hr>
<-- [**View all Bazzite documentation**](../../index.md)
<-- [**View all Bazzite documentation**](../../index.md)

33
docs/src/General/Installation_Guide/secure_boot.md
View File

@ -1,47 +1,56 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2742", "fetched_at": "2024-09-03 16:43:23.922705+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Secure Boot Information
## Secure Boot Information
![Secure Boot|690x378, 50%](../../img/Secure_Boot.jpeg)
>**Note**: Skip this section if Secure Boot is not enabled or unsupported with your hardware.
> **Note**: Skip this section if Secure Boot is not enabled or unsupported with your hardware.
> **Attention**: Updating your BIOS may re-enable Secure Boot and you may have to follow **"Method B"** after updating it to resolve the black screen on boot complaining about loading the kernel first.
> **Warning**: The Steam Deck does **not** come with secure boot enabled and does not ship with any keys enrolled by default, do not enable Secure Boot on your Steam Deck unless you absolutely know what you're doing.
## Error message if key is **not** enrolled properly:
### Error message if key is **not** enrolled properly:
![load the kernel first error|613x63](../../img/load_the_kernel_first_error.jpeg)
Follow **Method B** below to resolve this and move past the error message if you encounter it.
# **Method A**) During Installation Method (See Image Above)
## **Method A**) During Installation Method (See Image Above)
A blue screen will appear giving the option to enroll the signed keys after leaving the Bazzite installer.
`Enroll MOK` if you have secure boot enabled. If prompted to enter a password, then **enter**:
`Enroll MOK` if you have secure boot enabled. If prompted to enter a password, then **enter**:
```command
universalblue
```
Otherwise `Continue boot` if you have Secure Boot disabled or if it is not supported with your hardware.
# **Method B**) After Installation Method
## **Method B**) After Installation Method
>**ATTENTION**: Disable Secure Boot before doing this, and then re-enable it after enrolling the key.
> **ATTENTION**: Disable Secure Boot before doing this, and then re-enable it after enrolling the key.
If you have already installed Bazzite then **enter this command in a host terminal**:
If you have already installed Bazzite then **enter this command in a host terminal**:
```
ujust enroll-secure-boot-key
```
If prompted to enroll the required key, then **enter the password in the host terminal**:
```
If prompted to enroll the required key, then **enter the password in the host terminal**:
```command
universalblue
```
```
You can now turn Secure Boot back on in the BIOS.
**If you're rebasing from a Fedora Atomic Desktop image and use Secure Boot, then follow our [README](https://github.com/ublue-os/bazzite/blob/main/README.md#secure-boot)**.
**If you're rebasing from a Fedora Atomic Desktop image and use Secure Boot, then follow our [README](https://github.com/ublue-os/bazzite/blob/main/README.md#secure-boot)**.

55
docs/src/General/Installation_Guide/troubleshoot_guide.md
View File

@ -1,30 +1,34 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2495", "fetched_at": "2024-09-03 16:43:22.238775+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# ISO Workarounds
## ISO Workarounds
A generic error may appear during installation.
**Workaround Video Tutorial**:
https://www.youtube.com/watch?v=GRdz08hJByo
## Alternative Installation Methods
# Alternative Installation Methods
> **Attention**: Both workaround methods may have scaling issues with the installer depending on the hardware especially if it is a handheld PC.
>**Attention**: Both workaround methods may have scaling issues with the installer depending on the hardware especially if it is a handheld PC.
> **Note**: The workarounds below are also useful for **downloading a smaller ISO size**.
>**Note**: The workarounds below are also useful for **downloading a smaller ISO size**.
#### **Option 1**: Rebasing from a Fedora Atomic Desktop Image (Recommended)
### **Option 1**: Rebasing from a Fedora Atomic Desktop Image (Recommended)
If you experience issues with installing our ISO or the bootable drive you have is too small for Bazzite, then download the [Fedora Kinoite (**KDE Plasma**)](https://fedoraproject.org/atomic-desktops/kinoite/) or [Fedora Silverblue (**GNOME**)](https://fedoraproject.org/atomic-desktops/silverblue/) depending on which desktop environment preferred.
If you experience issues with installing our ISO or the bootable drive you have is too small for Bazzite, then download the [Fedora Kinoite (**KDE Plasma**)](https://fedoraproject.org/atomic-desktops/kinoite/) or [Fedora Silverblue (**GNOME**)](https://fedoraproject.org/atomic-desktops/silverblue/) depending on which desktop environment preferred.
1. The installation setup is similar to Bazzite and includes the same installer with the same instructions, but do **not** set a root account if its an option in the installer.
2. Once installed, you will not be on Bazzite until you enter the command found on our website that appears under ["**Existing Fedora Atomic Desktop Users**" section](https://download.bazzite.gg) when the download is ready.
2. Once installed, you will not be on Bazzite until you enter the command found on our website that appears under ["**Existing Fedora Atomic Desktop Users**" section](https://download.bazzite.gg) when the download is ready.
3. Open the terminal and enter this command, and keep in mind this process has **no progress indicator** and will take a long time.
3. Open the terminal and enter this command, and keep in mind this process has **no progress indicator** and will take a long time.
4. Reboot when the rebase has finished, and Bazzite should be installed after rebooting and your username as well as the user password will carry over from the upstream Fedora Atomic Desktop to Bazzite.
@ -33,40 +37,42 @@ If you experience issues with installing our ISO or the bootable drive you have
```command
ujust _install-system-flatpaks
```
>Choose the "Flathub" remote.
>
>**This command installs:**
>- [Flatpak applications for **KDE Plasma** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/kinoite/usr/share/ublue-os/bazzite/flatpak/install)
>- [Flatpak applications for **GNOME** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/silverblue/usr/share/ublue-os/bazzite/flatpak/install)
6. Once everything is setup properly, then you need to rebase from the **unsigned image** to the **signed image**, so **enter** in a host terminal:
> Choose the "Flathub" remote.
>
> **This command installs:**
>
> - [Flatpak applications for **KDE Plasma** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/kinoite/usr/share/ublue-os/bazzite/flatpak/install)
> - [Flatpak applications for **GNOME** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/silverblue/usr/share/ublue-os/bazzite/flatpak/install)
6. Once everything is setup properly, then you need to rebase from the **unsigned image** to the **signed image**, so **enter** in a host terminal:
```command
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/<IMAGE>
```
Replace `<IMAGE>` with the image you're using which can be found from the "**Existing Fedora Atomic Desktop Users**" section as well.
#### Video Tutorial
##### Video Tutorial
https://www.youtube.com/watch?v=Vs4cneBW5ck
#### **Option 2**: Older & Buggy Net-Installer (Not Recommended)
### **Option 2**: Older & Buggy Net-Installer (Not Recommended)
> **Note**: This is intended as a last resort!
>**Note**: This is intended as a last resort!
This is not something we recommend at all, but an alternative solution is using our [Github release](https://github.com/ublue-os/bazzite/releases/tag/v2.1.0) of the last **online** ISO. This is **extremely buggy** and suffers from other issues that are now fixed in the offline ISO.
This is not something we recommend at all, but an alternative solution is using our [Github release](https://github.com/ublue-os/bazzite/releases/tag/v2.1.0) of the last **online** ISO. This is **extremely buggy** and suffers from other issues that are now fixed in the offline ISO.
There is an older [video](https://www.youtube.com/watch?v=doQW1FyAISQ) showcasing how to install the Bazzite with this old online ISO.
>**IMPORTANT**: The video guide does **not** mention this part of the process since this wasn’t a requirement previously:
> **IMPORTANT**: The video guide does **not** mention this part of the process since this wasn’t a requirement previously:
After installing it and making it to the desktop, then you will have to **rebase** to a signed image:
```command
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/<IMAGE>
```
Replace `<IMAGE>` with the image you're using.
Reboot when the rebasing process has finished, and you will know because it will tell you to reboot your device.
@ -77,8 +83,9 @@ You will also be missing the default applications, so open a host terminal and *
ujust _install-system-flatpaks
```
>Choose the "Flathub" remote.
> Choose the "Flathub" remote.
**This command installs:**
- [Flatpak applications for **KDE Plasma** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/kinoite/usr/share/ublue-os/bazzite/flatpak/install)
- [Flatpak applications for **GNOME** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/silverblue/usr/share/ublue-os/bazzite/flatpak/install)
- [Flatpak applications for **GNOME** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/silverblue/usr/share/ublue-os/bazzite/flatpak/install)

26
docs/src/General/reporting_bugs.md
View File

@ -1,37 +1,45 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=3402", "fetched_at": "2024-09-03 16:43:15.937921+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Submit bug reports in the appropriate place
Report bugs experienced with Bazzite in our [**issue tracker**](https://github.com/ublue-os/bazzite/issues)! We discourage reporting bugs in the Discourse forums since reports can get lost or may not be viewed by Bazzite contributors as often as the issue tracker.
## Submit bug reports in the appropriate place
# Before submitting an issue
Report bugs experienced with Bazzite in our [**issue tracker**](https://github.com/ublue-os/bazzite/issues)! We discourage reporting bugs in the Discourse forums since reports can get lost or may not be viewed by Bazzite contributors as often as the issue tracker.
## Before submitting an issue
**Read [how to file an issue properly](https://universal-blue.discourse.group/docs?topic=1470) before proceeding!**
### **Bazzite Issue Template Walkthrough**
#### **Bazzite Issue Template Walkthrough**
![Bug report|690x174](../img/Bug_report.png)
![Template|690x436](../img/Bug_report_template.png)
## Update Bazzite before reporting
### Update Bazzite before reporting
Sometimes bugs are fixed during upgrades, so try updating and rebooting your device before submitting a report to see if the issue still persists between updates.
**Read how to update Bazzite for your device**:
[Updating guide](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/updating_guide.md)
## Make sure to attach system logs
### Make sure to attach system logs
Open a host terminal and **enter**:
```
ujust device-info
```
Attach the link that it outputs for system logs.
### Experience system crashes?
#### Experience system crashes?
```command
ujust logs-last-boot
```

46
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2414", "fetched_at": "2024-09-03 16:43:21.670173+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -19,7 +24,7 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
- Reboot device
- Configure the HHD Overlay by opening it with the QAM button
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
- There is **no default keybinding for Steam's on-screen keyboard** (Remap it to <kbd>**X**</kbd> or whatever you prefer)
- There is **no default keybinding for Steam's on-screen keyboard** (Remap it to <kbd>**X**</kbd> or whatever you prefer)
- Holding the Armoury Crate button (on the side) allows you to switch to Mouse Mode
- Enable the Steam Power Button Handler setting in Handheld Daemon
@ -29,16 +34,17 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
- Adjust the scaling of the UI in the Display Settings
- Set a charge limit in HHD with Handheld Daemon
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
```
ujust install-hhd-controller-glyph-theme
```
```
## Workarounds / Known Issues
- [Status of CPU Boost on Bazzite](https://github.com/aarron-lee/SimpleDeckyTDP/blob/main/README.md#are-there-cpu-boost-controls)
- Disable CPU boost to avoid excess power usage and other issues.
- Changing A/C power sometimes leads to a stuck TDP.
- Some users report that "Auto UMA" in the bios can cause crashes in some games.
- Some users report that "Auto UMA" in the bios can cause crashes in some games.
- If you encounter this, then try setting the VRAM in bios to **4GB** or **8GB**.
- LED is on max brightness by default and cannot be changed on any other operating system outside of Windows.
- This is tied to the firmware.
@ -57,34 +63,33 @@ ujust install-hhd-controller-glyph-theme
<hr>
# Additional Information
## Additional Information
This applies to most handhelds running Bazzite.
## TDP Controls
### TDP Controls
![TDP|690x431, 75%](../../img/TDP.jpeg)
There are a few options for TDP Controls that work with Bazzite:
* The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
* Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
* Steam Quick Access Menu TDP limit (part of Steam Gaming Mode)
* [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
* Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
- Steam Quick Access Menu TDP limit (part of Steam Gaming Mode)
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
## How do I open the HHD Overlay?
### How do I open the HHD Overlay?
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
![Settings Example|690x431, 75%](../../img/HHD_Settings_Example.jpeg)
Press, hold, or double-tap the Quick Access Menu button.
>**Note**: ASUS ROG Ally does not support **holding** for the QAM button!
> **Note**: ASUS ROG Ally does not support **holding** for the QAM button!
## Controller Information
### Controller Information
For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality.
@ -92,9 +97,9 @@ If your device has paddles, you will want to use the DualSense Edge controller.
Some games and emulators may need Steam Input **disabled** to work correctly with your controls.
### Desktop Controls
#### Desktop Controls
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
@ -104,16 +109,17 @@ Desktop Mode Controller Layout: It may not exist by default if Steam doesn't se
Make sure to **apply** the desktop controls when you select them.
## Force reboot device to prevent drive corruption if Steam crashes
>**Note**: This is only for the ASUS ROG Ally and Lenovo Legion Go.
### Force reboot device to prevent drive corruption if Steam crashes
> **Note**: This is only for the ASUS ROG Ally and Lenovo Legion Go.
Hold down the "**select**" button on your device to force a reboot. This feature can be disabled in the overlay settings.
<hr>
# Contributing
## Contributing
This page and all of the links to each specific handheld are **wikis**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
This page and all of the links to each specific handheld are **wikis**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)

74
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md
View File

@ -1,8 +1,14 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2417", "fetched_at": "2024-09-03 16:43:20.646543+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Ayaneo Geek 1S
![photo_5875160389711413569_y|663x500, 100%](../../img/Ayaneo_Geek_1S.jpeg)
**Status**: Silver
@ -17,12 +23,13 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
- Login to Steam
- Reboot device
- Configure the HHD Overlay by opening it with QAM button
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
- HHD's support of both LEDs and Gyroscope is fine out of the box (with bmi260 from [ublue-os/akmod].
## Workarounds / Known Issues
- Screen rotation is fixed with `rpm-ostree kargs --append-if-missing=video=eDP-1:panel_orientation=right_side_up` or editing the kernel command line with `rpm-ostree kargs --editor`.
- Audio driver does work but needs to adjusted to support the 3.5mm jack.
- Audio driver does work but needs to adjusted to support the 3.5mm jack.
- Either install [this rpm package](https://drive.google.com/drive/folders/1ShnESXQ1aFQjbe0mVW5b6VBrfrgDA2O6?usp=sharing) that was created using [this guide](https://www.reddit.com/r/Fedora/comments/wir3cq/guide_adding_custom_files_to_the_root_filesystem/).
- Alternatively, since ALC269VB is an audio chipset that has been around for years, it just need its pins to be rerouted with `hdajackretask` (part of fedora's alsa-tools) package. (You basically need to reroute the auto-generated "green headset" and "black headset" devices to "Channel 30 & 31").
- External audio works over both HDMI and eGPU.
@ -30,21 +37,22 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
- see suspend workaround [here](https://universal-blue.discourse.group/t/ayaneo-handheld-compatibility/2417#p-5599-suspend-workaround-5)
- VRAM size option is missing from BIOS as it's controlled by AYASPACE application under windows.
## Functional HHD**:
### Functional HHD\*\*:
```
sudo systemctl enable --now hhd@$(whoami)
```
## External Graphics:
### External Graphics:
- eGPU Thunderbolt 3/4 over USB4 is supported. USB4 enclosure needs proper testing but there is no reason to suspect it should not work.
- **AMD**:
- Automatic switch at boot with [all-ways-egpu](https://github.com/ewagner12/all-ways-egpu/tree/main) works fine using method 2 and 3 at boot, unfortunately method 1 is not supported but seems to be related to Steam Gaming Mode.
- The script needs to be installed with [Steam Deck/User Installation](https://github.com/ewagner12/all-ways-egpu/tree/main?tab=readme-ov-file#steam-deckuser-installation).
- In order to boot with eGPU attached you need to add a kernel parameter, seems to be related to [this kernel issue](https://lore.kernel.org/lkml/20240415163056.GP223006@ziepe.ca/). There are many other issues opened and according to [this](https://gitlab.freedesktop.org/drm/amd/-/issues/3182) it could be potentially fixed in kernel 6.9. As a temporary solution booting with eGPU connected works when launching the command `rpm-ostree kargs --append-if-missing=video=pci=nommconf` or editing the kernel command line with `rpm-ostree kargs --editor`.
- eGPU Thunderbolt 3/4 over USB4 is supported. USB4 enclosure needs proper testing but there is no reason to suspect it should not work.
- **AMD**:
- Automatic switch at boot with [all-ways-egpu](https://github.com/ewagner12/all-ways-egpu/tree/main) works fine using method 2 and 3 at boot, unfortunately method 1 is not supported but seems to be related to Steam Gaming Mode.
- The script needs to be installed with [Steam Deck/User Installation](https://github.com/ewagner12/all-ways-egpu/tree/main?tab=readme-ov-file#steam-deckuser-installation).
- In order to boot with eGPU attached you need to add a kernel parameter, seems to be related to [this kernel issue](https://lore.kernel.org/lkml/20240415163056.GP223006@ziepe.ca/). There are many other issues opened and according to [this](https://gitlab.freedesktop.org/drm/amd/-/issues/3182) it could be potentially fixed in kernel 6.9. As a temporary solution booting with eGPU connected works when launching the command `rpm-ostree kargs --append-if-missing=video=pci=nommconf` or editing the kernel command line with `rpm-ostree kargs --editor`.
- **NVIDIA**: currently untested and probably doesn't work.
## Suspend workaround
### Suspend workaround
> Thanks to ChimeraOS for the [original suspend workaround](https://github.com/ChimeraOS/chimeraos/wiki/Community-Guides#enabling-modern-sleep-on-7000-series-amd-hardware), and SteamFork for the [updated writeup](https://wiki.steamfork.org/troubleshooting/#enabling-modern-sleep-on-7000-series-amd-based-devices) of this workaround.
@ -58,17 +66,17 @@ sudo systemctl enable --now hhd@$(whoami)
>
> Bazzite takes no responsibility for any harm caused by following these steps. By following this guide you acknowledge that you are solely responsible for the outcome.
## Modern Standby Enablement Methods
### Modern Standby Enablement Methods
* Enter your bios/firmware settings to see if you already have the options listed in the steps for the [Enabling Modern Standby](https://universal-blue.discourse.group/t/ayaneo-handheld-compatibility/2417#p-5599-enabling-modern-standby-7) section of this guide. If so, skip the rest of this section.
* If the options are not available, follow the next few steps to create boot media.
* Format a USB stick with FAT32.
* Download [Smokeless UMAF](https://github.com/DavidS95/Smokeless_UMAF/raw/main/UMAF_BETA.zip).
* Extract `UMAF_Beta.zip` and copy the contents into the root of the usb stick.
* Boot your device and select the USB stick from the boot menu.
* Navigate to the `Front Page` tab and select `Device Manager`.
- Enter your bios/firmware settings to see if you already have the options listed in the steps for the [Enabling Modern Standby](https://universal-blue.discourse.group/t/ayaneo-handheld-compatibility/2417#p-5599-enabling-modern-standby-7) section of this guide. If so, skip the rest of this section.
- If the options are not available, follow the next few steps to create boot media.
- Format a USB stick with FAT32.
- Download [Smokeless UMAF](https://github.com/DavidS95/Smokeless_UMAF/raw/main/UMAF_BETA.zip).
- Extract `UMAF_Beta.zip` and copy the contents into the root of the usb stick.
- Boot your device and select the USB stick from the boot menu.
- Navigate to the `Front Page` tab and select `Device Manager`.
### Enabling Modern Standby
#### Enabling Modern Standby
1. Select `AMD PBS` then `Power Saving Configurations`.
2. Under `S3/Modern Standby Support` change the entry to `Modern Standby` (or `Modern Standby Enable` on some devices).
@ -77,36 +85,36 @@ sudo systemctl enable --now hhd@$(whoami)
Note: The first restart after this change may take longer than usual.
## External Resource
### External Resource
Check out the [original thread](https://universal-blue.discourse.group/t/ayaneo-geek-1s-2s-linux-bazzite-support-is-already-almost-there-lets-add-them-to-the-officially-supported-devices/1046) for more information and updates on this device.
<hr>
# Additional Information
## Additional Information
This applies to most handhelds running Bazzite.
## TDP Controls
### TDP Controls
![TDP|690x431, 75%](../../img/TDP.jpeg)
There are a few options for TDP Controls that work with Bazzite:
* The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
* Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
* [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
* Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
* [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
- [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
## How do I open the HHD Overlay?
### How do I open the HHD Overlay?
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
![Settings Example|690x432, 75%](../../img/HHD_Settings_Example.jpeg)
Press, hold, or double-tap the Quick Access Menu button.
## Controller Information
### Controller Information
For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality.
@ -114,9 +122,9 @@ If your device has paddles, you will want to use the DualSense Edge controller.
Some games and emulators may need Steam Input **disabled** to work correctly with your controls.
### Desktop Controls
#### Desktop Controls
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
@ -128,9 +136,9 @@ Make sure to **apply** the desktop controls when you select them.
<hr>
# Contributing
## Contributing
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)

66
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md
View File

@ -1,104 +1,112 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2416", "fetched_at": "2024-09-03 16:43:21.928758+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Ayn Loki Max
## Ayn Loki Max
![Loki Max|375x500, 100%](../../img/Loki_Max.jpeg)
**Status**: Platinum
## Installing Bazzite
### Installing Bazzite
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
## Post-Installation Setup
### Post-Installation Setup
- Complete the Bazzite Portal
- Login to Steam
- Reboot device
- Configure the HHD Overlay by opening it with QAM button
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
## Optional Tweaks
### Optional Tweaks
- Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings` or in Handheld Daemon
- Adjust the scaling of the UI in the Display Settings
- Set a charge limit in HHD with Handheld Daemon
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
```
ujust install-hhd-controller-glyph-theme
```
```
## Workarounds / Known Issues
### Workarounds / Known Issues
- Games can sometimes default to 800p resolution.
- * Manually change the resolution per game in the `Steam Settings > Properties > Game Resolution` to either "Native" or other higher resolutions.
- - Manually change the resolution per game in the `Steam Settings > Properties > Game Resolution` to either "Native" or other higher resolutions.
- Back buttons are hard mapped to L3 and R3.
- This is also an issue on Windows.
# Ayn Loki Mini Pro
## Ayn Loki Mini Pro
![loki_mini_pro|666x500, 100%](../../img/loki_mini_pro.jpeg)
**Status**: Silver
## Installing Bazzite
### Installing Bazzite
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
## Post-Installation Setup
### Post-Installation Setup
- Complete the Bazzite Portal
- Login to Steam
- Reboot device
- Configure the HHD Overlay by opening it with QAM button
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
## Optional Tweaks
### Optional Tweaks
- Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings` or in Handheld Daemon
- Adjust the scaling of the UI in the Display Settings
- Set a charge limit in HHD with Handheld Daemon
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
```
ujust install-hhd-controller-glyph-theme
```
```
### Workarounds / Known Issues
## Workarounds / Known Issues
- Games can sometimes default to 800p resolution.
- * Manually change the resolution per game in the `Steam Settings > Properties > Game Resolution` to either `Native` or other higher resolutions.
- - Manually change the resolution per game in the `Steam Settings > Properties > Game Resolution` to either `Native` or other higher resolutions.
- Audio driver does not currently work.
- No internal audio in either Gaming Mode or Desktop Mode.
- External audio is reported to have low sound quality.
- External audio is reported to have low sound quality.
- Rotation is wrong in Desktop Mode for KDE images.
- Mouse input may break in Desktop Mode.
<hr>
# Additional Information
## Additional Information
This applies to most handhelds running Bazzite.
## TDP Controls
### TDP Controls
![TDP|690x431, 75%](../../img/TDP.jpeg)
There are a few options for TDP Controls that work with Bazzite:
* The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
* Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
* [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
* Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
## How do I open the HHD Overlay?
### How do I open the HHD Overlay?
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
![RGB|690x431, 75%](../../img/HHD_RGB.jpeg)
Press, hold, or double-tap the Quick Access Menu button.
## Controller Information
### Controller Information
For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality.
@ -106,9 +114,9 @@ If your device has paddles, you will want to use the DualSense Edge controller (
Some games and emulators may need Steam Input **disabled** to work correctly with your controls.
### Desktop Controls
#### Desktop Controls
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
@ -120,9 +128,9 @@ Make sure to **apply** the desktop controls when you select them.
<hr>
# Contributing
## Contributing
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)

41
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md
View File

@ -1,18 +1,23 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2418", "fetched_at": "2024-09-03 16:43:21.260488+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# GPD Win 4
## GPD Win 4
![gpdwin4|690x328, 100%](../../img/gpdwin4.jpeg)
**Status**: Gold
## Installing Bazzite
### Installing Bazzite
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
## Post-Installation Setup
### Post-Installation Setup
- Complete the Bazzite Portal
- Login to Steam
@ -22,7 +27,7 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
- <kbd>Xbox</kbd> + <kbd>X</kbd> (This can be remapped)
- GPD devices also have a physical switch you can toggle to enable a separate desktop/mouse mode.
## Optional Tweaks
### Optional Tweaks
- Adjust RGB with Steam Gaming Mode in Handheld Daemon
- Adjust the scaling of the UI in the Display Settings
@ -33,7 +38,7 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
ujust install-hhd-controller-glyph-theme
```
## Workarounds / Known Issues
### Workarounds / Known Issues
- Suspend-resume fully works on the 6800u Win 4 after disabling the fingerprint scanner, but there are a few user reports of the 7840u and newer models having only partially working suspend-resume.
- It seems to be very similar/related to the suspend issue on the GPD WM2 7840u and newer devices, more details [here](https://gitlab.freedesktop.org/drm/amd/-/issues/3154)
@ -45,23 +50,23 @@ ujust install-hhd-controller-glyph-theme
- Manually remap back buttons as described in hhd docs [here](https://github.com/hhd-dev/hhd?tab=readme-ov-file#extra-steps-gpd-win-devices)
- Watch this [video](https://www.youtube.com/watch?v=lnNfMY9kzjk) if you need a visual guide.
## External Resource
### External Resource
For more information, check out the [GPD Win Tips and Tricks guide](https://github.com/aarron-lee/gpd-win-tricks) which includes useful scripts for this handheld.
<hr>
# GPD Win Max 2
## GPD Win Max 2
![placeholder_gpdwinmax2|407x312, 100%](../../img/GPD_Win_Max_2.png)
**Status**: Gold
## Installing Bazzite
### Installing Bazzite
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
## Post-Installation Setup
### Post-Installation Setup
- Complete the Bazzite Portal
- Login to Steam
@ -74,7 +79,7 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
- Steam Gaming Mode **Display** settings that are recommended to be changed:
- `Use Native Color Temperature` - Enabled
## Optional Tweaks
### Optional Tweaks
- Adjust RGB with Steam Gaming Mode in Handheld Daemon
- Adjust the scaling of the UI in the Display Settings
@ -85,7 +90,7 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
ujust install-hhd-controller-glyph-theme
```
## Workarounds / Known Issues
### Workarounds / Known Issues
- Suspend-resume works on the WM2 6800u model after disabling the fingerprint scanner, but 7840u and newer models have only partially working suspend-resume.
- Read about the issue [here](https://gitlab.freedesktop.org/drm/amd/-/issues/3154) for details on suspend-resume issues for the newer WM2 devices.
@ -98,17 +103,17 @@ ujust install-hhd-controller-glyph-theme
- Manually remap back buttons as described in hhd docs [here](https://github.com/hhd-dev/hhd?tab=readme-ov-file#extra-steps-gpd-win-devices)
- Watch this [video](https://www.youtube.com/watch?v=lnNfMY9kzjk) if you need a visual guide.
## External Resource
### External Resource
For more information, check out the [GPD Win Tips and Tricks guide](https://github.com/aarron-lee/gpd-win-tricks) which includes useful scripts for this handheld.
<hr>
# Additional Information
## Additional Information
This applies to most handhelds running Bazzite.
## TDP Controls
### TDP Controls
![TDP|690x431, 75%](../../img/TDP.jpeg)
@ -120,7 +125,7 @@ There are a few options for TDP Controls that work with Bazzite:
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
- [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
## How do I open the HHD Overlay?
### How do I open the HHD Overlay?
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
![Emulation Mode|690x434, 75%](../../img/HHD_Emulation_Mode.jpeg)
@ -129,7 +134,7 @@ Press, hold, or double-tap the Quick Access Menu button.
> **Note**: GPD devices do not support double-tapping the QAM button!
## Controller Information
### Controller Information
For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality.
@ -137,7 +142,7 @@ If your device has paddles, you will want to use the DualSense Edge controller.
Some games and emulators may need Steam Input **disabled** to work correctly with your controls.
### Desktop Controls
#### Desktop Controls
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
@ -151,7 +156,7 @@ Make sure to **apply** the desktop controls when you select them.
<hr>
# Contributing
## Contributing
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.

49
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2413", "fetched_at": "2024-09-03 16:43:19.836067+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -28,20 +33,21 @@ Open a host terminal and enter the following **commands**:
- Adjust the scaling of the UI in the Display Settings
- Set a charge limit in HHD with Handheld Daemon
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
```
ujust install-hhd-controller-glyph-theme
```
```
## Workarounds / Known Issues
- Performance overlay might be reporting inaccurate power consumption.
- Performance overlay might be reporting inaccurate power consumption.
- Adaptive/auto display brightness is currently broken.
- Manual brightness slider in Steam's UI works without issues.
- Manual brightness slider in Steam's UI works without issues.
- BIOS and controller firmware is **recommended** to update in Windows.
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode. (See "Desktop Controls" section below)
- <kbd>**Legion L**</kbd> + <kbd>**X**/**Square**</kbd> (This can be remapped)
- Try not to change the resolution in Desktop Mode!
- Connecting to an external monitor may also cause issues.
- <kbd>**Legion L**</kbd> + <kbd>**X**/**Square**</kbd> (This can be remapped)
- Try not to change the resolution in Desktop Mode!
- Connecting to an external monitor may also cause issues.
- If your screen doesn't display the correct output or looks grainy/noisy, then you will have to **ssh into it and enter this command**:
```command
@ -58,33 +64,32 @@ For more information, check out the [Legion Go Tips and Tricks guide](https://gi
<hr>
# Additional Information
## Additional Information
This applies to most handhelds running Bazzite.
## TDP Controls
### TDP Controls
![TDP|690x431, 75%](../../img/TDP.jpeg)
There are a few options for TDP Controls that work with Bazzite:
* The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
* Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
* [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
* Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
## How do I open the HHD Overlay?
### How do I open the HHD Overlay?
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
![Legion HHD|690x431, 75%](../../img/HHD_Settings_Example.jpeg)
Press, hold, or double-tap the Quick Access Menu button.
>**Example**: <kbd>Legion R</kbd> for the Lenovo Legion Go.
> **Example**: <kbd>Legion R</kbd> for the Lenovo Legion Go.
## Controller Information
### Controller Information
For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality.
@ -92,9 +97,9 @@ If your device has paddles, you will want to use the DualSense Edge controller.
Some games and emulators may need Steam Input **disabled** to work correctly with your controls.
### Desktop Controls
#### Desktop Controls
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
@ -104,17 +109,17 @@ Desktop Mode Controller Layout: It may not exist by default if Steam doesn't se
Make sure to **apply** the desktop controls when you select them.
## Force reboot device to prevent drive corruption if Steam crashes
### Force reboot device to prevent drive corruption if Steam crashes
>**Note**: This is only for the ASUS ROG Ally and Lenovo Legion Go.
> **Note**: This is only for the ASUS ROG Ally and Lenovo Legion Go.
Hold down the "**select**" button on your device to force a reboot. This feature can be disabled in the overlay settings.
<hr>
# Contributing
## Contributing
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)

36
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Other_Handhelds.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2415", "fetched_at": "2024-09-03 16:43:17.984951+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,11 +11,11 @@
![generic handheld|348x158, 100%](../../img/generic_handheld.jpeg)
>Certain handhelds have been confirmed to boot Bazzite, but are plagued by missing driver support for Linux including missing audio drivers.
> Certain handhelds have been confirmed to boot Bazzite, but are plagued by missing driver support for Linux including missing audio drivers.
Unsupported handhelds *could work* with Bazzite and the "**Other Handhelds**" section should cover unsupported handhelds, but there may be major issues encountered that are undocumented. If your handheld hardware is not listed, then you can still give Bazzite a try with our Handheld/HTPC image.
Unsupported handhelds _could work_ with Bazzite and the "**Other Handhelds**" section should cover unsupported handhelds, but there may be major issues encountered that are undocumented. If your handheld hardware is not listed, then you can still give Bazzite a try with our Handheld/HTPC image.
Your mileage may vary with untested hardware. Bazzite does **not** have the required setup for unsupported handheld, so setup will be manually done by the end user with unsupported handhelds.
Your mileage may vary with untested hardware. Bazzite does **not** have the required setup for unsupported handheld, so setup will be manually done by the end user with unsupported handhelds.
**Commands for functional HHD**:
@ -21,29 +26,30 @@ systemctl start hhd@yourusername
```command
systemctl enable hhd@yourusername
```
>**Note**: Replace `yourusername` with your Bazzite username.
> **Note**: Replace `yourusername` with your Bazzite username.
<hr>
# TDP Controls
## TDP Controls
![TDP|690x431, 75%](../../img/TDP.jpeg)
There are a few options for TDP Controls that work with Bazzite:
* The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
* Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
* [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
* Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
* [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
- [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
# How do I open the HHD Overlay?
## How do I open the HHD Overlay?
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
Press, hold, or double-tap the Quick Access Menu button.
# Controller Information
## Controller Information
For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality.
@ -51,9 +57,9 @@ If your device has paddles, you will want to use the DualSense Edge controller (
Some games and emulators may need Steam Input **disabled** to work correctly with your controls.
## Desktop Controls
### Desktop Controls
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings.
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
@ -67,4 +73,4 @@ Make sure to **apply** the desktop controls when you select them.
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
**<-- Back to [Handheld Wiki](./index.md)**
**<-- Back to [Handheld Wiki](./index.md)**

78
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Steam_Deck.md
View File

@ -1,8 +1,13 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1849", "fetched_at": "2024-09-03 16:43:16.550432+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# Steam Deck LCD (256GB+)
## Steam Deck LCD (256GB+)
![Steam Deck LCD|690x348, 100%](../../img/Steam_Deck_LCD.jpeg)
@ -12,16 +17,16 @@
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
## Post-Installation Setup
### Post-Installation Setup
- No additional setup required, but make sure to read the [installation Guide](https://universal-blue.discourse.group/docs?topic=30).
- It should function nearly identical to SteamOS with the benefits of [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/):
- Layer Fedora packages to the image without losing them between updates/reboots.
- Newer package upgrades including the Linux kernel and drivers.
- Printing support and other basic features that would make Bazzite viable for daily usage.
- It should function nearly identical to SteamOS with the benefits of [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/):
- Layer Fedora packages to the image without losing them between updates/reboots.
- Newer package upgrades including the Linux kernel and drivers.
- Printing support and other basic features that would make Bazzite viable for daily usage.
- View our [FAQ](https://universal-blue.discourse.group/docs?topic=33) for more information.
# Steam Deck OLED
## Steam Deck OLED
![Steam Deck OLED|667x500, 100%](../../img/Steam_Deck_OLED.jpeg)
@ -31,31 +36,33 @@ Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
## Post-Installation Setup
### Post-Installation Setup
* No additional setup required, but make sure to read the [installation Guide](https://universal-blue.discourse.group/docs?topic=30).
* It should function nearly identical to SteamOS with the benefits of [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/):
* Layer Fedora packages to the image without losing them between updates/reboots.
* Newer package upgrades including the Linux kernel and drivers.
* Printing support and other basic features that would make Bazzite viable for daily usage.
* View our [FAQ](https://universal-blue.discourse.group/docs?topic=33) for more information.
- No additional setup required, but make sure to read the [installation Guide](https://universal-blue.discourse.group/docs?topic=30).
- It should function nearly identical to SteamOS with the benefits of [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/):
- Layer Fedora packages to the image without losing them between updates/reboots.
- Newer package upgrades including the Linux kernel and drivers.
- Printing support and other basic features that would make Bazzite viable for daily usage.
- View our [FAQ](https://universal-blue.discourse.group/docs?topic=33) for more information.
<hr>
# How similar is Bazzite to SteamOS on Steam Deck hardware?
Bazzite should have most of the functionality from SteamOS with Steam Gaming Mode working as intended.
## How similar is Bazzite to SteamOS on Steam Deck hardware?
Bazzite Steam Deck images include the latest Gamescope and packages, which means we are always ahead of SteamOS in terms of Steam Gaming Mode and Desktop Mode features.
Bazzite should have most of the functionality from SteamOS with Steam Gaming Mode working as intended.
The Quick Access Menu (accessed with the <kbd>...</kbd> button on Steam Deck) is functional for TDP, framerate limiting, scaling, etc.
Bazzite Steam Deck images include the latest Gamescope and packages, which means we are always ahead of SteamOS in terms of Steam Gaming Mode and Desktop Mode features.
The Quick Access Menu (accessed with the <kbd>...</kbd> button on Steam Deck) is functional for TDP, framerate limiting, scaling, etc.
Third-party software like [Decky Loader](https://decky.xyz/), [Emudeck](https://www.emudeck.com/), [RetroDeck](https://retrodeck.net/), etc. should install and function properly.
# Why should I use Bazzite over SteamOS?
## Why should I use Bazzite over SteamOS?
Bazzite is great for users who feel that the device is too limited by SteamOS in comparison to other Linux operating systems, but do not want to sacrifice Steam Gaming Mode, stability, and the user friendliness of SteamOS.
Bazzite is great for users who feel that the device is too limited by SteamOS in comparison to other Linux operating systems, but do not want to sacrifice Steam Gaming Mode, stability, and the user friendliness of SteamOS.
### Enhancements
## Enhancements
- Shares packages from SteamOS
- Works on different hardware configurations (desktops, handhelds, etc.)
- Android applications can be installed with [Waydroid](https://universal-blue.discourse.group/docs?topic=32/)
@ -65,7 +72,7 @@ Bazzite is great for users who feel that the device is too limited by SteamOS in
- GNOME
- Budgie (**coming soon**)
## Daily Driving
### Daily Driving
- System packages that get updated on a regular basis
- Follows Fedora's [update cycle](https://docs.fedoraproject.org/en-US/releases/lifecycle/) and receive updates directly from upstream
@ -74,17 +81,18 @@ Bazzite is great for users who feel that the device is too limited by SteamOS in
- Printing support out of the box
- Wayland is the default session for Desktop Mode
## Tinkering
### Tinkering
- Access to multiple package managers and repositories in [containers](https://universal-blue.discourse.group/docs?topic=44)
- [Layer](https://universal-blue.discourse.group/docs?topic=513) Fedora packages to the system which survive between updates
- [`ujust`](https://universal-blue.discourse.group/docs?topic=42) commands to easily setup anything from virtualization support to supporting specific input peripherals
# Will there be any performance improvements with Bazzite?
## Will there be any performance improvements with Bazzite?
Performance should be on par with SteamOS, and every game capable of running on SteamOS should run on Bazzite. Bazzite and SteamOS share the same packages, so the difference is usually negligible.
Performance should be on par with SteamOS, and every game capable of running on SteamOS should run on Bazzite. Bazzite and SteamOS share the same packages, so the difference is usually negligible.
However there are some **advantages** that Bazzite may have in some edge cases:
- Performance Governor
- Bazzite uses powersave w/ [`amd-pstate`](https://www.kernel.org/doc/html/latest/admin-guide/pm/amd-pstate.html) which is more efficient on the hardware
- MGLRU is already enabled by default by Fedora
@ -96,26 +104,28 @@ However there are some **advantages** that Bazzite may have in some edge cases:
- Bazzite does not use a swapfile and rely on zram with zstd by default (compressed memory)
- Kernel is using 1000hz tick
>Performance tweaks are sourced from this [Medium article](https://medium.com/@a.b.t./here-are-some-possibly-useful-tweaks-for-steamos-on-the-steam-deck-fcb6b571b577).
> Performance tweaks are sourced from this [Medium article](https://medium.com/@a.b.t./here-are-some-possibly-useful-tweaks-for-steamos-on-the-steam-deck-fcb6b571b577).
# Does the Steam Deck image receive BIOS updates like SteamOS?
## Does the Steam Deck image receive BIOS updates like SteamOS?
**Yes**.
**Yes**.
If a BIOS update is available then it will install when you update Bazzite normally. It also supports controller firmware updates too.
If a BIOS update is available then it will install when you update Bazzite normally. It also supports controller firmware updates too.
If desired, there is a **command to disable BIOS updates** at your own risk:
If desired, there is a **command to disable BIOS updates** at your own risk:
```
ujust disable-bios-updates
```
# Why is the stock 64GB Steam Deck not supported on Bazzite?
## Why is the stock 64GB Steam Deck not supported on Bazzite?
It has **filesystem corruptions**.
It has **filesystem corruptions**.
You will have booting issues, freezes, and will not be able to update the image.
You will have booting issues, freezes, and will not be able to update the image.
### Solution
## Solution
**At your own risk**:
Upgrade the storage to resolve this.

44
docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/index.md
View File

@ -1,6 +1,9 @@
---
title: Handheld Wiki
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1038", "fetched_at": "2024-09-03 16:43:15.186486+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -11,41 +14,41 @@ title: Handheld Wiki
> **Note**: All handhelds except for the Steam Deck make use of [Handheld Daemon](https://github.com/hhd-dev/hhd/blob/master/readme.md) for controls, TDP, etc.
*Click the name of each hardware to view post-installation setup and known issues/workarounds.*
_Click the name of each hardware to view post-installation setup and known issues/workarounds._
- [**Steam Deck**](./Steam_Deck.md)
- [**Lenovo Legion Go**](./Lenovo_Legion_Go.md) ([*Edit Wiki*](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md))
- [**ASUS ROG Ally**](./ASUS_ROG_Ally.md) ([*Edit Wiki*](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md))
- [**Ayn Handhelds**](./Ayn_Handhelds.md) ([*Edit Wiki*](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md))
- [**GPD Handhelds**](./GPD_Handhelds.md) ([*Edit Wiki*](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md))
- [**Ayaneo Handhelds**](./Ayaneo_Handhelds.md) ([*Edit Wiki*](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md))
- [**Lenovo Legion Go**](./Lenovo_Legion_Go.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md))
- [**ASUS ROG Ally**](./ASUS_ROG_Ally.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md))
- [**Ayn Handhelds**](./Ayn_Handhelds.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md))
- [**GPD Handhelds**](./GPD_Handhelds.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md))
- [**Ayaneo Handhelds**](./Ayaneo_Handhelds.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md))
- [**Other Handhelds**](./Other_Handhelds.md)
## Support Rating
Bazzite takes a similar approach to [ProtonDB’s medal system](https://www.protondb.com/) by giving a generic label rating for each handheld.
Bazzite takes a similar approach to [ProtonDB’s medal system](https://www.protondb.com/) by giving a generic label rating for each handheld.
**Platinum**:
**Platinum**:
No major issues and/or simple workarounds are needed for small fixes.
**Gold**:
**Gold**:
Minor issues and/or simple workarounds required, but ultimately works.
**Silver**:
**Silver**:
Major issues and/or exhaustive workarounds required, but boots and can game.
**Bronze**:
**Bronze**:
Major issues and/or exhaustive workarounds, but boots and displays a desktop.
**Borked**:
**Borked**:
Bazzite does not boot on this hardware.
**Unknown** (*unlisted*):
**Unknown** (_unlisted_):
The handheld is not listed here and a general guide is under “Other Handhelds.”
# HHD Setup
>HHD is intended and functional for handhelds that are **not** the Steam Deck.
> HHD is intended and functional for handhelds that are **not** the Steam Deck.
**Read the [HHD README](https://github.com/hhd-dev/hhd/blob/master/readme.md) for more information.**
@ -53,14 +56,13 @@ The handheld is not listed here and a general guide is under “Other Handhelds.
2. Select the controller emulation and RGB color you want
>**Note**: Gyro functionality **requires** DualSense emulation
> **Note**: Gyro functionality **requires** DualSense emulation
# Decky Plugins
>**Note**: Decky may break or uninstall after updates especially if the Steam client or Gamescope is updated.
> **Note**: Decky may break or uninstall after updates especially if the Steam client or Gamescope is updated.
Install optional [Decky plugins](https://plugins.deckbrew.xyz/) for your handheld. If you experience any major issues then it is recommended to uninstall Decky before reporting Bazzite bugs.
Install optional [Decky plugins](https://plugins.deckbrew.xyz/) for your handheld. If you experience any major issues then it is recommended to uninstall Decky before reporting Bazzite bugs.
# Bazzite's Steam Gaming Mode Documentation
@ -68,15 +70,17 @@ Check out the [Steam Gaming Mode documentation](../Steam_Gaming_Mode.md) for an
# eGPU Support
>eGPU is **not** a fully supported feature and has many caveats.
> eGPU is **not** a fully supported feature and has many caveats.
**Notes**:
- Modern AMD GPUs are **supported**.
- Intel ARC GPUs are **supported**.
- Nvidia GPUs are **unsupported**.
- Nvidia GPUs are **unsupported**.
- Proprietary connectors, like the one for the ASUS ROG Ally, will not work.
## **Recommended External Guide & Script**:
Read this [guide](https://github.com/ewagner12/all-ways-egpu) for eGPU usage on Linux, and use the script at your own risk.
<hr>

127
docs/src/Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
View File

@ -1,110 +1,121 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=37", "fetched_at": "2024-09-03 16:43:12.251158+00:00"}-->
<!-- ANCHOR_END: METADATA -->
# General Information
## General Information
>**For Handheld PC users only**: View our [Handheld Wiki](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) for post-installation setup, workarounds, and known issues on handheld hardware.
> **For Handheld PC users only**: View our [Handheld Wiki](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) for post-installation setup, workarounds, and known issues on handheld hardware.
![Steam Gaming Mode UI|690x430](../img/Steam_Gaming_Mode_UI.jpeg)
> Steam Gaming Mode requires a modern AMD graphics card or an Intel Arc graphics card. Nvidia is **not** supported.
> Steam Gaming Mode requires a modern AMD graphics card or an Intel Arc graphics card. Nvidia is **not** supported.
## What is Steam Gaming Mode?
### What is Steam Gaming Mode?
https://www.youtube.com/watch?v=zXK1CXUyzXQ
**Steam Deck UI Tour by [Linux For Everyone](https://www.youtube.com/@LinuxForEveryone)**
Bazzite utilizes Steam Gaming Mode by [forking ChimeraOS’s `gamescope-session` ](https://github.com/KyleGospo/gamescope-session) and modifying it to fit the needs of our operating system. Steam Gaming Mode is also referred to as "gamepadUI" and "gamescope-session" but Bazzite documentation will usually refer to it as "Steam Gaming Mode" most of the time.
Bazzite utilizes Steam Gaming Mode by [forking ChimeraOS’s `gamescope-session` ](https://github.com/KyleGospo/gamescope-session) and modifying it to fit the needs of our operating system. Steam Gaming Mode is also referred to as "gamepadUI" and "gamescope-session" but Bazzite documentation will usually refer to it as "Steam Gaming Mode" most of the time.
Steam Gaming Mode is what SteamOS on the Steam Deck is built around. A simple interface that is controller-friendly built around Steam's "Big Picture Mode" UI/UX. The minimal session only runs the bare minimum in the background, so most of the hardware resources is going towards the game being played. [Gamescope](https://github.com/ValveSoftware/gamescope) is the main ingredient in Steam Gaming Mode which gives users options to set a framerate cap, resolution scaling options, etc.
Steam Gaming Mode is what SteamOS on the Steam Deck is built around. A simple interface that is controller-friendly built around Steam's "Big Picture Mode" UI/UX. The minimal session only runs the bare minimum in the background, so most of the hardware resources is going towards the game being played. [Gamescope](https://github.com/ValveSoftware/gamescope) is the main ingredient in Steam Gaming Mode which gives users options to set a framerate cap, resolution scaling options, etc.
## What are the HTPC/Handheld Images?
### What are the HTPC/Handheld Images?
>**Note**: The Steam beta client is **not** supported, please revert to the stable client before reporting issues.
> **Note**: The Steam beta client is **not** supported, please revert to the stable client before reporting issues.
Bazzite for Steam Deck hardware, Home Theater PC setups, and other Handheld PCs like the Lenovo Legion Go and Asus ROG Ally.
Bazzite for Steam Deck hardware, Home Theater PC setups, and other Handheld PCs like the Lenovo Legion Go and Asus ROG Ally.
It is intended to be a controller-friendly environment and give users a "console-like" experience similar to SteamOS for the Steam Deck. It is intended for both handhelds and home theatre PC setups. Bazzite is similar to SteamOS by sharing many packages that SteamOS includes, so it is ready to game as soon the installation process is finished.
It is intended to be a controller-friendly environment and give users a "console-like" experience similar to SteamOS for the Steam Deck. It is intended for both handhelds and home theatre PC setups. Bazzite is similar to SteamOS by sharing many packages that SteamOS includes, so it is ready to game as soon the installation process is finished.
This documentation may not cover specific areas with the assumption that the user is already aware of SteamOS and how it works. If you are unfamiliar with something that cannot be found in our [documentation](https://docs.bazzite.gg), then research your specific question with "SteamOS" or "Steam Deck" as keywords in your search. Otherwise, ask your question on our [forums](https://universal-blue.discourse.group/c/bazzite/5) or [Discord](https://discord.gg/f8MUghG5PB).
This documentation may not cover specific areas with the assumption that the user is already aware of SteamOS and how it works. If you are unfamiliar with something that cannot be found in our [documentation](https://docs.bazzite.gg), then research your specific question with "SteamOS" or "Steam Deck" as keywords in your search. Otherwise, ask your question on our [forums](https://universal-blue.discourse.group/c/bazzite/5) or [Discord](https://discord.gg/f8MUghG5PB).
<hr>
# Common Questions & Issues for Steam Gaming Mode
## Common Questions & Issues for Steam Gaming Mode
>[View the current Gamescope issues](https://github.com/ValveSoftware/gamescope/issues).
> [View the current Gamescope issues](https://github.com/ValveSoftware/gamescope/issues).
## How do I open the on-screen keyboard?
### How do I open the on-screen keyboard?
>**Note**: Steam must be running to access the keyboard.
> **Note**: Steam must be running to access the keyboard.
- By default it is bound to the <kbd>Steam</kbd> + <kbd>X</kbd> on the Steam Deck.
- For other handhelds it may require turning on Desktop Controls and configuring it manually.
- After that it is usually a combination of <kbd>X</kbd> (or equivalent) + one of the specific buttons your handheld has and it may also not be configured for your device out of the box.
## Update and Changelog Inaccuracy
### Update and Changelog Inaccuracy
>**Note**: Updates will also look for and upgrade Linux applications like installed [Flatpaks](https://universal-blue.discourse.group/docs?topic=2636).
> **Note**: Updates will also look for and upgrade Linux applications like installed [Flatpaks](https://universal-blue.discourse.group/docs?topic=2636).
### Steam Gaming Mode
The update indicator is not accurate and will most likely look it's stuck at "99%" for a long time. This is due to the update component not containing a live progress indicator, so it cannot hook into Steam Gaming Mode properly. After a while, the update progress bar will appear done and ask for a reboot.
#### Steam Gaming Mode
### Desktop Mode
In Desktop Mode, run our *System Update* tool for an accurate update visual if you are unsure if your system has actually updated properly in Gaming Mode. When the update has finished, it will output what has completed successfully. Alternatively, open a host terminal and **enter**:
The update indicator is not accurate and will most likely look it's stuck at "99%" for a long time. This is due to the update component not containing a live progress indicator, so it cannot hook into Steam Gaming Mode properly. After a while, the update progress bar will appear done and ask for a reboot.
#### Desktop Mode
In Desktop Mode, run our _System Update_ tool for an accurate update visual if you are unsure if your system has actually updated properly in Gaming Mode. When the update has finished, it will output what has completed successfully. Alternatively, open a host terminal and **enter**:
```command
ujust update
```
### Changelog
#### Changelog
The changelog is specifically for SteamOS by Valve, so the upgrade for Bazzite may not apply.
Read the [Universal Blue announcements](https://universal-blue.discourse.group/tag/announcements) for major changes and features.
The changelog is specifically for SteamOS by Valve, so the upgrade for Bazzite may not apply.
Read the [Universal Blue announcements](https://universal-blue.discourse.group/tag/announcements) for major changes and features.
View a changelog to the next update in the terminal by **entering**:
View a changelog to the next update in the terminal by **entering**:
```
ujust changelogs
```
## How do I access GRUB?
### How do I access GRUB?
[GRUB](https://www.gnu.org/software/grub/manual/grub/grub.html#Overview) used to be hidden by default, but new installations have defaulted to showing it.
Keep in mind, other handhelds and controllers may not be able to unhide GRUB without a physical keyboard connected, but a `ujust` command can be performed to unhide it permanently.
Enter this command in the terminal to have it appear every boot:
```
ujust configure-grub
```
Select "unhide" to have GRUB appear on boot.
> View the [Rollback Guide](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md) for more information.
>View the [Rollback Guide](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md) for more information.
## How do I open the Quick Access Menu (QAM) with a physical keyboard?
### How do I open the Quick Access Menu (QAM) with a physical keyboard?
<kbd>Ctrl</kbd>+<kbd>2</kbd>
## Change physical keyboard layout for Steam Gaming Mode
### Change physical keyboard layout for Steam Gaming Mode
As of writing, `gamescope-session` has no way to change the physical keyboard layout and will default to the US layout.
If you want to change the layout for Gamescope, you can set the environment variable `XKB_DEFAULT_LAYOUT=no` replacing `no` with the correct layout for you. Add this to `~/.config/environment.d/10-gamescope-session.conf`
>If the file or folder does not exist then create it.
If you want to change the layout for Gamescope, you can set the environment variable `XKB_DEFAULT_LAYOUT=no` replacing `no` with the correct layout for you. Add this to `~/.config/environment.d/10-gamescope-session.conf`
> If the file or folder does not exist then create it.
This works on desktop mode including running Nested Gamescope and also works for Steam Gaming Mode, but it has its own quirks: <kbd>altgr</kbd> + <kbd>2</kbd> to write "<kbd>@</kbd>" on the Norwegian layout will still not work, but the basic keyboard layout will always work, `altgr` is luckily not needed for normal typing on the norwegian layout, however <kbd>altgr</kbd> has been reported to work on the French layout, but your mileage may vary.
## Why do specific Decky Loader plugins not function on Bazzite?
### Why do specific Decky Loader plugins not function on Bazzite?
Some plugins are built specifically for SteamOS or the Steam Deck, and won’t necessarily work on Bazzite or non-Deck hardware.
For example, the [DeckMTP plugin](https://github.com/dafta/DeckMTP) only works on the Steam Deck, it will not work on alternative hardware.
## How do I use SteamDeckGyroDSU on hardware that isn't the Steam Deck?
### How do I use SteamDeckGyroDSU on hardware that isn't the Steam Deck?
You cannot use SteamDeckGyroDSU outside of the Steam Deck, but you can try disabling Steam Input and it *may* work depending on your hardware and use case.
You cannot use SteamDeckGyroDSU outside of the Steam Deck, but you can try disabling Steam Input and it _may_ work depending on your hardware and use case.
## How do I disable certain "Steam Deck" features that conflict with my setup?
### How do I disable certain "Steam Deck" features that conflict with my setup?
**Scenarios**:
@ -118,8 +129,10 @@ Open the game's properties on Steam and **enter this launch option**:
SteamDeck=0 %command%
```
## How do I specify the correct monitor for Gaming Mode to use? (HTPC only)
Go into desktop mode and open `ptyxis` our terminal and run
### How do I specify the correct monitor for Gaming Mode to use? (HTPC only)
Go into desktop mode and open `ptyxis` our terminal and run
```command
mkdir ~/.config/environment.d
nano ~/.config/environment.d/10-gamescope-session.conf
@ -129,6 +142,7 @@ add this to the file:
`OUTPUT_CONNECTOR=DP-1`
change `DP-1` to the correct output.
You can find your display outputs on KDE using the command
```
kscreen-doctor -o
```
@ -141,53 +155,54 @@ gnome-randr
Save with <kbd>CTRL</kbd> + <kbd>X</kbd> then pressing <kbd>Y</kbd> followed by <kbd>ENTER</kbd>
## How do I specify which GPU that Steam Gaming Mode should use?
### How do I specify which GPU that Steam Gaming Mode should use?
1. Open a TTY session with an **external physical keyboard** using this **keyboard combination**:
<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F4</kbd>
<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F4</kbd>
```command
export-gpu
```
**Alternatively**, in Desktop Mode, enter in a host terminal:
```
/usr/bin/export-gpu
```
2. Select the GPU to use for Steam Gaming Mode.
## "Something went wrong while displaying this content" Error
### "Something went wrong while displaying this content" Error
This is most likely due to a broken Decky Loader plugin you have installed. The easiest fix is to uninstall the broken plugin. CSS Loader themes can also cause this issue.
This is most likely due to a broken Decky Loader plugin you have installed. The easiest fix is to uninstall the broken plugin. CSS Loader themes can also cause this issue.
## Audio output not working (Default Device)
### Audio output not working (Default Device)
>This issue happens usually with HDMI TV audio.
> This issue happens usually with HDMI TV audio.
Go into Desktop Mode and into the system settings to adjust the sound settings. Disable devices that do not match the sound output that you're using. An example of this is disabling all the things that aren't HDMI for your TV audio.
Go into Desktop Mode and into the system settings to adjust the sound settings. Disable devices that do not match the sound output that you're using. An example of this is disabling all the things that aren't HDMI for your TV audio.
## Why is VRR not working on my VRR-compatible display?
### Why is VRR not working on my VRR-compatible display?
Most of the time this is because you're connecting the device via HDMI which does not support VRR on Linux. Here is the [source](https://www.phoronix.com/news/HDMI-2.1-OSS-Rejected) of that information.
Most of the time this is because you're connecting the device via HDMI which does not support VRR on Linux. Here is the [source](https://www.phoronix.com/news/HDMI-2.1-OSS-Rejected) of that information.
## Stuck at the Bazzite logo
### Stuck at the Bazzite logo
https://www.youtube.com/watch?v=gE1ff72g2Gk
>**Attention**: Try rebooting your device first before proceeding with the next steps.
> **Attention**: Try rebooting your device first before proceeding with the next steps.
1. Resolve this by opening a TTY session with an **external physical keyboard** using this **keyboard combination and entering this command**:
<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F4</kbd> and `mv ~/.local/share/Steam ~/.local/share/Steam1`
<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F4</kbd> and `mv ~/.local/share/Steam ~/.local/share/Steam1`
2. This command will rename the `Steam` directory to `Steam1`, and it will force Steam to reinitialize and create a new directory
3. You can move your games from the renamed `Steam1` directory to the new `Steam` directory if you had any installed previously on your internal storage
3. You can move your games from the renamed `Steam1` directory to the new `Steam` directory if you had any installed previously on your internal storage
4. Exit the TTY session by entering this **keyboard combination**: <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>F2</kbd>
## I lost my "Return to Gaming Mode" shortcut
### I lost my "Return to Gaming Mode" shortcut
You can restore this shortcut by creating a text file called `Return.desktop` and adding these specific lines to it:
### KDE
#### KDE
```file
[Desktop Entry]
@ -199,7 +214,7 @@ Type=Application
StartupNotify=false
```
### GNOME
#### GNOME
```file
[Desktop Entry]
@ -215,9 +230,9 @@ Save it and place it in the `Desktop` directory.
<hr>
# Valve's Official SteamOS Guide
## Valve's Official SteamOS Guide
>**Note**: Not all of the information will be accurate in regards to Bazzite.
> **Note**: Not all of the information will be accurate in regards to Bazzite.
Valve wrote a [guide](https://help.steampowered.com/en/faqs/view/7DD4-C618-182E-0E49) for the Steam Deck which may have some relevant information in regards to Bazzite.

13
docs/src/Installing_and_Managing_Software/AppImage.md
View File

@ -1,12 +1,17 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2641", "fetched_at": "2024-09-03 16:43:10.114605+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![AppImage|100x100, 100%](../img/AppImage.png)
>**Note**: AppImages may not be supported if rebasing to other Fedora Atomic Desktop images.
> **Note**: AppImages may not be supported if rebasing to other Fedora Atomic Desktop images.
AppImage is a universal package format that attempts to bundle every dependency that an application needs into one portable file. They can be installed by downloading any file with a `.AppImage` extension and then giving it executable permissions in the file's properties so the application can run properly. Like Windows executable files, they are usually found on the project's website to download.
AppImage is a universal package format that attempts to bundle every dependency that an application needs into one portable file. They can be installed by downloading any file with a `.AppImage` extension and then giving it executable permissions in the file's properties so the application can run properly. Like Windows executable files, they are usually found on the project's website to download.
# Gear Lever
@ -18,8 +23,6 @@ Applications installed as an AppImage can integrate with your desktop and be man
https://appimage.org/
<hr>
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)

7
docs/src/Installing_and_Managing_Software/Distrobox.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2640", "fetched_at": "2024-09-03 16:43:09.168054+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -20,8 +25,8 @@ Distrobox containers run sub-systems of other popular [Linux distributions](http
## Arch Linux Distrobox Container Example:
![i use arch btw|690x229, 75%](../img/i_use_arch_btw.png)
>i use Arch (in a container) btw.
> i use Arch (in a container) btw.
**Linux Distribution Examples**:

29
docs/src/Installing_and_Managing_Software/Flatpak.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2636", "fetched_at": "2024-09-03 16:43:08.564302+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,8 +11,7 @@
![Flatpak|100x100, 100%](../img/Flatpak.png)
Flatpak is a universal containerized package format that tries to sandbox applications through flexible permissions that the application has access to on your system.
Flatpak is a universal containerized package format that tries to sandbox applications through flexible permissions that the application has access to on your system.
> Flatpak is the **primary method of installing applications on Bazzite** and is recommended to use Flatpak over other formats for most software when possible.
@ -15,18 +19,17 @@ Flatpak is a universal containerized package format that tries to sandbox applic
Flatpaks can be installed via the software center of the desktop environment you chose.
![Discover|50x50, 100%](../img/Discover_icon.png)
**KDE**: *Discover*
![Discover|50x50, 100%](../img/Discover_icon.png)
**KDE**: _Discover_
![GNOME Software|50x50, 100%](../img/Gnome_Software.png)
**GNOME**: *GNOME Software*
![GNOME Software|50x50, 100%](../img/Gnome_Software.png)
**GNOME**: _GNOME Software_
![Discover|659x500, 100%](../img/Discover.png)
![GNOME Software Center](../img/Gnome_Software_Center.png)
**Alternatively open a host terminal and enter**:
```
flatpak install <application>
```
@ -39,7 +42,7 @@ The Flathub App Store is the definitive Linux app store and several Linux operat
### System & User Flathub Remotes
Flathub has different remotes, Bazzite enables both "**system**" and "**user**" Flathub by default. Bazzite pre-installs default applications with the system remote, and is mainly intended for multi-user systems. Some applications may require the system remote however.
Flathub has different remotes, Bazzite enables both "**system**" and "**user**" Flathub by default. Bazzite pre-installs default applications with the system remote, and is mainly intended for multi-user systems. Some applications may require the system remote however.
Read more about system versus user Flathub remotes in the [upstream documentation](https://docs.flathub.org/docs/for-users/user-vs-system-install/).
@ -55,20 +58,18 @@ Manage Flatpaks with [Flatseal](https://github.com/tchx84/Flatseal) and [Warehou
Alternatively, use KDE Plasma's system settings which has application permissions to adjust as well on KDE Plasma images.
Sometimes a project's website or [Github repository](https://github.com/flathub/com.discordapp.Discord/wiki/Rich-Precense-(discord-rpc)#flatpak-applications) contain information on what permissions need to be changed to perform certain functionality.
Sometimes a project's website or [Github repository](<https://github.com/flathub/com.discordapp.Discord/wiki/Rich-Precense-(discord-rpc)#flatpak-applications>) contain information on what permissions need to be changed to perform certain functionality.
## Warehouse
![Warehouse|690x376](../img/Warehouse.png)
**Warehouse** is a utility that gives users a graphical interface to downgrade applications, add other Flatpak sources outside of Flathub, and backup application user data. Its also a helpful tool for installing Flatpaks outside of Flathub, **at your own risk**.
**Warehouse** is a utility that gives users a graphical interface to downgrade applications, add other Flatpak sources outside of Flathub, and backup application user data. Its also a helpful tool for installing Flatpaks outside of Flathub, **at your own risk**.
# Project Website
https://www.flatpak.org/
<hr>
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)

10
docs/src/Installing_and_Managing_Software/Homebrew.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2639", "fetched_at": "2024-09-03 16:43:07.277727+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,10 +11,9 @@
![Homebrew|332x500, 15%](../img/Homebrew.png)
> **Note**: Any package that requires root privileges will either need a rootful Distrobox container or has to be layered with `rpm-ostree`.
>**Note**: Any package that requires root privileges will either need a rootful Distrobox container or has to be layered with `rpm-ostree`.
Homebrew is a package manager that installs packages to their own prefix, and is used strictly for command-line interface (CLI) and terminal user interface (TUI) applications. Do **not** install graphical applications or anything that may override system-level packages with Homebrew.
Homebrew is a package manager that installs packages to their own prefix, and is used strictly for command-line interface (CLI) and terminal user interface (TUI) applications. Do **not** install graphical applications or anything that may override system-level packages with Homebrew.
Install packages in a host terminal with this **command**:

21
docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/bazzite_rollback_helper.md
View File

@ -1,32 +1,41 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2647", "fetched_at": "2024-09-03 16:43:17.164020+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![Bazzite Rollback Helper Command|636x500](../../img/Bazzite_Rollback_Helper_Command.png)
>**Note**: Read the [rollback](./rolling_back_system_updates.md) and [rebasing](./rebase_guide.md) guides to understand the terms and what they do.
> **Note**: Read the [rollback](./rolling_back_system_updates.md) and [rebasing](./rebase_guide.md) guides to understand the terms and what they do.
A command-line utility that assists with **rollbacks**, **rebasing**, and **information on your current image**.
Open a host terminal and **enter**:
```command
bazzite-rollback-helper
```
# Options are available to the user:
- `list` = List images from the last 90 days that can rebased to.
- `rollback` = Rollback to the previous deployment on next reboot.
- `current` = Show information about your current deployment and image.
- `rebase` = Switch to another build, update branch, or a different Fedora image **at your own risk**.
- `list` = List images from the last 90 days that can rebased to.
- `rollback` = Rollback to the previous deployment on next reboot.
- `current` = Show information about your current deployment and image.
- `rebase` = Switch to another build, update branch, or a different Fedora image **at your own risk**.
# Video Guide
https://www.youtube.com/watch?v=XvljabnzgVo
> # Key Takeaways:
>
> **Updates**: Upgrades both system and installed software.
> **Rollbacks**: Return to a previous deployment after a bad system upgrade.
> **Rebasing**: Use the `bazzite-rollback-helper` command in the terminal.
<hr>
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)

25
docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=36", "fetched_at": "2024-09-03 16:43:15.473615+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,32 +11,32 @@
Updates are automatic on Desktop images and manually done on Handheld/HTPC images, and both Bazzite variants upgrade everything at both a system-level and user-installed applications during the updating process.
>**Full Documentation**:
[Updating guide](./updating_guide.md)
> **Full Documentation**:
> [Updating guide](./updating_guide.md)
# Rollbacks
Swap back to a previous system update if there are major issues after updating via the GRUB menu or the `rpm-ostree rollback` command.
>**Full Documentation**:
[Rollbacks guide](./rolling_back_system_updates.md)
> **Full Documentation**:
> [Rollbacks guide](./rolling_back_system_updates.md)
# Rebasing
>**Important**: Do **not** rebase to a different desktop environment than the one you are currently using, please backup and reinstall instead.
> **Important**: Do **not** rebase to a different desktop environment than the one you are currently using, please backup and reinstall instead.
Rebase to Bazzite builds from the last 90 days, change Bazzite update channels, swap between the Desktop and Handheld/HTPC images, or move completely to a different Fedora Atomic Desktop image.
>**Full Documentation**:
[Rebase guide](./rebase_guide.md)
> **Full Documentation**:
> [Rebase guide](./rebase_guide.md)
## Rollback Helper
Utility to assist with rolling back and rebasing to older Bazzite images.
>**Full Documentation**:
[Rollback Helper](./bazzite_rollback_helper.md)
> **Full Documentation**:
> [Rollback Helper](./bazzite_rollback_helper.md)
<hr>
← [**View all Bazzite documentation**](../../index.md)
← [**View all Bazzite documentation**](../../index.md)

53
docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rebase_guide.md
View File

@ -1,28 +1,36 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2646", "fetched_at": "2024-09-03 16:43:14.912897+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![Docker's OCI Icon|200x200, 100%](../../img/Dockers_OCI_Icon.png)]
![Docker's OCI Icon|200x200, 100%](../../img/Dockers_OCI_Icon.png)
# What is Rebasing?
>**Attention**: Do **not** rebase between different desktop environments.
> **Attention**: Do **not** rebase between different desktop environments.
Rebasing allows users to switch to a different image **without** having to reinstall and lose personal files and application data.
Rebasing allows users to switch to a different image **without** having to reinstall and lose personal files and application data.
[**It is recommended to use the Bazzite Rollback Helper utility**](./bazzite_rollback_helper.md).
# Rebase Scenarios
- Rebase to specific images of older builds within the last 90 days if issues are occurring on the newest build of Bazzite.
- Rebase to specific images of older builds within the last 90 days if issues are occurring on the newest build of Bazzite.
- Rebase to other Fedora Atomic Desktop images including other Bazzite images.
- Do **not** rebase between different desktop environments.
# How do I swap between Bazzite (and other Fedora Atomic Desktop) images?
See what channel or build you are on by **entering this command in a host terminal**:
```command
rpm-ostree status
```
Check under "Deployments:" and the output should be similar to:
> **● ostree-image-signed:docker://ghcr.io/ublue-os/[*image*]:[*channel*]**
@ -30,6 +38,7 @@ Check under "Deployments:" and the output should be similar to:
Switch to another Bazzite variant by entering the command for each specific image.
Open the terminal and **enter**:
```
rpm-ostree rebase <image>
```
@ -42,8 +51,8 @@ rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/bazzite-deck:sta
For rebasing to the generic KDE Plasma version of the Handheld & HTPC image.
>**NOTE**: Rebasing between different desktop environments **may cause issues** and is **unsupported**.
> **NOTE**: Rebasing between different desktop environments **may cause issues** and is **unsupported**.
# How do I change the Bazzite's update branch? (Stable, Testing, and Unstable)
There are 3 branches you can switch to:
@ -54,7 +63,7 @@ There are 3 branches you can switch to:
- Get a sneak peak of future Bazzite builds before release
- Bugs may frequently appear
- Encouraged to rebase back to `:stable` after testing a major release
- It can be behind on certain updates for a long time
- It can be behind on certain updates for a long time
- Unstable (`:unstable`) **(DO NOT USE**)
- **Not recommended**
- Testing playground for developers/contributors
@ -66,7 +75,7 @@ Handheld/HTPC images can switch branches in `Settings > System > OS Update Chann
If you enabled **advanced update channel**, then additional options will appear. The options map as the following:
```
Stable (:stable)
Stable (:stable)
Release Candidate (:testing)
Beta (:testing)
Beta Candidate (:unstable)
@ -75,26 +84,28 @@ Main (:unstable)
For Desktop images, replacing `:stable` with `:testing` or `:unstable` to the end of the rebase command for your Bazzite image allows you to switch to the experimental branches (which may have frequent bugs.)
**Example**:
**Example**:
```command
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/bazzite:testing
```
```
For the **testing** branch on the generic AMD/Intel Desktop image.
# Can I stay on a specific Fedora release?
>**Warning**: You will have to rebase back to `:stable` once you want to upgrade to the next Fedora version.
> **Warning**: You will have to rebase back to `:stable` once you want to upgrade to the next Fedora version.
>**Note:** Switching to older Fedora versions will not bring new updates until you upgrade back to `:stable` and this also means **no security updates** for the time being.
> **Note:** Switching to older Fedora versions will not bring new updates until you upgrade back to `:stable` and this also means **no security updates** for the time being.
**Yes**, but only if that version of Fedora is still currently supported upstream.
**Yes**, but only if that version of Fedora is still currently supported upstream.
- Replace `:stable` with the supported version of Fedora you would like to stay on.
- [Fedora Rawhide](https://docs.fedoraproject.org/en-US/releases/rawhide/) is **not** supported.
# Rebasing to older builds
>**Warning**: You will have to rebase back to `:stable` once you want to upgrade to the newest release.
> **Warning**: You will have to rebase back to `:stable` once you want to upgrade to the newest release.
- Like rolling back to the previous Bazzite deployment, users can also rebase to a specific Bazzite builds that was were built within the last 90 days.
- All of your userdata will remain intact, but like how the warning indicates above, you will have to rebase manually back to `:stable` to update the system to receive the newest build.
@ -105,16 +116,20 @@ View the list of available builds by **entering**:
skopeo list-tags docker://ghcr.io/ublue-os/bazzite | grep -- "-stable-" | sort -rV
```
Rebasing to a specific build requires users to open a host terminal and **enter**:
Rebasing to a specific build requires users to open a host terminal and **enter**:
```command
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/IMAGE-NAME:VERSION-YEARMONTHDAY
```
**Example**:
```
**Example**:
```command
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/bazzite-deck:39-20240113
```
For the *Jan. 13th 2024* `bazzite-deck` (*Fedora 39*) build.
For the _Jan. 13th 2024_ `bazzite-deck` (_Fedora 39_) build.
<hr>
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)

31
docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2644", "fetched_at": "2024-09-03 16:43:14.300522+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,13 +11,15 @@
# How do I rollback a system update?
A rollback to the previous system deployment can be done by **entering this command in a host terminal**:
A rollback to the previous system deployment can be done by **entering this command in a host terminal**:
```command
rpm-ostree rollback
```
Rollback can also be done in the GRUB menu (the menu you see before booting into Bazzite on Desktop images) by choosing the previous boot entry before booting to the desktop. It shows your current (`:0`) and your previous (`:1`) deployments, but due to a bug upstream there may be duplicates below them. Your personal files will **not** be affected by this, and you can still update to the newest builds after rolling back.
```
>If you need to rollback to a different OS image, use the [`bazzite-rollback-helper`](./bazzite_rollback_helper.md) to do so.
Rollback can also be done in the GRUB menu (the menu you see before booting into Bazzite on Desktop images) by choosing the previous boot entry before booting to the desktop. It shows your current (`:0`) and your previous (`:1`) deployments, but due to a bug upstream there may be duplicates below them. Your personal files will **not** be affected by this, and you can still update to the newest builds after rolling back.
> If you need to rollback to a different OS image, use the [`bazzite-rollback-helper`](./bazzite_rollback_helper.md) to do so.
## Unhide The GRUB Menu
@ -23,30 +30,35 @@ Unhide GRUB on Handheld/HTPC images with this **command**:
```
ujust configure-grub
```
Select the "**unhide**" opiton to have GRUB appear on boot.
>Controls may vary with different handheld or HTPC navigate the menu and an external physical keyboard may be needed.
> Controls may vary with different handheld or HTPC navigate the menu and an external physical keyboard may be needed.
# How do I save my **current** deployment?
You can pin your **current** deployment with this **command**:
```command
sudo ostree admin pin 0
```
In a host terminal for a backup save state of your **current** deployment to rollback to if a new system update causes issues.
```
In a host terminal for a backup save state of your **current** deployment to rollback to if a new system update causes issues.
# How do I save my **previous** deployment?
You can pin your **previous** deployment with this **command**:
```command
sudo ostree admin pin 1
```
```
In a host terminal for a backup save state of your **previous** deployment to rollback if the current deployment has issues.
# How do I unpin a deployment if I saved it?
Unpin saved **current** deployment:
```command
sudo ostree admin pin --unpin 0
```
@ -64,6 +76,7 @@ rpm-ostree status -v
```
Unpin **saved** deployment:
```command
sudo ostree admin pin --unpin <index number>
```

34
docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/updating_guide.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2637", "fetched_at": "2024-09-03 16:43:13.297624+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,7 +11,7 @@
# How do updates work?
Bazzite updates all of the changes made specifically in Bazzite itself, updates from Fedora's base packages upstream, and most user installed applications. Bazzite typically has new builds twice a week and you can see when it builds [here](https://github.com/ublue-os/bazzite/actions/workflows/build.yml?query=branch%3Amain).
Bazzite updates all of the changes made specifically in Bazzite itself, updates from Fedora's base packages upstream, and most user installed applications. Bazzite typically has new builds twice a week and you can see when it builds [here](https://github.com/ublue-os/bazzite/actions/workflows/build.yml?query=branch%3Amain).
## Desktop Images
@ -17,16 +22,15 @@ Bazzite updates all of the changes made specifically in Bazzite itself, updates
## Handheld/HTPC Images
- Updates can be managed in Steam Gaming Mode **manually** by the user.
- Open: **Steam Menu** > **Settings** > **System** > **Check for Updates** > **Apply**
- **Reboot** to apply system upgrades.
- Open: **Steam Menu** > **Settings** > **System** > **Check for Updates** > **Apply**
- **Reboot** to apply system upgrades.
- Updates upgrade system packages, containers and installed applications.
- The progress indicator and changelogs are not accurate currently.
- There's more information at the bottom of this [documentation](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md).
# How do I update manually on Desktop images?
>**Note**: This manual method also works in Desktop Mode on Handheld/HTPC images in Desktop Mode.
> **Note**: This manual method also works in Desktop Mode on Handheld/HTPC images in Desktop Mode.
**Note**: `rpm-ostree` does not show a progress indicator for system updates and may appear frozen, but it is not.
@ -35,18 +39,21 @@ Bazzite updates all of the changes made specifically in Bazzite itself, updates
- This upgrades system packages, containers, and installed applications.
## Terminal command to update manually:
```command
ujust update
```
```
## Do I have to reboot after every system update?
**No**, but the system upgrade will not apply until the next reboot.
**No**, but the system upgrade will not apply until the next reboot.
- Desktop images: While your device is running, newer updates will still download in the background once a day, and will be waiting to be applied until the device is rebooted.
- Handheld/HTPC images: Updates will be checked daily and can be downloaded at your leisure.
- Users will need to apply system updates manually similarly to SteamOS.
# How do I view the changelog for each update?
Open a host terminal and enter this **command**:
```
@ -65,25 +72,28 @@ If the package update contains a formal changelog:
rpm-ostree db diff --changelogs
```
Alternatively, you can subscribe to the [RSS feed](https://universal-blue.discourse.group/t/tutorial-subscribing-to-bazzite-news-for-major-update-information/3672) for major announcements regarding the project.
Alternatively, you can subscribe to the [RSS feed](https://universal-blue.discourse.group/t/tutorial-subscribing-to-bazzite-news-for-major-update-information/3672) for major announcements regarding the project.
# How often is there a new Bazzite build?
Usually Bazzite is built twice a week which includes the new changes from us, but it can also be built more than this. Updates may happen multiple times a day regardless due to updates from upstream (Universal Blue and Fedora), applications installed, firmware upgrades, and any containers that exist on your system updating their packages.
Usually Bazzite is built twice a week which includes the new changes from us, but it can also be built more than this. Updates may happen multiple times a day regardless due to updates from upstream (Universal Blue and Fedora), applications installed, firmware upgrades, and any containers that exist on your system updating their packages.
# How does updating to a new Fedora major release work?
Bazzite should automatically update when our new builds based on that new major release are ready, and usually aims for the around the same day when the new Fedora Linux release is out.
Bazzite should automatically update when our new builds based on that new major release are ready, and usually aims for the around the same day when the new Fedora Linux release is out.
# Can I enable update notifications for Desktop images?
**Yes**
1. Open a host terminal and **enter**:
```command
sudo nano /etc/ublue-update/ublue-update.toml
```
2. Change this line inside of the file:
`dbus_notify = false` to `dbus_notify = true`
`dbus_notify = false` to `dbus_notify = true`
3. Save the file as `/etc/ublue-update/ublue-update.toml`
@ -95,4 +105,4 @@ Read the [upstream documentation](https://universal-blue.discourse.group/docs?to
<hr>
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)

38
docs/src/Installing_and_Managing_Software/Waydroid_Setup_Guide.md
View File

@ -1,15 +1,21 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=32", "fetched_at": "2024-09-03 16:43:06.740654+00:00"}-->
<!-- ANCHOR_END: METADATA -->
![Google Play Store|650x500](../img/Google_Play_Store.jpeg)
>**Note**: Waydroid does **not** work on Nvidia's proprietary drivers, and requires an AMD or Intel GPU for the best results.
> **Note**: Waydroid does **not** work on Nvidia's proprietary drivers, and requires an AMD or Intel GPU for the best results.
# What is Waydroid?
![Waydroid](../img/Waydroid.jpeg)
[Waydroid](https://waydro.id/) is an Android container that runs on Linux. Bazzite users can run Android applications using this method.
[Waydroid](https://waydro.id/) is an Android container that runs on Linux. Bazzite users can run Android applications using this method.
# First Time Setup
@ -21,7 +27,7 @@ ujust setup-waydroid
## Initialize Waydroid
Waydroid requires users to initialize it for the first time which can be done by selecting:
Waydroid requires users to initialize it for the first time which can be done by selecting:
`Initialize Waydroid`
Make sure this worked by entering this **command**:
@ -29,6 +35,7 @@ Make sure this worked by entering this **command**:
```bash
/usr/bin/waydroid-launcher
```
This will launch Waydroid for the first time.
## Configure Waydroid
@ -46,20 +53,21 @@ waydroid session stop
### Part 2: Configuration
Open a host terminal and enter this **command**:
```
ujust setup-waydroid
```
Selecting `Configure Waydroid` will allow users to install additional Android tweaks with the [Waydroid Extras Scripts.](https://github.com/casualsnek/waydroid_script#waydroid-extras-script)
1. Select Android Version (***Android 11* recommended**)
1. Select Android Version (**_Android 11_ recommended**)
2. Select items to install
#### Available Waydroid Extras:
- [GApps](https://github.com/opengapps/opengapps/wiki/FAQ) (Default Android applications including the **Google Play Store)** or [microG](https://microg.org/) (Free alternatives to Google applications)
- ARM Translation (*libndk* for **AMD CPUs only** & *libhoudini* for **Intel CPUs only**)
- ARM Translation (_libndk_ for **AMD CPUs only** & _libhoudini_ for **Intel CPUs only**)
- [Magisk](https://github.com/topjohnwu/Magisk) (Android power user suite)
@ -73,9 +81,8 @@ Selecting `Configure Waydroid` will allow users to install additional Android tw
![Waydroid_DeviceID|690x182](../img/Waydroid_DeviceID.png)
1. Launch Waydroid
(**Waydroid must be running**)
1. Launch Waydroid
(**Waydroid must be running**)
2. After selecting your current Android version, select `Get Google Device ID to Get Certified` especially if you plan to use the Google Play Store (**GApps**).
@ -84,7 +91,8 @@ Selecting `Configure Waydroid` will allow users to install additional Android tw
After verification has happened, it will usually take a while before your device is verified.
# Add as a Non-Steam Shortcut
>This is useful for [Bazzite images that use Steam Gaming Mode.](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
> This is useful for [Bazzite images that use Steam Gaming Mode.](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
Make sure to add `/usr/bin/waydroid-launcher` to Steam as a non-Steam game for Waydroid to work properly in Steam Gaming Mode.
@ -96,9 +104,9 @@ Waydroid has an [issue](https://github.com/waydroid/waydroid/issues/135) where i
Disable this functionality:
>Note: **Waydroid must be running**!
> Note: **Waydroid must be running**!
In a host terminal, **run this command**:
In a host terminal, **run this command**:
```command
waydroid prop set persist.waydroid.uevent false
@ -108,7 +116,7 @@ If you ever want to undo this change, run the same steps but set `true` instead
# Resolution & Density Options
>**Note**: This is intended for users who have issues with Waydroid's resolution, scaling, or running Waydroid nested. This is **optional**.
> **Note**: This is intended for users who have issues with Waydroid's resolution, scaling, or running Waydroid nested. This is **optional**.
Open a host terminal and enter the following **commands**:
@ -124,7 +132,7 @@ Save the text files when done.
# Waydroid Hybrid Graphics Fix
>**Note**: This is only intended for users who have multiple GPUs in their hardware who experience graphical corruptions in Waydroid.
> **Note**: This is only intended for users who have multiple GPUs in their hardware who experience graphical corruptions in Waydroid.
**Enter in a host terminal**:
@ -138,7 +146,7 @@ Then `Select GPU for Waydroid` which will give the option on what GPU to utilize
# Reset Waydroid
>**Warning**: You will lose all of your Waydroid data.
> **Warning**: You will lose all of your Waydroid data.
If you experience issues or want a fresh Waydroid container, then select `Reset Waydroid` after **entering**:
@ -152,4 +160,4 @@ ujust setup-waydroid
**See also**: [Upstream documentation](https://docs.waydro.id/)
<-- [**View all Bazzite documentation**](../index.md)
<-- [**View all Bazzite documentation**](../index.md)

30
docs/src/Installing_and_Managing_Software/index.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=35", "fetched_at": "2024-09-03 16:43:05.697052+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -5,44 +10,41 @@
# Linux Package Formats
> **Package formats ranked from most recommended for daily usage**:
>
>
> 1. [Flatpak](./Flatpak.md) - Universal package format using a permissions-based model; use for most graphical applications.
> 2. [`ujust`](./ujust.md) - Custom scripts maintained by Bazzite & Universal Blue contributors that can install applications.
> 3. [Homebrew](./Homebrew.md) - Install applications intended to run inside of the terminal (CLI/TUI).
> 3. [Homebrew](./Homebrew.md) - Install applications intended to run inside of the terminal (CLI/TUI).
> 4. [Distrobox](./Distrobox.md) - Intended for legacy applications that do not support Flatpak and Homebrew, or for use as development boxes.
> 5. [AppImage](./AppImage.md) - Portable universal package format that relies on specific host libraries at a system-level, usually obtained from a project's website.
> 6. [`rpm-ostree`](./rpm-ostree.md) - Layer Fedora packages at a system-level (**not recommended, use as a last resort**)
# How do I run Windows applications?
> **Use a [WINE](https://www.winehq.org/) front-end**:
>
> * [Steam](https://store.steampowered.com/) (*pre-installed*) has a Windows compatibility layer built-in.
> * [Lutris](https://lutris.net/about) (*pre-installed*) for non-Steam video games.
> * [Heroic](https://heroicgameslauncher.com/) for Epic Games, GOG, and Amazon Games integration.
> * [Bottles](https://usebottles.com/) for general-purpose applications or as an alternative to Lutris.
> * [itch](https://flathub.org/apps/io.itch.itch) for games on itch.io.
> * [WineZGUI](https://github.com/fastrizwaan/WineZGUI) (*pre-installed*) for Windows applications that don’t require special considerations for their prefix.
> - [Steam](https://store.steampowered.com/) (_pre-installed_) has a Windows compatibility layer built-in.
> - [Lutris](https://lutris.net/about) (_pre-installed_) for non-Steam video games.
> - [Heroic](https://heroicgameslauncher.com/) for Epic Games, GOG, and Amazon Games integration.
> - [Bottles](https://usebottles.com/) for general-purpose applications or as an alternative to Lutris.
> - [itch](https://flathub.org/apps/io.itch.itch) for games on itch.io.
> - [WineZGUI](https://github.com/fastrizwaan/WineZGUI) (_pre-installed_) for Windows applications that don’t require special considerations for their prefix.
# How do I install Android applications?
Follow the [Waydroid Setup Guide](./Waydroid_Setup_Guide.md) to install Android applications on Bazzite.
>**Note**: Waydroid is **not supported** on other Universal Blue images like Aurora and Bluefin.
> **Note**: Waydroid is **not supported** on other Universal Blue images like Aurora and Bluefin.
# Tutorials for Installing Other Software
- [Plex Media Server](https://universal-blue.discourse.group/t/video-tutorial-how-to-install-plex-media-server-using-distrobox-on-bazzite/1999) (**Note**: Podman or Docker is recommended over Distrobox)
- [Flash Games](https://universal-blue.discourse.group/t/how-to-run-old-browser-games-with-web-apps/486)
<hr>
# Video Showcase of Installing Software
>**Note**: This video is missing Homebrew.
> **Note**: This video is missing Homebrew.
https://www.youtube.com/watch?v=ITuT23YrgPs
@ -52,4 +54,4 @@ https://www.youtube.com/watch?v=ITuT23YrgPs
**See also**: [Updates, Rollbacks, & Rebasing](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md)
<-- [**View all Bazzite documentation**](../index.md)
<-- [**View all Bazzite documentation**](../index.md)

31
docs/src/Installing_and_Managing_Software/rpm-ostree.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2642", "fetched_at": "2024-09-03 16:43:05.295995+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,9 +11,9 @@
# `rpm-ostree` Overview
>**Notice**: Using `rpm-ostree` irresponsibly can be **destructive**.
> **Notice**: Using `rpm-ostree` irresponsibly can be **destructive**.
>**Attention**: Layering packages may prevent updates and **may cause several issues until the layered packages are uninstalled**.
> **Attention**: Layering packages may prevent updates and **may cause several issues until the layered packages are uninstalled**.
Install Fedora Linux packages by installing them with `rpm-ostree`.
@ -21,16 +26,19 @@ Install Fedora Linux packages by installing them with `rpm-ostree`.
```
rpm-ostree install <package>
```
Installs Fedora package(s) to the system that stay between updates.
```
rpm-ostree uninstall <package>
```
```
Uninstalls any layered packages added to the system.
```
rpm-ostree search <package>
```
Search for Fedora packages that can be installed.
# RPM packages installed on the host
@ -38,16 +46,18 @@ Search for Fedora packages that can be installed.
Fedora containers should be used for most RPM files, but sometimes they need to be installed to your host.
You can install RPM files **to your host** with `rpm-ostree` by entering:
```
rpm-ostree install <package>.rpm
```
You may need to copy the full path (`/path/to/rpmfile.rpm`) for it to install properly.
>**Note**: The downside of installing local RPM files outside of the Fedora repositories is updates for the specific RPM package will not apply automatically.
> **Note**: The downside of installing local RPM files outside of the Fedora repositories is updates for the specific RPM package will not apply automatically.
# How do I install [COPR](https://copr.fedorainfracloud.org) repositories?
>**Note**: It is highly advised to **not** use third-party COPR repos if possible, so be aware there are risks associated with it including broken updates until removed.
> **Note**: It is highly advised to **not** use third-party COPR repos if possible, so be aware there are risks associated with it including broken updates until removed.
1. Download the .repo file and save it to `/etc/yum.repos.d/`
@ -61,19 +71,21 @@ There is also an experimental `copr` utility script that ships with Bazzite. Run
# **MAJOR** caveats using `rpm-ostree`
Layering packages are mostly intended for system-level applications, libraries, and other dependencies. It is recommend by upstream to use all of the methods above **before** installing software with `rpm-ostree`. Typical users should **not** be using `rpm-ostree` to install end-user graphical applications.
Layering packages are mostly intended for system-level applications, libraries, and other dependencies. It is recommend by upstream to use all of the methods above **before** installing software with `rpm-ostree`. Typical users should **not** be using `rpm-ostree` to install end-user graphical applications.
Layering packages can cause **severe consequences** including:
- Break upgrades or prevent rebasing.
- Conflict with existing packages as part of the image leading to dependency issues.
- Updates will take longer to download as you layer more packages to your system.
- Eventually package layering will be removed later in the future for Fedora Atomic Desktop and is only used currently as a crutch for the current software ecosystem on desktop Linux.
It is **highly recommended** to only use this command when absolutely necessary especially if the application can be obtained through other methods.
It is **highly recommended** to only use this command when absolutely necessary especially if the application can be obtained through other methods.
# How to remove **ALL** Layered Packages
If you run into issues upgrading due to a layered package conflict, then either optionally uninstall the conflicted package(s) or remove all layered packages with this **command**:
```bash
rpm-ostree reset
```
@ -94,5 +106,4 @@ https://coreos.github.io/rpm-ostree/
**See also**: https://universal-blue.discourse.group/docs?topic=513
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)

44
docs/src/Installing_and_Managing_Software/ujust.md
View File

@ -1,3 +1,8 @@
---
authors:
- "@nicknamenamenick"
---
<!-- ANCHOR: METADATA -->
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2638", "fetched_at": "2024-09-03 16:43:04.643633+00:00"}-->
<!-- ANCHOR_END: METADATA -->
@ -6,7 +11,7 @@
![Shell Scripts (.sh)|96x96, 100%](../img/Shell_Scripts__sh.png)
Technically `ujust` is **not** a package format, but are convenience commands that automate tasks using scripts which can be utilized to install specific software. There are also commands for system configuration and maintenance included here, so run `ujust` commands **at your own risk.**
Technically `ujust` is **not** a package format, but are convenience commands that automate tasks using scripts which can be utilized to install specific software. There are also commands for system configuration and maintenance included here, so run `ujust` commands **at your own risk.**
# Using `ujust`
@ -14,12 +19,11 @@ Technically `ujust` is **not** a package format, but are convenience commands th
Open a host terminal and **enter**:
```
ujust
```
```
>This will output a list of available commands.
> This will output a list of available commands.
![ujust TUI|690x403](../img/ujust_TUI.png)
@ -29,7 +33,7 @@ ujust --choose
This will show a terminal user interface of `ujust` commands that you can choose to execute with arrow keys or mouse input.
>**Note**: Commands that require values or flags do not function with this method.
> **Note**: Commands that require values or flags do not function with this method.
## Manually Entering Commands
@ -45,21 +49,23 @@ You can search for specific commands by **entering**:
ujust | grep "<search keyword(s)>"
```
* `install-`: Install program, there is no configuration or uninstall commands at this time
* `get-`: Install an "extension" like Decky plugins, and if it is an extension then it can use `get-` too
* `setup-`: Install program, provides uninstall and configuration options for after install
* `configure-`: Configure something that came by default on the image
* If it must be installed first, then it will be in `setup-`
* `toggle-`: Turns something on/off
* Selection might be automatic or manual depending on implementation
* `fix-`: Fixes, patches or works around an issue
* `distrobox-`: Distrobox exclusive verb for useful Distrobox stuff
* `foo`: Replace this with whatever the command is called
* These are shortcuts that we have deemed necessary to not have a verb
* **Examples**: `ujust update` and `ujust enroll-secureboot-key`
- `install-`: Install program, there is no configuration or uninstall commands at this time
- `get-`: Install an "extension" like Decky plugins, and if it is an extension then it can use `get-` too
- `setup-`: Install program, provides uninstall and configuration options for after install
- `configure-`: Configure something that came by default on the image
- If it must be installed first, then it will be in `setup-`
- `toggle-`: Turns something on/off
- Selection might be automatic or manual depending on implementation
- `fix-`: Fixes, patches or works around an issue
- `distrobox-`: Distrobox exclusive verb for useful Distrobox stuff
- `foo`: Replace this with whatever the command is called
- These are shortcuts that we have deemed necessary to not have a verb
- **Examples**: `ujust update` and `ujust enroll-secureboot-key`
# View each `ujust` script's source code
If you would like to see what each script does for each command then open a host terminal and **enter**:
```
ujust --show <command>
```
@ -67,11 +73,11 @@ ujust --show <command>
Alternatively, you can find the `ujust` commands locally in:
`/usr/share/ublue-os/just`
>This directory also shows **hidden** `ujust` commands.
> This directory also shows **hidden** `ujust` commands.
# Uninstalling Applications Installed Through `ujust`
Most applications installed via a `ujust` script would have to be uninstalled manually. Follow the instructions found on the project's website or README file in the source code to uninstall it properly.
Most applications installed via a `ujust` script would have to be uninstalled manually. Follow the instructions found on the project's website or README file in the source code to uninstall it properly.
This **command** Shows layered packages that may be installed from the Bazzite Portal / `ujust`:

2
docs/src/index.md
View File

@ -91,7 +91,7 @@ A quick list of stuff you might be interested in checking out:
[rpm-ostree]: Installing_and_Managing_Software/rpm-ostree.md
[distrobox]: Installing_and_Managing_Software/Distrobox.md
[installing_software]: Installing_and_Managing_Software/index.md
[contrib]: General/Contributing_to_Bazzite.md
[contrib]: Advanced/Contributing_to_bazzite.md
[homebrew]: Installing_and_Managing_Software/Homebrew.md
[rpm-ostree_caveats]: Installing_and_Managing_Software/rpm-ostree.md#major-caveats-using-rpm-ostree
[steam_game_mode]: Handheld_and_HTPC_edition/Steam_Gaming_Mode.md#what-is-steam-gaming-mode

7
docs/src/stylesheets/bazzite.css
View File

@ -89,6 +89,13 @@ nav.md-nav {
}
}
/* Authors list */
.authors-list, .authors-list .authors-chip {
display: inline-flex;
align-items: center;
gap: 0.3rem;
}
/* Mobile tweaks */
@media screen and (max-width: 59.9844em) {
.md-nav__source {

27
docs/theme_overrides/main.html
View File

@ -1,6 +1,25 @@
{% extends "base.html" %}
{% block announce %}
<span class="twemoji">⚠️</span>
Welcome to the new home for Bazzite documentation!
{% endblock %}
<!-- TODO: replace with eiher git-committers or a better looking template -->
{% block content %}
{% if page.meta.authors %}
<small class="authors-list">
Authors:
<nav>
{% for author in page.meta.authors %}
{% if "@" in author %}
{% set author = author[1:] %}
<a href="https://github.com/{{author}}" class="author-chip" title="@{{author}}"
style="display: inline-flex; align-items: center; gap: 0.3rem;">
<img class="md-author" src="https://github.com/{{author}}.png?size=40">
{{author}}
</a>
{% else %}
<span title="{{author}}">{{author}}</span>
{% endif %}
{% endfor %}
</nav>
</small>
{% endif %}
{{ super() }}
{% endblock %}

5
docs/utils/install-deps.sh
View File

@ -16,6 +16,9 @@ if ! command -v just >/dev/null; then
echod "Installing just"
brew install just
fi
if ! command -v just >/dev/null; then
brew install prettier
fi
# Install poetry project
echod "Setting up poetry project"
@ -27,4 +30,4 @@ echod "Setting up poetry project"
echod "Error setting up poetry project"
exit 1
}
echod "Dependencies installed succesfully"
echod "Dependencies installed succesfully"