mirror of
https://github.com/ublue-os/bazzite.git
synced 2025-02-23 15:40:23 +00:00
chore(docs): Delete offline documentation temporarily... (#1521)
* chore(docs): Delete Bazzite Landing * chore(docs): Delete Updates Directory * chore(docs): Delete Apps Doc Dir * chore(docs): Delete HTPC and Handheld Doc Dirs * chore(docs): Delete General Docs Dir * chore(docs): Delete Gaming Docs Dir * chore(docs): delete goofy ah icon * chore(docs): Delete docs .desktop We have the Discourse shortcut which leads to the documentation anyways.
This commit is contained in:
Pat Connors
GitHub
parent
e55ea85217
commit
fc473e1cc5
@ -1,9 +0,0 @@
|
||||
[Desktop Entry]
|
||||
Type=Application
|
||||
NoDisplay=false
|
||||
Terminal=false
|
||||
Exec=xdg-open /usr/share/ublue-os/docs
|
||||
Icon=/usr/share/ublue-os/bazzite/docs.svg
|
||||
Name=Documentation
|
||||
Comment=View Bazzite Documentation
|
||||
Categories=Utility;
|
||||
@ -1,114 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
|
||||
<svg
|
||||
version="1.1"
|
||||
id="svg1"
|
||||
width="750.71106"
|
||||
height="947.2074"
|
||||
viewBox="0 0 750.71109 947.2074"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:svg="http://www.w3.org/2000/svg">
|
||||
<defs
|
||||
id="defs1">
|
||||
<linearGradient
|
||||
id="linearGradient4">
|
||||
<stop
|
||||
style="stop-color:#5f12b7;stop-opacity:1;"
|
||||
offset="0"
|
||||
id="stop4" />
|
||||
<stop
|
||||
style="stop-color:#8723fb;stop-opacity:1;"
|
||||
offset="1"
|
||||
id="stop5" />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
xlink:href="#linearGradient4"
|
||||
id="linearGradient5"
|
||||
x1="1394.0055"
|
||||
y1="-101.43397"
|
||||
x2="1457.4017"
|
||||
y2="1090.4152"
|
||||
gradientUnits="userSpaceOnUse" />
|
||||
<linearGradient
|
||||
xlink:href="#linearGradient4"
|
||||
id="linearGradient2"
|
||||
gradientUnits="userSpaceOnUse"
|
||||
x1="1394.0055"
|
||||
y1="-101.43397"
|
||||
x2="1457.4017"
|
||||
y2="1090.4152" />
|
||||
<linearGradient
|
||||
xlink:href="#linearGradient4"
|
||||
id="linearGradient3"
|
||||
gradientUnits="userSpaceOnUse"
|
||||
x1="1394.0055"
|
||||
y1="-101.43397"
|
||||
x2="1457.4017"
|
||||
y2="1090.4152" />
|
||||
<linearGradient
|
||||
xlink:href="#linearGradient4"
|
||||
id="linearGradient6"
|
||||
gradientUnits="userSpaceOnUse"
|
||||
x1="1394.0055"
|
||||
y1="-101.43397"
|
||||
x2="1457.4017"
|
||||
y2="1090.4152" />
|
||||
</defs>
|
||||
<g
|
||||
id="g1"
|
||||
transform="translate(-246.83755,-209.60313)">
|
||||
<g
|
||||
id="g3"
|
||||
transform="translate(-758.23194)">
|
||||
<g
|
||||
id="g5">
|
||||
<g
|
||||
id="g4"
|
||||
style="fill:url(#linearGradient5);fill-opacity:1;stroke:#000000;stroke-width:7.3;stroke-linecap:square;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke markers fill">
|
||||
<g
|
||||
id="g2"
|
||||
transform="translate(704.43845,48.670292)"
|
||||
style="fill:url(#linearGradient6);fill-opacity:1;stroke:#000000;stroke-width:7.3;stroke-linecap:square;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke markers fill">
|
||||
<path
|
||||
style="fill:url(#linearGradient2);fill-opacity:1;stroke:#000000;stroke-width:7.3;stroke-linecap:square;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke markers fill"
|
||||
d="m 1045.1529,391.52422 v 671.82698 l -8.0903,30.0612 -41.52493,11.0778 H 326.8898 l -22.60877,-41.139 V 164.69605 l 521.79738,-0.11321 12.17395,207.78153 163.42224,0.11321 43.2109,23.20755 -218.66351,-230.75617 z"
|
||||
id="path1" />
|
||||
<path
|
||||
style="fill:url(#linearGradient3);fill-opacity:1;stroke:#000000;stroke-width:7.3;stroke-linecap:square;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1;paint-order:stroke markers fill"
|
||||
d="m 827.00999,165.26154 220.68211,210.01204 -2.4162,20.45058 -45.42613,-22.89563 -159.64681,-2.03774 -13.18978,-163.11408 z"
|
||||
id="path2" />
|
||||
</g>
|
||||
</g>
|
||||
<rect
|
||||
style="fill:#1a1a1a;stroke:#000000;stroke-width:0.397529"
|
||||
id="rect2"
|
||||
width="529.18396"
|
||||
height="62.078384"
|
||||
x="1145.3259"
|
||||
y="608.38336"
|
||||
rx="3.3387284"
|
||||
ry="0.48468551" />
|
||||
<rect
|
||||
style="fill:#1a1a1a;stroke:#000000;stroke-width:0.347533"
|
||||
id="rect2-1"
|
||||
width="404.09219"
|
||||
height="62.132801"
|
||||
x="1145.2484"
|
||||
y="707.18713"
|
||||
rx="2.5494993"
|
||||
ry="0.48511037" />
|
||||
<rect
|
||||
style="fill:#1a1a1a;stroke:#000000;stroke-width:0.241988"
|
||||
id="rect2-1-3"
|
||||
width="195.57281"
|
||||
height="62.242683"
|
||||
x="1147.7803"
|
||||
y="806.3158"
|
||||
rx="1.2339084"
|
||||
ry="0.48596832" />
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 3.9 KiB |
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: Bazzite Landing
|
||||
|
||||
---
|
||||
|
||||
# Bazzite Online Resources
|
||||
|
||||
- [Website](https://bazzite.gg/)
|
||||
|
||||
- [Features](https://github.com/ublue-os/bazzite/blob/main/README.md)
|
||||
|
||||
- [Documentation](https://docs.bazzite.gg)
|
||||
|
||||
- [Announcements](https://universal-blue.discourse.group/tag/announcements)
|
||||
|
||||
- [Newsletters](https://universal-blue.discourse.group/docs?topic=2252)
|
||||
|
||||
- [Forums](https://universal-blue.discourse.group/c/bazzite/5)
|
||||
|
||||
- [Discord Archive](https://www.answeroverflow.com/c/1072614816579063828/1143023993041993769)
|
||||
|
||||
- [Mastodon](https://fosstodon.org/@UniversalBlue)
|
||||
|
||||
- [Steam Group](https://steamcommunity.com/groups/Bazzite)
|
||||
|
||||
- [Download Bazzite](https://download.bazzite.gg)
|
||||
@ -1,90 +0,0 @@
|
||||
---
|
||||
title: Common Gaming Issues
|
||||
|
||||
---
|
||||
|
||||
# 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%`
|
||||
|
||||
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.
|
||||
|
||||
# Valve/Source Engine Games Not launching
|
||||
|
||||
>**Attention**: This only applies to specific games running on the [Source engine](https://www.pcgamingwiki.com/wiki/Engine:Source).
|
||||
|
||||
## Audio & Custom Content Bugs
|
||||
|
||||
>**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*.
|
||||
|
||||
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).
|
||||
|
||||
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**
|
||||
|
||||
1. Open a host terminal and **enter these 4 commands**:
|
||||
|
||||
```
|
||||
sudo su
|
||||
```
|
||||
```
|
||||
cd /tmp
|
||||
```
|
||||
|
||||
```
|
||||
ausearch -c 'hl2_linux' --raw | audit2allow -M my-hl2linux
|
||||
```
|
||||
|
||||
```
|
||||
semodule -X 300 -i my-hl2linux.pp
|
||||
```
|
||||
|
||||
2. Reboot your device
|
||||
|
||||
### If you want to undo this change eventually:
|
||||
|
||||
>Disable **or** remove the module.
|
||||
|
||||
#### Disable it:
|
||||
|
||||
```command
|
||||
semodule -X 300 -d my-hl2linux
|
||||
```
|
||||
|
||||
#### Remove and delete it:
|
||||
|
||||
```command
|
||||
semodule -X 300 -r my-hl2linux
|
||||
```
|
||||
|
||||
The `.pp` file should just be in `/root` if you want to remove that.
|
||||
|
||||
## 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**:
|
||||
|
||||
1. Add the following as a **launch option** to the affected game in Steam:
|
||||
```
|
||||
LD_PRELOAD=/usr/lib/libtcmalloc_and_profiler.so.4 %command%
|
||||
```
|
||||
2. 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.
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [RJ Trujillo](https://github.com/EyeCantCU), [Benjamin Shermin](https://github.com/bsherman), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
[**<-- View online documentation**](https://universal-blue.discourse.group/docs?topic=2658)
|
||||
@ -1,51 +0,0 @@
|
||||
---
|
||||
title: Game Launchers
|
||||
|
||||
---
|
||||
|
||||
# **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.
|
||||
|
||||
## Enabling Proton For All Steam Games
|
||||
|
||||
>**Note**: Skip this section if you're using a *Handheld/HTPC* 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**
|
||||
|
||||
## 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**
|
||||
|
||||
# **Non-Steam Games**
|
||||
|
||||
* **It is recommended to use [Lutris](https://lutris.net/games?q=&ordering=-popularity&paginate_by=100) for _most_ non-steam games**.
|
||||
* [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 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 Shortcuts
|
||||
|
||||
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)
|
||||
|
||||
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).
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [RJ Trujillo](https://github.com/EyeCantCU), [Benjamin Shermin](https://github.com/bsherman), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
[**<-- View online documentation**](https://universal-blue.discourse.group/docs?topic=2656)
|
||||
@ -1,50 +0,0 @@
|
||||
---
|
||||
title: Hardware Compatibility
|
||||
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
Check which Vulkan version your GPU uses, enter this in the terminal:
|
||||
```
|
||||
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.
|
||||
- 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**:
|
||||
|
||||
```
|
||||
PROTON_USE_WINED3D=1 %command%
|
||||
```
|
||||
|
||||
# **Storage**: NTFS and exFAT Filesystems for Secondary Drives
|
||||
|
||||
>**Warning**: You will lose all of your data reformatting secondary internal/external drives.
|
||||
|
||||
Bazzite supports BTRFS or Ext4 for secondary filesystems that are intended to run video games off of.
|
||||
|
||||
## 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.
|
||||
|
||||
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**.
|
||||
|
||||
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 are **unsupported** entirely. Both filesystems **do not support symlinks** which is what Proton prefixes use.
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [RJ Trujillo](https://github.com/EyeCantCU), [Benjamin Shermin](https://github.com/bsherman), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
[**<-- View online documentation**](https://universal-blue.discourse.group/docs?topic=2659)
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
title: Linux Gaming Resources
|
||||
|
||||
---
|
||||
|
||||
# Introduction to Linux Gaming
|
||||
|
||||
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.
|
||||
|
||||
# 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 useful external resources
|
||||
* [**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>
|
||||
|
||||
[**<-- View online documentation**](https://universal-blue.discourse.group/docs?topic=31)
|
||||
@ -1,87 +0,0 @@
|
||||
---
|
||||
title: Managing and Modding Games
|
||||
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
>**KDE Plasma Images**: [ProtonUp-Qt](https://davidotek.github.io/protonup-qt/)
|
||||
**GNOME Images**: [ProtonPlus](https://github.com/Vysp3r/protonplus)
|
||||
|
||||
## Using ProtonUp-Qt/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).
|
||||
|
||||
> 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/).
|
||||
|
||||
## Protontricks / Winetricks
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
These directories and files all start with a `.` before it
|
||||
|
||||
# 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>`
|
||||
|
||||
|
||||
## Equivalent with Windows
|
||||
|
||||
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.
|
||||
|
||||
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 Steam Prefix?
|
||||
|
||||
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 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
|
||||
|
||||
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).
|
||||
|
||||
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%`
|
||||
|
||||
# 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
|
||||
|
||||
Bazzite users can use templates for some of the pre-installed tools which can be accessed by right clicking anywhere in the file manager.
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [RJ Trujillo](https://github.com/EyeCantCU), [Benjamin Shermin](https://github.com/bsherman), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
[**<-- View online documentation**](https://universal-blue.discourse.group/docs?topic=2657)
|
||||
@ -1,95 +0,0 @@
|
||||
---
|
||||
title: Bazzite FAQ
|
||||
|
||||
---
|
||||
|
||||
# What Bazzite image am I on?
|
||||
|
||||
|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|
|
||||
|
||||
|
||||
# How do I change the hostname of my device?
|
||||
|
||||
Edit the `/etc/hostname` file with a new hostname, save it, and reboot.
|
||||
|
||||
```
|
||||
hostnamectl hostname <hostname>
|
||||
```
|
||||
|
||||
# Why are builds failing?
|
||||
|
||||
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.
|
||||
|
||||
# How do I report a bug?
|
||||
|
||||
While we try to help people as much as we can, we prefer that issues are triaged through GitHub so they can be tracked and labelled properly. Here's a quick guide.
|
||||
|
||||
If you've been redirected here it means one of us wants to track this in GitHub. Don't worry, you didn't mess up, we just need to put it in the system. This forum and GitHub support markdown formatting, so usually it's just a matter of copying and pasting it into GitHub.
|
||||
|
||||
Read the [GitHub Quickstart](https://docs.github.com/en/issues/tracking-your-work-with-issues/quickstart) for more information.
|
||||
|
||||
## Quick Tips to Reporting Issues
|
||||
|
||||
- One issue per problem please!
|
||||
- Try to fill out the form as best you can
|
||||
- Remember we're enthusiasts with jobs, sometimes it might take a while, especially if it's a nice-to-have and not a critical issue
|
||||
|
||||
## Setting Expectations
|
||||
|
||||
We're Linux geeks, but most of us come from a dev-ops background and not deep technical distribution work. More hands on deck are always welcome!
|
||||
|
||||
- Kernel issues like freezes and crashes can be tough to diagnose, we'll do our best
|
||||
- There's not much we can do in certain situations, if you're using an Nvidia closed source driver sometimes you might get an issue that is completely out of our control - the gift that keeps on giving!
|
||||
- Check Fedora's [How to File a Bug](https://docs.fedoraproject.org/en-US/quick-docs/bugzilla-file-a-bug/) docs - **please be respectful when reporting issues to Fedora** - it doesn't hurt to rule out a Universal Blue issue before reporting something for Fedora. Our intended mission is to **help** Fedora as efficiently as possible.
|
||||
- Some days the t-rex just gets you - If you're treading off the beaten path it's entirely possible that you are the first person trying it. Thanks for volunteering by filing issues and submitting documentation.
|
||||
|
||||
## Finding where to file an issue (Universal Blue Repositories)
|
||||
|
||||
Depending on where you find an issue, it might need to go in a certain repository. Don't worry if you mess this up, we can move them, here's a quick guide to save you some time.
|
||||
|
||||
- [ublue-os/bazzite](https://github.com/ublue-os/bazzite/issues/new) - Bazzite issues.
|
||||
|
||||
- [ublue-os/config](https://github.com/ublue-os/config/issues/new) - for just commands, udev rules, and service units. Things in this repo end up on every Universal Blue image.
|
||||
|
||||
- [ublue-os/akmods](https://github.com/ublue-os/akmods/issues/new) - extra kernel modules. Usually for that awful piece of hardware that doesn't have inkernel driver support. :smile:
|
||||
|
||||
- [ublue-os/main](https://github.com/ublue-os/main/issues/new) - for base images. Issues about codecs, and general issues. This is usually our catch all repo and will have issues relating to things that affect the entire project. These don't integrate akmods so no weird hardware things don't go in here.
|
||||
|
||||
- [ublue-os/hwe](https://github.com/ublue-os/hwe/issues/new) - hwe means "hardware enablement". If you have an issue with Nvidia, Asus, or Surface devices, file it in this repo.
|
||||
|
||||
- [ublue-os/toolboxes](https://github.com/ublue-os/toolboxes/issues/new) - Anything related to our distroboxes and associated podman quadlets.
|
||||
|
||||
For everything else check out the [list of repositories](https://github.com/ublue-os).
|
||||
|
||||
## Update before reporting
|
||||
|
||||
First, see if the bug is already fixed in an update by manually updating the system, then rebooting to see if the issue still persists between updates.
|
||||
|
||||
## Attaching system logs
|
||||
Open a host terminal and **enter**:
|
||||
```
|
||||
ujust device-info
|
||||
```
|
||||
Attach the link that it outputs for system logs.
|
||||
|
||||
## Experience a crash?
|
||||
```
|
||||
ujust logs-last-boot
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [RJ Trujillo](https://github.com/EyeCantCU), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
[**<-- View online documentation**](https://faq.bazzite.gg)
|
||||
@ -1,216 +0,0 @@
|
||||
---
|
||||
title: Bazzite README
|
||||
|
||||
---
|
||||
|
||||
# Bazzite README
|
||||
[Please see our website](https://bazzite.gg/) for a newcomer-friendly explanation of Bazzite. This readme will cover everything in-depth.
|
||||
|
||||
## About & Features
|
||||
|
||||
Bazzite is an OCI image that serves as an alternative operating system for the [Steam Deck](https://www.steamdeck.com/), and a ready-to-game SteamOS-like for desktop computers and living room home theater PCs.
|
||||
|
||||
Bazzite is built from [ublue-os/main](https://github.com/ublue-os/main) and [ublue-os/nvidia](https://github.com/ublue-os/nvidia) using [Fedora](https://fedoraproject.org/) technology, which means expanded hardware support and built in drivers are included. Additionally, Bazzite adds the following features:
|
||||
|
||||
- Uses the [fsync kernel](https://copr.fedorainfracloud.org/coprs/sentry/kernel-fsync/) to achieve HDR and expanded hardware support, among numerous other included patches.
|
||||
- HDR available in Game mode.
|
||||
- NVK available on non-Nvidia builds.
|
||||
- Full hardware accelerated codec support for H264 decoding.
|
||||
- Full support for AMD's ROCM OpenCL/HIP run-times.
|
||||
- [xone](https://github.com/medusalix/xone) driver for Xbox controllers.
|
||||
- Full support for [DisplayLink](https://www.synaptics.com/products/displaylink-graphics).
|
||||
- Includes Valve's KDE themes from SteamOS.
|
||||
- Features optional Valve-inspired GTK3/4 themes matching Vapor and VGUI2 from SteamOS. Install [Gradience](https://flathub.org/apps/com.github.GradienceTeam.Gradience) to make use of them.
|
||||
- [LatencyFleX](https://github.com/ishitatsuyuki/LatencyFleX), [vkBasalt](https://github.com/DadSchoorse/vkBasalt), [MangoHud](https://github.com/flightlessmango/Mangohud), and [OBS VkCapture](https://github.com/nowrep/obs-vkcapture) installed and available by default
|
||||
- [Patched Switcheroo-Control](https://copr.fedorainfracloud.org/coprs/sentry/switcheroo-control_discrete/) fixing default-broken iGPU/dGPU switching.
|
||||
- Support for [Wallpaper Engine](https://www.wallpaperengine.io/en). <sub><sup>(Only on KDE)</sup></sub>
|
||||
- [ROM Properties Page shell extension](https://github.com/GerbilSoft/rom-properties) included.
|
||||
- Full support for [Winesync/Fastsync/NTsync](https://github.com/Frogging-Family/wine-tkg-git/issues/936).
|
||||
- [Distrobox](https://github.com/89luca89/distrobox) preinstalled with automatic updates for created containers.
|
||||
- [Ptyxis Terminal](https://gitlab.gnome.org/chergert/ptyxis) used as the default in all images. This terminal is specifically designed for the container workflow you'll use in Bazzite. If you wish to return to stock, run `ujust _restore-original-terminal`
|
||||
- Automated `duperemove` service for reducing the disk space used by wine prefix contents.
|
||||
- Support for HDMI CEC via [libCEC](https://libcec.pulse-eight.com/).
|
||||
- Uses [Google's BBR TCP congestion control](https://github.com/google/bbr) by default.
|
||||
- [Input Remapper](https://github.com/sezanzeb/input-remapper) preinstalled and enabled. <sub><sup>(Available but default-disabled on the Deck variant, may be enabled with `ujust restore-input-remapper`)</sup></sub>
|
||||
- Bazzite Portal provides an easy way to install numerous applications and tweaks, including installing [LACT](https://github.com/ilya-zlobintsev/LACT).
|
||||
- [Waydroid](https://waydro.id/) preinstalled for running Android apps. Set it up with this [quick guide](https://universal-blue.discourse.group/docs?topic=32).
|
||||
- Manage applications using [Flatseal](https://github.com/tchx84/Flatseal), [Warehouse](https://github.com/flattool/warehouse), and [Gear Lever](https://github.com/mijorus/gearlever).
|
||||
- [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) i2c-piix4 and i2c-nct6775 drivers for controlling RGB on certain motherboards.
|
||||
- [OpenRazer](https://openrazer.github.io) drivers built in, Select OpenRazer in Bazzite Portal or run `ujust install-openrazer` in a terminal to begin using it.
|
||||
- [OpenTabletDriver](https://opentabletdriver.net/) udev rules built in, with the full software suite installable via Bazzite Portal or by running `ujust install-opentabletdriver` in a terminal.
|
||||
- Out of the box support for [Wooting](https://wooting.io/) keyboards.
|
||||
- Built in support for Southern Islands <sub><sup>(HD 7000)</sup></sub> and Sea Islands <sub><sup>(HD 8000)</sup></sub> AMD GPUs under the `amdgpu` driver.
|
||||
- [XwaylandVideoBridge](https://invent.kde.org/system/xwaylandvideobridge) is available for Discord screensharing on Wayland.
|
||||
- [Webapp Manager](https://github.com/linuxmint/webapp-manager) is available for creating applications from websites for a variety of browsers, including Firefox.
|
||||
|
||||
### Desktop
|
||||
|
||||
Common variant available as `bazzite`, suitable for desktop computers.
|
||||
|
||||
- Automatic updates for the OS, Flatpaks, and all Distrobox containers - powered by [ublue-update](https://github.com/ublue-os/ublue-update) and [topgrade](https://github.com/topgrade-rs/topgrade).
|
||||
|
||||
**For users with Secure Boot enabled:** Follow our secure boot documentation prior to rebasing.
|
||||
|
||||
### Steam Deck/Home Theater PCs (HTPCs)
|
||||
>Devices that are NOT the Steam Deck can still use the `bazzite-deck` images, but must use a modern AMD GPU. Intel Arc GPUs also have been confirmed to work.
|
||||
|
||||
Variant designed for usage as an alternative to SteamOS on the Steam Deck, and for a console-like experience on HTPCs, available as `bazzite-deck`:
|
||||
|
||||
- Directly boots to Game mode matching SteamOS's behavior.
|
||||
- **Automatic `duperemove` greatly trims the size of compatdata.**
|
||||
- **Latest version of Mesa creates smaller shader caches and does not require them to prevent stutter.**
|
||||
- **Able to be booted even if the drive is full.**
|
||||
- **Support for every language supported by upstream Fedora.**
|
||||
- **Uses Wayland on the desktop with [support for Steam input](https://github.com/Supreeeme/extest).**
|
||||
- Includes [HHD](https://github.com/hhd-dev/hhd) for expanded input support on non-Valve handhelds.
|
||||
- Features ported versions of most SteamOS packages, including drivers, firmware updaters, and fan controllers [from the evlaV repository](https://gitlab.com/evlaV).
|
||||
- Patched Mesa for proper framerate control from Gamescope.
|
||||
- Comes with patches from [SteamOS BTRFS](https://gitlab.com/popsulfr/steamos-btrfs) for full BTRFS support for the SD card by default.
|
||||
- Ships with a ported copy of [SDGyroDSU](https://github.com/kmicki/SteamDeckGyroDSU), enabled by default.
|
||||
- Option to install [Decky Loader](https://github.com/SteamDeckHomebrew/decky-loader), [EmuDeck](https://www.emudeck.com/), [RetroDECK](https://retrodeck.net/), and [ProtonUp-Qt](https://davidotek.github.io/protonup-qt/), among numerous other useful packages on installation.
|
||||
- Custom update system allows for the OS, Flatpaks, and Distrobox images to be updated directly from the Game mode UI powered by [ublue-update](https://github.com/ublue-os/ublue-update) and [topgrade](https://github.com/topgrade-rs/topgrade).
|
||||
- Built in support for Windows dual-boot thanks to Fedora's installation of GRUB being left intact.
|
||||
- Update break something? Easily roll back to the previous version of Bazzite thanks to `rpm-ostree`'s rollback functionality. You can even select previous images at boot.
|
||||
- Steam and Lutris preinstalled on the image as layered packages.
|
||||
- [Discover Overlay](https://github.com/trigg/Discover) for Discord pre-installed and automatically launches in both Game mode and on the Desktop if Discord is installed. [View the official documentation here](https://trigg.github.io/Discover/bazzite).
|
||||
- Uses ZRAM<sub><sup>(4GB)</sup></sub> with the ZSTD compression algorithm by default with the option to switch back to a 1GB swap file and set a custom size for it if desired.
|
||||
- [BORE CPU scheduler](https://github.com/firelzrd/bore-scheduler) for smooth and responsive gameplay.
|
||||
- Kyber I/O scheduler to prevent I/O starvation when installing games or during background `duperemove` process.
|
||||
- Applies SteamOS's kernel parameters.
|
||||
- Color calibrated display profiles for matte and reflective Steam Deck screens included.
|
||||
- Default-disabled power-user features, including:
|
||||
- Service for low-risk undervolting of the Steam Deck as well as AMD Framework Laptops via [RyzenAdj](https://github.com/FlyGoat/RyzenAdj) and [Ryzen SMU](https://gitlab.com/leogx9r/ryzen_smu), see `ryzenadj.service` and `/etc/default/ryzenadj`.
|
||||
- Service for limiting the max charge level of the battery, see `batterylimit.service` and `/etc/default/batterylimit`. <sup><sub>(Works even when the device is off)</sub></sup>
|
||||
- Built in support for display overclocking. For example, add `GAMESCOPE_OVERRIDE_REFRESH_RATE=40,70` to `/etc/environment`.
|
||||
- 32GB RAM mod your Steam Deck? Enjoy double the maximum VRAM amount, automatically applied. <sup><sub>(Can you share your soldering skills?)</sub></sup>
|
||||
- Steam Deck hardware-specific services can be disabled by running `ujust disable-bios-updates` and `ujust disable-firmware-updates` in the terminal. These are automatically disabled on non-Deck hardware, and on Decks with DeckHD displays or 32GB RAM mods.
|
||||
- More information can be found [here](https://universal-blue.discourse.group/docs?topic=37) on the Bazzite Steam Deck images.
|
||||
|
||||
> **Due to an upstream bug, Bazzite cannot be used on Steam Decks with 64GB eMMC storage at this time. Upgrading the storage resolves the issue.**
|
||||
|
||||
Rebase from an existing upstream Fedora Atomic to this image:
|
||||
|
||||
#### Alternative Handhelds
|
||||
|
||||
Please refer to our [Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) for required post-setup instructions.
|
||||
|
||||
**Be sure to also read the [hhd documentation](https://github.com/hhd-dev/hhd#after-install), some handhelds require specific setting changes/tweaks to function properly.**
|
||||
|
||||
We also ship `ujust` commands to install various [CSS Loader](https://docs.deckthemes.com/CSSLoader/Install/#linux-or-steam-deck) themes that can't be found on the CSS Loader store. These will be automatically updated with Bazzite if installed.
|
||||
|
||||
```bash
|
||||
# Install Handheld Controller Theme (https://github.com/victor-borges/handheld-controller-glyphs)
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
|
||||
### GNOME
|
||||
|
||||
Builds with the GNOME desktop environment are available in both desktop and deck flavors. These builds come with the following additional features:
|
||||
|
||||
- [Variable refresh rate support and fractional scaling enabled under Wayland](https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1154).
|
||||
- Custom menu in the top bar for returning to game mode, launching Steam, and opening a number of useful utilities.
|
||||
- [GSConnect](https://extensions.gnome.org/extension/1319/gsconnect/) preinstalled and ready to use.
|
||||
- [Hanabi extension](https://github.com/jeffshee/gnome-ext-hanabi) included to offer similar features to Wallpaper Engine in KDE.
|
||||
- Numerous optional extensions pre-installed, including [important user experience fixes](https://www.youtube.com/watch?v=nbCg9_YgKgM).
|
||||
- Automatic updates for the [Firefox GNOME theme](https://github.com/rafaelmardojai/firefox-gnome-theme) and [Thunderbird GNOME theme](https://github.com/rafaelmardojai/thunderbird-gnome-theme). <sup><sub>(If installed)</sub></sup>
|
||||
|
||||
> **Due to an upstream bug, Bazzite cannot be used on Steam Decks with 64GB eMMC storage at this time.**
|
||||
|
||||
**For users with Secure Boot enabled:** Follow our secure boot documentation prior to rebasing.
|
||||
|
||||
### Features from Upstream
|
||||
|
||||
#### Universal Blue
|
||||
|
||||
- Proprietary Nvidia drivers pre-installed. <sub><sup>(Only for Nvidia images)</sup></sub>
|
||||
- Flathub is enabled by default.
|
||||
- [`ujust`](https://github.com/casey/just) commands for convenience.
|
||||
- Multi-media codecs out of the box.
|
||||
- Rollback Bazzite from any build within the last 90 days.
|
||||
|
||||
#### Features from Fedora Linux (Kinoite & Silverblue)
|
||||
|
||||
- A rock solid and stable base.
|
||||
- System packages stay relatively up to date.
|
||||
- Can layer Fedora packages to the image without losing them between updates.
|
||||
- Security focused with [SELinux](https://github.com/SELinuxProject/selinux) preinstalled and configured out of the box.
|
||||
- The ability to rebase to different Fedora Atomic images, if desired, without losing user data.
|
||||
- Printing support thanks to [CUPS](https://www.cups.org/) being preinstalled.
|
||||
|
||||
## Why
|
||||
|
||||
Bazzite started as a project to resolve some of the issues that plague SteamOS, mainly out of date packages (despite an Arch base) and the lack of a functional package manager.
|
||||
|
||||
Despite this project also being image-based, you are able to install any Fedora package straight from the command line. These packages will persist across updates <sub><sup>(So go ahead and install that obscure VPN software you spent an hour trying to get working in SteamOS)</sup></sub>. Additionally, Bazzite is updated multiple times a week with packages from upstream Fedora, giving you the best possible performance and latest features - all on a stable base.
|
||||
|
||||
Bazzite ships with the latest Linux kernel and SELinux enabled by default with full support for secure boot <sub><sup>(Run `ujust enroll-secure-boot-key` and enter the password `ublue-os` if prompted to enroll our key)</sup></sub> and disk encryption, making this a sensible solution for general computing. <sup><sub>(Yes, you can print from Bazzite)</sub></sup>
|
||||
|
||||
Read the [FAQ](https://universal-blue.discourse.group/docs?topic=33) for details on what makes Bazzite stand out from other Linux based operating systems.
|
||||
|
||||
## Newsletters
|
||||
|
||||
Check out our [newsletters](https://universal-blue.discourse.group/docs?topic=2252) that get published on a regular basis for updates on the project.
|
||||
|
||||
## Custom Packages
|
||||
|
||||
Ported SteamOS and ChimeraOS packages, among others used by Bazzite, are built on Copr in [bazzite](https://copr.fedorainfracloud.org/coprs/kylegospo/bazzite/) and [bazzite-multilib](https://copr.fedorainfracloud.org/coprs/kylegospo/bazzite-multilib/).
|
||||
|
||||
## Verification
|
||||
|
||||
These images are signed with sigstore's [cosign](https://docs.sigstore.dev/cosign/overview/). You can verify the signature by downloading the `cosign.pub` key from this repo and running the following command:
|
||||
|
||||
```bash
|
||||
cosign verify --key cosign.pub ghcr.io/ublue-os/bazzite
|
||||
```
|
||||
|
||||
## Secure Boot
|
||||
|
||||
> **Steam Deck Users: The Steam Deck does not come with secure boot enabled and does not ship with any keys enrolled by default. Do not enable this unless you absolutely know what you're doing.**
|
||||
|
||||
Secure boot is supported with our custom key. The pub key can be found in the root of this repository [here](https://github.com/ublue-os/bazzite/blob/main/secure_boot.der).
|
||||
|
||||
If you'd like to enroll this key prior to installation or rebase, download the key and run the following:
|
||||
|
||||
```bash
|
||||
sudo mokutil --timeout -1
|
||||
sudo mokutil --import secure_boot.der
|
||||
```
|
||||
|
||||
For users already on a Universal Blue image, you may instead run `ujust enroll-secure-boot-key`.
|
||||
|
||||
If asked for a password, use `universalblue`.
|
||||
|
||||
## Special Thanks
|
||||
|
||||
Bazzite is a community effort and wouldn't exist without everyone's support. Below are some of the people who've helped us along the way:
|
||||
|
||||
- [rei.svg](https://github.com/reisvg) - For creating our logo and overall branding.
|
||||
- [SuperRiderTH](https://github.com/SuperRiderTH) - For creating our Steam game mode startup video.
|
||||
- [evlaV](https://gitlab.com/evlaV) - For making Valve's code available and for being [this person](https://xkcd.com/2347/).
|
||||
- [ChimeraOS](https://chimeraos.org/) - For gamescope-session and for valuable support along the way.
|
||||
- [Jovian-NixOS](https://github.com/Jovian-Experiments) - For supporting us with technical issues and for creating a similar project. Seriously, go check it out. It's our Nix-based cousin.
|
||||
- [sentry](https://copr.fedorainfracloud.org/coprs/sentry/) - For assistance with needed kernel patches and for creating the [kernel-fsync repo](https://copr.fedorainfracloud.org/coprs/sentry/kernel-fsync/) we now use.
|
||||
- [nicknamenamenick](https://github.com/nicknamenamenick) - For being the MVP nearly single-handedly upkeeping our documentation and support literature, and countless cases of helping users.
|
||||
- [Steam Deck Homebrew](https://deckbrew.xyz) - For choosing to support distributions other than SteamOS despite the extra work, and a special thanks to [PartyWumpus](https://github.com/PartyWumpus) for getting Decky Loader working with SELinux for us.
|
||||
- [cyrv6737](https://github.com/cyrv6737) - For the initial inspiration and the base that became bazzite-arch.
|
||||
|
||||
## Build Your Own
|
||||
|
||||
Bazzite is built entirely in GitHub and creating your own custom version of it is as easy as forking this repository, adding a private signing key, and enabling GitHub actions.
|
||||
|
||||
[Familiarize yourself](https://docs.github.com/en/actions/security-guides/encrypted-secrets) on keeping secrets in github. You'll need to [generate a new keypair](https://docs.sigstore.dev/cosign/overview/) with cosign. The public key can be in your public repo <sub><sup>(Your users need it to check the signatures)</sup></sub>, and you can paste the private key in `Settings -> Secrets -> Actions` with the name `SIGNING_SECRET`.
|
||||
|
||||
We also ship a config for the popular [pull app](https://github.com/apps/pull) if you'd like to keep your fork in sync with upstream. Enable this app on your repo to keep track of Bazzite changes while also making your own modifications.
|
||||
|
||||
## Join The Community
|
||||
|
||||
You can find us on the [Universal Blue Discord](https://discord.gg/f8MUghG5PB) and view the [archive](https://www.answeroverflow.com/c/1072614816579063828/1143023993041993769) of support threads without an account.
|
||||
|
||||
Discuss and create user guides over at the [Universal Blue Discourse Forums](https://universal-blue.discourse.group/c/bazzite/5).
|
||||
|
||||
Follow Universal Blue on [Mastodon](https://fosstodon.org/@UniversalBlue).
|
||||
|
||||
<hr>
|
||||
|
||||
[<**-- View updated README online**](https://github.com/ublue-os/bazzite/blob/main/README.md)
|
||||
@ -1,83 +0,0 @@
|
||||
---
|
||||
title: Bazzite and SteamOS Comparison
|
||||
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
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?
|
||||
|
||||
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
|
||||
- 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/)
|
||||
- Updating in Steam Gaming Mode will also update installed applications
|
||||
- Access to multiple desktop environments
|
||||
- KDE
|
||||
- GNOME
|
||||
- Budgie (**coming soon**)
|
||||
|
||||
## 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
|
||||
- This includes graphics drivers, the Linux kernel, and desktop environment upgrades
|
||||
- Security focused with the [Security Enhanced Linux](https://www.redhat.com/en/topics/linux/what-is-selinux) kernel module enabled by default
|
||||
- Printing support out of the box
|
||||
- Wayland is the default session for Desktop Mode
|
||||
|
||||
## 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?
|
||||
|
||||
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
|
||||
- Watchdog is disabled by default
|
||||
- Memory lock is tweaked for [RPCS3](https://rpcs3.net/)
|
||||
- Kyber I/O scheduler is used
|
||||
- File access times is disabled
|
||||
- Transparent Huge Pages is not used
|
||||
- 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).
|
||||
|
||||
# Does the Steam Deck image receive BIOS updates like SteamOS?
|
||||
|
||||
**Yes**.
|
||||
|
||||
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:
|
||||
```
|
||||
ujust disable-bios-updates
|
||||
```
|
||||
|
||||
# Why is the stock 64GB Steam Deck not supported on Bazzite?
|
||||
|
||||
It has **filesystem corruptions**.
|
||||
|
||||
You will have booting issues, freezes, and will not be able to update the image.
|
||||
|
||||
## Solution
|
||||
**At your own risk**:
|
||||
Upgrade the storage to resolve this.
|
||||
|
||||
>This [post](https://universal-blue.discourse.group/t/my-experience-using-bazzite-on-the-64gb-steam-deck/125/1) covers a detailed explanation and first-hand experience of using Bazzite on the stock 64GB Steam Deck.
|
||||
@ -1,70 +0,0 @@
|
||||
---
|
||||
title: Desktop Environment Tweaks
|
||||
|
||||
---
|
||||
|
||||
# Customizing KDE Plasma
|
||||
|
||||
>A fantastic 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.
|
||||
|
||||
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.
|
||||
|
||||
## Universal instructions for most custom themes
|
||||
|
||||
1. Download the theme manually from the [KDE Store](https://store.kde.org/browse/)
|
||||
2. Extract the contents to `~/.local/share/plasma/` (**you may need to make this directory**)
|
||||
2a. "Global themes" are placed in `~/.local/share/plasma/look-and-feel/` (**you may need to make this directory**)
|
||||
2b. "Plasma themes" are placed in `~/.local/share/plasma/desktoptheme/` (**you may need to make this directory**)
|
||||
2c. SDDM* themes are placed in `/etc/sddm/themes` (**you may need to make this directory**)
|
||||
2c1. SDDM* themes can also be layered at your own risk if they are available as RPM packages
|
||||
2d. "Icon/Cursor themes" are placed in `~/.icons`
|
||||
2da. Some Flatpaks need filesystem permissions for applications that have issues with cursor themes (`~/.icons/:ro` in "Filesystem" in each problematic application or globally in Flatseal)
|
||||
3. Open system settings and select your theme, style, cursor, etc. as it now should appear
|
||||
|
||||
**SDDM is the login manager*.
|
||||
|
||||
### 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.
|
||||
|
||||
Install it with this **command**:
|
||||
|
||||
```
|
||||
rpm-ostree install kvantum
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
[Wallpaper Engine](https://www.wallpaperengine.io/en) is a live wallpaper application intended for Windows.
|
||||
|
||||
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`)
|
||||
|
||||
>**Note**: If your session crashes, then all of your extensions will be disabled.
|
||||
|
||||
Bazzite's GNOME variant uses [Extension Manager](https://flathub.org/apps/com.mattjakeman.ExtensionManager) by Matthew Jakeman to manage the desktop extensions. The application is included by default. You can access it via the [Logo Menu](https://github.com/Aryan20/Logomenu) (thanks Aryan Kaushik!)
|
||||
|
||||
## Upstream GNOME Experience:
|
||||
|
||||
- Turn off the AppIndicator extension and the Dash to Dock extension.
|
||||
|
||||
- Hide the GSConnect and/or Tailscale extensions by toggling them on/off as well.
|
||||
|
||||
<hr>
|
||||
|
||||
# Steam Gaming Mode Tweaks (`-deck`)
|
||||
|
||||
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.
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=574)
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
title: Reset User Password
|
||||
|
||||
---
|
||||
|
||||
# Reset User Password
|
||||
|
||||
>**Attention**: Follow this guide **at your own discretion** because you can break your system attempting any of this.
|
||||
|
||||
>**Note**: Bazzite Handheld/HTPC users: Press <kbd>Esc</kbd> on a physical keyboard.
|
||||
|
||||
Reboot your device and edit the last deployment by presssing <kbd>E</kbd> on your keyboard.
|
||||
|
||||
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
|
||||
```
|
||||
2. Load SELinux policy
|
||||
```
|
||||
/sbin/load_policy
|
||||
```
|
||||
3. Enter your new password (i.e. passwd nick)
|
||||
```
|
||||
passwd [INSERT USERNAME HERE]
|
||||
```
|
||||
4. Sync
|
||||
```
|
||||
sync
|
||||
```
|
||||
5. Reboot
|
||||
```
|
||||
/sbin/reboot -ff
|
||||
```
|
||||
|
||||
Your user password should now be reset.
|
||||
|
||||
Thanks to [Colin Walters](https://github.com/cgwalters) for the [solution](https://github.com/ublue-os/main/issues/469#issuecomment-1885264886).
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Noel Miller](https://github.com/noelmiller)
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=161)
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
title: Secure Boot Guide
|
||||
|
||||
---
|
||||
|
||||
# Secure Boot Post-Installation
|
||||
|
||||
>**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**:
|
||||
```
|
||||
ujust enroll-secure-boot-key
|
||||
```
|
||||
If prompted to enroll the required key, then **enter the password in the host terminal**:
|
||||
```
|
||||
universalblue
|
||||
```
|
||||
|
||||
You can now turn Secure Boot back on in the BIOS.
|
||||
@ -1,80 +0,0 @@
|
||||
---
|
||||
title: ASUS ROG Ally
|
||||
|
||||
---
|
||||
|
||||
# ASUS ROG Ally
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
- Complete the Bazzite Portal
|
||||
- Login to Steam
|
||||
- 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)
|
||||
- Holding the Armoury Crate button (on the side) allows you to switch to Mouse Mode
|
||||
- **Optional**: Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings`
|
||||
|
||||
## 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.
|
||||
- [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.
|
||||
- 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.
|
||||
- This also affects when the ally is charging.
|
||||
- The Ally does **not support** button holding.
|
||||
- Steam Input's chords do not work by default.
|
||||
- Swapping the Start/Select button(s) is a workaround.
|
||||
- Suspend can break if SMT is disabled
|
||||
- Current issues with the Ally's BIOS may cause may cause the Ally to be stuck at 10w TDP, and won't be able to change after suspending.
|
||||
- This does not occur using SimpleDeckyTDP with [Ryzenadj](https://github.com/FlyGoat/RyzenAdj).
|
||||
- VRR may limit the FPS to 70.
|
||||
- Fix this by enabling "Force Composite" in Steam Gaming Mode under "Developer" settings.
|
||||
- Developer Mode must be turned on first.
|
||||
|
||||
<hr>
|
||||
|
||||
# TDP Controls
|
||||
|
||||
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.
|
||||
|
||||
# How do I open the HHD Overlay?
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
>**Note**: ASUS ROG Ally does not support **holding**!
|
||||
|
||||
# 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.
|
||||
|
||||
If your device has paddles, you will want to use the DualSense Edge controller. It’s disabled by default because some games do not map it correctly.
|
||||
|
||||
Some games and emulators may need Steam Input **disabled** to work correctly with your 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.
|
||||
|
||||
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.
|
||||
|
||||
Hold down the "**select**" button on your device to force a reboot. This feature can be disabled in the overlay settings.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=2414)
|
||||
@ -1,79 +0,0 @@
|
||||
---
|
||||
title: Ayaneo Handhelds
|
||||
|
||||
---
|
||||
|
||||
# Ayaneo Geek 1S
|
||||
|
||||
**Status**: Silver
|
||||
|
||||
**You will need this command for functional HHD**:
|
||||
```
|
||||
sudo systemctl enable --now hhd@$(whoami)
|
||||
```
|
||||
## 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)
|
||||
- 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.
|
||||
- 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.
|
||||
- **Suspend does not work**!
|
||||
- The screen stays up and the fans spins, the device only supports S2IDLE and needs to be investigated more with [this tool](https://gitlab.freedesktop.org/drm/amd/-/blob/master/scripts/amd_s2idle.py).
|
||||
- VRAM size option is missing from BIOS as it's controlled by AYASPACE application under windows.
|
||||
|
||||
## 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`.
|
||||
- **NVIDIA**: currently untested and probably doesn't work.
|
||||
|
||||
## 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>
|
||||
|
||||
# TDP Controls
|
||||
|
||||
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.
|
||||
|
||||
# How do I open the HHD Overlay?
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
# 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.
|
||||
|
||||
If your device has paddles, you will want to use the DualSense Edge controller. It’s disabled by default because some games do not map it correctly.
|
||||
|
||||
Some games and emulators may need Steam Input **disabled** to work correctly with your 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.
|
||||
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=2417)
|
||||
@ -1,79 +0,0 @@
|
||||
---
|
||||
title: Ayn Handhelds
|
||||
|
||||
---
|
||||
|
||||
# Ayn Loki Max
|
||||
|
||||
**Status**: Platinum
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
- Complete the Bazzite Portal
|
||||
- Login to Steam
|
||||
- Reboot device
|
||||
- Configure the HHD Overlay by opening it with QAM button
|
||||
- **Optional**: Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings`
|
||||
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
|
||||
|
||||
## 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.
|
||||
- Back buttons are hard mapped to L3 and R3.
|
||||
- This is also an issue on Windows.
|
||||
|
||||
# Ayn Loki Mini Pro
|
||||
|
||||
**Status**: Silver
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
- Complete the Bazzite Portal
|
||||
- Login to Steam
|
||||
- Reboot device
|
||||
- Configure the HHD Overlay by opening it with QAM button
|
||||
- **Optional**: Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings`
|
||||
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode (See "Desktop Controls" section below)
|
||||
|
||||
## 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.
|
||||
- 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.
|
||||
- Rotation is wrong in Desktop Mode for KDE images.
|
||||
- Mouse input may break in Desktop Mode.
|
||||
|
||||
<hr>
|
||||
|
||||
# TDP Controls
|
||||
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.
|
||||
|
||||
# How do I open the HHD Overlay?
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
# 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.
|
||||
|
||||
If your device has paddles, you will want to use the DualSense Edge controller (**excluding the Ayn Loki**). It’s disabled by default because some games do not map it correctly.
|
||||
|
||||
Some games and emulators may need Steam Input **disabled** to work correctly with your 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.
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=2416)
|
||||
@ -1,93 +0,0 @@
|
||||
---
|
||||
title: GPD Handhelds
|
||||
|
||||
---
|
||||
|
||||
# GPD Win 4
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
## 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)
|
||||
- <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.
|
||||
|
||||
## 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.
|
||||
- Fix controls and gyro after suspend-resume cycles (confirmed to work on both the 7840u and 6800u variants).
|
||||
- Run these [commands](https://github.com/aarron-lee/gpd-win-tricks/blob/df0cb72ee11cfd0ba30c8bcffe0e395b99b713d3/win4-gyro-suspend-fix/README.md) in a host terminal.
|
||||
|
||||
## 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
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
## 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)
|
||||
- <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.
|
||||
|
||||
## 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.
|
||||
- Fix controls and gyro after suspend-resume cycles (confirmed to work on both the 7840u and 6800u variants).
|
||||
- Run these [commands](https://github.com/aarron-lee/gpd-win-tricks/blob/df0cb72ee11cfd0ba30c8bcffe0e395b99b713d3/win4-gyro-suspend-fix/README.md) in a host terminal.
|
||||
|
||||
## 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>
|
||||
|
||||
# TDP Controls
|
||||
|
||||
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.
|
||||
|
||||
# How do I open the HHD Overlay?
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
>**Note**: GPD devices do not support double-tapping!
|
||||
|
||||
# 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.
|
||||
|
||||
If your device has paddles, you will want to use the DualSense Edge controller. It's disabled by default because some games do not map it correctly.
|
||||
|
||||
Some games and emulators may need Steam Input **disabled** to work correctly with your 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.
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=2418)
|
||||
@ -1,62 +0,0 @@
|
||||
---
|
||||
title: General Handheld Information
|
||||
|
||||
---
|
||||
|
||||
# Handheld Compatibility
|
||||
|
||||
> This list is incomplete and does not indicate that unlisted handhelds do not work with Bazzite currently, but because we lack specific information regarding their post-installation setup, workarounds, and proper support they are unlisted here.
|
||||
|
||||
- Steam Deck
|
||||
- Lenovo Legion Go
|
||||
- ASUS ROG Ally
|
||||
- Ayn Handhelds
|
||||
- GPD Handhelds
|
||||
- Ayaneo Handhelds
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
* **Platinum**: No major issues and/or simple workarounds are needed for small fixes.
|
||||
* **Gold**: Minor issues and/or simple workarounds required, but ultimately works.
|
||||
* **Silver**: Major issues and/or exhaustive workarounds required, but boots and can game.
|
||||
* **Bronze**: Major issues and/or exhaustive workarounds, but boots and displays a desktop.
|
||||
* **Borked**: Bazzite does not boot on this hardware.
|
||||
* **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.
|
||||
|
||||
**Read the [HHD README](https://github.com/hhd-dev/hhd/blob/master/readme.md) for more information.**
|
||||
|
||||
1. Double press side menu button to access Handheld Daemon overlay in Steam Gaming Mode
|
||||
2. Select the controller emulation and RGB color you want
|
||||
2a. Gyro functionality **requires** DualSense emulation
|
||||
|
||||
|
||||
# Decky Plugins
|
||||
|
||||
>**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.
|
||||
|
||||
# eGPU Support
|
||||
|
||||
>eGPU is **not** a fully supported feature and has many caveats.
|
||||
|
||||
- Modern AMD GPUs *should* work.
|
||||
- Nvidia GPUs are most completely unsupported.
|
||||
- Proprietary connectors, like the one for the ASUS ROG Ally, will not work.
|
||||
|
||||
**Recommended Script**:
|
||||
https://github.com/ewagner12/all-ways-egpu
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Antheas Kapenekakis](https://github.com/antheas), [Aarron Lee](https://github.com/aarron-lee), and [Zetarancio](https://universal-blue.discourse.group/u/zetarancio)
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=1038)
|
||||
@ -1,83 +0,0 @@
|
||||
---
|
||||
title: Lenovo Legion Go
|
||||
|
||||
---
|
||||
|
||||
# Lenovo Legion Go
|
||||
|
||||
- **Status**: Platinum
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
Open a host terminal and enter the following **commands**:
|
||||
|
||||
- Complete the Bazzite Portal
|
||||
- Login to Steam
|
||||
- Reboot device
|
||||
- Configure the HHD Overlay by opening it with <kbd>Legion R</kbd>
|
||||
- **Optional**: Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings`
|
||||
|
||||
## 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.
|
||||
- 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.
|
||||
- BIOS and controller firmware **require** Windows to update them.
|
||||
- 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.
|
||||
- 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
|
||||
mv ~/.config/kwinoutputconfig.json ~/.config/kwinoutputconfig.json.old
|
||||
```
|
||||
|
||||
## External Resource
|
||||
|
||||
For more information, check out the [Legion Go Tips and Tricks guide](https://github.com/aarron-lee/legion-go-tricks) which includes useful scripts for this handheld.
|
||||
|
||||
<hr>
|
||||
|
||||
# TDP Controls
|
||||
|
||||
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.
|
||||
|
||||
# How do I open the HHD Overlay?
|
||||
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
>**Example**: <kbd>Legion R</kbd> for the Lenovo Legion Go.
|
||||
|
||||
# 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.
|
||||
|
||||
If your device has paddles, you will want to use the DualSense Edge controller. It’s disabled by default because some games do not map it correctly.
|
||||
|
||||
Some games and emulators may need Steam Input **disabled** to work correctly with your 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.
|
||||
|
||||
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.
|
||||
|
||||
Hold down the "**select**" button on your device to force a reboot. This feature can be disabled in the overlay settings.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=2413)
|
||||
@ -1,60 +0,0 @@
|
||||
---
|
||||
title: Other Handhelds
|
||||
|
||||
---
|
||||
|
||||
# Other Handhelds
|
||||
|
||||
>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.
|
||||
|
||||
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**:
|
||||
**Test HHD**:
|
||||
|
||||
```
|
||||
systemctl start hhd@yourusername
|
||||
```
|
||||
|
||||
If the test is successful:
|
||||
|
||||
```
|
||||
systemctl enable hhd@yourusername
|
||||
```
|
||||
>**Note**: Replace `yourusername` with your Bazzite username.
|
||||
|
||||
<hr>
|
||||
|
||||
# TDP Controls
|
||||
|
||||
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.
|
||||
|
||||
# How do I open the HHD Overlay?
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
# 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.
|
||||
|
||||
If your device has paddles, you will want to use the DualSense Edge controller (**except for a few like the Ayn Loki**). It’s disabled by default because some games do not map it correctly.
|
||||
|
||||
Some games and emulators may need Steam Input **disabled** to work correctly with your 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.
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=2415)
|
||||
@ -1,40 +0,0 @@
|
||||
---
|
||||
title: Steam Deck
|
||||
|
||||
---
|
||||
|
||||
# Steam Deck LCD (256GB+)
|
||||
|
||||
- **Status**: Platinum
|
||||
|
||||
## 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.
|
||||
|
||||
# Steam Deck OLED
|
||||
|
||||
- **Status**: Gold
|
||||
|
||||
## 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.
|
||||
|
||||
## Workarounds / Known Issues
|
||||
|
||||
- Similar to using Bazzite on the Steam Deck LCD, but currently suffers from the following:
|
||||
- Installer requires **Basic Graphics Mode**.
|
||||
|
||||
<hr>
|
||||
|
||||
[View online documentation](https://universal-blue.discourse.group/docs?topic=1849)
|
||||
|
||||
@ -1,173 +0,0 @@
|
||||
---
|
||||
title: Steam Gaming Mode Common Issues
|
||||
|
||||
---
|
||||
|
||||
# How do I open the on-screen 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
|
||||
|
||||
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**:
|
||||
|
||||
```
|
||||
ujust update
|
||||
```
|
||||
|
||||
## Changelog
|
||||
|
||||
The changelog is specifically for SteamOS by Valve, so the upgrade for Bazzite may not apply. Check out our [newsletters](https://universal-blue.discourse.group/docs?topic=2252) for major changes and features. If you want to see the patch notes in real time, check the newest [commits](https://github.com/ublue-os/bazzite/commits/main) on Github.
|
||||
|
||||
View a changelog to the next update in the terminal by **entering**:
|
||||
```
|
||||
ujust changelogs
|
||||
```
|
||||
|
||||
# How do I access GRUB?
|
||||
[GRUB](https://www.gnu.org/software/grub/manual/grub/grub.html#Overview) is hidden by default.
|
||||
|
||||
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.
|
||||
|
||||
# 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
|
||||
|
||||
`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.
|
||||
|
||||
you can add this to `~/.config/environment.d/10-gamescope-session.conf`
|
||||
If the file or folder does not exist... make them
|
||||
|
||||
This works on desktop mode for things running in nested gamescope and also works for gamescope-session, but it has its own quirks (like `altgr+2` to write `@` 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 `altgr` has been reported to work on the French layout, your mileage may vary)
|
||||
|
||||
# Why do specific Decky Loader plugins not function on Bazzite?
|
||||
|
||||
- Bazzite does not provide the functionality.
|
||||
- [PauseGames](https://github.com/popsUlfr/SDH-PauseGames) requires a swapfile while Bazzite utilizes zram for example.
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
You can find your display outputs in GNOME using this command
|
||||
|
||||
```
|
||||
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?
|
||||
|
||||
1. Open a TTY session with an **external physical keyboard** using this **keyboard combination**:
|
||||
<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F4</kbd>
|
||||
|
||||
```
|
||||
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.
|
||||
|
||||
# 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.
|
||||
|
||||
# How do I disable certain "Steam Deck" features that conflict with my setup?
|
||||
|
||||
**Scenarios**:
|
||||
- *Example 1*: Keyboard and mouse is not working for this title.
|
||||
- *Example 2*: The game's launcher for adjusting video settings or adding mods does not launch.
|
||||
- *Example 3*: Certain features/options are not available for Steam Deck.
|
||||
|
||||
Open the game's properties on Steam and **enter this launch option**:
|
||||
|
||||
```
|
||||
SteamDeck=0 %command%
|
||||
```
|
||||
|
||||
# Stuck at the Bazzite logo
|
||||
|
||||
>**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`
|
||||
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
|
||||
4. Exit the TTY session by entering this **keyboard combination**: <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>F2</kbd>
|
||||
|
||||
# "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.
|
||||
|
||||
# Audio output not working (Default Device)
|
||||
|
||||
>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.
|
||||
|
||||
# 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
|
||||
|
||||
```
|
||||
[Desktop Entry]
|
||||
Name=Return to Gaming Mode
|
||||
Exec=qdbus org.kde.Shutdown /Shutdown org.kde.Shutdown.logout
|
||||
Icon=steamdeck-gaming-return
|
||||
Terminal=false
|
||||
Type=Application
|
||||
StartupNotify=false
|
||||
```
|
||||
|
||||
## GNOME
|
||||
|
||||
```
|
||||
[Desktop Entry]
|
||||
Name=Return to Gaming Mode
|
||||
Exec=gnome-session-quit --logout --no-prompt
|
||||
Icon=steamdeck-gaming-return
|
||||
Terminal=false
|
||||
Type=Application
|
||||
StartupNotify=false
|
||||
```
|
||||
|
||||
Save it and place it in the `Desktop` directory.
|
||||
|
||||
<hr>
|
||||
|
||||
<-- [**View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=37)
|
||||
@ -1,32 +0,0 @@
|
||||
---
|
||||
title: Steam Gaming Mode Overview
|
||||
|
||||
---
|
||||
|
||||
# What is Steam Gaming Mode?
|
||||
|
||||
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.
|
||||
|
||||
# What are the HTPC/Handheld Images?
|
||||
|
||||
>**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.
|
||||
|
||||
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.
|
||||
|
||||
Bazzite's 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, 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>
|
||||
|
||||
# Valve's Official SteamOS Guide
|
||||
|
||||
>**Note**: Not all of the information will be accurate in regards to Bazzite.
|
||||
|
||||
https://help.steampowered.com/en/faqs/view/7DD4-C618-182E-0E49
|
||||
|
||||
<hr>
|
||||
|
||||
<-- [**View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=37)
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
title: AppImage
|
||||
|
||||
---
|
||||
|
||||
>**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.
|
||||
|
||||
# Gear Lever
|
||||
|
||||
Applications installed as an AppImage can integrate with your desktop and be managed with [Gear Lever](https://github.com/mijorus/gearlever) which is pre-installed on Bazzite.
|
||||
|
||||
# Project Website
|
||||
|
||||
https://appimage.org/
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2641)
|
||||
@ -1,82 +0,0 @@
|
||||
---
|
||||
title: Distrobox
|
||||
|
||||
---
|
||||
|
||||
# What is Distrobox?
|
||||
|
||||
Run other minimal variants of popular Linux distributions in Bazzite inside of a container, and access each distribution's packages without any of their dependencies and libraries affecting the host machine.
|
||||
|
||||
**Important Notes**:
|
||||
- Containers are **not** virtual machines.
|
||||
- Containers are intended to be **disposable** and may run into issues where they need to be recreated.
|
||||
- Using this method to obtain software **requires knowledge of how traditional Linux operating systems install packages**.
|
||||
- Create a test container to familiarize yourself with basic Linux commands before diving in further.
|
||||
|
||||
Distrobox containers run sub-systems of other popular [Linux distributions](https://distrobox.it/compatibility/#containers-distros) with access to their package managers (`apt`, `dnf`, `pacman`, etc.) and their package formats (`.deb`/`.rpm`) and any additional repositories like the [AUR](https://aur.archlinux.org/).
|
||||
|
||||
**Linux Distribution Examples**:
|
||||
|
||||
| OS | Package Manager | Search for Packages
|
||||
| -------- | -------- | --------
|
||||
| [Fedora](https://fedoraproject.org/) | [`dnf`](https://docs.fedoraproject.org/en-US/quick-docs/dnf/) | [Fedora Packages](https://packages.fedoraproject.org/index-static.html) / [COPR Packages](https://copr.fedorainfracloud.org/)
|
||||
| [Arch Linux](https://archlinux.org/)| [`pacman`](https://wiki.archlinux.org/title/Pacman) | [Arch Linux Packages](https://archlinux.org/packages/) / [AUR Packages](https://aur.archlinux.org/)
|
||||
| [Debian](https://www.debian.org/) / [Ubuntu](https://ubuntu.com/) | [`apt`](https://ubuntu.com/server/docs/package-management) | [Debian Packages](https://packages.debian.org/stable/) / [Ubuntu Packages](https://packages.ubuntu.com/) ([PPA](https://launchpad.net/ubuntu/+ppas))
|
||||
| [openSUSE](https://get.opensuse.org/)| [`zypper`](https://documentation.suse.com/smart/systems-management/html/concept-zypper/index.html) | [openSUSE Packages](https://search.opensuse.org/packages/)
|
||||
| [Void Linux](https://voidlinux.org/) | [`xbps`](https://docs.voidlinux.org/xbps/index.html) | [Void Linux Packages](https://voidlinux.org/packages/)
|
||||
| [Alpine Linux](https://www.alpinelinux.org/) | [`apk`](https://wiki.alpinelinux.org/wiki/Alpine_Package_Keeper) | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages)
|
||||
|
||||
# Use Cases
|
||||
|
||||
Distrobox containers can be used for both **development environments** and **installing applications that are not available in any of the other installation methods** which can be exclusive to specific package managers.
|
||||
|
||||
# Distrobox Graphical Interface
|
||||
|
||||
Distrobox containers can be created and managed graphically with [BoxBuddy](https://github.com/Dvlv/BoxBuddyRS) which is pre-installed.
|
||||
|
||||
# Desktop Integration
|
||||
|
||||
Applications with a graphical user interface can integrate with your system with an application shortcut **entering this command inside of the container**:
|
||||
|
||||
```bash
|
||||
distrobox-export --app <package>
|
||||
```
|
||||
|
||||
>Read our [Ptyxis documentation](https://universal-blue.discourse.group/docs?topic=300) on how containers integrate with your system.
|
||||
|
||||
# Manually Create Pre-Configured Distrobox Containers
|
||||
|
||||
```
|
||||
ujust distrobox-assemble
|
||||
```
|
||||
Select the container that you want to use.
|
||||
|
||||
>**Advanced users**: Declare your own custom Distrobox containers following the [`distrobox-assemble` documentation](https://distrobox.it/usage/distrobox-assemble/).
|
||||
|
||||
## Entering The Container
|
||||
|
||||
Swap between different containers in your host with the terminal or alternatively **enter**:
|
||||
```
|
||||
distrobox enter <container>
|
||||
```
|
||||
|
||||
## Removing Distrobox Containers
|
||||
|
||||
Delete containers graphically with BoxBuddy.
|
||||
|
||||
Alternatively, use the **command line**:
|
||||
|
||||
```command
|
||||
distrobox stop <container_name>
|
||||
```
|
||||
```commmand
|
||||
distrobox rm -f <container_name>
|
||||
```
|
||||
|
||||
# Project Website
|
||||
|
||||
https://distrobox.it/
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2640)
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: Flatpak
|
||||
|
||||
---
|
||||
|
||||
# What is Flatpak?
|
||||
|
||||
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.
|
||||
|
||||
# Installing Flatpaks
|
||||
|
||||
Flatpaks can be installed via the software center of the desktop environment you chose.
|
||||
|
||||
**Alternatively open a host terminal and enter**:
|
||||
```
|
||||
flatpak install <application>
|
||||
```
|
||||
|
||||
# Flatpak Remotes
|
||||
|
||||
Flatpaks can be hosted anywhere, but by default Bazzite ships with the [Flathub](https://flathub.org/) remote which is a centralized repository of Linux applications.
|
||||
|
||||
The Flathub App Store is the definitive Linux app store and several Linux operating systems like SteamOS and Linux Mint ship with full support for it.
|
||||
|
||||
### 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.
|
||||
|
||||
Read more about system versus user Flathub remotes in the [upstream documentation](https://docs.flathub.org/docs/for-users/user-vs-system-install/).
|
||||
|
||||
### Manage Flatpaks
|
||||
|
||||
Manage Flatpaks with [Flatseal](https://github.com/tchx84/Flatseal) and [Warehouse](https://github.com/flattool/warehouse) which are both pre-installed.
|
||||
|
||||
## Flatseal
|
||||
|
||||
**Flatseal** is for changing [application permissions](https://github.com/tchx84/Flatseal/blob/92e675e5ad2129f2aabf324261570eef442494f6/DOCUMENTATION.md) if necessary.
|
||||
|
||||
Alternatively, use KDE Plasma's system settings has application permissions to adjust too on KDE Plasma images.
|
||||
|
||||
## Warehouse
|
||||
|
||||
**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>
|
||||
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2636)
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Homebrew
|
||||
|
||||
---
|
||||
|
||||
# What is Homebrew?
|
||||
|
||||
>**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.
|
||||
|
||||
Install packages in a host terminal with this **command**:
|
||||
|
||||
```
|
||||
brew install <package>
|
||||
```
|
||||
|
||||
# Project Website
|
||||
|
||||
https://brew.sh/
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2639)
|
||||
@ -1,32 +0,0 @@
|
||||
---
|
||||
title: Steam Gaming Mode Overview
|
||||
|
||||
---
|
||||
|
||||
# What is Steam Gaming Mode?
|
||||
|
||||
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.
|
||||
|
||||
# What are the HTPC/Handheld Images?
|
||||
|
||||
>**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.
|
||||
|
||||
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.
|
||||
|
||||
Bazzite's 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, 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>
|
||||
|
||||
# Valve's Official SteamOS Guide
|
||||
|
||||
>**Note**: Not all of the information will be accurate in regards to Bazzite.
|
||||
|
||||
https://help.steampowered.com/en/faqs/view/7DD4-C618-182E-0E49
|
||||
|
||||
<hr>
|
||||
|
||||
<-- [**View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=37)
|
||||
@ -1,126 +0,0 @@
|
||||
---
|
||||
title: Waydroid Setup Guide
|
||||
|
||||
---
|
||||
|
||||
|
||||
# What is Waydroid?
|
||||
|
||||
>**Note**: Waydroid does **not** work on Nvidia's proprietary drivers, and requires an AMD or Intel GPU for the best results.
|
||||
|
||||
[Waydroid](https://waydro.id/) is an Android container that runs on Linux. Bazzite users can run Android applications using this method.
|
||||
|
||||
|
||||
# First Time Setup
|
||||
|
||||
Open a host terminal and **enter this command to setup Waydroid**:
|
||||
|
||||
```bash
|
||||
ujust setup-waydroid
|
||||
```
|
||||
|
||||
## Initialize Waydroid
|
||||
|
||||
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**:
|
||||
|
||||
```bash
|
||||
/usr/bin/waydroid-launcher
|
||||
```
|
||||
This will launch Waydroid for the first time.
|
||||
|
||||
## Configure Waydroid
|
||||
|
||||
### Part 1: Stop Waydroid Session
|
||||
|
||||
Waydroid needs to stop running to configure properly.
|
||||
|
||||
Open a host terminal and enter this **command**:
|
||||
|
||||
```
|
||||
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**)
|
||||
2. Select items to install
|
||||
a) [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)
|
||||
b) ARM Translation (*libndk* for **AMD CPUs** & *libhoudini* for **Intel CPUs**)
|
||||
c) [Magisk](https://github.com/topjohnwu/Magisk) (Android power user suite)
|
||||
d) [Logitech Smartdock Support](https://support.logi.com/hc/en-us/articles/360023201574-What-is-SmartDock) (Currently broken)
|
||||
e) [F-Droid Privileged Extension](https://f-droid.org/packages/org.fdroid.fdroid.privileged/) (Proper [F-Droid](https://f-droid.org/en/packages/) support)
|
||||
f) [widevine](https://widevine.com/) (Support for video streaming DRM)
|
||||
|
||||
|
||||
### Get Google Device ID to Get Certified
|
||||
|
||||
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).
|
||||
|
||||
3. Follow the instructions in the terminal output.
|
||||
|
||||
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.](https://universal-blue.discourse.group/docs?topic=37)
|
||||
|
||||
Make sure to add the .desktop shortcut in `/usr/bin/waydroid-launcher` for Waydroid to work properly in Steam Gaming Mode.
|
||||
|
||||
|
||||
# Resolution & Density Options
|
||||
|
||||
>**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**:
|
||||
|
||||
```bash
|
||||
sudoedit /etc/default/waydroid-launcher
|
||||
```
|
||||
|
||||
```bash
|
||||
sudoedit /etc/default/steamos-nested-desktop
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
**Enter in a host terminal**:
|
||||
|
||||
```
|
||||
ujust setup-waydroid
|
||||
```
|
||||
|
||||
Then `Select GPU for Waydroid` which will give the option on what GPU to utilize for Waydroid to fix graphical corruptions.
|
||||
|
||||
# Reset Waydroid
|
||||
|
||||
>**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**:
|
||||
|
||||
```
|
||||
ujust setup-waydroid
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospo](https://github.com/KyleGospo), [Gecked-Deck](https://github.com/Gecked-Deck), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
|
||||
|
||||
See also: [Upstream documentation](https://docs.waydro.id/)
|
||||
|
||||
[**<-- View online documentation**](https://universal-blue.discourse.group/docs?topic=32)
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
title: 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.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=35)
|
||||
@ -1,94 +0,0 @@
|
||||
---
|
||||
title: rpm-ostree
|
||||
|
||||
---
|
||||
|
||||
# `rpm-ostree` Overview
|
||||
|
||||
>**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**.
|
||||
|
||||
Install Fedora Linux packages by installing them with `rpm-ostree`.
|
||||
|
||||
- This is known as "layering packages" to the image.
|
||||
- Layering packages will **require** a system reboot when it finishes creating the new deployment with the package(s) added to your image.
|
||||
- Use this method as a **last resort** and for anything at a "system-level" only.
|
||||
|
||||
### Common `rpm-ostree` Terminal Commands:
|
||||
|
||||
```
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
# How do I install [COPR](https://copr.fedorainfracloud.org) repositories?
|
||||
|
||||
>**Note**: It is highly advised to **not** use third-party COPR repos if you can, but if you do realize there are risks associated with it.
|
||||
|
||||
1. Download the .repo file and save it to `/etc/yum.repos.d/`
|
||||
|
||||
2. Then install the package with `rpm-ostree`
|
||||
|
||||
3. Reboot
|
||||
|
||||
If you experience issues updating your system due to GPG signature issues, then this can be fixed by either removing the COPR repository, or editing the file by changing `gpgcheck=1` to `gpgcheck=0` (or similar) and saving it **at your own risk**.
|
||||
|
||||
There is also an experimental `copr` utility script that ships with Bazzite. Run `copr --help` in the terminal for to see usage documentation, and the source code for the helper script can be found [here](https://github.com/ublue-os/COPR-command).
|
||||
|
||||
# **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 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.
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
# Image Information
|
||||
|
||||
See information about image build date, update channel, layered packages, etc. by **entering this command in a host terminal**:
|
||||
|
||||
```
|
||||
rpm-ostree status
|
||||
```
|
||||
|
||||
# Project Website
|
||||
|
||||
https://coreos.github.io/rpm-ostree/
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2642)
|
||||
@ -1,77 +0,0 @@
|
||||
---
|
||||
title: ujust
|
||||
|
||||
---
|
||||
|
||||
# What is `ujust`?
|
||||
|
||||
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 too included here, so run `ujust` commands **at your own risk.**
|
||||
|
||||
## Using `ujust`
|
||||
|
||||
Open a host terminal and **enter**:
|
||||
|
||||
```
|
||||
ujust
|
||||
```
|
||||
This will output a list of available commands.
|
||||
|
||||
```
|
||||
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.
|
||||
|
||||
## Manually Entering Commands
|
||||
|
||||
**Find the command you want to use and enter**:
|
||||
```
|
||||
ujust <command>
|
||||
```
|
||||
|
||||
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`
|
||||
|
||||
# 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>
|
||||
```
|
||||
|
||||
Alternatively, you can find the `ujust` commands locally in:
|
||||
`/usr/share/ublue-os/just`
|
||||
|
||||
# Uninstalling Applications Installed w/ `ujust`
|
||||
|
||||
Most applications installed via a `ujust` script would have to be uninstalled manually. Follow the instructions found on the project's website or repository online to uninstall it properly.
|
||||
|
||||
This **command** Shows layered packages that may be installed from the Bazzite Portal and using `ujust`:
|
||||
```
|
||||
rpm-ostree status
|
||||
````
|
||||
|
||||
# Project Website
|
||||
|
||||
https://just.systems/
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [HikariKnight](https://github.com/HikariKnight)
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2638)
|
||||
@ -1,109 +0,0 @@
|
||||
---
|
||||
title: Rebasing Guide
|
||||
|
||||
---
|
||||
|
||||
# What is Rebasing?
|
||||
|
||||
>**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.
|
||||
|
||||
**It is recommended to use the Bazzite Rollback Helper utility**.
|
||||
|
||||
# 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 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**:
|
||||
```
|
||||
rpm-ostree status
|
||||
```
|
||||
Check under "Deployments:" and the output should be similar to:
|
||||
|
||||
> **● ostree-image-signed:docker://ghcr.io/ublue-os/[*image*]:[*channel*]**
|
||||
|
||||
Switch to another Bazzite variant by entering the command for each specific image.
|
||||
|
||||
Open the terminal and **enter**:
|
||||
```
|
||||
rpm-ostree rebase <image>
|
||||
```
|
||||
|
||||
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**.
|
||||
|
||||
# How do I change the Bazzite's update branch? (Stable, Testing, and Unstable)
|
||||
|
||||
There are 3 branches you can switch to:
|
||||
|
||||
- Stable (`:stable`)
|
||||
- Default branch that's used in normal Bazzite installations
|
||||
- Testing (`:testing`)
|
||||
- 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
|
||||
- Unstable (`:unstable`) **(DO NOT USE**)
|
||||
- **Not recommended**
|
||||
- Testing playground for developers/contributors
|
||||
- Can be **several months behind** compared to both `:stable` and `:testing` updates
|
||||
- Intended for testing desktop environments and other radically changed functionality to Bazzite for the future
|
||||
|
||||
Handheld/HTPC images can switch branches in `Settings > System > OS Update Channel` in Steam Gaming Mode.
|
||||
|
||||
If you enabled **advanced update channel**, then additional options will appear. The options map as the following:
|
||||
|
||||
```
|
||||
Stable (:stable)
|
||||
Release Candidate (:testing)
|
||||
Beta (:testing)
|
||||
Beta Candidate (:unstable)
|
||||
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**:
|
||||
```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.
|
||||
|
||||
>**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.
|
||||
|
||||
- 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.
|
||||
|
||||
- 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.
|
||||
|
||||
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**:
|
||||
|
||||
```
|
||||
ostree-image-signed:docker://ghcr.io/ublue-os/IMAGE-NAME:VERSION-YEARMONTHDAY
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2646)
|
||||
@ -1,68 +0,0 @@
|
||||
---
|
||||
title: System Rollbacks
|
||||
|
||||
---
|
||||
|
||||
# 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**:
|
||||
```
|
||||
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.
|
||||
|
||||
## Unhide The GRUB Menu on Handheld/HTPC Images
|
||||
|
||||
Handheld/HTPC images do **not** show the GRUB menu at boot by default, and controls may vary with different handheld or HTPC hardware to unhide the menu.
|
||||
|
||||
Unhide GRUB on Handheld/HTPC images with this **command**:
|
||||
|
||||
```
|
||||
ujust configure-grub
|
||||
```
|
||||
Select the "**unhide**" opiton to have GRUB appear on boot.
|
||||
|
||||
# How do I save my **current** deployment?
|
||||
|
||||
You can pin your **current** deployment with this **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.
|
||||
|
||||
# How do I save my **previous** deployment?
|
||||
|
||||
You can pin your **previous** deployment with this **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:
|
||||
```
|
||||
sudo ostree admin pin --unpin 0
|
||||
```
|
||||
|
||||
Unpin saved **previous** deployment:
|
||||
|
||||
```
|
||||
sudo ostree admin pin --unpin 1
|
||||
```
|
||||
|
||||
View all deployment index numbers:
|
||||
|
||||
```
|
||||
rpm-ostree status -v
|
||||
```
|
||||
|
||||
Unpin **saved** deployment:
|
||||
```
|
||||
sudo ostree admin pin --unpin <index number>
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2644)
|
||||
@ -1,94 +0,0 @@
|
||||
---
|
||||
title: Updating Guide
|
||||
|
||||
---
|
||||
|
||||
# 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).
|
||||
|
||||
## Desktop Images
|
||||
|
||||
- System updates happen **automatically daily** on a schedule and when the hardware is not under heavy use, like playing video games.
|
||||
- There is a check in-place to only update the image when your CPU, battery, and RAM usage meets certain requirements.
|
||||
- Updates will be downloaded in the background and will **apply on the next reboot** and should contain the newest build of Bazzite.
|
||||
|
||||
## 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.
|
||||
- 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](https://universal-blue.discourse.group/docs?topic=37).
|
||||
|
||||
# How do I update manually on Desktop images?
|
||||
|
||||
**Note**: `rpm-ostree` does not show a progress indicator for system updates and may appear frozen, but it is not.
|
||||
|
||||
- You can force an update with the System Update tool at your own convenience.
|
||||
- Reboot your device after it has finished.
|
||||
- This upgrades system packages, containers, and installed applications.
|
||||
|
||||
## Terminal command to update manually:
|
||||
```
|
||||
ujust update
|
||||
```
|
||||
**Note**: This manual method also works in Desktop Mode on Handheld/HTPC images too
|
||||
|
||||
## Do I have to reboot after every system update?
|
||||
**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**:
|
||||
|
||||
```
|
||||
ujust changelogs
|
||||
```
|
||||
|
||||
If you want to see what packages were upgraded/downgraded then enter this **command**:
|
||||
|
||||
```
|
||||
rpm-ostree db diff
|
||||
```
|
||||
|
||||
If the package update contains a formal changelog:
|
||||
|
||||
```
|
||||
rpm-ostree db diff --changelogs
|
||||
```
|
||||
|
||||
# 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.
|
||||
|
||||
# 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.
|
||||
|
||||
# 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`
|
||||
|
||||
3. Save the file as `/etc/ublue-update/ublue-update.toml`
|
||||
|
||||
Notifications for updates are now active.
|
||||
|
||||
# How do I disable automatic updates for Desktop images?
|
||||
|
||||
- `systemctl disable ublue-update.timer` - Disable automatic updates
|
||||
- `systemctl enable ublue-update.timer` - Enable automatic updates
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2637)
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: bazzite-rollback-helper
|
||||
|
||||
---
|
||||
|
||||
>**Warning**: This utility is considered **experimental** however it is recommended to use this over manual rebase commands.
|
||||
|
||||
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**.
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View online Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=2647)
|
||||
Loading…
x
Reference in New Issue
Block a user