docs: Migrate docs to a separate repo (#1668)
* ci(docs): Remove deploy docs action See issue #1667 * ci(docs): Adapt offline docs step in build to pull from new docs repo See issue #1667 * docs: Move docs to new repo See issue #1667 * docs: Replace links from ublue-os.github.io/bazzite to docs.bazzite.gg See issue #1667 * docs: Add readme with link pointing to new documentation repo
2
.github/workflows/build.yml
vendored
@ -139,6 +139,8 @@ jobs:
|
||||
|
||||
# Prepare offline documentation
|
||||
- run: mkdir -p ${{ github.workspace }}/system_files/desktop/shared/usr/share/ublue-os/docs/html
|
||||
- name: Checkout docs repo
|
||||
run: git clone https://github.com/KyleGospo/docs.bazzite.gg.git ${{ github.workspace }}/docs
|
||||
- name: Build offline documentation
|
||||
uses: ./.github/workflows/build_mkdocs
|
||||
continue-on-error: true
|
||||
|
98
.github/workflows/deploy_docs.yml
vendored
@ -1,98 +0,0 @@
|
||||
name: Deploy documentation
|
||||
|
||||
# Check for reference:
|
||||
# https://github.com/s1rius/ezlog/blob/20dce11e6d324bb18f57dc7c7c6d4a8bf40064de/.github/workflows/publish_pages.yml
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "40 03 */2 * *" # Runs at 03:40, every 2 days
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- docs/**
|
||||
- .github/workflows/deploy_docs.yml
|
||||
- README*.md
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: pages
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
runner: ubuntu-latest
|
||||
cache-mkdocs-key: cache-mkdocs
|
||||
SITE_SUFFIX: /bazzite/
|
||||
REPO_URL: ${{ github.server_url }}/${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
permissions:
|
||||
contents: read # To push a branch
|
||||
pages: write # To push to a GitHub Pages site
|
||||
id-token: write # To update the deployment status
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
# environment:
|
||||
# name: github-pages
|
||||
# url: ${{ steps.deployment.outputs.page_url }}
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./docs
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Prepare env vars
|
||||
run: |
|
||||
_OWNER_NAME=${{ github.repository_owner }}
|
||||
_OWNER_NAME=${_OWNER_NAME,,}
|
||||
_SITE_PREFIX=${{ env.SITE_SUFFIX }}
|
||||
_SITE_PREFIX=${_SITE_PREFIX#/}
|
||||
echo "SITE_URL=https://${_OWNER_NAME}.github.io/$_SITE_PREFIX" >> $GITHUB_ENV
|
||||
|
||||
# Necessary in order to have fetch_discourse_md.py available for mdbook-cmd
|
||||
- name: Add docs/utils to PATH
|
||||
run: |
|
||||
echo $PWD/utils:$PATH >> $GITHUB_PATH
|
||||
|
||||
- name: Build book
|
||||
uses: ./.github/workflows/build_mkdocs
|
||||
with:
|
||||
site_url: ${{ env.SITE_URL }}
|
||||
repo_url: ${{ env.REPO_URL }}
|
||||
working_dir: ${{ github.workspace }}/docs
|
||||
output_dir: ${{ github.workspace }}/book
|
||||
upload_github_page: "true"
|
||||
github_token: ${{ github.token }}
|
||||
|
||||
clean_cache:
|
||||
needs: deploy
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
actions: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Cache Cleanup
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
set -x
|
||||
old_caches=($(gh cache list \
|
||||
--repo ${{ github.repository }} \
|
||||
--key "${{ runner.os }}-build-${{ env.cache-mkdocs-key }}-" \
|
||||
--sort created_at -O asc --json id | jq '.[:-1][].id'))
|
||||
for id in "${old_caches[@]}"; do
|
||||
gh cache delete $id
|
||||
done
|
||||
- name: Remove Page Artifacts
|
||||
uses: remagpie/gha-remove-artifact@v1
|
||||
with:
|
||||
only-name: github-pages
|
||||
max-age: 7776000 # 90 days
|
||||
max-count: 50
|
16
README-BR.md
@ -64,7 +64,7 @@ O Bazzite é feito a partir do [ublue-os/main](https://github.com/ublue-os/main)
|
||||
- Usa o [controle de congestionamento TCP BBR da Google](https://github.com/google/bbr) por padrão.
|
||||
- [Input Remapper](https://github.com/sezanzeb/input-remapper) pré-instalado e habilitado. <sub><sup>(Disponível mas desabilitado por padrão na versão Deck, ative executando `ujust _restore-input-remapper`)</sup></sub>
|
||||
- O Bazzite Portal traz um jeito simples de instalar múltiplos aplicativos e ajustes, incluindo a instalação do [LACT](https://github.com/ilya-zlobintsev/LACT).
|
||||
- [Waydroid](https://waydro.id/) pré-instalado para rodar aplicativos Android. Confira esse [guia rápido](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Waydroid_Setup_Guide/) para configurá-lo.
|
||||
- [Waydroid](https://waydro.id/) pré-instalado para rodar aplicativos Android. Confira esse [guia rápido](https://docs.bazzite.gg/Installing_and_Managing_Software/Waydroid_Setup_Guide/) para configurá-lo.
|
||||
- Gerencie aplicativos usando o [Flatseal](https://github.com/tchx84/Flatseal), [Warehouse](https://github.com/flattool/warehouse), e [Gear Lever](https://github.com/mijorus/gearlever).
|
||||
- Drivers i2c-piix4 e i2c-nct6775 pra [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) para controlar o RGB em certas placas-mãe.
|
||||
- Drivers [OpenRazer](https://openrazer.github.io) inclusos, Selecione OpenRazer no Bazzite Portal ou rode `ujust install-openrazer` no terminal para começar a usá-lo.
|
||||
@ -81,7 +81,7 @@ Imagem genérica disponível como `bazzite`, própria para computadores desktop.
|
||||
- Atualiza automaticamente o sistema, Flatpaks, e todos os containers Distrobox - via [ublue-update](https://github.com/ublue-os/ublue-update) e [topgrade](https://github.com/topgrade-rs/topgrade).
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
|
||||
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://docs.bazzite.gg/General/Installation_Guide/).**
|
||||
|
||||
Rebaseie de uma instalação existente de Fedora Atômico para esta imagem se você quiser **Drivers de GPU Open Source**:
|
||||
(Nota: A solução Open Source Mesa para GPUs NVIDIA, NVK ainda é propensa a erros quando esta orientação é redigida, pra qualquer problema pertinente à NVK [por favor mande um relatório ao projeto Mesa]([url](https://docs.mesa3d.org/bugs.html)), não ao Ublue/Bazzite)
|
||||
@ -138,7 +138,7 @@ Imagem feita pra ser utilizada como alternativa ao SteamOS no Steam Deck, e para
|
||||
> **Devido a um bug upstream, o Bazzite não pode ser utilizado em Steam Decks com 64GB de armazenamento eMMC no momento. Fazer um upgrade de armazenamento resolve o problema.**
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
|
||||
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://docs.bazzite.gg/General/Installation_Guide/).**
|
||||
|
||||
Pra fazer rebase de uma instalação existente de Fedora Atômico para esta imagem:
|
||||
|
||||
@ -170,7 +170,7 @@ Imagens com o ambiente desktop GNOME estão disponíveis pra ambas as versões d
|
||||
- Atualizações automáticas para o [tema GNOME pro Firefox](https://github.com/rafaelmardojai/firefox-gnome-theme) e o [tema GNOME pro Thunderbird](https://github.com/rafaelmardojai/thunderbird-gnome-theme). <sup><sub>(Se instalados)</sub></sup>
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
|
||||
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://docs.bazzite.gg/General/Installation_Guide/).**
|
||||
|
||||
Pra fazer rebase de uma instalação existente de Fedora Atômico para esta imagem:
|
||||
|
||||
@ -222,7 +222,7 @@ Apesar deste projeto também ser baseado em imagens, você pode instalar qualque
|
||||
|
||||
O Bazzite inclui a versão mais recente do kernel Linux e vem com SELinux habilitado por padrão com suporte total a secure boot <sub><sup>(Execute `ujust enroll-secure-boot-key` e insira a senha `universalblue` se requisitada para adicionar a nossa chave)</sup></sub> e criptografia de disco, fazendo dele uma solução razoável pra computação em geral. <sup><sub>(Sim, você pode usar sua impressora no Bazzite)</sub></sup>
|
||||
|
||||
Confira o [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) para mais detalhes no que faz o Bazzite ser diferente de outros sistemas operacionais Linux.
|
||||
Confira o [FAQ](https://docs.bazzite.gg/General/FAQ/) para mais detalhes no que faz o Bazzite ser diferente de outros sistemas operacionais Linux.
|
||||
|
||||
## Imagens
|
||||
|
||||
@ -236,9 +236,9 @@ Confira o [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) para mais detal
|
||||
|
||||
## Documentação
|
||||
|
||||
- [Instalando e Gerenciando Programas](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/)
|
||||
- [Atualizações, Rollbacks, e Rebase](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
|
||||
- [Guia pra Gaming](https://ublue-os.github.io/bazzite/Gaming/)
|
||||
- [Instalando e Gerenciando Programas](https://docs.bazzite.gg/Installing_and_Managing_Software/)
|
||||
- [Atualizações, Rollbacks, e Rebase](https://docs.bazzite.gg/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
|
||||
- [Guia pra Gaming](https://docs.bazzite.gg/Gaming/)
|
||||
|
||||
Leia [documentação adicional](http://docs.bazzite.gg/) ao redor do projeto.
|
||||
|
||||
|
20
README.md
@ -64,7 +64,7 @@ Bazzite is built from [ublue-os/main](https://github.com/ublue-os/main) and [ubl
|
||||
- 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://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Waydroid_Setup_Guide/).
|
||||
- [Waydroid](https://waydro.id/) preinstalled for running Android apps. Set it up with this [quick guide](https://docs.bazzite.gg/Installing_and_Managing_Software/Waydroid_Setup_Guide/).
|
||||
- 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.
|
||||
@ -81,7 +81,7 @@ 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).
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
|
||||
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://docs.bazzite.gg/General/Installation_Guide/).**
|
||||
|
||||
Rebase from an existing upstream Fedora Atomic to this image if you want **Open Source GPU Drivers**:
|
||||
(Please note: Mesa's Open Source option for NVIDIA GPUs, NVK is still prone to errors at the time of writing, for any issues relating to NVK [please submit a report with Mesa]([url](https://docs.mesa3d.org/bugs.html)), not Ublue/Bazzite)
|
||||
@ -132,13 +132,13 @@ Variant designed for usage as an alternative to SteamOS on the Steam Deck, and f
|
||||
- Built in support for display overclocking. For example, add `CUSTOM_REFRESH_RATES=30-68` to `/etc/environment`. Minimum and maximum refresh rates differ per handheld!
|
||||
- 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://ublue-os.github.io/bazzite/Handheld_and_HTPC_edition/Steam_Gaming_Mode/) on the Bazzite Steam Deck images.
|
||||
- More information can be found [here](https://docs.bazzite.gg/Handheld_and_HTPC_edition/Steam_Gaming_Mode/) on the Bazzite Steam Deck images.
|
||||
|
||||
> [!WARNING]
|
||||
> **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.**
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
|
||||
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://docs.bazzite.gg/General/Installation_Guide/).**
|
||||
|
||||
Rebase from an existing upstream Fedora Atomic to this image:
|
||||
|
||||
@ -148,7 +148,7 @@ rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/bazzite-deck:stabl
|
||||
|
||||
#### Alternative Handhelds
|
||||
|
||||
Please refer to our [Handheld Wiki](https://ublue-os.github.io/bazzite/Handheld_and_HTPC_edition/Handheld_Wiki/) for required setting changes and Decky Loader plugins for Steam Gaming Mode on your specific Handheld.
|
||||
Please refer to our [Handheld Wiki](https://docs.bazzite.gg/Handheld_and_HTPC_edition/Handheld_Wiki/) for required setting changes and Decky Loader plugins for Steam Gaming Mode on your specific Handheld.
|
||||
|
||||
**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.**
|
||||
|
||||
@ -170,7 +170,7 @@ Builds with the GNOME desktop environment are available in both desktop and deck
|
||||
- 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>
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
|
||||
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://docs.bazzite.gg/General/Installation_Guide/).**
|
||||
|
||||
Rebase from an existing upstream Fedora Atomic to this image:
|
||||
|
||||
@ -222,7 +222,7 @@ Despite this project also being image-based, you are able to install any Fedora
|
||||
|
||||
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 `universalblue` 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://ublue-os.github.io/bazzite/General/FAQ/) for details on what makes Bazzite stand out from other Linux based operating systems.
|
||||
Read the [FAQ](https://docs.bazzite.gg/General/FAQ/) for details on what makes Bazzite stand out from other Linux based operating systems.
|
||||
|
||||
## Showcase
|
||||
|
||||
@ -236,9 +236,9 @@ Read the [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) for details on w
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Installing and Managing Applications](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/)
|
||||
- [Updates, Rollbacks, and Rebasing](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
|
||||
- [Gaming Guide](https://ublue-os.github.io/bazzite/Gaming/)
|
||||
- [Installing and Managing Applications](https://docs.bazzite.gg/Installing_and_Managing_Software/)
|
||||
- [Updates, Rollbacks, and Rebasing](https://docs.bazzite.gg/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
|
||||
- [Gaming Guide](https://docs.bazzite.gg/Gaming/)
|
||||
|
||||
View [additional documentation](http://docs.bazzite.gg/) surrounding the project.
|
||||
|
||||
|
179
docs/.gitignore
vendored
@ -1,179 +0,0 @@
|
||||
book
|
||||
debug.txt
|
||||
# Created by https://www.toptal.com/developers/gitignore/api/python
|
||||
# Edit at https://www.toptal.com/developers/gitignore?templates=python
|
||||
|
||||
### Python ###
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
cover/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
.pybuilder/
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
# For a library or package, you might want to ignore these files since the code is
|
||||
# intended to run in multiple environments; otherwise, check them in:
|
||||
# .python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
||||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# poetry
|
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
||||
#poetry.lock
|
||||
|
||||
# pdm
|
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
||||
#pdm.lock
|
||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
||||
# in version control.
|
||||
# https://pdm.fming.dev/#use-with-ide
|
||||
.pdm.toml
|
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
celerybeat-schedule
|
||||
celerybeat.pid
|
||||
|
||||
# SageMath parsed files
|
||||
*.sage.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
|
||||
# PyCharm
|
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
|
||||
### Python Patch ###
|
||||
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
|
||||
poetry.toml
|
||||
|
||||
# ruff
|
||||
.ruff_cache/
|
||||
|
||||
# LSP config files
|
||||
pyrightconfig.json
|
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/python
|
||||
*.code-workspace
|
@ -1,22 +0,0 @@
|
||||
export PATH := justfile_directory() + "/utils:" + env("PATH")
|
||||
export GITHUB_REPOSITORY := "ublue-os/bazzite"
|
||||
export MKDOCS_REPO_URL := "https://github.com/" + GITHUB_REPOSITORY
|
||||
MKDOCS_DIR := justfile_directory()
|
||||
|
||||
_default:
|
||||
just --list
|
||||
|
||||
# Install dependencies required for documentation stuff
|
||||
install_dependencies:
|
||||
bash ./utils/install-deps.sh
|
||||
|
||||
mkdocs +ARGS="":
|
||||
rm -rf {{ MKDOCS_DIR }}/.cache/cmdrun
|
||||
poetry run mkdocs {{ ARGS }}
|
||||
|
||||
mkdocs_clean:
|
||||
rm -rf {{ MKDOCS_DIR }}/.cache
|
||||
|
||||
# Format all markdown files with prettier
|
||||
fmt:
|
||||
prettier --check --write $(find src -type f -name '*.md')
|
1
docs/README
Normal file
@ -0,0 +1 @@
|
||||
Documentation moved to https://github.com/KyleGospo/docs.bazzite.gg
|
@ -1,97 +0,0 @@
|
||||
# Contributing to Bazzite MkDocs documentation
|
||||
|
||||
## Introduction
|
||||
|
||||
This is a guide that will show you how to write, or transcribe documentation from Discourse forums (https://universal-blue.discourse.group/) to MkDocs pages.
|
||||
|
||||
## What is MkDocs
|
||||
|
||||
> _MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file._
|
||||
>
|
||||
> Source ~ https://www.mkdocs.org/
|
||||
|
||||
**TL;DR**: Its a fancy way tool that allows us to create a documentation website with basic [Markdown](https://commonmark.org/help/).
|
||||
|
||||
The essential part that can't be missing in a mdBook is the `mkdocs.yml` file.
|
||||
|
||||
`mkdocs.yml` acts as our main configuration file. One of its main tasks is to configure the **Table of Contents** and to configure translation files.
|
||||
|
||||
## Setup MkDocs tooling
|
||||
|
||||
> ⚠️ WARNING ⚠️
|
||||
>
|
||||
> This step is **required** in order to setup previews of the resulting MkDocs
|
||||
|
||||
To install our dependencies, run this:
|
||||
|
||||
```sh
|
||||
bash docs/utils/install-deps.sh
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<big>Dependencies list</big><br>
|
||||
<sup>Ignore if using install-deps.sh</sup>
|
||||
</summary>
|
||||
|
||||
- [Poetry](https://python-poetry.org/) (can be installed with Homebrew)
|
||||
- [Just](https://just.systems/man/en/) (preinstalled in all [Universal Blue](https://universal-blue.org/) images)
|
||||
|
||||
</details>
|
||||
|
||||
You will need other tools as well, like:
|
||||
|
||||
- A markdown compatible code editor (ex.: **Visual Studio Code**)
|
||||
- **git** (comes preinstalled in most Linux distributions)
|
||||
|
||||
### 1. Create the markdown file where we will store our document.
|
||||
|
||||
> ⚠️ WARNING
|
||||
>
|
||||
> Just remember, ⚠️**DO NOT USE SPACES IN THE FILE NAME**⚠️. Is really important, spaces in filenames is going to bit us later in a future.
|
||||
> Instead, use underscores `_`
|
||||
|
||||
### 2. Set a proper page name
|
||||
|
||||
You can add more explicit page titles (used by the browser tab names) by using YAML metadata.
|
||||
|
||||
Adding this at the start of the markdown file would change the tab name to "Hello world":
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Hello world"
|
||||
---
|
||||
```
|
||||
|
||||
## Translate documentation
|
||||
|
||||
Translating documentation is as straightfoward as can be.
|
||||
Lets say we want to translate `Homebrew.md` to Spanish. All what you would have to do is make a copy of the file with the name `Homebrew.es.md` and start translating.
|
||||
|
||||
Perhaps you can't see your translation with `just mkdocs serve`.
|
||||
Chances are we need to configure MkDocs to do so.
|
||||
|
||||
Open `mkdocs.yml`, look for the field `languages`, should look something like this:
|
||||
|
||||
```yaml
|
||||
languages:
|
||||
- locale: en
|
||||
default: true
|
||||
name: English
|
||||
build: true
|
||||
```
|
||||
|
||||
Add your language, in our case is Spanish:
|
||||
|
||||
```yaml
|
||||
languages:
|
||||
- locale: en
|
||||
default: true
|
||||
name: English
|
||||
build: true
|
||||
- locale: es
|
||||
name: Spanish
|
||||
build: true
|
||||
```
|
||||
|
||||
MkDocs should show a language selector in the top bar.
|
@ -1,111 +0,0 @@
|
||||
import hashlib
|
||||
import os
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
import yaml
|
||||
from mkdocs import plugins
|
||||
from mkdocs.config.defaults import MkDocsConfig
|
||||
from mkdocs.structure.files import Files
|
||||
from mkdocs.structure.pages import Page
|
||||
|
||||
sys.path.append(os.path.dirname(os.path.abspath(__file__)))
|
||||
import re
|
||||
from copy import copy
|
||||
|
||||
from fetch_discourse_md import fetch as fetch_md_discourse
|
||||
|
||||
CMDRUN_PATTERN = r"<!--\s?cmdrun\s+fetch_discourse_md\.py\s+\"(.*)\"\s*-->"
|
||||
PLUGIN_NAME = os.path.basename(__file__).rstrip(".py")
|
||||
|
||||
plugin_cache_dir: str
|
||||
url_mappings: dict = {}
|
||||
"""Dict with mappings for discourse urls to be replaced with mkdocs ones"""
|
||||
|
||||
|
||||
def log_info(*args):
|
||||
return print(f"{PLUGIN_NAME}:", *args)
|
||||
|
||||
|
||||
def _cache_filename_generator(text: str) -> str:
|
||||
"""Generate a sha265 encoded cache file path of a piece of text inside the plugin cache dir"""
|
||||
cache_file = os.path.join(
|
||||
plugin_cache_dir, hashlib.sha256(text.encode()).hexdigest()
|
||||
)
|
||||
return cache_file
|
||||
|
||||
|
||||
def _fetch_callback(url: str):
|
||||
cache_file = _cache_filename_generator(url)
|
||||
if os.path.exists(cache_file):
|
||||
return Path(cache_file).read_text().strip()
|
||||
|
||||
elif content := fetch_md_discourse(url):
|
||||
with open(cache_file, "w+t") as c_file:
|
||||
c_file.write(content)
|
||||
return content
|
||||
else:
|
||||
return ""
|
||||
|
||||
|
||||
def _cmdrun_sub_handler(match: re.Match) -> str:
|
||||
print(match.group(1))
|
||||
url = match.group(1)
|
||||
result = _fetch_callback(url)
|
||||
return result or ""
|
||||
|
||||
|
||||
def on_config(config: MkDocsConfig):
|
||||
"""Initialize configuration"""
|
||||
global plugin_cache_dir, url_mappings
|
||||
mkdocs_config_dir = os.path.dirname(config.config_file_path)
|
||||
plugin_cache_dir = os.path.join(mkdocs_config_dir, ".cache", PLUGIN_NAME)
|
||||
try:
|
||||
os.makedirs(plugin_cache_dir, exist_ok=True)
|
||||
except FileExistsError:
|
||||
pass
|
||||
|
||||
try:
|
||||
url_overrides_file = os.path.join(mkdocs_config_dir, "url_overrides.yml")
|
||||
with open(url_overrides_file) as f:
|
||||
url_mappings = yaml.load(f.read(), Loader=yaml.SafeLoader)
|
||||
except FileNotFoundError:
|
||||
log_info(
|
||||
f"'{os.path.relpath(url_overrides_file)}' doesnt exist, using default mapping '{url_mappings}'"
|
||||
)
|
||||
|
||||
|
||||
@plugins.event_priority(100)
|
||||
def _on_page_markdown_fetch_discourse(markdown: str, **kargs):
|
||||
markdown_orig = markdown
|
||||
result = copy(markdown_orig)
|
||||
|
||||
try:
|
||||
result = re.sub(CMDRUN_PATTERN, _cmdrun_sub_handler, markdown_orig)
|
||||
except Exception as err:
|
||||
print("ERROR", err)
|
||||
|
||||
return result
|
||||
|
||||
|
||||
@plugins.event_priority(99)
|
||||
def _on_page_markdown_replace_urls(
|
||||
markdown: str,
|
||||
page: Page,
|
||||
config: MkDocsConfig,
|
||||
files: Files,
|
||||
**kargs,
|
||||
):
|
||||
"""Replace discourse urls"""
|
||||
res = markdown
|
||||
for src, dst in [x for x in url_mappings.items()]:
|
||||
if config.site_url:
|
||||
dst = f"{config.site_url.rstrip("/")}/{dst.lstrip("/")}"
|
||||
res = re.sub(rf"\b{re.escape(src)}\b", dst, res, flags=re.UNICODE)
|
||||
return res
|
||||
|
||||
|
||||
on_page_markdown = plugins.CombinedEvent(
|
||||
_on_page_markdown_fetch_discourse,
|
||||
_on_page_markdown_replace_urls,
|
||||
)
|
@ -1,27 +0,0 @@
|
||||
import re
|
||||
from mkdocs import plugins
|
||||
|
||||
|
||||
YOUTUBE_URL_PATTERN = r"(?<!<|\(|\")\bhttps:\/\/(?:www\.youtube\.com\/watch\?v=|youtu\.be/)(?P<id>[a-zA-Z0-9_-]{11})\b"
|
||||
|
||||
|
||||
def _generate_embed_from_id(
|
||||
yt_id: str,
|
||||
/,
|
||||
*,
|
||||
width: int = 560,
|
||||
height: int = 315,
|
||||
) -> str:
|
||||
"""Generate a youtube embed from a video id"""
|
||||
return f"""\
|
||||
<iframe width="{width}" height="{height}" src="https://www.youtube.com/embed/{yt_id}" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>"""
|
||||
|
||||
|
||||
def on_page_content(html: str, **kargs):
|
||||
def resub_handler(match: re.Match) -> str:
|
||||
id = match.group("id")
|
||||
if id:
|
||||
return _generate_embed_from_id(id)
|
||||
return match.string
|
||||
|
||||
return re.sub(YOUTUBE_URL_PATTERN, resub_handler, html)
|
@ -1 +0,0 @@
|
||||
../utils/fetch_discourse_md.py
|
@ -1,41 +0,0 @@
|
||||
import re
|
||||
import string
|
||||
from mkdocs.config.defaults import MkDocsConfig
|
||||
from mkdocs.structure.pages import Page
|
||||
from mkdocs.structure.files import Files
|
||||
from mkdocs.plugins import event_priority
|
||||
|
||||
|
||||
IMG_SIZED_RE = (
|
||||
r"\!\[.*?\s*(?P<width>\d+)x(?P<height>\d+)(?:,\s*(?P<multi>\d+)%)?\]\(.*\)"
|
||||
)
|
||||
"""Used to get width, height from `text|WIDTHxHEIGHT`"""
|
||||
|
||||
|
||||
def _add_attr_handler(match: re.Match[str]) -> str:
|
||||
width = match.group("width")
|
||||
height = match.group("height")
|
||||
if multi := match.group("multi"):
|
||||
multi = int(multi) / 100
|
||||
width = str(int(width) * multi)
|
||||
height = str(int(height) * multi)
|
||||
res = match.group(0) + string.Template(
|
||||
'{ style="max-width:${width}px; max-height:${height}px; width: 100%;" }'
|
||||
).substitute(width=width, height=height)
|
||||
return res
|
||||
|
||||
|
||||
is_enabled: bool
|
||||
|
||||
|
||||
def on_config(config: MkDocsConfig):
|
||||
global is_enabled
|
||||
is_enabled = "attr_list" in config.markdown_extensions
|
||||
|
||||
|
||||
@event_priority(70)
|
||||
def on_page_markdown(
|
||||
markdown: str, page: Page, config: MkDocsConfig, files: Files, **kargs
|
||||
):
|
||||
if is_enabled:
|
||||
return re.sub(IMG_SIZED_RE, _add_attr_handler, markdown)
|
152
docs/mkdocs.yml
@ -1,152 +0,0 @@
|
||||
site_name: Bazzite Documentation
|
||||
site_author: nicknamenamenick
|
||||
site_url: !ENV MKDOCS_SITE_URL
|
||||
repo_url: !ENV MKDOCS_REPO_URL
|
||||
repo_name: !ENV GITHUB_REPOSITORY
|
||||
edit_uri_template: edit/main/docs/src/{path}
|
||||
site_description: Bazzite is a custom image built upon Fedora Atomic Desktops that brings the best of Linux gaming to all of your devices - including your favorite handheld.
|
||||
|
||||
validation:
|
||||
links:
|
||||
not_found: warn
|
||||
absolute_links: relative_to_docs
|
||||
anchors: warn
|
||||
unrecognized_links: warn
|
||||
|
||||
extra_css:
|
||||
- stylesheets/image_sizing.css
|
||||
- stylesheets/bazzite.css
|
||||
theme:
|
||||
name: material
|
||||
custom_dir: theme_overrides
|
||||
palette:
|
||||
- media: "(prefers-color-scheme)"
|
||||
primary: deep purple
|
||||
toggle:
|
||||
icon: material/brightness-auto
|
||||
name: Switch to light mode
|
||||
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: deep purple
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: deep purple
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to system preference
|
||||
|
||||
favicon: static/favicon.svg
|
||||
logo: static/favicon.svg
|
||||
icon:
|
||||
repo: fontawesome/brands/github
|
||||
features:
|
||||
- navigation.indexes
|
||||
- navigation.sections
|
||||
- navigation.tabs
|
||||
# - navigation.instant # Incompatible with mkdocs_static_i18n
|
||||
- toc.integrate
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- content.action.edit
|
||||
- content.action.view
|
||||
|
||||
docs_dir: src
|
||||
site_dir: book
|
||||
|
||||
hooks:
|
||||
- hooks/cmdrun.py # 100-99
|
||||
- hooks/embed_youtube.py # 80
|
||||
- hooks/md_image_sizing.py
|
||||
|
||||
plugins:
|
||||
- privacy
|
||||
- i18n:
|
||||
languages:
|
||||
- locale: en
|
||||
default: true
|
||||
name: English
|
||||
build: true
|
||||
|
||||
- search
|
||||
- git-revision-date-localized:
|
||||
enable_creation_date: !ENV [CI, false]
|
||||
fallback_to_build_date: true
|
||||
- git-committers:
|
||||
enabled: !ENV [CI, false]
|
||||
token: !ENV ["GH_TOKEN"]
|
||||
repository: !ENV GITHUB_REPOSITORY
|
||||
branch: !ENV GITHUB_REF_NAME
|
||||
- social
|
||||
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- nl2br
|
||||
- mdx_truly_sane_lists
|
||||
- toc:
|
||||
permalink: true
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||
- pymdownx.magiclink
|
||||
|
||||
nav:
|
||||
- index.md
|
||||
- General:
|
||||
- "Bazzite's README": "Bazzite_README.md"
|
||||
- "FAQ": "General/FAQ.md"
|
||||
- "Installation Guide":
|
||||
- General/Installation_Guide/index.md
|
||||
- "Installing Bazzite for Desktop/Laptop Hardware": General/Installation_Guide/Installing_Bazzite_for_Desktop_or_Laptop_Hardware.md
|
||||
- "Installing Bazzite for Framework Laptop 16": General/Installation_Guide/Installing_Bazzite_for_Framework_Laptop_16.md
|
||||
- "Installing Bazzite for Framework Laptop 13 (AMD/Intel GPU)": General/Installation_Guide/Installing_Bazzite_Framework_Laptop_13.md
|
||||
- "Installing Bazzite for Home Theater PC (HTPC) Setups": General/Installation_Guide/Installing_Bazzite_for_HTPC_Setups.md
|
||||
- "Installing Bazzite on the Steam Deck": General/Installation_Guide/Installing_Bazzite_for_Steam_Deck.md
|
||||
- "Installing Bazzite on Handheld PCs": General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs.md
|
||||
- "Installation Troubleshoot Guide": General/Installation_Guide/troubleshoot_guide.md
|
||||
- "Secure Boot Instructions": General/Installation_Guide/secure_boot.md
|
||||
- "Dual Boot Preliminary Setup and Post-Setup Guide": General/Installation_Guide/dual_boot_setup_guide.md
|
||||
- "Gaming":
|
||||
- Gaming/index.md
|
||||
- "Game Launchers": Gaming/Game_Launchers.md
|
||||
- "Managing & Modding Games": Gaming/Managing_and_modding_games.md
|
||||
- "Common Gaming Issues": Gaming/Common_gaming_issues.md
|
||||
- "Hardware Compatibility for Gaming": Gaming/Hardware_compatibility_for_gaming.md
|
||||
- "Desktop Environment Tweaks": General/Desktop_Environment_Tweaks.md
|
||||
- "Reporting Bugs": General/reporting_bugs.md
|
||||
- Handheld & HTPC Hardware:
|
||||
- "Steam Gaming Mode": Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
|
||||
- "Handheld Wiki":
|
||||
- Handheld_and_HTPC_edition/Handheld_Wiki/index.md
|
||||
- "Steam Deck": Handheld_and_HTPC_edition/Handheld_Wiki/Steam_Deck.md
|
||||
- "Lenovo Legion Go": Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md
|
||||
- "ASUS ROG Ally": Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md
|
||||
- "Ayn Handhelds": Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md
|
||||
- "GPD Handhelds": Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md
|
||||
- "Ayaneo Handhelds": Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md
|
||||
- "Other Handhelds": Handheld_and_HTPC_edition/Handheld_Wiki/Other_Handhelds.md
|
||||
- Software:
|
||||
- "Installing and Managing Software":
|
||||
- Installing_and_Managing_Software/index.md
|
||||
- "Flatpak": Installing_and_Managing_Software/Flatpak.md
|
||||
- "ujust": Installing_and_Managing_Software/ujust.md
|
||||
- "Homebrew": Installing_and_Managing_Software/Homebrew.md
|
||||
- "Distrobox": Installing_and_Managing_Software/Distrobox.md
|
||||
- "Appimage": Installing_and_Managing_Software/AppImage.md
|
||||
- "rpm-ostree": Installing_and_Managing_Software/rpm-ostree.md
|
||||
- "Updates, Rollbacks, & Rebasing":
|
||||
- "Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md"
|
||||
- "Updating Guide": "Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/updating_guide.md"
|
||||
- "Rolling Back System Updates": "Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md"
|
||||
- "Rebase Guide": "Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rebase_guide.md"
|
||||
- "Bazzite Rollback Helper": "Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/bazzite_rollback_helper.md"
|
||||
- "Waydroid Setup Guide": Installing_and_Managing_Software/Waydroid_Setup_Guide.md
|
||||
- Advanced:
|
||||
- "Reset Forgotten User Password": Advanced/Reset_Forgotten_User_Password.md
|
||||
- "Creating A Custom Bazzite Image": Advanced/creating_custom_image.md
|
||||
- "Contributing to Bazzite": Advanced/Contributing_to_bazzite.md
|
1143
docs/poetry.lock
generated
@ -1,22 +0,0 @@
|
||||
[tool.poetry]
|
||||
name = "bazzite-docs"
|
||||
version = "0.1.0"
|
||||
description = ""
|
||||
authors = ["Zeglius <33781398+Zeglius@users.noreply.github.com>"]
|
||||
readme = "README.md"
|
||||
package-mode = false
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.12"
|
||||
mkdocs = "^1.6.0"
|
||||
requests = "^2.32.3"
|
||||
mkdocs-material = {extras = ["imaging"], version = "^9.5.33"}
|
||||
mkdocs-static-i18n = {extras = ["material"], version = "^1.2.3"}
|
||||
mdx-truly-sane-lists = "^1.3"
|
||||
mkdocs-git-revision-date-localized-plugin = "^1.2.7"
|
||||
mkdocs-git-committers-plugin-2 = "^2.3.0"
|
||||
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core"]
|
||||
build-backend = "poetry.core.masonry.api"
|
@ -1,92 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=970", "fetched_at": "2024-09-03 16:43:14.005694+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
> # WARNING!
|
||||
>
|
||||
> **Attention**: You may lose data on the drive(s) or result in an unbootable system if configured improperly.
|
||||
>
|
||||
> **Note:** MicroSD cards automatically mount without any manual intervention required on Bazzite.
|
||||
>
|
||||
> **Important**: Do **not** use the NTFS, exFAT, or FAT32 filesystems for game library storage.
|
||||
>
|
||||
> Follow this guide **at your own discretion** and make sure to read the entire document relevant to your method, so you do not miss anything!
|
||||
|
||||
<hr>
|
||||
|
||||
# Formatting a disk
|
||||
|
||||
> **Warning**: This will wipe all existing data on it
|
||||
|
||||
## Note when formatting in **KDE Partition Manager**
|
||||
|
||||
Make sure you set permissions to **everyone**.
|
||||
|
||||
Use a disk graphical user interface like KDE Plasma or GNOME Disks to format your drive. We recommend formatting secondary drives to **BTRFS** or **Ext4**. BTRFS is our recommended filesystem, but Ext4 may be better for older spinning mechanical HDDs as secondary drives.
|
||||
|
||||
## Creating a secondary drive directory and where to mount drives?
|
||||
|
||||
> **Note**: Drive directories should be **lowercase** with **no spaces** for best practice.
|
||||
|
||||
> **Attention**: `/var/mnt` should NOT be the path, but create a new **directory** in either `/var/mnt` or `/var/run/media/`.
|
||||
|
||||
- `/var/mnt/...` for **permanent** drives
|
||||
- `/var/run/media/...` for **removable** drives
|
||||
|
||||
You can make a directory in `/var/mnt/` by opening a host terminal and **entering this command in a host terminal**:
|
||||
|
||||
```command
|
||||
cd /var/mnt
|
||||
```
|
||||
|
||||
```command
|
||||
sudo mkdir /var/mnt/games
|
||||
```
|
||||
|
||||
The drive will now be mounted in a directory known as `games`.
|
||||
|
||||
> **Note**: `games` can be named anything you desire that fits best practices.
|
||||
|
||||
### Permissions for the drive
|
||||
|
||||
```command
|
||||
sudo chown $USER:$USER /var/mnt/games
|
||||
```
|
||||
|
||||
> **Note**: If you plan to reformat the partition, remember to edit the mount point and "Remove" the mount path before you reformat! If not you will have to manually edit `/etc/fstab`.
|
||||
|
||||
# Graphical User Interface (GUI) Methods for Auto-Mounting
|
||||
|
||||
> **Warning**: Do not set up auto-mount, unmount then format a drive! It can confuse the software you are configuring drives with. Instead, **remove the auto-mount first before formatting the drive**.
|
||||
|
||||
- [**KDE Partition Manager**](./KDE_Partition_Manager_Auto_Mount_Guide.md)
|
||||
- [**GNOME Disks**](./GNOME_Disks_Auto-Mount_Guide.md)
|
||||
|
||||
# Alternative Methods (CLI)
|
||||
|
||||
There are also two command-line interface (CLI) methods.
|
||||
|
||||
1. Using `systemd.mount`
|
||||
|
||||
2. Editing the `/etc/fstab` file
|
||||
|
||||
Command Line Interface methods are intended for advanced users, and it is recommended to research one of the two methods outside of this documentation.
|
||||
|
||||
<hr>
|
||||
|
||||
# Emergency Mode After Mounting?
|
||||
|
||||
This video tutorial shows how to recover from your mounting mistakes.
|
||||
|
||||
https://www.youtube.com/watch?v=-2wca_0CpXY
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [HikariKnight](https://github.com/HikariKnight) and [asen23](https://github.com/asen23)
|
||||
|
||||
<-- [**View all Bazzite documentation**](https://docs.bazzite.gg)
|
@ -1,50 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=38", "fetched_at": "2024-09-03 16:43:12.863190+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## **Preliminary Reading**:
|
||||
|
||||
- [**Universal Blue Project Governance**](https://universal-blue.discourse.group/docs?topic=51)
|
||||
|
||||
- [**Contributing Guide**](https://universal-blue.discourse.group/docs?topic=81)
|
||||
|
||||
<hr>
|
||||
|
||||
## Overview
|
||||
|
||||
Bazzite is an image from [Universal Blue](https://universal-blue.org/) and you should follow Universal Blue's [contribution guidelines](https://universal-blue.org/CONTRIBUTING) before proceeding. Also read our [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) if contributing to documentation.
|
||||
|
||||
Check out the Bazzite's [issue tracker](https://github.com/ublue-os/bazzite/issues) to see what issues users are currently experiencing. Also check out the current [roadmap](https://github.com/orgs/ublue-os/projects/1/views/1) for Universal Blue. There is also a [forum](https://universal-blue.discourse.group/c/contributing/7) for general Universal Blue contributions.
|
||||
|
||||
## Contributing to Bazzite
|
||||
|
||||
- Adding features or fixing bugs by submitting a [pull request](https://github.com/ublue-os/bazzite/pulls).
|
||||
- Reporting issues you experience on our [issue tracker](https://github.com/ublue-os/bazzite/issues).
|
||||
- Adding and contributing to [documentation](https://docs.bazzite.gg).
|
||||
- Language translations are encouraged for documentation and the [README](https://github.com/ublue-os/bazzite/blob/main/README.md).
|
||||
- Testing Bazzite on unique hardware configurations.
|
||||
- Troubleshooting issues with handheld hardware is appreciated.
|
||||
- Reporting issues with [HHD](https://github.com/hhd-dev/hhd) directly is also helpful on handhelds.
|
||||
|
||||
## Building Your Own Bazzite for Testing
|
||||
|
||||
> **[Bazzite Template](https://github.com/ublue-os/image-template)**
|
||||
|
||||
Read about forking your own Bazzite image [here](https://ublue-os.github.io/bazzite/Advanced/creating_custom_image/).
|
||||
|
||||
If you feel comfortable with bash scripting, programming, working with containers, or anything upstream (Fedora, Flatpak, etc.) then feel free to contribute to Bazzite if you have want to add a feature or bug fix.
|
||||
|
||||
Building your own Bazzite will give you a sandbox to play in with your own personal changes to it. Also, this can be your own version of Bazzite to daily drive. This is useful to receive the same updates upstream, but with your spin on it with differences that we cannot or will not include regarding specific packages, drivers, etc.
|
||||
|
||||
### Alternative Method
|
||||
|
||||
Using the unaffiliated [BlueBuild](https://blue-build.org/learn/universal-blue/) project to build your own Bazzite.
|
||||
|
||||
<hr>
|
||||
|
||||
<-- [**View all Bazzite documentation**](../index.md)
|
@ -1,96 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=3781", "fetched_at": "2024-09-03 16:43:10.816923+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# GNOME Disks Auto-Mount Guide
|
||||
|
||||
![GNOME|120x120, 50%](../img/GNOME_Disks_icon.png)
|
||||
|
||||
**This comes pre-installed on GNOME images.**
|
||||
|
||||
# Instructions
|
||||
|
||||
![GNOME_Disks|690x463, 75%](../img/GNOME_Disks.png)
|
||||
|
||||
1. Open GNOME Disks (`gnome-disk-utility`)
|
||||
2. Locate the disk and partition you want to mount
|
||||
3. Click the cog icon on the partition
|
||||
4. Select "Edit Mount Options"
|
||||
5. Turn off "User Session Default"
|
||||
6. Check: "**Mount at system startup**" and "**Show in user interface**"
|
||||
7. In the space where this is no label: `nosuid,nodev,nofail,x-gvfs-show,` (refer to the correct filesystem below for more options)
|
||||
8. `/var/mnt/games` (or whatever directory you made)
|
||||
9. `auto`
|
||||
10. Select "Take Ownership"
|
||||
11. Open the terminal to test the mounts by running the **command**:
|
||||
|
||||
```command
|
||||
sudo systemctl daemon-reload && sudo mount -a
|
||||
```
|
||||
|
||||
12. **If no errors appeared then it should be safe to reboot.**
|
||||
|
||||
> **Note**: If errors occur, then research the error and undo what you did and try again. Redo the previous two steps in the terminal as GNOME Disks might not give a good error to search for if the test mount fails.
|
||||
|
||||
Display Name should be added too. Name it whatever you want it to be identified as.
|
||||
|
||||
## Filesystem Arguments
|
||||
|
||||
> **Warning**: If a drive is formatted, then do not remove it from `/etc/fstab`, so the "nofail" option is a must to avoid issues with booting.
|
||||
|
||||
![GNOME_Edit_Mount_Options|690x465, 75%](../img/GNOME_Edit_Mount_Options.png)
|
||||
|
||||
![GNOME_Mount_Options|549x500, 75%](../img/GNOME_Mount_Options.png)
|
||||
|
||||
### **BTRFS**:
|
||||
|
||||
```command
|
||||
defaults,compress-force=zstd:3,noatime,lazytime,commit=120,space_cache=v2,nofail
|
||||
```
|
||||
|
||||
### **Ext4**:
|
||||
|
||||
```command
|
||||
defaults,noatime,errors=remount-ro,nofail,rw,users,exec
|
||||
```
|
||||
|
||||
### **NTFS**:
|
||||
|
||||
```command
|
||||
defaults,noatime,nofail,rw,users,exec
|
||||
```
|
||||
|
||||
> **Note**: Do not use the NTFS filesystem for game library storage in Bazzite, and it is not supported and you will get lots of issues with it. NTFS is **not** intended as a game drive for Bazzite.
|
||||
|
||||
## Permissions for the drive
|
||||
|
||||
```command
|
||||
sudo chown $USER:$USER /mnt/games
|
||||
```
|
||||
|
||||
### Advanced Options (Not required for most setups)
|
||||
|
||||
> Change at your own risk!
|
||||
|
||||
### Information about compression:
|
||||
|
||||
**3** is a good balance, older CPUs should use **1**.
|
||||
|
||||
### Information about subvolumes:
|
||||
|
||||
use `subvol=name` as an option, KDE and GNOME Disks let you only mount 1 subvolume through the GUI, you can mount the root with `subvol=/` if a default subvolume is configured in the filesystem
|
||||
|
||||
# Installing GNOME Disks on non-GNOME images
|
||||
|
||||
If you would like to install this, then it can be layered to your system by entering in a terminal:
|
||||
|
||||
```
|
||||
rpm-ostree install gnome-disk-utility
|
||||
```
|
||||
|
||||
Reboot your system after it has finished installing the terminal.
|
@ -1,98 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=3780", "fetched_at": "2024-09-03 16:43:09.824214+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# KDE Partition Manager Auto-Mount Guide
|
||||
|
||||
![KDE|48x48](../img/KDE_Partition_Manager_icon.png)
|
||||
|
||||
**This is pre-installed on KDE images.**
|
||||
|
||||
# Instructions
|
||||
|
||||
![KDE Partition Manager|690x462, 75%](../img/KDE_Partition_Manager.png)
|
||||
![Do not check the boxes!|690x197](../img/Do_not_check_the_boxes.png)
|
||||
|
||||
1. Open KDE Partition Manager
|
||||
2. Locate the disk and partition you want to mount
|
||||
3. Right click on the partition and click "Edit Mount Point"
|
||||
4. Select "Identify by: UUID" (This will guarantee you mount THIS partition instead of a different one if the device nodes change for some reason)
|
||||
5. Select a mounting path (You would want to use `/var/mnt/games` or something similar for permanent mounts)
|
||||
6. **Untick all the boxes in the graphical application if they are checked**
|
||||
7. Click "More..." and add extra options depending on what filesystem is on the partition (read the "Filesystem Arguments" section)
|
||||
8. Click OK on both windows to save the mount points.
|
||||
9. A message will appear that the actions will edit `/etc/fstab` (Click "OK" to continue)
|
||||
10. Mount the disk manually in KDE Partition Manager and enter your sudo password
|
||||
11. Open the terminal to test the mounts by running the **command**:
|
||||
|
||||
```command
|
||||
sudo systemctl daemon-reload && sudo mount -a
|
||||
```
|
||||
|
||||
12. **If no errors appeared then it should be safe to reboot.**
|
||||
|
||||
> **Note**: If errors occur, then research the error and undo what you did and try again. Redo the previous two steps in the terminal (see CLI method down below and research how to use fstab) as KDE Partition Manager might not give a good error to search for if the test mount fails.
|
||||
|
||||
Display Name should be added too. Name it whatever you want it to be identified as.
|
||||
|
||||
## Required additional options depending on **filesystem**
|
||||
|
||||
Use the below generic options depending on your filesystem (these are just good defaults)
|
||||
You can copy+paste these into the "More.." dialog and they will be valid
|
||||
|
||||
> **Note**: "Users can mount and unmount" is an **optional** setting.
|
||||
|
||||
## Filesystem arguments
|
||||
|
||||
> **Warning**: If a drive is formatted, then do not remove it from `/etc/fstab`, so the "nofail" option is a must to avoid issues with booting.
|
||||
|
||||
![btrfs example|290x317](../img/btrfs_example.png)
|
||||
|
||||
> **Example: btrfs requires these additional options.**
|
||||
|
||||
### **BTRFS**:
|
||||
|
||||
```command
|
||||
defaults,compress-force=zstd:3,noatime,lazytime,commit=120,space_cache=v2,nofail
|
||||
```
|
||||
|
||||
### **Ext4**:
|
||||
|
||||
```command
|
||||
defaults,noatime,errors=remount-ro,nofail,rw,users,exec
|
||||
```
|
||||
|
||||
### **NTFS**:
|
||||
|
||||
```command
|
||||
defaults,noatime,nofail,rw,users,exec
|
||||
```
|
||||
|
||||
> **Note**: Do not use the NTFS filesystem for game library storage in Bazzite, and it is not supported and you will get lots of issues with it. NTFS is **not** intended as a game drive for Bazzite.
|
||||
|
||||
## Advanced Options (Not required for most setups)
|
||||
|
||||
> Change at your own risk!
|
||||
|
||||
### Information about compression:
|
||||
|
||||
**3** is a good balance, older CPUs should use **1**.
|
||||
|
||||
### Information about subvolumes:
|
||||
|
||||
use `subvol=name` as an option, KDE and GNOME Disks let you only mount 1 subvolume through the GUI, you can mount the root with `subvol=/` if a default subvolume is configured in the filesystem.
|
||||
|
||||
# Installing KDE Partition Manager on non-KDE images
|
||||
|
||||
If you would like to install this, then it can be layered to your system by entering in a terminal:
|
||||
|
||||
```
|
||||
rpm-ostree install kde-partitionmanager
|
||||
```
|
||||
|
||||
Reboot your system after it has finished installing the terminal.
|
@ -1,68 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=161", "fetched_at": "2024-09-03 16:43:11.636024+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
> This method is only if you forgot your current user password! Changing your current password should be done through the desktop environment.
|
||||
|
||||
> Follow this guide **at your own discretion** because you can break your system attempting any of this.
|
||||
|
||||
![Edit the command for the latest boot entry|690x351](../img/Edit_the_command_for_the_latest_boot_entry.png)
|
||||
|
||||
Reboot your device and edit the last deployment by presssing <kbd>E</kbd> on your keyboard.
|
||||
|
||||
![Boot with init=/bin/bash|689x359](../img/Boot_with_init_bin_bash.jpeg)
|
||||
|
||||
Boot with `init=/bin/bash` on the kernel command line (e.g. edit GRUB prompt.)
|
||||
|
||||
![Reboot|689x359](../img/Reset_Password_Reboot.jpeg)
|
||||
|
||||
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
|
||||
|
||||
```command
|
||||
sync
|
||||
```
|
||||
|
||||
5. Reboot
|
||||
|
||||
```
|
||||
/sbin/reboot -ff
|
||||
```
|
||||
|
||||
![Commands|690x334](../img/Reset_Password_Commands.png)
|
||||
|
||||
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 all Bazzite documentation**](https://docs.bazzite.gg)
|
@ -1,29 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@castrojo"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=43", "fetched_at": "2024-09-03 16:43:11.309087+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Making your own image
|
||||
|
||||
Sometimes you don't want to make a whole new image from scratch, you just want to change some things without too much extra work. Sometimes it's nicer to derive from images that more end-user focused like [Bazzite](https://github.com/ublue-os/bazzite), [Bluefin](https://github.com/ublue-os/bluefin), and [Aurora](https://getaurora.dev/).
|
||||
|
||||
**Use the official [template image](https://github.com/ublue-os/image-template) to build off of to make your own custom Bazzite.**
|
||||
|
||||
# Use Cases
|
||||
|
||||
- You want to help development by being able to test your contributions prior to submiting to the community.
|
||||
- Hardware enablement, experimental features, confirming fixes ahead of merge
|
||||
- You want to change out applications and other default choices but want to stick close to Bazzite/Bluefin to get improvements automatically
|
||||
- For example, Bluefin DX has Visual Studio baked into the image. If you want the rest of it but don't use vscode you could replace it or remove it.
|
||||
- You need to layer something like VPN software that has to be on an image but you don't want to maintain your own standalone image. (Deriving off of others is always easier, that's why we made this project)
|
||||
- You want a personal-use image with config and software changes, but also want to benefit from work being completed upstream.
|
||||
|
||||
[`ublue-os/main`](https://github.com/ublue-os/main) are used to generate base images of everything, so are usually not good candidates for this unless you are familiar with git, containers, and GitHub Actions.
|
||||
|
||||
<hr>
|
||||
|
||||
**See also**: [Community Created Custom Images](https://universal-blue.discourse.group/docs?topic=340)
|
@ -1 +0,0 @@
|
||||
See <https://github.com/ublue-os/bazzite/blob/main/README.md>
|
@ -1,97 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2658", "fetched_at": "2024-09-03 16:43:04.885968+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Steam Logs
|
||||
|
||||
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 Problems
|
||||
|
||||
> **Note**: 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**
|
||||
|
||||
Open a host terminal and **enter these 4 commands**:
|
||||
|
||||
```command
|
||||
sudo su
|
||||
```
|
||||
|
||||
```command
|
||||
cd /tmp
|
||||
```
|
||||
|
||||
```command
|
||||
ausearch -c 'hl2_linux' --raw | audit2allow -M my-hl2linux
|
||||
```
|
||||
|
||||
```command
|
||||
semodule -X 300 -i my-hl2linux.pp
|
||||
```
|
||||
|
||||
Reboot your device
|
||||
|
||||
#### If you want to undo this change eventually:
|
||||
|
||||
> 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 be in `/root` if you want to remove that.
|
||||
|
||||
### Source Games Not Launching
|
||||
|
||||
If a 32-bit Source 1 engine game is not opening due to [tmalloc libraries issues](https://github.com/ValveSoftware/csgo-osx-linux/issues/3229), then open a host terminal and **enter**:
|
||||
|
||||
Add the following as a **launch option** to the affected game in Steam:
|
||||
|
||||
```command
|
||||
LD_PRELOAD=/usr/lib/libtcmalloc_and_profiler.so.4 %command%
|
||||
```
|
||||
|
||||
Delete `libtcmalloc_minimal.so.x` in the game's bin folder if present.
|
||||
|
||||
If this fails to fix it, then try forcing Proton Experimental in the game's properties.
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [M2](https://github.com/m2Giles)
|
||||
|
||||
[**<-- Back to Gaming Guide**](./index.md)
|
@ -1,78 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2656", "fetched_at": "2024-09-03 16:43:09.533219+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## **Steam Setup**
|
||||
|
||||
Steam 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_](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) image.
|
||||
|
||||
- Currently Steam only allows whitelisted games to run by default on the desktop Steam client.
|
||||
- You can change this by going into the Steam **Settings** > **Compatibility** > Check **Enable Steam Play for all other titles**
|
||||
|
||||
![Steam Settings|256x267, 75%](../img/Steam_Setup_Settings.png)
|
||||
![Compatibility|589x499, 75%](../img/Steam_Setup_Compatibility.png)
|
||||
|
||||
### Forcing A Specific Proton / Steam Play Tool Version
|
||||
|
||||
- Games with a Linux port will be used by default on Desktop images.
|
||||
- Valve selects the default runner on _Handheld/HTPC_ images.
|
||||
- Some games run better with a specific version of Proton or forcing the Linux runtime.
|
||||
- Run that specific version by going into the game's **Properties** > **Compatibility** > **Force the use of a specific Steam Play compatibility tool**
|
||||
|
||||
![Cog Icon > Properties|690x284, 75%](../img/Steam_Setup_Cog.png)
|
||||
![Compatibility tab|690x492, 75%](../img/Steam_Setup_Compat_Tab.png)
|
||||
|
||||
## **Non-Steam Games**
|
||||
|
||||
- **It is recommended to use [Lutris](https://lutris.net/games?q=&ordering=-popularity&paginate_by=100) for _most_ non-steam games**.
|
||||
- However, [Heroic Games Launcher](https://heroicgameslauncher.com) is intended as a suitable replacement for the Epic Games Launcher.
|
||||
- [Bottles](https://usebottles.com/) is an alternative to Lutris and great for non-gaming Windows software.
|
||||
- Other games and launchers are also available in the software center (_Discover_ or _GNOME Software_) like itch.io.
|
||||
|
||||
### Lutris Setup
|
||||
|
||||
![Lutris|617x500, 75%](../img/Lutris_Setup.png)
|
||||
|
||||
![Example of Lutris installers|623x500, 75%](../img/Lutris_Setup_Installers.png)
|
||||
|
||||
Lutris is game management software that doubles as a WINE front-end for Windows games. Several games and launchers can be installed by searching for the title and using one of the installer scripts for it.
|
||||
|
||||
#### Manually adding a Windows game to Lutris
|
||||
|
||||
However if your game is not listed or doesn't work with the provided script, then manually add the executable. Add locally installed game and make sure to configure it properly within the game and runner options.
|
||||
|
||||
![Add Locally Installed Game|632x496, 75%](../img/Lutris_Setup_Add_Local_Game.png)
|
||||
|
||||
**Example 1**:
|
||||
|
||||
![Lutris manually adding games example 1|690x213](../img/Lutris_Setup_Add_Local_Game_1.png)
|
||||
|
||||
**Example 2**:
|
||||
![Lutris manually adding games example 2|690x342, 100%](../img/Lutris_Setup_Add_Local_Game_2.png)
|
||||
|
||||
#### Lutris Shortcuts
|
||||
|
||||
![Lutris_Right_Click_Menu|421x447, 75%](../img/Lutris_Setup_Shortcut.png)
|
||||
|
||||
Right clicking a game on Lutris gives the option to add it as a non-Steam game (useful for Steam Gaming Mode), create a desktop shortcut, or an application menu shortcut.
|
||||
|
||||
### Gamepass / Microsoft Store Games (Cloud Streaming)
|
||||
|
||||
Games installed from the Microsoft Store do **not** run on desktop Linux unless you use a xCloud client like [Greenlight](https://github.com/unknownskl/greenlight). Fortnite can also be played via xCloud without a Gamepass subscription using this method.
|
||||
|
||||
## Auto-Mounting Game Drives
|
||||
|
||||
Read the [Auto-Mounting Secondary Drives Guide](../Advanced/Auto-Mounting_Secondary_Drives.md) for more information. It is also recommended to do your own research on drive mounting on Linux.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Gaming Guide**](./index.md)
|
@ -1,63 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2659", "fetched_at": "2024-09-03 16:43:08.896738+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Compatible Handhelds
|
||||
|
||||
Read the [Handheld Wiki](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) to see what handhelds Bazzite currently supports.
|
||||
|
||||
## Desktop/HTPC Hardware: Vulkan Compatible GPU
|
||||
|
||||
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:
|
||||
|
||||
```command
|
||||
vulkaninfo | grep 'Instance Version'
|
||||
```
|
||||
|
||||
- If it outputs less than `1.3` in the `Vulkan Instance Version:` or does not work at all, then you will run into issues including unplayable games and worse performance.
|
||||
- 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**:
|
||||
|
||||
```command
|
||||
PROTON_USE_WINED3D=1 %command%
|
||||
```
|
||||
|
||||
## Unsupported Filesystems for Secondary Drives
|
||||
|
||||
> **Warning**: You will lose all of your data reformatting secondary internal/external drives.
|
||||
|
||||
See also: [**Auto-Mounting Secondary Drives**](../Advanced/Auto-Mounting_Secondary_Drives.md)
|
||||
|
||||
### NTFS
|
||||
|
||||
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 symbolic links** which is what Proton prefixes use.
|
||||
|
||||
> However, scenarios where a microSD card is formatted to exFAT _may work_ in some cases, but it is entirely unsupported by Universal Blue if something goes horribly wrong using it.
|
||||
|
||||
## Sharing Games w/ Windows Installation
|
||||
|
||||
Install the unofficial [WinBtrfs](https://github.com/maharmstone/btrfs) driver on your Windows installation at your own risk. Please note that Gamepass games and games installed and launched through the Epic Games Launcher do **not** work with BTRFS under Windows.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Gaming Guide**](./index.md)
|
@ -1,110 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2657", "fetched_at": "2024-09-03 16:43:07.954041+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Compatibility Layers
|
||||
|
||||
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
|
||||
|
||||
![ProtonUp-Qt Interface|690x388](../img/ProtonUp-Qt_Interface.png)
|
||||
|
||||
> **KDE Plasma Images**: [**ProtonUp-Qt**](https://davidotek.github.io/protonup-qt/)
|
||||
|
||||
> **GNOME Images**: [**ProtonPlus**](https://github.com/Vysp3r/protonplus)
|
||||
|
||||
Install and update to the latest [GE-Proton](https://github.com/GloriousEggroll/proton-ge-custom), [Luxtorpeda](https://github.com/luxtorpeda-dev/luxtorpeda), and other useful [SteamPlay tools](https://steamcommunity.com/games/221410/announcements/detail/1696055855739350561).
|
||||
|
||||
#### Steamplay Tools
|
||||
|
||||
> View the tested games with [**GE-Proton**](https://github.com/GloriousEggroll/proton-ge-custom/blob/master/README.md#tested-games).
|
||||
|
||||
> View the compatible games with [**Luxtorpeda**](https://luxtorpeda-dev.github.io/packages).
|
||||
|
||||
### Protontricks / Winetricks
|
||||
|
||||
![Protontricks|660x500](../img/Protontricks.png)
|
||||
|
||||
Some games require [Protontricks](https://github.com/Matoking/protontricks) (pre-installed) or [Winetricks](https://github.com/Winetricks/winetricks) (for non-Steam games, included with Lutris) to function properly.
|
||||
|
||||
## Hidden Files in File Manager
|
||||
|
||||
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 Windows Folders
|
||||
|
||||
Many PC games drop files in Windows folders like "My Documents" or "AppData" and both can be found in your prefix directory. This prefix directory may be useful for modding your games, backing up your saves, or configuration files.
|
||||
|
||||
![AppID|690x482, 75%](../img/Steam_AppID.png)
|
||||
|
||||
For games on Steam, they are located in your `~/.steam/root/steamapps/compatdata/` folder, and then the **AppID number of the game**:
|
||||
|
||||
- This ID by going into the game's properties on Steam in the games `Properties > Updates > App ID`
|
||||
- Continue to `.../pfx/drive_c/` and wherever the game drops the file on Windows.
|
||||
|
||||
### Broken Proton Prefix?
|
||||
|
||||
![Delete Proton Prefix|382x341, 75%](../img/Steam_Delete_Prefix.png)
|
||||
|
||||
> **Note**: Save files are located in the prefix, so backup the save file in there before deleting especially if the game does not support cloud saving.
|
||||
|
||||
1. Steam allows users to delete and reset their prefix only in Big Picture Mode (and Gaming Mode) by going into the game's "Developer" settings (accessed with the 'cog' / game settings icon)
|
||||
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
|
||||
|
||||
![Template|690x334, 50%](../img/DXVK_Mango_VkBasalt_templ.png)
|
||||
|
||||
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>
|
||||
|
||||
[**<-- Back to Gaming Guide**](./index.md)
|
@ -1,57 +0,0 @@
|
||||
---
|
||||
title: Gaming
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=31", "fetched_at": "2024-09-03 16:43:06.311188+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Linux Gaming Introduction
|
||||
|
||||
Linux gaming being a viable competitor to Windows is a relatively new paradigm. Most Windows exclusive games can run on Bazzite using modern hardware. There are still some rough edges, but gaming on Linux does offer advantages on the appropriate hardware such as better frame-times than on Windows.
|
||||
|
||||
## [Game Launchers](Game_Launchers.md)
|
||||
|
||||
- Setting Up Steam
|
||||
- Non-Steam Games
|
||||
- Available Options
|
||||
- Configuring Lutris
|
||||
- Gamepass Using Xbox Cloud Gaming
|
||||
|
||||
## [Managing & Modding Games](Managing_and_modding_games.md)
|
||||
|
||||
- Compatibility Layers
|
||||
- Proton Prefix Information
|
||||
- Hidden Files in File Manager
|
||||
- Modding Quick-Start
|
||||
- Pre-Installed Enhancements
|
||||
|
||||
## [Common Gaming Issues](Common_gaming_issues.md)
|
||||
|
||||
- Proton Logs
|
||||
- Native Linux Builds vs. Proton
|
||||
- Issues with Valve/Source Games
|
||||
|
||||
## [Hardware Compatibility for Gaming](Hardware_compatibility_for_gaming.md)
|
||||
|
||||
- Compatible Handhelds
|
||||
- Vulkan Capable GPU for Desktop/HTPC Hardware
|
||||
- Information Regarding Unsupported Filesystems
|
||||
|
||||
## Useful External Resources
|
||||
|
||||
- [**ProtonDB**](https://www.protondb.com/explore) - User reports for game compatibility on Linux
|
||||
- [**Are We Anti-Cheat Yet?**](https://areweanticheatyet.com/) - List of popular games utilizing anti-cheat software and if the game supports Linux
|
||||
- [**Linux Gaming Wiki**](https://linux-gaming.kwindu.eu/index.php?title=Main_Page) - Introduction to Linux gaming that includes helpful links
|
||||
- [**PC Gaming Wiki**](https://www.pcgamingwiki.com/wiki/Home) - General information, workarounds, and enhancements for PC games
|
||||
- [**General Emulation Wiki**](https://emulation.gametechwiki.com/index.php/Main_Page) - Emulation resources
|
||||
|
||||
<hr>
|
||||
|
||||
**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)
|
||||
|
||||
**See also**: [Steam Deck Gaming Mode Overview](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
|
||||
|
||||
<-- [**View all Bazzite documentation**](../index.md)
|
@ -1,94 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=574", "fetched_at": "2024-09-03 16:43:19.212243+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Customizing KDE Plasma
|
||||
|
||||
> 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.
|
||||
|
||||
![Directory|401x207, 75%](../img/Directory.png)
|
||||
|
||||
### Universal instructions for most custom themes
|
||||
|
||||
Step-by-step instructions to install custom themes on KDE Plasma.
|
||||
|
||||
1. Download the theme manually from the [KDE Store](https://store.kde.org/browse/)
|
||||
2. Extracting the contents to `~/.local/share/plasma/` (you may need to make this directory)
|
||||
3. Open the system settings and select your theme, style, cursor etc. as it now should appear
|
||||
|
||||
#### Theme Extraction Locations
|
||||
|
||||
The location where specific KDE Plasma components will be extracted on the desktop.
|
||||
|
||||
##### Global Themes
|
||||
|
||||
Global themes are placed in `~/.local/share/plasma/look-and-feel/` (_you may need to make this directory_).
|
||||
|
||||
##### Plasma Themes
|
||||
|
||||
"Plasma themes" are placed in `~/.local/share/plasma/desktoptheme/` (_you may need to make this directory_).
|
||||
|
||||
##### SDDM (Login Manager) Themes
|
||||
|
||||
SDDM themes are placed in `/etc/sddm/themes` (_you may need to make this directory_).
|
||||
|
||||
SDDM themes can also be layered at your own risk if they are available as RPM packages.
|
||||
|
||||
##### Icon / Cursor Themes
|
||||
|
||||
"Icon/Cursor themes" are placed in `~/.icons`
|
||||
|
||||
##### Application Permissions to Use Themes
|
||||
|
||||
Some Flatpaks need filesystem permissions for applications that have issues with cursor themes.
|
||||
|
||||
**Example**: (`~/.icons/:ro` in "Filesystem" in each problematic application or globally in Flatseal).
|
||||
|
||||
##### Themes that require `kvantum`
|
||||
|
||||
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.
|
||||
|
||||
![KDE Wallpaper Settings|682x500, 75%](../img/KDE_Wallpaper_Settings.jpeg)
|
||||
|
||||
**[Wallpaper Engine](https://www.wallpaperengine.io/en) is a live wallpaper application intended for Windows.**
|
||||
|
||||
![Wallpaper settings|549x500, 75%](../img/Wallpaper_settings.png)
|
||||
|
||||
Read this [guide](https://github.com/catsout/wallpaper-engine-kde-plugin/blob/main/README.md#usage) on how to set it up on KDE Plasma.
|
||||
|
||||
<hr>
|
||||
|
||||
## Manage GNOME Extensions (`-gnome` Images)
|
||||
|
||||
View the [Bluefin documentation](https://docs.projectbluefin.io/administration#managing-extensions) since most of the information will be relevant to Bazzite as well.
|
||||
|
||||
<hr>
|
||||
|
||||
## Steam Gaming Mode Tweaks (`-deck` Images)
|
||||
|
||||
> Decky Loader will sometimes have issues with new Steam and Gamescope updates, and may need to be uninstalled temporarily.
|
||||
|
||||
Install [Decky Loader](https://decky.xyz/) then install [CSS Loader](https://docs.deckthemes.com/) to customize how Steam Gaming Mode looks. Be aware that third-party plugins may cause issues. Read Bazzite's [Steam Gaming Mode documentation](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) to resolve common issues if you run into them after using Decky Loader.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View all Bazzite documentation**](../index.md)
|
@ -1,198 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=33", "fetched_at": "2024-09-03 16:43:17.727110+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Why is it called Bazzite?
|
||||
|
||||
[Fedora Linux's Atomic Desktops](https://fedoraproject.org/atomic-desktops/) originally followed a naming scheme based on [minerals.](https://fedoraproject.org/kinoite/) Bazzite is a mineral that is known for being strong, lightweight, and is colored [blue](https://universal-blue.org/).
|
||||
|
||||
## What Bazzite image do I use?
|
||||
|
||||
Bazzite's [website](https://bazzite.gg/#image-picker) offers a streamlined way of selecting the correct image which will be chosen based on hardware, desktop environment, and to include Steam Gaming Mode if the hardware supports it.
|
||||
|
||||
Bazzite offers multiple images, but most images will be following _one of these two formats_:
|
||||
|
||||
- Bazzite that automatically boots into Steam Gaming Mode with manual updates
|
||||
- Bazzite that does **not** have Steam Gaming Mode and receives automatic updates daily
|
||||
|
||||
**Images are split up between **two** types of Bazzite editions**:
|
||||
|
||||
### 1. Desktop Edition
|
||||
|
||||
> **Steam Gaming Mode is not on these specific images!**
|
||||
|
||||
Intended specifically for desktops and laptops with a focus on gaming which is influenced by SteamOS's Desktop Mode and the maintenance-free nature of ChromeOS.
|
||||
|
||||
Steam and other gaming utilities are part of the base operating system. System rollbacks available with a rock-solid stable Fedora Linux base. **Updates are automatically downloaded in the background and applied on a restart**. Most modern hardware should be compatible outside of specific drivers that do not work well on desktop Linux.
|
||||
|
||||
The choice of KDE Plasma and GNOME for the desktop environment with others planned for the future. [Flathub](https://flathub.org/) is enabled out of the box, so all of the applications that you would find on SteamOS are available on Bazzite.
|
||||
|
||||
### [2. Handheld/HTPC Edition (`-deck` Images)](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
|
||||
|
||||
Mimics SteamOS with "**Steam Gaming Mode**" and its features fully functional. This version of Bazzite boots directly into the Steam Gaming Mode session and are intended for handheld PCs and home theater setups.
|
||||
|
||||
Images also includes a Desktop Mode session with the choice of GNOME or KDE Plasma and is based on our Desktop images. **Updates are manually installed by the user and applied on a restart**.
|
||||
|
||||
> Steam Gaming Mode **requires** a modern AMD graphics card or an Intel Arc graphics card.
|
||||
|
||||
#### Desktop Environments & Specific Hardware Variants
|
||||
|
||||
Both types of images also come with the choice of using [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for the desktop environment and certain images are made with specific hardware support.
|
||||
|
||||
There is more information about this topic on the [Installation Guide](../General/Installation_Guide/index.md) to help guide users on which image to choose before the installation.
|
||||
|
||||
### Bazzite Image Chart
|
||||
|
||||
| Image | Desktop Environment | Steam Gaming Mode | Hardware | Edition |
|
||||
| --------------------------- | ------------------- | ----------------- | ---------------------------------------- | ------------- |
|
||||
| `bazzite` | KDE Plasma | No | AMD/Intel GPUs | Desktop |
|
||||
| `bazzite-nvidia` | KDE Plasma | No | Nvidia GPUs | Desktop |
|
||||
| `bazzite-gnome` | GNOME | No | AMD/Intel GPUs | Desktop |
|
||||
| `bazzite-gnome-nvidia` | GNOME | No | Nvidia GPUs | Desktop |
|
||||
| `bazzite-deck` | KDE Plasma | Yes | AMD/Intel Arc GPUs | Handheld/HTPC |
|
||||
| `bazzite-deck-gnome` | GNOME | Yes | AMD/Intel Arc GPUs | Handheld/HTPC |
|
||||
| `bazzite-asus` | KDE Plasma | No | ASUS Laptops (AMD/Intel GPUs | Desktop |
|
||||
| `bazzite-asus-gnome` | GNOME | No | ASUS Laptops (AMD/Intel GPUs) | Desktop |
|
||||
| `bazzite-asus-nvidia` | KDE Plasma | No | ASUS Laptops (Nvidia GPUs) | Desktop |
|
||||
| `bazzite-gnome-asus-nvidia` | GNOME | No | ASUS Laptops (Nvidia GPUs) | Desktop |
|
||||
| `bazzite-ally` | KDE Plasma | Yes | ASUS Laptops (Steam Gaming Mode Enabled) | Handheld/HTPC |
|
||||
| `bazzite-ally-gnome` | GNOME | Yes | ASUS Laptops (Steam Gaming Mode Enabled) | Handheld/HTPC |
|
||||
|
||||
### Who are the target audiences?
|
||||
|
||||
- Desktop users who want an operating system designed for gaming with inspiration from SteamOS that has fairly low maintenance.
|
||||
- Steam Deck users who feel limited by SteamOS and also want newer system packages.
|
||||
- Home Theater PC setups for a console-like experience.
|
||||
- [Handheld PC](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) users who would prefer a SteamOS-like experience.
|
||||
|
||||
## SteamOS is based on Arch Linux, so why use Fedora Linux?
|
||||
|
||||
SteamOS receives package and driver updates less frequently despite the rolling release base.
|
||||
|
||||
Bazzite will follow Fedora's update release cycle which means early access to new graphics card driver and kernel updates in comparison to SteamOS.
|
||||
|
||||
Fedora Linux and Universal Blue currently supports a specific "atomic" implementation to maintain multiple images that can receive all of the same updates at once, which is unlike a derivative Linux distribution.
|
||||
|
||||
> The **goal** of Bazzite is to have an operating system ready to game after installing it.
|
||||
|
||||
#### Any advantages to using Fedora?
|
||||
|
||||
Since Bazzite is a custom Fedora Atomic Desktop image, it makes use of read-only root files for stability purposes, and is built with [libostree](https://docs.fedoraproject.org/en-US/fedora-silverblue/technical-information/) which has advantages such as:
|
||||
|
||||
- Low risk of an unbootable system
|
||||
- Rollback system updates if necessary, and the ability to pin your current deployment as a backup save state without losing user data.
|
||||
- Smooth upgrade process from major Fedora point releases.
|
||||
- Layer Fedora packages to the host that survive between updates.
|
||||
- Focus on containerized applications that do not interfere with your host system.
|
||||
|
||||
> Check out the [Universal Blue homepage](https://universal-blue.org) for more information on what this project is capable of.
|
||||
|
||||
### How is Fedora Atomic Desktop different than Fedora Workstation?
|
||||
|
||||
If you're familiar with [Fedora Workstation](https://www.fedoraproject.org/workstation/) and [Fedora's Spins](https://www.fedoraproject.org/spins/), but not the Fedora Atomic Desktops paradigm, the major difference is with stability between system upgrades. There are read-only root files and an emphasis on installing applications as a Flatpak or inside [containers.](https://distrobox.it/) Read more about [obtaining software on Bazzite](../Installing_and_Managing_Software/index.md).
|
||||
|
||||
Users can rollback to a previous deployment if a system update breaks their workflow, or rebase entirely back to a stock Fedora Atomic image, [Aurora](https://getaurora.dev/), [Bluefin](https://projectbluefin.io/), or a [custom image by the community](https://universal-blue.discourse.group/docs?topic=340). Do **not** rebase between different desktop environments. Read more about how [updates, rolling back, and rebasing works on Bazzite](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
|
||||
|
||||
Here's a helpful [cheat sheet](https://docs.fedoraproject.org/en-US/fedora-silverblue/_attachments/silverblue-cheatsheet.pdf) for using **advanced** commands, but gives a glimpse of what this paradigm is capable of. There is also a future planned ahead of this technology. Upcoming additions like [bootc](https://containers.github.io/bootc/) will be a major change when it is ready for production.
|
||||
|
||||
### Is this another fringe Linux distribution?
|
||||
|
||||
Bazzite is **not** a Linux distribution in the traditional sense. It's a custom Fedora Atomic Desktop image with a recipe on top of it. Universal Blue images are a proof of concept of using containerized workflows with transactional and in-place operating system updates, and Bazzite exists by being gaming focused with inspiration from SteamOS.
|
||||
|
||||
> Essentially, Bazzite is a Fedora Atomic Desktop installation, but with the aid of Universal Blue's tooling, adds packages, services, drivers, etc. to the base image of it.
|
||||
|
||||
#### How does Bazzite differ?
|
||||
|
||||
Bazzite is using a new "**container-native**" approach that Fedora has been testing, and we are taking full advantage of it.
|
||||
|
||||
We are utilizing the [Open Container Initiative (OCI)](https://opencontainers.org/about/overview/) to build the images, and are simply adding packages, services, kernel modules, and our own spin to existing Fedora operating systems.
|
||||
|
||||
Unlike traditional Linux distributions, **most of the maintenance and security updates are done upstream** by Fedora and Universal Blue while Bazzite only has to focus on creating a great experience for PC gaming.
|
||||
|
||||
> The ultimate goal of Bazzite is to be Fedora Linux, but provide a great gaming experience out of the box while also being an alternative operating system for the Steam Deck.
|
||||
|
||||
##### Image Matrix
|
||||
|
||||
We provide several different images that all get the same additions and fixes through updates at the same time unless specified otherwise. Many images are hardware specific for compatibility reasons, yet all of the images will usually receive the same features and fixes at the same time.
|
||||
|
||||
There can be a hypothetical scenario where everyone involved with Bazzite could stop maintaining the project at once and it will still continue to receive updates directly from upstream.
|
||||
|
||||
## Can this be used as a daily driver?
|
||||
|
||||
**Yes**.
|
||||
|
||||
Updates are obtained and downloaded straight from upstream which means there is little maintenance to be done with the image on our end since these images are modified Fedora images. Users will receive application and system updates from Bazzite, Universal Blue, and Fedora daily.
|
||||
|
||||
> A friendly reminder that this project is still in its early stages and moving at a fast pace with updates and changes nearly daily.
|
||||
|
||||
### What are some of the utilities that Bazzite ships?
|
||||
|
||||
(_in alphabetical order_)
|
||||
|
||||
- [Boxkit](https://github.com/ublue-os/boxkit): Tool used for custom OCI Distrobox/Toolbox containers, and anything from [DaVinci Resolve](https://github.com/zelikos/davincibox) to [OBS Studio Portable](https://github.com/ublue-os/obs-studio-portable) can be accessed with this. (The software is in their own special container, so dependencies do not affect your host.)
|
||||
- [Discover Overlay](https://github.com/trigg/Discover): Discord chat overlay integration for Steam Gaming Mode which has a [special configuration](https://trigg.github.io/Discover/bazzite) for Bazzite where it launches automatically
|
||||
- [Handheld Daemon](https://github.com/hhd-dev/hhd): Tool for configuring and managing handheld devices from gyro, LEDs, paddles, and TDP.
|
||||
- [Ptyxis](https://devsuite.app/ptyxis/): Terminal with first-class container support.
|
||||
- [`ujust`](../Installing_and_Managing_Software/ujust.md): Execute custom commands based on recipes.
|
||||
- [yafti (Bazzite Portal)](https://github.com/ublue-os/yafti/): First-boot utility for installing additional software.
|
||||
|
||||
### Can I use this desktop environment or that standalone window manager?
|
||||
|
||||
Make your own [custom image based off Bazzite](https://universal-blue.discourse.group/docs?topic=43) with the DE and WM change that you want.
|
||||
|
||||
### Is Secure Boot supported?
|
||||
|
||||
> **WARNING (Steam Deck hardware only):** The Steam Deck does not come with secure boot enabled and does not ship with any keys enrolled by default, so do not enable this on Steam Deck hardware unless you absolutely know what you're doing!
|
||||
|
||||
**Yes**, but you will have to enroll our key.
|
||||
|
||||
More information on enrolling the key in our [Secure Boot guide](https://universal-blue.discourse.group/docs?topic=2742).
|
||||
|
||||
## Are AMD, Intel, and Nvidia graphics card drivers pre-installed?
|
||||
|
||||
Yes and they are updated during a system upgrade when available.
|
||||
|
||||
### What if I change hardware?
|
||||
|
||||
Most hardware changes should **not** require any manual intervention outside of the expectations from that particular hardware which would be OS-agnostic.
|
||||
|
||||
However, if you swap from or to a Nvidia GPU, then [rebasing](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rebase_guide.md) will be necessary as a manual intervention to get the appropriate graphics drivers.
|
||||
|
||||
## What is the difference between Bluefin, Aurora, and Bazzite?
|
||||
|
||||
> **TL;DR**: Bazzite is the gaming-centric version of Bluefin (GNOME) and Aurora (KDE Plasma).
|
||||
|
||||
[Bluefin](https://projectbluefin.io/) and [Aurora](https://getaurora.dev) are nearly identical outside of branding and desktop environment, but Bazzite strays away from both. All three are similar for desktop PCs and function similarly and share contributors between projects. Bluefin and Aurora target two audiences---individuals who want a maintenance-free Linux desktop experience and developers (using the `-dx` images).
|
||||
|
||||
Bazzite exclusively focuses on having an out of the box Linux gaming experience for desktop, HTPC hardware, and handhelds. Bazzite can be summed up as Bluefin and Aurora but tuned for PC gaming. All 3 are community-centric custom Fedora Atomic Desktop that is configured for their specific target audience, and for Bazzite specifically: PC gamers who want to use the Linux desktop as the alternative to Windows.
|
||||
|
||||
## How do I change the hostname of my device?
|
||||
|
||||
Edit the `/etc/hostname` file with a new hostname, save it, and reboot.
|
||||
|
||||
```
|
||||
hostnamectl hostname <hostname>
|
||||
```
|
||||
|
||||
## Questions Regarding Java
|
||||
|
||||
If its for Minecraft, then install the [Prism Launcher](https://flathub.org/apps/org.prismlauncher.PrismLauncher) for mods that require anything Java related. If its for development use [Distrobox](../Installing_and_Managing_Software/Distrobox.md). You will not be able to change Java on your host.
|
||||
|
||||
## Why are builds failing?
|
||||
|
||||
![Builds Failing|178x43](../img/Builds_Failing.png)
|
||||
|
||||
Do not be alarmed if you see this on our [Github repository](https://github.com/ublue-os/bazzite/). Builds can fail for a number of reasons, but it's only temporary. You can still install and use Bazzite without any issues. Latest features and fixes may be delayed until the builds are successfully built again however.
|
||||
|
||||
<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)
|
||||
|
||||
**See also**: [Upstream Fedora Silverblue FAQ](https://docs.fedoraproject.org/en-US/fedora-silverblue/faq/)
|
||||
|
||||
<-- [**View all Bazzite documentation**](../index.md)
|
@ -1,57 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- Matt_Hartley
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1818", "fetched_at": "2024-09-03 16:43:26.585334+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## 1. Download the image
|
||||
|
||||
Download the Framework Laptop image of [Bazzite](https://bazzite.gg/). Make sure you select Intel or AMD depending on the mainboard in your device:
|
||||
![1|690x426](../../img/Framework_bazzite.jpeg)
|
||||
|
||||
## 2. Create a USB bootable stick
|
||||
|
||||
**Create a USB stick** using [Fedora Media Writer](https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_on_windows) ([Windows](https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe) or [Mac](https://fedoraproject.org/fmw/FedoraMediaWriter-osx-latest.dmg) or [Linux](https://flathub.org/apps/org.fedoraproject.MediaWriter))
|
||||
|
||||
- Insert your USB drive (8GB or larger). Note that it will be reformatted, so make sure you are ok with erasing any data that is on it.
|
||||
- After installing Fedora Media Writer, run it. Choose Select .iso file, browse to bazzite-gnome-stable.iso (GNOME) or bazzite-stable.iso (KDE) and select it.
|
||||
- Click the Write button.
|
||||
- Once the USB drive creation is complete, you can click Finish, close Fedora Media Writer, eject your USB drive.
|
||||
|
||||
## 3. Booting to the Bazzite USB
|
||||
|
||||
- Insert the USB drive into your powered off Framework Laptop 13, and then power on. If you have an existing OS installed on the Storage drive in your laptop, immediately after the power light comes on begin rapidly tapping (continuously ) the F12 key - you must begin tapping well before you see the Framework logo.
|
||||
- Select Linpus lite (General UDisk) with your arrow keys. Enter key.
|
||||
- Next select Install Bazzite. Hit the enter key.
|
||||
- Select the keyboard language you’d like to use. On the next screen, click on the Installation Destination button to choose the disk.
|
||||
- If there is an OS already installed on the target drive, you’ll need to follow the guided steps to delete the existing partitions.
|
||||
- Click Finish Installation and then reboot into your new Bazzite install!
|
||||
|
||||
![boot1|592x444](../../img/Installing_Framework_1.jpeg)
|
||||
|
||||
![2|690x359](../../img/Installing_Framework_2.jpeg)
|
||||
|
||||
![3|690x359](../../img/Installing_Framework_3.png)
|
||||
|
||||
![4|690x359](../../img/Installing_Framework_4.png)
|
||||
|
||||
![5|690x359](../../img/Installing_Framework_5.png)
|
||||
|
||||
![6|690x359](../../img/Installing_Framework_6.png)
|
||||
|
||||
![7|690x359](../../img/Installing_Framework_7.png)
|
||||
|
||||
![8|690x359](../../img/Installing_Framework_8.png)
|
||||
|
||||
![9|690x432](../../img/Installing_Framework_9.jpeg)
|
||||
|
||||
![10|690x432](../../img/Installing_Framework_10.jpeg)
|
||||
|
||||
![11|690x432](../../img/Installing_Framework_11.jpeg)
|
||||
|
||||
![12|690x432](../../img/Installing_Framework_12.jpeg)
|
||||
|
||||
![13|690x388](../../img/Installing_Framework_13.jpeg)
|
@ -1,198 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1146", "fetched_at": "2024-09-03 16:43:27.199924+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![Desktop|690x448](../../img/Desktop.jpeg)
|
||||
|
||||
## Pre-Installation
|
||||
|
||||
> Pre-requisites and steps before installing Bazzite.
|
||||
|
||||
### Minimum System Requirements
|
||||
|
||||
- **Architecture**: x86_64
|
||||
- **Firmware**: UEFI (CSM Support should be **disabled** if available)
|
||||
- **Processor (CPU)** : 2GHz quad core processor or better
|
||||
- **System Memory (RAM)**: 4GB
|
||||
- **Graphics**: A graphics card that can utilize Vulkan 1.3+
|
||||
- **Storage**: 50GB free on an internal solid-state drive
|
||||
- **Network**: Stable internet connection with no bandwidth caps
|
||||
- **Additional Notes**: Certain [drivers](https://github.com/morrownr/8812au-20210820) are **not** compatible with Bazzite.
|
||||
|
||||
#### Installer Requirements
|
||||
|
||||
- A USB flash drive with 10GB free space
|
||||
- **Note**: All data on this drive will be wiped when flashed
|
||||
- Software to flash the image:
|
||||
- [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
|
||||
- Make sure to properly eject the drive after flashing the ISO to it
|
||||
- Physical keyboard
|
||||
|
||||
### Desktop Environments
|
||||
|
||||
Bazzite comes with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for the desktop environment.
|
||||
|
||||
[Steam Gaming Mode](https://github.com/KyleGospo/gamescope-session) is an option and if you opt to use it, then this installation guide no longer applies and it is recommended to read the [HTPC installation guide](./Installing_Bazzite_for_HTPC_Setups.md) instead.
|
||||
|
||||
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
|
||||
|
||||
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
|
||||
|
||||
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
|
||||
|
||||
- KDE Plasma's default interface has a traditional and familiar layout
|
||||
- Highly customizable with tons of settings
|
||||
- Qt framework
|
||||
- Popular Linux distributions like SteamOS use KDE Plasma
|
||||
|
||||
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
|
||||
|
||||
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
|
||||
|
||||
- GNOME's default interface has an elegant and touch-friendly layout
|
||||
- Simple and concise
|
||||
- GTK framework
|
||||
- Popular Linux distributions like Ubuntu use GNOME
|
||||
|
||||
#### [Steam Gaming Mode (`-deck` images)](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
|
||||
|
||||
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
|
||||
|
||||
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
|
||||
|
||||
- **Requires a [Steam](https://store.steampowered.com/) account**
|
||||
- Included in the [Handheld/HTPC images](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
|
||||
- Interface is designed for handheld and couch gaming
|
||||
- Controller friendly
|
||||
- Choice of KDE Plasma or GNOME in Desktop Mode
|
||||
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
|
||||
|
||||
### Dual Boot Preliminary Setup + Post-Setup Guide
|
||||
|
||||
Read the [Dual Boot Guide](./dual_boot_setup_guide.md) **after** reading this guide before proceeding.
|
||||
|
||||
## Installation Guide
|
||||
|
||||
> The part of the guide that requires the most effort.
|
||||
|
||||
### 1. Download and Flash Bazzite
|
||||
|
||||
- Download [Bazzite](https://download.bazzite.gg) after choosing the correct ISO for your hardware with our Image Picker tool.
|
||||
- Flash Bazzite to your bootable medium.
|
||||
- Eject drive.
|
||||
|
||||
#### Current Fedora Atomic Desktop Users
|
||||
|
||||
Current [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/) users can rebase with the terminal command listed on the website under the "**Existing Fedora Atomic Desktop Users**" section and can skip the next step.
|
||||
|
||||
### 2. Boot Bazzite
|
||||
|
||||
- Connect your bootable medium to your device and boot into it.
|
||||
- After connecting the device, boot into the Bazzite installer.
|
||||
- This depends on your motherboard hardware, but most of the time it could be a function keys like <kbd>F9</kbd> or similar.
|
||||
- Sometimes you need to consult the manual, look up your device online, or read any hotkeys that appear when you boot your PC.
|
||||
- Alternatively change the BIOS settings to boot with your bootable device first before your current storage, but this is **not recommended** to keep enabled after installing Bazzite.
|
||||
- Verify the media correctly and proceed to the installer.
|
||||
|
||||
### 3. Installer
|
||||
|
||||
![Installer](../../img/anaconda_installer.png)
|
||||
|
||||
![Automatic drive configuration|690x497, 75%](../../img/anaconda_drive_configuration.png)
|
||||
|
||||
![User setup example|690x359, 75%](../../img/anaconda_user_setup.png)
|
||||
|
||||
- Select your language, region, keyboard layout, and time zone.
|
||||
- Select the drive that Bazzite is going to be installed on.
|
||||
- Delete any partitions that you have remaining on the drive **unless dual booting on the same drive**.
|
||||
- Recommended to use the automatic storage configuration **unless dual booting on the same drive**.
|
||||
- Optionally encrypt the drive with a password if desired.
|
||||
- **If you lose this password, then it cannot be decrypted**.
|
||||
- Setup a user account.
|
||||
- Give administrative privileges and **set a user password**.
|
||||
- Begin the installation.
|
||||
- Reboot device after it has finished installing.
|
||||
|
||||
#### Important information for users with Secure Boot **enabled**:
|
||||
|
||||
Read the [Secure Boot Guide](https://universal-blue.discourse.group/docs?topic=2742) for more information.
|
||||
|
||||
<hr>
|
||||
|
||||
## Post-Installation
|
||||
|
||||
> The fine tuning before gaming.
|
||||
|
||||
### GRUB Menu
|
||||
|
||||
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
|
||||
|
||||
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
|
||||
|
||||
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
|
||||
|
||||
### Configuring System Settings for KDE Plasma and GNOME
|
||||
|
||||
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
|
||||
**_KDE Plasma's System Settings application_**
|
||||
|
||||
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
|
||||
**_GNOME's Settings application_**
|
||||
|
||||
It is important to configure the system settings on a first boot to personalize your desktop especially if you notice the scaling is incorrect on first-boot.
|
||||
|
||||
### First Boot Setup Utility: Bazzite Portal
|
||||
|
||||
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
|
||||
|
||||
> **Attention**: Make sure you are connected to the internet.
|
||||
|
||||
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
|
||||
|
||||
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
|
||||
|
||||
- Click "Next" to begin configuring Bazzite.
|
||||
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
|
||||
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
|
||||
- Installing items from the portal **may take a long time**.
|
||||
|
||||
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
|
||||
|
||||
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
|
||||
|
||||
### Installing additional software
|
||||
|
||||
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
|
||||
|
||||
## Ready to Game
|
||||
|
||||
**You have now installed Bazzite!**
|
||||
|
||||
View our [Gaming Guide](../../Gaming/index.md) for a quick rundown of Linux gaming, useful resources, and setting up Proton on Steam.
|
||||
|
||||
Check out the additional [documentation](https://docs.bazzite.gg) surrounding the project.
|
||||
|
||||
<hr>
|
||||
|
||||
## **Video Tutorial - Dual Boot Setup w/ Secure Boot Enabled**:
|
||||
|
||||
https://www.youtube.com/watch?v=dXBN9OM7mSE
|
||||
|
||||
<hr>
|
||||
|
||||
## Issues Installing Bazzite?
|
||||
|
||||
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [Nathaniel Warburton](https://github.com/storyaddict), [Jorge Castro](https://github.com/castrojo), [Noel Miller](https://github.com/noelmiller), [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Justin Garrison](https://github.com/rothgar)
|
||||
|
||||
**See also:** [Upstream Manual Partitioning Guide](https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/#manual-partition) & [Auto-Mounting Secondary Drives](../../Advanced/Auto-Mounting_Secondary_Drives.md)
|
||||
|
||||
<-- [**View all Bazzite documentation**](../../index.md)
|
@ -1,70 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- Matt_Hartley
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1819", "fetched_at": "2024-09-03 16:43:25.971719+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## 1. Download the image
|
||||
|
||||
Download the Framework Laptop image of [Bazzite](https://bazzite.gg/). Make sure you select Intel or AMD depending on the mainboard in your device:
|
||||
|
||||
![1](../../img/Framework_bazzite.jpeg)
|
||||
|
||||
## 2. Create a USB bootable stick
|
||||
|
||||
**Create a USB stick** using [Fedora Media Writer](https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_on_windows) ([Windows](https://fedoraproject.org/fmw/FedoraMediaWriter-win32-latest.exe) or [Mac](https://fedoraproject.org/fmw/FedoraMediaWriter-osx-latest.dmg) or [Linux](https://flathub.org/apps/org.fedoraproject.MediaWriter))
|
||||
|
||||
- Insert your USB drive (8GB or larger). Note that it will be reformatted, so make sure you are ok with erasing any data that is on it.
|
||||
- After installing Fedora Media Writer, run it. Choose Select .iso file, browse to bazzite-gnome-stable.iso (GNOME) or bazzite-stable.iso (KDE) and select it.
|
||||
- Click the Write button.
|
||||
- Once the USB drive creation is complete, you can click Finish, close Fedora Media Writer, eject your USB drive.
|
||||
|
||||
## 3. Linux Audio Compatibility
|
||||
|
||||
- Before we begin the installation process with the Live USB, let’s make sure you have your Linux Audio Compatibility set to Linux in the BIOS.
|
||||
- Power on the laptop, repeatedly tapping F2 in order to get into the BIOS. Note: If you’re having trouble with this, try again, holding down the Fn key while rapidly tapping F2.
|
||||
- In BIOS mode, arrow key over to Setup Utility. Press the enter key. Arrow down to Advanced. Then arrow right, then arrow down to Linux Audio Compatibility. Press enter.
|
||||
- A new box for Linux Audio Compatibility will appear, arrow to Linux, then press enter. Now press F10 key to reboot.
|
||||
- Now we don’t have an OS installed yet. So the reboot won’t get us to a running operating system and we fully expect to see an error to this point. Simply press the power button to shutdown.
|
||||
|
||||
![audio1|592x444](../../img/Install_Framework_16_audio_1.jpeg)
|
||||
|
||||
![audio2|592x444](../../img/Install_Framework_16_audio_2.jpeg)
|
||||
|
||||
## 4. Booting to the Bazzite USB
|
||||
|
||||
- Insert the USB drive into your powered off Framework Laptop 13, and then power on. If you have an existing OS installed on the Storage drive in your laptop, immediately after the power light comes on begin rapidly tapping (continuously ) the F12 key - you must begin tapping well before you see the Framework logo.
|
||||
- Select Linpus lite (General UDisk) with your arrow keys. Enter key.
|
||||
- Next select Install Bazzite. Hit the enter key.
|
||||
- Select the keyboard language you’d like to use. On the next screen, click on the Installation Destination button to choose the disk.
|
||||
- If there is an OS already installed on the target drive, you’ll need to follow the guided steps to delete the existing partitions.
|
||||
- Click Finish Installation and then reboot into your new Bazzite install!
|
||||
|
||||
![boot1|592x444](../../img/Installing_Framework_1.jpeg)
|
||||
|
||||
![2](../../img/Installing_Framework_2.jpeg)
|
||||
|
||||
![3](../../img/Installing_Framework_3.png)
|
||||
|
||||
![4](../../img/Installing_Framework_4.png)
|
||||
|
||||
![5](../../img/Installing_Framework_5.png)
|
||||
|
||||
![6](../../img/Installing_Framework_6.png)
|
||||
|
||||
![7](../../img/Installing_Framework_7.png)
|
||||
|
||||
![8](../../img/Installing_Framework_8.png)
|
||||
|
||||
![9](../../img/Installing_Framework_9.jpeg)
|
||||
|
||||
![10](../../img/Installing_Framework_10.jpeg)
|
||||
|
||||
![11](../../img/Installing_Framework_11.jpeg)
|
||||
|
||||
![12](../../img/Installing_Framework_12.jpeg)
|
||||
|
||||
![13](../../img/Installing_Framework_13.jpeg)
|
@ -1,205 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1145", "fetched_at": "2024-09-03 16:43:24.537747+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![HTPC|609x371](../../img/HTPC.png)
|
||||
|
||||
## Pre-Installation
|
||||
|
||||
> Pre-requisites and steps before installing Bazzite.
|
||||
|
||||
### Minimum System Requirements
|
||||
|
||||
- **Architecture**: x86_64
|
||||
- **Firmware**: UEFI (CSM Support should be **disabled** if available)
|
||||
- **Processor (CPU)** : 2GHz quad core processor or better
|
||||
- **System Memory (RAM)**: 4GB
|
||||
- **Graphics**: A graphics card that can utilize Vulkan 1.3+
|
||||
- **Storage**: 50GB free on an internal solid-state drive
|
||||
- **Network**: Stable internet connection with no bandwidth caps
|
||||
- **Additional Notes**: Certain [drivers](https://github.com/morrownr/8812au-20210820) are **not** compatible with Bazzite.
|
||||
|
||||
#### Steam Gaming Mode Requirements
|
||||
|
||||
- A modern AMD GPU
|
||||
- Intel Arc GPUs may work with **major caveats**
|
||||
- Nvidia GPUs are **not** supported
|
||||
- [Steam](https://store.steampowered.com/) account
|
||||
|
||||
#### Installer Requirements
|
||||
|
||||
- A USB flash drive with 10GB free space
|
||||
- **Note**: All data on this drive will be wiped when flashed
|
||||
- Software to flash the image:
|
||||
- [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
|
||||
- Make sure to properly eject the drive after flashing the ISO to it
|
||||
- Physical keyboard
|
||||
|
||||
### Desktop Environments
|
||||
|
||||
All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for their desktop environment.
|
||||
|
||||
[Steam Gaming Mode](https://github.com/KyleGospo/gamescope-session) is an option and is recommended for HTPC setups.
|
||||
|
||||
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
|
||||
|
||||
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
|
||||
|
||||
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
|
||||
|
||||
- KDE Plasma's default interface has a traditional and familiar layout
|
||||
- Highly customizable with tons of settings
|
||||
- Qt framework
|
||||
- Popular Linux distributions like SteamOS use KDE Plasma
|
||||
|
||||
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
|
||||
|
||||
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
|
||||
|
||||
- GNOME's default interface has an elegant and touch-friendly layout
|
||||
- Simple and concise
|
||||
- GTK framework
|
||||
- Popular Linux distributions like Ubuntu use GNOME
|
||||
|
||||
#### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
|
||||
|
||||
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
|
||||
|
||||
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
|
||||
|
||||
- **Requires a [Steam](https://store.steampowered.com/) account**
|
||||
- Included in the [Handheld/HTPC images][Steam_Gaming_Mode]
|
||||
- Interface is designed for handheld and couch gaming
|
||||
- Controller friendly
|
||||
- Choice of KDE Plasma or GNOME in Desktop Mode
|
||||
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
|
||||
|
||||
## Installation Guide
|
||||
|
||||
> The part of the guide that requires the most effort.
|
||||
|
||||
### 1. Download and Flash Bazzite
|
||||
|
||||
- Download [Bazzite](https://download.bazzite.gg) after choosing the correct ISO for your hardware with our Image Picker tool.
|
||||
- Flash Bazzite to your bootable medium.
|
||||
- Eject drive.
|
||||
|
||||
#### Current Fedora Atomic Desktop Users
|
||||
|
||||
Current [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/) users can rebase with the terminal command listed on the website under the "Existing Fedora Atomic Desktop Users" section and can skip the next step.
|
||||
|
||||
### 2. Boot Bazzite
|
||||
|
||||
- Connect your bootable medium to your device and boot into it.
|
||||
- After connecting the device, boot into the Bazzite installer.
|
||||
- This depends on your motherboard hardware, but most of the time it could be a function keys like <kbd>F9</kbd> or similar.
|
||||
- Sometimes you need to consult the manual, look up your device online, or read any hotkeys that appear when you boot your PC.
|
||||
- Alternatively change the BIOS settings to boot with your bootable device first before your current storage, but this is **not recommended** to keep enabled after installing Bazzite.
|
||||
- Verify the media correctly and proceed to the installer.
|
||||
|
||||
### Dual Boot Preliminary Setup + Post-Setup Guide
|
||||
|
||||
Read the [Dual Boot Guide](https://universal-blue.discourse.group/docs?topic=2743) **after** reading this guide before proceeding.
|
||||
|
||||
### 3. Installer
|
||||
|
||||
![Installer](../../img/anaconda_installer.png)
|
||||
|
||||
![Automatic drive configuration|690x497, 75%](../../img/anaconda_drive_configuration.png)
|
||||
|
||||
![User setup example|690x359, 75%](../../img/anaconda_user_setup.png)
|
||||
|
||||
- Select your language, region, keyboard layout, and time zone.
|
||||
- Select the drive that Bazzite is going to be installed on.
|
||||
- Delete any partitions that you have remaining on the drive **unless dual booting on the same drive**.
|
||||
- Recommended to use the automatic storage configuration **unless dual booting on the same drive**.
|
||||
- Optionally encrypt the drive with a password if desired.
|
||||
- **If you lose this password, then it cannot be decrypted**.
|
||||
- Setup a user account.
|
||||
- Give administrative privileges and **set a user password**.
|
||||
- Begin the installation.
|
||||
- Reboot device after it has finished installing.
|
||||
|
||||
#### Important information for users with Secure Boot **enabled**:
|
||||
|
||||
Read the [Secure Boot Guide](https://universal-blue.discourse.group/docs?topic=2742) for more information.
|
||||
|
||||
<hr>
|
||||
|
||||
## Post-Installation
|
||||
|
||||
> The fine tuning before gaming.
|
||||
|
||||
### GRUB Menu
|
||||
|
||||
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
|
||||
|
||||
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
|
||||
|
||||
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
|
||||
|
||||
### Configuring System Settings for KDE Plasma and GNOME
|
||||
|
||||
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
|
||||
**_KDE Plasma's System Settings application_**
|
||||
|
||||
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
|
||||
**_GNOME's Settings application_**
|
||||
|
||||
It is important to configure the system settings on a first boot to personalize your desktop especially if you notice the scaling is incorrect on first-boot.
|
||||
|
||||
### First Boot Setup Utility: Bazzite Portal
|
||||
|
||||
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
|
||||
|
||||
**Attention**: Make sure you are connected to the internet.
|
||||
|
||||
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
|
||||
|
||||
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
|
||||
|
||||
- Click "Next" to begin configuring Bazzite.
|
||||
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
|
||||
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
|
||||
- Installing items from the portal **may take a long time**.
|
||||
|
||||
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
|
||||
|
||||
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
|
||||
|
||||
### Installing additional software
|
||||
|
||||
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
|
||||
|
||||
### Login to Steam & Reboot Device
|
||||
|
||||
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
|
||||
|
||||
#### Setup Steam Gaming Mode
|
||||
|
||||
![Steam Gaming Mode Setup|690x442, 50%](../../img/pLvHB1NAMlb3ghsR72q7l9Auj8B.jpeg)
|
||||
|
||||
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
|
||||
|
||||
> [Read further information about Steam Gaming Mode][Steam_Gaming_Mode].
|
||||
|
||||
<hr>
|
||||
|
||||
## Issues Installing Bazzite?
|
||||
|
||||
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [Nathaniel Warburton](https://github.com/storyaddict), [Jorge Castro](https://github.com/castrojo), [Noel Miller](https://github.com/noelmiller), [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Justin Garrison](https://github.com/rothgar)
|
||||
|
||||
**See also:** [Upstream Manual Partitioning Guide](https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/#manual-partition) & [Steam Gaming Mode Overview][Steam_Gaming_Mode]
|
||||
|
||||
<-- [**View all Bazzite documentation**](../../index.md)
|
||||
|
||||
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
|
@ -1,216 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1144", "fetched_at": "2024-09-03 16:43:22.899176+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![ASUS ROG Ally|690x301](../../img/ASUS_ROG_Ally.jpeg)
|
||||
|
||||
## Important Notes on Handheld Hardware
|
||||
|
||||
> **Note**: Bazzite requires a stable internet connection with no bandwidth cap in place.
|
||||
|
||||
> **Attention**: Several handhelds require BitLocker to be unlocked (write down your recovery key too), Windows "Fast Startup" disabled, and **not** putting Windows into Hibernation Mode before installing Bazzite.
|
||||
|
||||
> [Bazzite's Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) contains information on setting up your handheld after installing Bazzite and workarounds for known issues.
|
||||
|
||||
<hr>
|
||||
|
||||
## Pre-Installation
|
||||
|
||||
> Pre-requisites and steps before installing Bazzite.
|
||||
|
||||
#### Installer Requirements
|
||||
|
||||
- A USB flash drive with 10GB free space
|
||||
- **Note**: All data on this drive will be wiped when flashed
|
||||
- Software to flash the image:
|
||||
- [Fedora Media Writer](https://www.fedoraproject.org/en/workstation/download/), [Ventoy](https://www.ventoy.net/en/index.html), or [Rufus](https://rufus.ie/en/)
|
||||
- Make sure to properly eject the drive after flashing the ISO to it
|
||||
- Optional: Physical keyboard (without one, your username will be `bazzite` and the password will be `bazzite`)
|
||||
|
||||
#### Steam Gaming Mode Requirements
|
||||
|
||||
- Compatible graphics card
|
||||
- A **modern AMD GPU**
|
||||
- An **Intel Arc GPU** (Other Intel GPU series will not boot Steam Gaming Mode)
|
||||
- Intel Arc handhelds will currently have missing functionality (TDP limit, controls, etc.)
|
||||
|
||||
Handheld users will also benefit from also reading the [Steam Gaming Mode documentation][Steam_Gaming_Mode].
|
||||
|
||||
### Desktop Environments
|
||||
|
||||
All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for their desktop environment.
|
||||
|
||||
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
|
||||
|
||||
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
|
||||
|
||||
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
|
||||
|
||||
- KDE Plasma's default interface has a traditional and familiar layout
|
||||
- Highly customizable with tons of settings
|
||||
- Qt framework
|
||||
- Popular Linux distributions like SteamOS use KDE Plasma
|
||||
|
||||
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
|
||||
|
||||
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
|
||||
|
||||
- GNOME's default interface has an elegant and touch-friendly layout
|
||||
- Simple and concise
|
||||
- GTK framework
|
||||
- Popular Linux distributions like Ubuntu use GNOME
|
||||
|
||||
#### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
|
||||
|
||||
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
|
||||
|
||||
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
|
||||
|
||||
- **Requires a [Steam](https://store.steampowered.com/) account**
|
||||
- Included in the [Handheld/HTPC images][Steam_Gaming_Mode]
|
||||
- Interface is designed for handheld and couch gaming
|
||||
- Controller friendly
|
||||
- Choice of KDE Plasma or GNOME in Desktop Mode
|
||||
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
|
||||
|
||||
### Dual Boot Preliminary Setup + Post-Setup Guide
|
||||
|
||||
Read the [Dual Boot Guide](https://universal-blue.discourse.group/docs?topic=2743) **after** reading this guide first before proceeding.
|
||||
|
||||
<hr>
|
||||
|
||||
## Installation Guide
|
||||
|
||||
> The part of the guide that requires the most effort.
|
||||
|
||||
### 1. Download and Flash Bazzite
|
||||
|
||||
- Download [Bazzite](https://download.bazzite.gg) after choosing the correct handheld hardware with our Image Picker tool.
|
||||
- Flash Bazzite to your bootable medium.
|
||||
- Eject drive.
|
||||
|
||||
### 2. Boot Installation Medium
|
||||
|
||||
You may need to research your handheld on how to boot from removable storage. It may be similar to the Steam Deck with holding down one of the "volume buttons" and pressing another button, but like for other general hardware, it highly dependent on your hardware.
|
||||
|
||||
### 3. Installer Setup
|
||||
|
||||
> **NOTE**: If you do not have a usb physical keyboard connected, do **NOT** press “_User Creation_”, since it will remove the default username and password, and you will be unable to type a username or password without a physical keyboard.
|
||||
|
||||
> **default user**: `bazzite` > **default password**: `bazzite`
|
||||
|
||||
![Installer|690x348](../../img/uHKqd8F4nxZryfP8ebBz1DIbNVv.png)
|
||||
|
||||
<!--![Installer](../../img/zfpz6EXcBqQ6jxho1O9jLLSRUE9.png)--!
|
||||
|
||||
<!--
|
||||
![Automatic Partitioning|690x359](../../img/83958112b4d1d96874868fa33f889bfd0162da9a.png)-->
|
||||
|
||||
![User setup example|690x359, 100%](../../img/anaconda_user_setup.png)
|
||||
|
||||
- Select your language, region, keyboard layout, and time zone.
|
||||
- Select the drive that Bazzite is going to be installed on.
|
||||
- Delete any partitions that you have remaining on the drive **unless [dual booting on the same drive](https://universal-blue.discourse.group/t/dual-boot-preliminary-setup-and-post-setup-guide/2743#p-6361-b-same-drive-method-3)**.
|
||||
- If **[dual booting on the same drive](https://universal-blue.discourse.group/t/dual-boot-preliminary-setup-and-post-setup-guide/2743#p-6361-b-same-drive-method-3)**, it is **strongly recommended** to do manual partitioning and create a separate EFI partition.
|
||||
- The separate EFI partition will help prevent Windows Updates from affecting your Bazzite installation later down the line.
|
||||
- Only use the automatic storage configuration when installing to separate drives
|
||||
- Optionally encrypt the drive with a password if desired.
|
||||
- **If you lose this password, then it cannot be decrypted**.
|
||||
- Setup a user account and begin the installation. (If you do not have a physical, skip this step and begin the installation)
|
||||
- Give administrative privileges and set a user password. (**required**)
|
||||
- Begin the installation.
|
||||
- Reboot device after it has finished installing.
|
||||
|
||||
#### Important information for users with Secure Boot **enabled**:
|
||||
|
||||
Read the [Secure Boot Guide](https://universal-blue.discourse.group/docs?topic=2742).
|
||||
|
||||
<hr>
|
||||
|
||||
## Post-Installation
|
||||
|
||||
> The fine tuning before gaming.
|
||||
|
||||
### GRUB Menu
|
||||
|
||||
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
|
||||
|
||||
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
|
||||
|
||||
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
|
||||
|
||||
### Configuring System Settings for KDE Plasma and GNOME
|
||||
|
||||
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
|
||||
**_KDE Plasma's System Settings application_**
|
||||
|
||||
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
|
||||
**_GNOME's Settings application_**
|
||||
|
||||
After you have booted into the Desktop for the first-time configuration, then you can should adjust the settings to your liking. The most important setting that may need to be changed is the scaling setting in "Display(s) [and Monitor]" since it can be incorrect for the screen of your hardware on a fresh installation. Monitor orientation should also be corrected if it is rotated improperly.
|
||||
|
||||
### First Boot Setup Utility: Bazzite Portal
|
||||
|
||||
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
|
||||
|
||||
> **Attention**: This section requires a stable internet connection. Make sure you are connected to a network.
|
||||
|
||||
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
|
||||
|
||||
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
|
||||
|
||||
- Click "Next" to begin configuring Bazzite.
|
||||
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
|
||||
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
|
||||
- Installing items from the portal **may take a long time**.
|
||||
|
||||
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
|
||||
|
||||
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
|
||||
|
||||
### Installing additional software
|
||||
|
||||
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
|
||||
|
||||
### Login to Steam & Reboot Device
|
||||
|
||||
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
|
||||
|
||||
![Steam Gaming Mode Setup|690x442, 50%](../../img/pLvHB1NAMlb3ghsR72q7l9Auj8B.jpeg)
|
||||
|
||||
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
|
||||
|
||||
#### Post-Setup and Known Issues for Handhelds and Steam Gaming Mode
|
||||
|
||||
Read the [Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) and [Steam Gaming Mode Overview documentation][Steam_Gaming_Mode] for information regarding Bazzite on handheld PCs.
|
||||
|
||||
<hr>
|
||||
|
||||
## **Video Tutorial**
|
||||
|
||||
> **Note**: We strongly recommend **manual partitioning + creating a separate EFI partition** for dual-booting, **not** automatic partitioning.
|
||||
>
|
||||
> See instructions for manual partitioning [here.](https://universal-blue.discourse.group/t/dual-boot-preliminary-setup-and-post-setup-guide/2743#p-6361-manual-partitioning-to-the-same-drive-for-dual-boot-setups-6)
|
||||
|
||||
https://www.youtube.com/watch?v=H4226yq0ZwY
|
||||
|
||||
<hr>
|
||||
|
||||
## Issues Installing Bazzite?
|
||||
|
||||
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [Nathaniel Warburton](https://github.com/storyaddict), [Jorge Castro](https://github.com/castrojo), [Noel Miller](https://github.com/noelmiller), [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Justin Garrison](https://github.com/rothgar)
|
||||
|
||||
**See also:** [Upstream Manual Partitioning Guide](https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/#manual-partition) & [Steam Gaming Mode][Steam_Gaming_Mode]
|
||||
|
||||
<-- [**View all Bazzite documentation**](../../index.md)
|
||||
|
||||
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
|
@ -1,194 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1143", "fetched_at": "2024-09-03 16:43:25.151999+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![image|690x332](../../img/image.jpeg)
|
||||
|
||||
## Bazzite on the Steam Deck
|
||||
|
||||
> **Attention**: XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings, and more information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
|
||||
|
||||
### Status
|
||||
|
||||
Bazzite functions properly on the Steam Deck LCD (256GB+) and Steam Deck OLED models.
|
||||
|
||||
**Bazzite and SteamOS** comparison:
|
||||
Read the [Handheld Wiki entry for the Steam Deck](https://universal-blue.discourse.group/docs?topic=1849) for a quick comparison.
|
||||
|
||||
> **Note**: Bazzite requires a stable internet connection with no bandwidth cap in place.
|
||||
|
||||
<hr>
|
||||
|
||||
## Pre-Installation
|
||||
|
||||
> Pre-requisites and steps before installing Bazzite.
|
||||
|
||||
#### Installer Requirements
|
||||
|
||||
- A USB flash drive with 10GB free space
|
||||
- **Note**: All data on this drive will be wiped when flashed
|
||||
- Software to flash the image:
|
||||
- [Ventoy](https://www.ventoy.net/en/index.html)
|
||||
- Make sure to properly eject the drive after flashing the ISO to it
|
||||
- Optional: Physical keyboard (without one, your username will be `bazzite` and the password will be `bazzite`)
|
||||
|
||||
### Desktop Environments
|
||||
|
||||
All of the images come with the choice of [KDE Plasma](https://kde.org/plasma-desktop/) or [GNOME](https://www.gnome.org/) for their desktop environment.
|
||||
|
||||
[Steam Gaming Mode](https://github.com/KyleGospo/gamescope-session) is a requirement for the Steam Deck.
|
||||
|
||||
More information can be found on our [FAQ](https://faq.bazzite.gg) about the differences between the image variants.
|
||||
|
||||
#### [KDE Plasma (Default)](https://kde.org/plasma-desktop/)
|
||||
|
||||
![KDE Plasma|690x388, 75%](../../img/KDE_Plasma_DE.jpeg)
|
||||
|
||||
- KDE Plasma's default interface has a traditional and familiar layout
|
||||
- Highly customizable with tons of settings
|
||||
- Qt framework
|
||||
- Popular Linux distributions like SteamOS use KDE Plasma
|
||||
|
||||
#### [GNOME (`-gnome` images)](https://www.gnome.org/)
|
||||
|
||||
![GNOME|690x359, 75%](../../img/GNOME_DE.png)
|
||||
|
||||
- GNOME's default interface has an elegant and touch-friendly layout
|
||||
- Simple and concise
|
||||
- GTK framework
|
||||
- Popular Linux distributions like Ubuntu use GNOME
|
||||
|
||||
#### [Steam Gaming Mode (`-deck` images)][Steam_Gaming_Mode]
|
||||
|
||||
![Gaming Mode|690x388, 75%](../../img/Gaming_Mode.jpeg)
|
||||
|
||||
> **Note**: Your device will automatically boot into the Steam Gaming Mode session at startup, and Desktop Mode can be accessed from the "**power menu**" in Steam Gaming Mode.
|
||||
|
||||
- **Requires a [Steam](https://store.steampowered.com/) account**
|
||||
- Included in the [Handheld/HTPC images][Steam_Gaming_Mode]
|
||||
- Interface is designed for handheld and couch gaming
|
||||
- Controller friendly
|
||||
- Choice of KDE Plasma or GNOME in Desktop Mode
|
||||
- Extra functionality with [Decky](https://github.com/SteamDeckHomebrew/decky-loader) [plugins](https://plugins.deckbrew.xyz/)
|
||||
- XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings. More information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
|
||||
|
||||
<hr>
|
||||
|
||||
## Installation Guide
|
||||
|
||||
> The part of the guide that requires the most effort.
|
||||
|
||||
**IMPORTANT**: XHCI has to be set as the USB Mode for the Steam Deck for our ISO to boot! If it is set to DRD, please change it in your BIOS settings. More information can be found [here](https://github.com/ublue-os/bazzite/issues/808#issuecomment-1963141866).
|
||||
|
||||
### 1. Download and Flash Bazzite
|
||||
|
||||
- Download [Bazzite](https://download.bazzite.gg) after choosing the Steam Deck ISO with our Image Picker tool.
|
||||
- Flash Bazzite to your bootable medium.
|
||||
- Eject drive.
|
||||
|
||||
### 2. Boot Installation Medium
|
||||
|
||||
Hold the 'Volume Down' (<kbd>-</kbd>) button and click the Power Button, and when you hear the chime, let go of both buttons, and you'll be booted into the Boot Manager.
|
||||
|
||||
When you get to the boot menu, select your bootable device to boot into the Bazzite installer.
|
||||
|
||||
### 3. Installer
|
||||
|
||||
> **NOTE**: If you do not have a usb physical keyboard connected, do **NOT** press "_User Creation_", since it will remove the default username and password, and you will be unable to type a username or password without a physical keyboard.
|
||||
|
||||
> **default user**: `bazzite` >**default password**: `bazzite`
|
||||
|
||||
![Installer|690x348](../../img/uHKqd8F4nxZryfP8ebBz1DIbNVv.png)
|
||||
|
||||
<!--![Installer](../../img/zfpz6EXcBqQ6jxho1O9jLLSRUE9.png)-->
|
||||
|
||||
![Automatic drive configuration|690x497, 75%](../../img/anaconda_drive_configuration.png)
|
||||
|
||||
![User setup example|690x359, 75%](../../img/anaconda_user_setup.png)
|
||||
|
||||
- Select your language, region, keyboard layout, and time zone.
|
||||
- Select the drive that Bazzite is going to be installed on.
|
||||
- Delete any partitions that you have remaining on the drive.
|
||||
- Recommended to use the automatic storage configuration.
|
||||
- Optionally encrypt the drive with a password if desired.
|
||||
- **If you lose this password, then it cannot be decrypted**.
|
||||
- Setup a user account. (If you do not have a physical, skip this step and begin the installation)
|
||||
- Give administrative privileges and **set a user password**.
|
||||
- Begin the installation.
|
||||
- Reboot device after it has finished installing.
|
||||
|
||||
## Post-Installation
|
||||
|
||||
> The fine tuning before gaming.
|
||||
|
||||
### GRUB Menu
|
||||
|
||||
![Rollbacks|690x402, 50%](../../img/GRUB_Menu.png)
|
||||
|
||||
The first boot will show a screen showing your current and last deployment. It will automatically boot if nothing. It is important to note that the GRUB menu can be used to rollback Bazzite deployments if you encounter issues.
|
||||
|
||||
Read more about this in the [Updates, Rollback, and Rebasing documentation](../../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md).
|
||||
|
||||
![Display Settings (KDE Plasma)|690x370, 75%](../../img/KDE_Display_Settings.png)
|
||||
**_KDE Plasma's System Settings application_**
|
||||
|
||||
![Display Settings (GNOME)|690x344, 75%](../../img/GNOME_Display_Settings.png)
|
||||
**_GNOME's Settings application_**
|
||||
|
||||
It is important to configure the system settings on a first boot to personalize your desktop especially if you notice the scaling is incorrect on first-boot.
|
||||
|
||||
### First Boot Setup Utility: Bazzite Portal
|
||||
|
||||
![Welcome to Bazzite|618x500, 75%](../../img/yafti_welcome.jpeg)
|
||||
|
||||
> **Attention**: Make sure you are connected to the internet.
|
||||
|
||||
An application will pop up welcoming you to Bazzite when you boot into the desktop for the first time. This is a utility that allows you to tailor Bazzite to your liking by installing additional software.
|
||||
|
||||
![Bazzite Portal|584x500, 75%](../../img/yafti_options.png)
|
||||
|
||||
- Click "Next" to begin configuring Bazzite.
|
||||
- Press the toggle switch button next to the item to have the option enabled or disabled for your installation, some are already toggled on by default.
|
||||
- If you would like to customize any of the options, then press the arrow next to the toggle switch button if available.
|
||||
- Installing items from the portal **may take a long time**.
|
||||
|
||||
> **Note**: If you only check a few items in a category, then it will only install those selected items. The switch is only toggled to install **everything** in that category.
|
||||
|
||||
> **Attention**: There is a rare chance you will be asked to setup KDE Wallet or GNOME Keyring and set a password to continue installing items from the Bazzite Portal.
|
||||
|
||||
### Installing additional software
|
||||
|
||||
The [Installing and Managing Applications documentation](../../Installing_and_Managing_Software/index.md) is useful to learn how to install additional software on Bazzite outside of the Bazzite Portal.
|
||||
|
||||
### Login to Steam & Reboot Device
|
||||
|
||||
Login to Steam then **reboot** your device when you finish setting up your device during the first-boot process.
|
||||
|
||||
#### Setting Up Steam Gaming Mode
|
||||
|
||||
![Gaming Mode Setup|690x442, 50%](../../img/pLvHB1NAMlb3ghsR72q7l9Auj8B.jpeg)
|
||||
|
||||
After completing all of the above, then your next boot will be in Steam Gaming Mode which requires additional setup for Steam.
|
||||
|
||||
> [Read further information about Steam Gaming Mode][Steam_Gaming_Mode]
|
||||
|
||||
<hr>
|
||||
|
||||
## Issues Installing Bazzite?
|
||||
|
||||
View the [Installation Troubleshoot Guide](./troubleshoot_guide.md).
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [Kyle Gospodnetich](https://github.com/KyleGospo), [Nathaniel Warburton](https://github.com/storyaddict), [Jorge Castro](https://github.com/castrojo), [Noel Miller](https://github.com/noelmiller), [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Justin Garrison](https://github.com/rothgar)
|
||||
|
||||
**See also:** [Upstream Manual Partitioning Guide](https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/#manual-partition) & [Steam Gaming Mode][Steam_Gaming_Mode]
|
||||
|
||||
<-- [**View all Bazzite documentation**](../../index.md)
|
||||
|
||||
[Steam_Gaming_Mode]: ../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
|
@ -1,110 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2743", "fetched_at": "2024-09-03 16:43:23.309649+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
> **Note**: Make sure to read the [**Installation Guide**](./index.md) for your device first before proceeding.
|
||||
|
||||
## Two Methods: Method _A_ or Method _B_
|
||||
|
||||
- **A)** Installing Bazzite on a separate drive (Recommended)
|
||||
- **B)** Manual partitioning on the same drive
|
||||
|
||||
### **A**) _Separate_ Drive Method
|
||||
|
||||
> **Note**: This method is ideal for desktops and HTPCs, and would be inconvenient for handhelds unless planned to keep stationary.
|
||||
|
||||
Install Bazzite on a separate internal or external drive.
|
||||
|
||||
1. Install the other operating system on a drive (like Windows)
|
||||
2. Install Bazzite on a **second** drive
|
||||
3. Set Bazzite as the **default** in your boot order (optional)
|
||||
|
||||
You can also install Windows to an external drive with Windows-to-Go using [Rufus](https://rufus.ie/en/) to dual boot if you do not have an internal drive available.
|
||||
|
||||
### **B**) _Same_ Drive Method
|
||||
|
||||
> **Note**: This must be done **before installing Bazzite**.
|
||||
|
||||
> Recommended for handheld PCs or mobile setups.
|
||||
|
||||
If you do not have multiple drives or are using a device that will not be stationary, then you will have to manually partition on the same drive.
|
||||
|
||||
#### Note about dual booting with **Windows** specifically:
|
||||
|
||||
Dual booting Bazzite with Windows on the same drive works better with **Windows already installed before Bazzite**.
|
||||
|
||||
#### Bazzite Partition
|
||||
|
||||
Create space for Bazzite with the Disk Management application in Windows.
|
||||
|
||||
<kbd>Win</kbd> + <kbd>R</kbd> to open Windows Run and enter:
|
||||
|
||||
```
|
||||
diskmgmt.msc
|
||||
```
|
||||
|
||||
Then, right-click your Windows partition and select "Shrink Volume" from the drop-down menu. Afterwards, select how much storage you want to allocate for Bazzite.
|
||||
|
||||
It is **strongly recommended for to setup a separate EFI partition**. The separate EFI partition will help prevent Windows Updates from affecting your Bazzite installation later down the line.
|
||||
|
||||
## Manual Partitioning to the Same Drive for Dual Boot Setups
|
||||
|
||||
If you need a tutorial video for manual partitioning, watch this [tutorial](https://www.youtube.com/watch?v=EDip92Zq-RE).
|
||||
|
||||
1. Select Installation Destination
|
||||
2. Select `Advanced Custom(Blivet-GUI)` under Storage Configuration.
|
||||
3. Create partitions and devices:
|
||||
|
||||
```
|
||||
Manual Partitioning Scheme:
|
||||
|
||||
mount point: /boot/efi
|
||||
format: EFI system partition
|
||||
size: 300MB
|
||||
|
||||
mount point: /boot
|
||||
format: ext4
|
||||
size: 1GB
|
||||
|
||||
mount point:
|
||||
format: btrfs
|
||||
size: [max]
|
||||
|
||||
mount point: /
|
||||
format: btrfs (subvolume)
|
||||
|
||||
mount point: /var
|
||||
format: btrfs (subvolume)
|
||||
|
||||
mount point: /var/home
|
||||
format: btrfs (subvolume)
|
||||
```
|
||||
|
||||
> **Note about dual booting other Fedora Atomic Desktop images on the **same** drive**: If you want to dual boot another **Fedora libostree image** (like [Bluefin](https://projectbluefin.io/)) installed alongside Bazzite, then you would have to make an additional EFI partition and switch between them through the BIOS boot menu.
|
||||
|
||||
<hr>
|
||||
|
||||
## Dual Boot Post-Configuration Setup
|
||||
|
||||
> **Note:** [Handheld/HTPC](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) images hide GRUB by default, but the <kbd>Esc</kbd> key on a keyboard will unhide the GRUB menu without unhiding it with a `ujust` command.
|
||||
|
||||
### Regenerate GRUB to show Windows Entry
|
||||
|
||||
If you do **not** see your Windows boot in the GRUB menu, then open a host terminal and **enter**:
|
||||
|
||||
```
|
||||
ujust regenerate-grub
|
||||
```
|
||||
|
||||
### Bazzite as Primary Boot
|
||||
|
||||
If the `OS Boot Manager` has set `Windows Boot Manager` to be the first boot priority, then this may result in booting directly into Windows after the install instead of Bazzite. You may have to fix this in your BIOS settings.
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Aarron Lee](https://github.com/aarron-lee)
|
@ -1,47 +0,0 @@
|
||||
---
|
||||
title: Installation Guide
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=30", "fetched_at": "2024-09-03 16:43:25.704918+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# **Important Installation Notes**:
|
||||
|
||||
- Use a download manager if the direct download fails or is downloading too slow.
|
||||
|
||||
- A physical wired keyboard is **recommended**.
|
||||
|
||||
- Create a User Account with a **username** and a **user password** if you have a keyboard.
|
||||
|
||||
- Make sure to only select the appropriate drives to avoid losing data on others, and it is best practice to safely remove any external drives before proceeding.
|
||||
|
||||
- Secure Boot is supported on most hardware, but you must [**enroll our key**](./secure_boot.md).
|
||||
|
||||
# Choose Your Hardware:
|
||||
|
||||
- [Installing Bazzite for **Desktop/Laptop Hardware**](./Installing_Bazzite_for_Desktop_or_Laptop_Hardware.md)
|
||||
|
||||
- [Installing Bazzite for **Framework Laptop 16**](./Installing_Bazzite_for_Framework_Laptop_16.md)
|
||||
|
||||
- [Installing Bazzite for **Framework Laptop 13 (AMD/Intel GPU)**](./Installing_Bazzite_Framework_Laptop_13.md)
|
||||
|
||||
- [Installing Bazzite for **Home Theater PC (HTPC) Setups**](./Installing_Bazzite_for_HTPC_Setups.md)\*
|
||||
|
||||
- [Installing Bazzite on the **Steam Deck**](./Installing_Bazzite_for_Steam_Deck.md)\*
|
||||
|
||||
- [Installing Bazzite on **Handheld PCs**](./Installing_Bazzite_for_Handheld_PCs.md)\*
|
||||
|
||||
\*_Indicates that [**Steam Gaming Mode**](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md) is intended for this device and ships with the ISO._
|
||||
|
||||
# Issues Installing Bazzite?
|
||||
|
||||
> The workarounds detailed in the guide are also useful for **downloading a smaller ISO size**.
|
||||
|
||||
View the [**Troubleshooting Guide**](./troubleshoot_guide.md) for installation workarounds.
|
||||
|
||||
<hr>
|
||||
|
||||
<-- [**View all Bazzite documentation**](../../index.md)
|
@ -1,56 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2742", "fetched_at": "2024-09-03 16:43:23.922705+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Secure Boot Information
|
||||
|
||||
![Secure Boot|690x378, 50%](../../img/Secure_Boot.jpeg)
|
||||
|
||||
> **Note**: Skip this section if Secure Boot is not enabled or unsupported with your hardware.
|
||||
|
||||
> **Attention**: Updating your BIOS may re-enable Secure Boot and you may have to follow **"Method B"** after updating it to resolve the black screen on boot complaining about loading the kernel first.
|
||||
|
||||
> **Warning**: The Steam Deck does **not** come with secure boot enabled and does not ship with any keys enrolled by default, do not enable Secure Boot on your Steam Deck unless you absolutely know what you're doing.
|
||||
|
||||
### Error message if key is **not** enrolled properly:
|
||||
|
||||
![load the kernel first error|613x63](../../img/load_the_kernel_first_error.jpeg)
|
||||
|
||||
Follow **Method B** below to resolve this and move past the error message if you encounter it.
|
||||
|
||||
## **Method A**) During Installation Method (See Image Above)
|
||||
|
||||
A blue screen will appear giving the option to enroll the signed keys after leaving the Bazzite installer.
|
||||
|
||||
`Enroll MOK` if you have secure boot enabled. If prompted to enter a password, then **enter**:
|
||||
|
||||
```command
|
||||
universalblue
|
||||
```
|
||||
|
||||
Otherwise `Continue boot` if you have Secure Boot disabled or if it is not supported with your hardware.
|
||||
|
||||
## **Method B**) After Installation Method
|
||||
|
||||
> **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**:
|
||||
|
||||
```command
|
||||
universalblue
|
||||
```
|
||||
|
||||
You can now turn Secure Boot back on in the BIOS.
|
||||
|
||||
**If you're rebasing from a Fedora Atomic Desktop image and use Secure Boot, then follow our [README](https://github.com/ublue-os/bazzite/blob/main/README.md#secure-boot)**.
|
@ -1,91 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2495", "fetched_at": "2024-09-03 16:43:22.238775+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## ISO Workarounds
|
||||
|
||||
A generic error may appear during installation.
|
||||
|
||||
**Workaround Video Tutorial**:
|
||||
https://www.youtube.com/watch?v=GRdz08hJByo
|
||||
|
||||
## Alternative Installation Methods
|
||||
|
||||
> **Attention**: Both workaround methods may have scaling issues with the installer depending on the hardware especially if it is a handheld PC.
|
||||
|
||||
> **Note**: The workarounds below are also useful for **downloading a smaller ISO size**.
|
||||
|
||||
#### **Option 1**: Rebasing from a Fedora Atomic Desktop Image (Recommended)
|
||||
|
||||
If you experience issues with installing our ISO or the bootable drive you have is too small for Bazzite, then download the [Fedora Kinoite (**KDE Plasma**)](https://fedoraproject.org/atomic-desktops/kinoite/) or [Fedora Silverblue (**GNOME**)](https://fedoraproject.org/atomic-desktops/silverblue/) depending on which desktop environment preferred.
|
||||
|
||||
1. The installation setup is similar to Bazzite and includes the same installer with the same instructions, but do **not** set a root account if its an option in the installer.
|
||||
|
||||
2. Once installed, you will not be on Bazzite until you enter the command found on our website that appears under ["**Existing Fedora Atomic Desktop Users**" section](https://download.bazzite.gg) when the download is ready.
|
||||
|
||||
3. Open the terminal and enter this command, and keep in mind this process has **no progress indicator** and will take a long time.
|
||||
|
||||
4. Reboot when the rebase has finished, and Bazzite should be installed after rebooting and your username as well as the user password will carry over from the upstream Fedora Atomic Desktop to Bazzite.
|
||||
|
||||
5. You will also be **missing the default applications** until you open a host terminal and **enter**:
|
||||
|
||||
```command
|
||||
ujust _install-system-flatpaks
|
||||
```
|
||||
|
||||
> Choose the "Flathub" remote.
|
||||
>
|
||||
> **This command installs:**
|
||||
>
|
||||
> - [Flatpak applications for **KDE Plasma** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/kinoite/usr/share/ublue-os/bazzite/flatpak/install)
|
||||
> - [Flatpak applications for **GNOME** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/silverblue/usr/share/ublue-os/bazzite/flatpak/install)
|
||||
|
||||
6. Once everything is setup properly, then you need to rebase from the **unsigned image** to the **signed image**, so **enter** in a host terminal:
|
||||
|
||||
```command
|
||||
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/<IMAGE>
|
||||
```
|
||||
|
||||
Replace `<IMAGE>` with the image you're using which can be found from the "**Existing Fedora Atomic Desktop Users**" section as well.
|
||||
|
||||
##### Video Tutorial
|
||||
|
||||
https://www.youtube.com/watch?v=Vs4cneBW5ck
|
||||
|
||||
#### **Option 2**: Older & Buggy Net-Installer (Not Recommended)
|
||||
|
||||
> **Note**: This is intended as a last resort!
|
||||
|
||||
This is not something we recommend at all, but an alternative solution is using our [Github release](https://github.com/ublue-os/bazzite/releases/tag/v2.1.0) of the last **online** ISO. This is **extremely buggy** and suffers from other issues that are now fixed in the offline ISO.
|
||||
|
||||
There is an older [video](https://www.youtube.com/watch?v=doQW1FyAISQ) showcasing how to install the Bazzite with this old online ISO.
|
||||
|
||||
> **IMPORTANT**: The video guide does **not** mention this part of the process since this wasn’t a requirement previously:
|
||||
|
||||
After installing it and making it to the desktop, then you will have to **rebase** to a signed image:
|
||||
|
||||
```command
|
||||
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/<IMAGE>
|
||||
```
|
||||
|
||||
Replace `<IMAGE>` with the image you're using.
|
||||
|
||||
Reboot when the rebasing process has finished, and you will know because it will tell you to reboot your device.
|
||||
|
||||
You will also be missing the default applications, so open a host terminal and **enter**:
|
||||
|
||||
```command
|
||||
ujust _install-system-flatpaks
|
||||
```
|
||||
|
||||
> Choose the "Flathub" remote.
|
||||
|
||||
**This command installs:**
|
||||
|
||||
- [Flatpak applications for **KDE Plasma** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/kinoite/usr/share/ublue-os/bazzite/flatpak/install)
|
||||
- [Flatpak applications for **GNOME** images](https://github.com/ublue-os/bazzite/blob/9f6f5e143b7545d06803e70e7723997400bd8b88/system_files/desktop/silverblue/usr/share/ublue-os/bazzite/flatpak/install)
|
@ -1,49 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=3402", "fetched_at": "2024-09-03 16:43:15.937921+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Submit bug reports in the appropriate place
|
||||
|
||||
Report bugs experienced with Bazzite in our [**issue tracker**](https://github.com/ublue-os/bazzite/issues)! We discourage reporting bugs in the Discourse forums since reports can get lost or may not be viewed by Bazzite contributors as often as the issue tracker.
|
||||
|
||||
## Before submitting an issue
|
||||
|
||||
**Read [how to file an issue properly](https://universal-blue.discourse.group/docs?topic=1470) before proceeding!**
|
||||
|
||||
#### **Bazzite Issue Template Walkthrough**
|
||||
|
||||
![Bug report|690x174](../img/Bug_report.png)
|
||||
|
||||
![Template|690x436](../img/Bug_report_template.png)
|
||||
|
||||
### Update Bazzite before reporting
|
||||
|
||||
Sometimes bugs are fixed during upgrades, so try updating and rebooting your device before submitting a report to see if the issue still persists between updates.
|
||||
|
||||
**Read how to update Bazzite for your device**:
|
||||
[Updating guide](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/updating_guide.md)
|
||||
|
||||
### Make sure to attach system logs
|
||||
|
||||
Open a host terminal and **enter**:
|
||||
|
||||
```
|
||||
ujust device-info
|
||||
```
|
||||
|
||||
Attach the link that it outputs for system logs.
|
||||
|
||||
#### Experience system crashes?
|
||||
|
||||
```command
|
||||
ujust logs-last-boot
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- View all Bazzite documentation**](https://docs.bazzite.gg)
|
@ -1,126 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2414", "fetched_at": "2024-09-03 16:43:21.670173+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# ASUS ROG Ally / ASUS ROG Ally X
|
||||
|
||||
![ally|603x500, 100%](../../img/ally.png)
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
## Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
- 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
|
||||
- Enable the Steam Power Button Handler setting in Handheld Daemon
|
||||
|
||||
## Optional Tweaks
|
||||
|
||||
- Adjust RGB with Steam Gaming Mode in Handheld Daemon
|
||||
- Adjust the scaling of the UI in the Display Settings
|
||||
- Set a charge limit in HHD with Handheld Daemon
|
||||
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
|
||||
|
||||
```
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
## Workarounds / Known Issues
|
||||
|
||||
- [Status of CPU Boost on Bazzite](https://github.com/aarron-lee/SimpleDeckyTDP/blob/main/README.md#are-there-cpu-boost-controls)
|
||||
- Disable CPU boost to avoid excess power usage and other issues.
|
||||
- Changing A/C power sometimes leads to a stuck TDP.
|
||||
- Some users report that "Auto UMA" in the bios can cause crashes in some games.
|
||||
- If you encounter this, then try setting the VRAM in bios to **4GB** or **8GB**.
|
||||
- LED is on max brightness by default and cannot be changed on any other operating system outside of Windows.
|
||||
- This is tied to the firmware.
|
||||
- This also affects when the ally is charging and sleeping.
|
||||
- The Ally does **not support** button holding for the Steam or QAM buttons.
|
||||
- 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
|
||||
- Fingerprint driver does not work.
|
||||
- Storage shows duplicate drives.
|
||||
- This is a visual bug, do **not** attempt to format!
|
||||
- Rainbow RGB on the original ROG Ally that can affect Windows even after Bazzite is remove
|
||||
- Turning on the wake animation when resuming from sleep causes the device to act erratically.
|
||||
- No controls outside of Steam.
|
||||
- Steam's top and bottom panels missing.
|
||||
|
||||
<hr>
|
||||
|
||||
## Additional Information
|
||||
|
||||
This applies to most handhelds running Bazzite.
|
||||
|
||||
### TDP Controls
|
||||
|
||||
![TDP|690x431, 75%](../../img/TDP.jpeg)
|
||||
|
||||
There are a few options for TDP Controls that work with Bazzite:
|
||||
|
||||
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
|
||||
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
|
||||
- Steam Quick Access Menu TDP limit (part of Steam Gaming Mode)
|
||||
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
|
||||
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
|
||||
|
||||
### How do I open the HHD Overlay?
|
||||
|
||||
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
|
||||
|
||||
![Settings Example|690x431, 75%](../../img/HHD_Settings_Example.jpeg)
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
> **Note**: ASUS ROG Ally does not support **holding** for the QAM button!
|
||||
|
||||
### 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.
|
||||
|
||||
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
|
||||
|
||||
![desktop_controls_step_2|690x431, 75%](../../img/handheld_desktop_controls_2.png)
|
||||
|
||||
![desktop_controls_step_3|690x431, 75%](../../img/handheld_desktop_controls_3.jpeg)
|
||||
|
||||
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>
|
||||
|
||||
## Contributing
|
||||
|
||||
This page and all of the links to each specific handheld are **wikis**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,145 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2417", "fetched_at": "2024-09-03 16:43:20.646543+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Ayaneo Geek 1S
|
||||
|
||||
![photo_5875160389711413569_y|663x500, 100%](../../img/Ayaneo_Geek_1S.jpeg)
|
||||
|
||||
**Status**: Silver
|
||||
|
||||
## Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
- 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 without a workaround**!
|
||||
- see suspend workaround [here](https://universal-blue.discourse.group/t/ayaneo-handheld-compatibility/2417#p-5599-suspend-workaround-5)
|
||||
- VRAM size option is missing from BIOS as it's controlled by AYASPACE application under windows.
|
||||
|
||||
### Functional HHD\*\*:
|
||||
|
||||
```
|
||||
sudo systemctl enable --now hhd@$(whoami)
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
### Suspend workaround
|
||||
|
||||
> Thanks to ChimeraOS for the [original suspend workaround](https://github.com/ChimeraOS/chimeraos/wiki/Community-Guides#enabling-modern-sleep-on-7000-series-amd-hardware), and SteamFork for the [updated writeup](https://wiki.steamfork.org/troubleshooting/#enabling-modern-sleep-on-7000-series-amd-based-devices) of this workaround.
|
||||
|
||||
7000 series and newer AMD APU's no longer support S3 sleep, and unfortunately many handheld manufacturers don't configure their firmware to take advantage of modern standby by default. Fortunately, modern standby can be configured manually with Smokeless UMAF.
|
||||
|
||||
> **Warning!**
|
||||
>
|
||||
> The Smokeless UMAF tool has been known to brick devices even by reading values in the BIOS.
|
||||
>
|
||||
> **There is a good chance that setting something incorrectly in the BIOS with this tool will brick your device and void your warranty.**
|
||||
>
|
||||
> Bazzite takes no responsibility for any harm caused by following these steps. By following this guide you acknowledge that you are solely responsible for the outcome.
|
||||
|
||||
### Modern Standby Enablement Methods
|
||||
|
||||
- Enter your bios/firmware settings to see if you already have the options listed in the steps for the [Enabling Modern Standby](https://universal-blue.discourse.group/t/ayaneo-handheld-compatibility/2417#p-5599-enabling-modern-standby-7) section of this guide. If so, skip the rest of this section.
|
||||
- If the options are not available, follow the next few steps to create boot media.
|
||||
- Format a USB stick with FAT32.
|
||||
- Download [Smokeless UMAF](https://github.com/DavidS95/Smokeless_UMAF/raw/main/UMAF_BETA.zip).
|
||||
- Extract `UMAF_Beta.zip` and copy the contents into the root of the usb stick.
|
||||
- Boot your device and select the USB stick from the boot menu.
|
||||
- Navigate to the `Front Page` tab and select `Device Manager`.
|
||||
|
||||
#### Enabling Modern Standby
|
||||
|
||||
1. Select `AMD PBS` then `Power Saving Configurations`.
|
||||
2. Under `S3/Modern Standby Support` change the entry to `Modern Standby` (or `Modern Standby Enable` on some devices).
|
||||
3. Under `Modern Standby Type` select `Modern Standby + S0i2 + S0i3`.
|
||||
4. Save changes and exit, allowing the device to reboot.
|
||||
|
||||
Note: The first restart after this change may take longer than usual.
|
||||
|
||||
### External Resource
|
||||
|
||||
Check out the [original thread](https://universal-blue.discourse.group/t/ayaneo-geek-1s-2s-linux-bazzite-support-is-already-almost-there-lets-add-them-to-the-officially-supported-devices/1046) for more information and updates on this device.
|
||||
|
||||
<hr>
|
||||
|
||||
## Additional Information
|
||||
|
||||
This applies to most handhelds running Bazzite.
|
||||
|
||||
### TDP Controls
|
||||
|
||||
![TDP|690x431, 75%](../../img/TDP.jpeg)
|
||||
|
||||
There are a few options for TDP Controls that work with Bazzite:
|
||||
|
||||
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
|
||||
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
|
||||
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
|
||||
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
|
||||
- [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
|
||||
|
||||
### How do I open the HHD Overlay?
|
||||
|
||||
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
|
||||
![Settings Example|690x432, 75%](../../img/HHD_Settings_Example.jpeg)
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
### Controller Information
|
||||
|
||||
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.
|
||||
|
||||
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
|
||||
|
||||
![desktop_controls_step_2|690x431, 75%](../../img/handheld_desktop_controls_2.png)
|
||||
|
||||
![desktop_controls_step_3|690x431, 75%](../../img/handheld_desktop_controls_3.jpeg)
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
## Contributing
|
||||
|
||||
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,137 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2416", "fetched_at": "2024-09-03 16:43:21.928758+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Ayn Loki Max
|
||||
|
||||
![Loki Max|375x500, 100%](../../img/Loki_Max.jpeg)
|
||||
|
||||
**Status**: Platinum
|
||||
|
||||
### Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
### Post-Installation Setup
|
||||
|
||||
- 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)
|
||||
|
||||
### Optional Tweaks
|
||||
|
||||
- Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings` or in Handheld Daemon
|
||||
- Adjust the scaling of the UI in the Display Settings
|
||||
- Set a charge limit in HHD with Handheld Daemon
|
||||
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
|
||||
|
||||
```
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
### Workarounds / Known Issues
|
||||
|
||||
- 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
|
||||
|
||||
![loki_mini_pro|666x500, 100%](../../img/loki_mini_pro.jpeg)
|
||||
|
||||
**Status**: Silver
|
||||
|
||||
### Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
### Post-Installation Setup
|
||||
|
||||
- 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)
|
||||
|
||||
### Optional Tweaks
|
||||
|
||||
- Adjust RGB with Steam Gaming Mode under `Settings > Controller > Calibration & Advanced > LED Settings` or in Handheld Daemon
|
||||
- Adjust the scaling of the UI in the Display Settings
|
||||
- Set a charge limit in HHD with Handheld Daemon
|
||||
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
|
||||
|
||||
```
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
### Workarounds / Known Issues
|
||||
|
||||
- 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>
|
||||
|
||||
## Additional Information
|
||||
|
||||
This applies to most handhelds running Bazzite.
|
||||
|
||||
### TDP Controls
|
||||
|
||||
![TDP|690x431, 75%](../../img/TDP.jpeg)
|
||||
|
||||
There are a few options for TDP Controls that work with Bazzite:
|
||||
|
||||
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
|
||||
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
|
||||
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
|
||||
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
|
||||
|
||||
### How do I open the HHD Overlay?
|
||||
|
||||
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
|
||||
![RGB|690x431, 75%](../../img/HHD_RGB.jpeg)
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
### Controller Information
|
||||
|
||||
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.
|
||||
|
||||
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
|
||||
|
||||
![desktop_controls_step_2|690x431, 75%](../../img/handheld_desktop_controls_2.png)
|
||||
|
||||
![desktop_controls_step_3|690x431, 75%](../../img/handheld_desktop_controls_3.jpeg)
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
## Contributing
|
||||
|
||||
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,165 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2418", "fetched_at": "2024-09-03 16:43:21.260488+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## GPD Win 4
|
||||
|
||||
![gpdwin4|690x328, 100%](../../img/gpdwin4.jpeg)
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
### Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
### Post-Installation Setup
|
||||
|
||||
- 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.
|
||||
|
||||
### Optional Tweaks
|
||||
|
||||
- Adjust RGB with Steam Gaming Mode in Handheld Daemon
|
||||
- Adjust the scaling of the UI in the Display Settings
|
||||
- Set a charge limit in HHD with Handheld Daemon
|
||||
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
|
||||
|
||||
```
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
### Workarounds / Known Issues
|
||||
|
||||
- Suspend-resume fully works on the 6800u Win 4 after disabling the fingerprint scanner, but there are a few user reports of the 7840u and newer models having only partially working suspend-resume.
|
||||
- It seems to be very similar/related to the suspend issue on the GPD WM2 7840u and newer devices, more details [here](https://gitlab.freedesktop.org/drm/amd/-/issues/3154)
|
||||
- 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.
|
||||
- Back buttons may need to be manually remapped before they are usable.
|
||||
- Manually remap back buttons as described in hhd docs [here](https://github.com/hhd-dev/hhd?tab=readme-ov-file#extra-steps-gpd-win-devices)
|
||||
- Watch this [video](https://www.youtube.com/watch?v=lnNfMY9kzjk) if you need a visual guide.
|
||||
|
||||
### External Resource
|
||||
|
||||
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
|
||||
|
||||
![placeholder_gpdwinmax2|407x312, 100%](../../img/GPD_Win_Max_2.png)
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
### Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
### Post-Installation Setup
|
||||
|
||||
- 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
|
||||
- Steam Gaming Mode **Display** settings that are recommended to be changed:
|
||||
- `Use Native Color Temperature` - Enabled
|
||||
|
||||
### Optional Tweaks
|
||||
|
||||
- Adjust RGB with Steam Gaming Mode in Handheld Daemon
|
||||
- Adjust the scaling of the UI in the Display Settings
|
||||
- Set a charge limit in HHD with Handheld Daemon
|
||||
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
|
||||
|
||||
```
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
### Workarounds / Known Issues
|
||||
|
||||
- Suspend-resume works on the WM2 6800u model after disabling the fingerprint scanner, but 7840u and newer models have only partially working suspend-resume.
|
||||
- Read about the issue [here](https://gitlab.freedesktop.org/drm/amd/-/issues/3154) for details on suspend-resume issues for the newer WM2 devices.
|
||||
- If you install your OS on an m2 2230 SSD in the secondary drive slot, it can cause suspend issues.
|
||||
- You should install your OS onto the primary internal SSD only.
|
||||
- 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.
|
||||
- Gyro is non-functional.
|
||||
- Back buttons may need to be manually remapped before they are usable.
|
||||
- Manually remap back buttons as described in hhd docs [here](https://github.com/hhd-dev/hhd?tab=readme-ov-file#extra-steps-gpd-win-devices)
|
||||
- Watch this [video](https://www.youtube.com/watch?v=lnNfMY9kzjk) if you need a visual guide.
|
||||
|
||||
### External Resource
|
||||
|
||||
For more information, check out the [GPD Win Tips and Tricks guide](https://github.com/aarron-lee/gpd-win-tricks) which includes useful scripts for this handheld.
|
||||
|
||||
<hr>
|
||||
|
||||
## Additional Information
|
||||
|
||||
This applies to most handhelds running Bazzite.
|
||||
|
||||
### TDP Controls
|
||||
|
||||
![TDP|690x431, 75%](../../img/TDP.jpeg)
|
||||
|
||||
There are a few options for TDP Controls that work with Bazzite:
|
||||
|
||||
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
|
||||
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
|
||||
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
|
||||
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
|
||||
- [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
|
||||
|
||||
### How do I open the HHD Overlay?
|
||||
|
||||
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
|
||||
![Emulation Mode|690x434, 75%](../../img/HHD_Emulation_Mode.jpeg)
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
> **Note**: GPD devices do not support double-tapping the QAM 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.
|
||||
|
||||
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
|
||||
|
||||
![desktop_controls_step_2|690x431, 75%](../../img/handheld_desktop_controls_2.png)
|
||||
|
||||
![desktop_controls_step_3|690x431, 75%](../../img/handheld_desktop_controls_3.jpeg)
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
## Contributing
|
||||
|
||||
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,126 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2413", "fetched_at": "2024-09-03 16:43:19.836067+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Lenovo Legion Go
|
||||
|
||||
![legion_go|690x387, 100%](../../img/legion_go.jpeg)
|
||||
|
||||
**Status**: Platinum
|
||||
|
||||
## Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
## Post-Installation Setup
|
||||
|
||||
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`
|
||||
|
||||
## Optional Tweaks
|
||||
|
||||
- Adjust RGB with Steam Gaming Mode in Handheld Daemon
|
||||
- Adjust the scaling of the UI in the Display Settings
|
||||
- Set a charge limit in HHD with Handheld Daemon
|
||||
- Install Decky + the [CSS Loader plugin](https://deckthemes.com/download/deck) and then in Desktop Mode, open the "Terminal" application and enter:
|
||||
|
||||
```
|
||||
ujust install-hhd-controller-glyph-theme
|
||||
```
|
||||
|
||||
## Workarounds / Known Issues
|
||||
|
||||
- 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 is **recommended** to update in Windows.
|
||||
- Virtual keyboard is Steam's keyboard, but needs to be setup in Steam's settings in Desktop Mode. (See "Desktop Controls" section below)
|
||||
- <kbd>**Legion L**</kbd> + <kbd>**X**/**Square**</kbd> (This can be remapped)
|
||||
- Try not to change the resolution in Desktop Mode!
|
||||
- Connecting to an external monitor may also cause issues.
|
||||
- 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
|
||||
```
|
||||
|
||||
## BIOS Update Information
|
||||
|
||||
A [thread](https://universal-blue.discourse.group/docs?topic=3064) on our forums goes over in detail on how to update the BIOS without having Windows installed.
|
||||
|
||||
## 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>
|
||||
|
||||
## Additional Information
|
||||
|
||||
This applies to most handhelds running Bazzite.
|
||||
|
||||
### TDP Controls
|
||||
|
||||
![TDP|690x431, 75%](../../img/TDP.jpeg)
|
||||
|
||||
There are a few options for TDP Controls that work with Bazzite:
|
||||
|
||||
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
|
||||
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
|
||||
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
|
||||
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
|
||||
|
||||
### How do I open the HHD Overlay?
|
||||
|
||||
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
|
||||
|
||||
![Legion HHD|690x431, 75%](../../img/HHD_Settings_Example.jpeg)
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
> **Example**: <kbd>Legion R</kbd> for the Lenovo Legion Go.
|
||||
|
||||
### 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.
|
||||
|
||||
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
|
||||
|
||||
![desktop_controls_step_2|690x431, 75%](../../img/handheld_desktop_controls_2.png)
|
||||
|
||||
![desktop_controls_step_3|690x431, 75%](../../img/handheld_desktop_controls_3.jpeg)
|
||||
|
||||
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>
|
||||
|
||||
## Contributing
|
||||
|
||||
This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,76 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2415", "fetched_at": "2024-09-03 16:43:17.984951+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Other Handhelds
|
||||
|
||||
![generic handheld|348x158, 100%](../../img/generic_handheld.jpeg)
|
||||
|
||||
> Certain handhelds have been confirmed to boot Bazzite, but are plagued by missing driver support for Linux including missing audio drivers.
|
||||
|
||||
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**:
|
||||
|
||||
```command
|
||||
systemctl start hhd@yourusername
|
||||
```
|
||||
|
||||
```command
|
||||
systemctl enable hhd@yourusername
|
||||
```
|
||||
|
||||
> **Note**: Replace `yourusername` with your Bazzite username.
|
||||
|
||||
<hr>
|
||||
|
||||
## TDP Controls
|
||||
|
||||
![TDP|690x431, 75%](../../img/TDP.jpeg)
|
||||
|
||||
There are a few options for TDP Controls that work with Bazzite:
|
||||
|
||||
- The [HHD-overlay](https://github.com/hhd-dev/hhd/blob/master/readme.md) supports TDP controls.
|
||||
- Also has a desktop app that is pre-installed, look for the Handheld Daemon app in Desktop Mode.
|
||||
- [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings.
|
||||
- Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed.
|
||||
- [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices.
|
||||
|
||||
## How do I open the HHD Overlay?
|
||||
|
||||
![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg)
|
||||
|
||||
Press, hold, or double-tap the Quick Access Menu button.
|
||||
|
||||
## Controller Information
|
||||
|
||||
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.
|
||||
|
||||
![desktop_controls_step_1|588x500, 75%](../../img/handheld_desktop_controls_1.png)
|
||||
|
||||
![desktop_controls_step_2|690x431, 75%](../../img/handheld_desktop_controls_2.png)
|
||||
|
||||
![desktop_controls_step_3|690x431, 75%](../../img/handheld_desktop_controls_3.jpeg)
|
||||
|
||||
Make sure to **apply** the desktop controls when you select them.
|
||||
|
||||
<hr>
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,138 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1849", "fetched_at": "2024-09-03 16:43:16.550432+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## Steam Deck LCD (256GB+)
|
||||
|
||||
![Steam Deck LCD|690x348, 100%](../../img/Steam_Deck_LCD.jpeg)
|
||||
|
||||
**Status**: Platinum
|
||||
|
||||
## Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
### Post-Installation Setup
|
||||
|
||||
- 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://faq.bazzite.gg) for more information.
|
||||
|
||||
## Steam Deck OLED
|
||||
|
||||
![Steam Deck OLED|667x500, 100%](../../img/Steam_Deck_OLED.jpeg)
|
||||
|
||||
**Status**: Gold
|
||||
|
||||
## Installing Bazzite
|
||||
|
||||
Read the [**Installing Bazzite on Handheld PCs documentation**](https://ublue-os.github.io/bazzite/General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs/).
|
||||
|
||||
### Post-Installation Setup
|
||||
|
||||
- No additional setup required, but make sure to read the [installation Guide](https://universal-blue.discourse.group/docs?topic=30).
|
||||
- It should function nearly identical to SteamOS with the benefits of [Fedora Atomic Desktop](https://fedoraproject.org/atomic-desktops/):
|
||||
- Layer Fedora packages to the image without losing them between updates/reboots.
|
||||
- Newer package upgrades including the Linux kernel and drivers.
|
||||
- Printing support and other basic features that would make Bazzite viable for daily usage.
|
||||
- View our [FAQ](https://universal-blue.discourse.group/docs?topic=33) for more information.
|
||||
|
||||
<hr>
|
||||
|
||||
## How similar is Bazzite to SteamOS on Steam Deck hardware?
|
||||
|
||||
Bazzite should have most of the functionality from SteamOS with Steam Gaming Mode working as intended.
|
||||
|
||||
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.
|
||||
|
||||
<hr>
|
||||
|
||||
**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md)
|
||||
|
||||
**<-- Back to [Handheld Wiki](./index.md)**
|
@ -1,90 +0,0 @@
|
||||
---
|
||||
title: Handheld Wiki
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=1038", "fetched_at": "2024-09-03 16:43:15.186486+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Handheld Compatibility
|
||||
|
||||
> **Attention**: 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 hardware support for Linux, so they are unlisted here.
|
||||
|
||||
> **Note**: All handhelds except for the Steam Deck make use of [Handheld Daemon](https://github.com/hhd-dev/hhd/blob/master/readme.md) for controls, TDP, etc.
|
||||
|
||||
_Click the name of each hardware to view post-installation setup and known issues/workarounds._
|
||||
|
||||
- [**Steam Deck**](./Steam_Deck.md)
|
||||
- [**Lenovo Legion Go**](./Lenovo_Legion_Go.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md))
|
||||
- [**ASUS ROG Ally**](./ASUS_ROG_Ally.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md))
|
||||
- [**Ayn Handhelds**](./Ayn_Handhelds.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md))
|
||||
- [**GPD Handhelds**](./GPD_Handhelds.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md))
|
||||
- [**Ayaneo Handhelds**](./Ayaneo_Handhelds.md) ([_Edit Wiki_](https://github.com/ublue-os/bazzite/blob/main/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md))
|
||||
- [**Other Handhelds**](./Other_Handhelds.md)
|
||||
|
||||
## Support Rating
|
||||
|
||||
Bazzite takes a similar approach to [ProtonDB’s medal system](https://www.protondb.com/) by giving a generic label rating for each handheld.
|
||||
|
||||
**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 the 'side menu button' to access Handheld Daemon overlay in Steam Gaming Mode
|
||||
|
||||
2. Select the controller emulation and RGB color you want
|
||||
|
||||
> **Note**: Gyro functionality **requires** DualSense emulation
|
||||
|
||||
# Decky Plugins
|
||||
|
||||
> **Note**: Decky may break or uninstall after updates especially if the Steam client or Gamescope is updated.
|
||||
|
||||
Install optional [Decky plugins](https://plugins.deckbrew.xyz/) for your handheld. If you experience any major issues then it is recommended to uninstall Decky before reporting Bazzite bugs.
|
||||
|
||||
# Bazzite's Steam Gaming Mode Documentation
|
||||
|
||||
Check out the [Steam Gaming Mode documentation](../Steam_Gaming_Mode.md) for an in-depth guide on Steam Gaming Mode plus general fixes for common issues.
|
||||
|
||||
# eGPU Support
|
||||
|
||||
> eGPU is **not** a fully supported feature and has many caveats.
|
||||
|
||||
**Notes**:
|
||||
|
||||
- Modern AMD GPUs are **supported**.
|
||||
- Intel ARC GPUs are **supported**.
|
||||
- Nvidia GPUs are **unsupported**.
|
||||
- Proprietary connectors, like the one for the ASUS ROG Ally, will not work.
|
||||
|
||||
## **Recommended External Guide & Script**:
|
||||
|
||||
Read this [guide](https://github.com/ewagner12/all-ways-egpu) for eGPU usage on Linux, and use the script at your own risk.
|
||||
|
||||
<hr>
|
||||
|
||||
**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 all Bazzite documentation**](https://docs.bazzite.gg)
|
@ -1,245 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=37", "fetched_at": "2024-09-03 16:43:12.251158+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
## General Information
|
||||
|
||||
> **For Handheld PC users only**: View our [Handheld Wiki](../Handheld_and_HTPC_edition/Handheld_Wiki/index.md) for post-installation setup, workarounds, and known issues on handheld hardware.
|
||||
|
||||
![Steam Gaming Mode UI|690x430](../img/Steam_Gaming_Mode_UI.jpeg)
|
||||
|
||||
> Steam Gaming Mode requires a modern AMD graphics card or an Intel Arc graphics card. Nvidia is **not** supported.
|
||||
|
||||
### What is Steam Gaming Mode?
|
||||
|
||||
https://www.youtube.com/watch?v=zXK1CXUyzXQ
|
||||
**Steam Deck UI Tour by [Linux For Everyone](https://www.youtube.com/@LinuxForEveryone)**
|
||||
|
||||
Bazzite utilizes Steam Gaming Mode by [forking ChimeraOS’s `gamescope-session` ](https://github.com/KyleGospo/gamescope-session) and modifying it to fit the needs of our operating system. Steam Gaming Mode is also referred to as "gamepadUI" and "gamescope-session" but Bazzite documentation will usually refer to it as "Steam Gaming Mode" most of the time.
|
||||
|
||||
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.
|
||||
|
||||
This documentation may not cover specific areas with the assumption that the user is already aware of SteamOS and how it works. If you are unfamiliar with something that cannot be found in our [documentation](https://docs.bazzite.gg), then research your specific question with "SteamOS" or "Steam Deck" as keywords in your search. Otherwise, ask your question on our [forums](https://universal-blue.discourse.group/c/bazzite/5) or [Discord](https://discord.gg/f8MUghG5PB).
|
||||
|
||||
<hr>
|
||||
|
||||
## Common Questions & Issues for Steam Gaming Mode
|
||||
|
||||
> [View the current Gamescope issues](https://github.com/ValveSoftware/gamescope/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
|
||||
|
||||
> **Note**: Updates will also look for and upgrade Linux applications like installed [Flatpaks](https://universal-blue.discourse.group/docs?topic=2636).
|
||||
|
||||
#### Steam Gaming Mode
|
||||
|
||||
The update indicator is not accurate and will most likely look it's stuck at "99%" for a long time. This is due to the update component not containing a live progress indicator, so it cannot hook into Steam Gaming Mode properly. After a while, the update progress bar will appear done and ask for a reboot.
|
||||
|
||||
#### Desktop Mode
|
||||
|
||||
In Desktop Mode, run our _System Update_ tool for an accurate update visual if you are unsure if your system has actually updated properly in Gaming Mode. When the update has finished, it will output what has completed successfully. Alternatively, open a host terminal and **enter**:
|
||||
|
||||
```command
|
||||
ujust update
|
||||
```
|
||||
|
||||
#### Changelog
|
||||
|
||||
The changelog is specifically for SteamOS by Valve, so the upgrade for Bazzite may not apply.
|
||||
Read the [Universal Blue announcements](https://universal-blue.discourse.group/tag/announcements) for major changes and features.
|
||||
|
||||
View a changelog to the next update in the terminal by **entering**:
|
||||
|
||||
```
|
||||
ujust changelogs
|
||||
```
|
||||
|
||||
### How do I access GRUB?
|
||||
|
||||
[GRUB](https://www.gnu.org/software/grub/manual/grub/grub.html#Overview) used to be hidden by default, but new installations have defaulted to showing it.
|
||||
|
||||
Keep in mind, other handhelds and controllers may not be able to unhide GRUB without a physical keyboard connected, but a `ujust` command can be performed to unhide it permanently.
|
||||
|
||||
Enter this command in the terminal to have it appear every boot:
|
||||
|
||||
```
|
||||
ujust configure-grub
|
||||
```
|
||||
|
||||
Select "unhide" to have GRUB appear on boot.
|
||||
|
||||
> View the [Rollback Guide](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md) for more information.
|
||||
|
||||
### 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
|
||||
|
||||
As of writing, `gamescope-session` has no way to change the physical keyboard layout and will default to the US layout.
|
||||
|
||||
If you want to change the layout for Gamescope, you can set the environment variable `XKB_DEFAULT_LAYOUT=no` replacing `no` with the correct layout for you. Add this to `~/.config/environment.d/10-gamescope-session.conf`
|
||||
|
||||
> If the file or folder does not exist then create it.
|
||||
|
||||
This works on desktop mode including running Nested Gamescope and also works for Steam Gaming Mode, but it has its own quirks: <kbd>altgr</kbd> + <kbd>2</kbd> to write "<kbd>@</kbd>" on the Norwegian layout will still not work, but the basic keyboard layout will always work, `altgr` is luckily not needed for normal typing on the norwegian layout, however <kbd>altgr</kbd> has been reported to work on the French layout, but your mileage may vary.
|
||||
|
||||
### Why do specific Decky Loader plugins not function on Bazzite?
|
||||
|
||||
Some plugins are built specifically for SteamOS or the Steam Deck, and won’t necessarily work on Bazzite or non-Deck hardware.
|
||||
|
||||
For example, the [DeckMTP plugin](https://github.com/dafta/DeckMTP) only works on the Steam Deck, it will not work on alternative hardware.
|
||||
|
||||
### How do I use SteamDeckGyroDSU on hardware that isn't the Steam Deck?
|
||||
|
||||
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**:
|
||||
|
||||
```command
|
||||
SteamDeck=0 %command%
|
||||
```
|
||||
|
||||
### How do I specify the correct monitor for Gaming Mode to use? (HTPC only)
|
||||
|
||||
Go into desktop mode and open `ptyxis` our terminal and run
|
||||
|
||||
```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>
|
||||
|
||||
```command
|
||||
export-gpu
|
||||
```
|
||||
|
||||
**Alternatively**, in Desktop Mode, enter in a host terminal:
|
||||
|
||||
```
|
||||
/usr/bin/export-gpu
|
||||
```
|
||||
|
||||
2. Select the GPU to use for Steam Gaming Mode.
|
||||
|
||||
### "Something went wrong while displaying this content" Error
|
||||
|
||||
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.
|
||||
|
||||
### Why is VRR not working on my VRR-compatible display?
|
||||
|
||||
Most of the time this is because you're connecting the device via HDMI which does not support VRR on Linux. Here is the [source](https://www.phoronix.com/news/HDMI-2.1-OSS-Rejected) of that information.
|
||||
|
||||
### Stuck at the Bazzite logo
|
||||
|
||||
https://www.youtube.com/watch?v=gE1ff72g2Gk
|
||||
|
||||
> **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>
|
||||
|
||||
### 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
|
||||
|
||||
```file
|
||||
[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
|
||||
|
||||
```file
|
||||
[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>
|
||||
|
||||
## Valve's Official SteamOS Guide
|
||||
|
||||
> **Note**: Not all of the information will be accurate in regards to Bazzite.
|
||||
|
||||
Valve wrote a [guide](https://help.steampowered.com/en/faqs/view/7DD4-C618-182E-0E49) for the Steam Deck which may have some relevant information in regards to Bazzite.
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [HikariKnight](https://github.com/HikariKnight)
|
||||
|
||||
**See also**: [Gaming Guide](../Gaming/index.md)
|
||||
|
||||
<-- [**View all Bazzite documentation**](../index.md)
|
@ -1,28 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2641", "fetched_at": "2024-09-03 16:43:10.114605+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![AppImage|100x100, 100%](../img/AppImage.png)
|
||||
|
||||
> **Note**: AppImages may not be supported if rebasing to other Fedora Atomic Desktop images.
|
||||
|
||||
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
|
||||
|
||||
![Gear Lever|500x500](../img/Gear_Level.png)
|
||||
|
||||
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>
|
||||
|
||||
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
|
@ -1,128 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2640", "fetched_at": "2024-09-03 16:43:09.168054+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# What is Distrobox?
|
||||
|
||||
![distrobox|310x113, 50%](../img/distrobox.png)
|
||||
|
||||
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/).
|
||||
|
||||
## Arch Linux Distrobox Container Example:
|
||||
|
||||
![i use arch btw|690x229, 75%](../img/i_use_arch_btw.png)
|
||||
|
||||
> i use Arch (in a container) btw.
|
||||
|
||||
**Linux Distribution Examples**:
|
||||
|
||||
| OS | Package Manager | Search for Packages |
|
||||
| ----------------------------------- | ------------------ | ------------------------------------------------------------------------- |
|
||||
| [Fedora][fedora] | [`dnf`][dnf] | [Fedora Packages][fedora_pkgs] / [COPR Packages][copr] |
|
||||
| [Arch Linux][arch] | [`pacman`][pacman] | [Arch Linux Packages][arch_pkgs] / [AUR Packages][aur_pkgs] |
|
||||
| [Debian][debian] / [Ubuntu][ubuntu] | [`apt`][apt] | [Debian Packages][deb_pkgs] / [Ubuntu Packages][ubuntu_pkgs] ([PPA][ppa]) |
|
||||
| [openSUSE][osuse] | [`zypper`][zypper] | [openSUSE Packages][osuse_pkgs] |
|
||||
| [Void Linux][void] | [`xbps`][xbps] | [Void Linux Packages][void_pkgs] |
|
||||
| [Alpine Linux][alpine] | [`apk`][apk] | [Alpine Linux Packages][alpine_pkgs] |
|
||||
|
||||
# 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
|
||||
|
||||
![BoxBuddy|690x382, 75%](../img/BoxBuddy.png)
|
||||
|
||||
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 Bluefin's documentation on how containers integrate with your system](https://docs.projectbluefin.io/bluefin-dx#pet-containers).
|
||||
|
||||
# Manually Create Pre-Configured Distrobox Containers
|
||||
|
||||
```command
|
||||
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>
|
||||
```
|
||||
|
||||
# Distrobox Video Guide
|
||||
|
||||
https://youtu.be/5m0YfIiypwA
|
||||
|
||||
# Project Website
|
||||
|
||||
https://distrobox.it/
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
|
||||
|
||||
[fedora]: https://fedoraproject.org/
|
||||
[dnf]: https://docs.fedoraproject.org/en-US/quick-docs/dnf/
|
||||
[fedora_pkgs]: https://packages.fedoraproject.org/index-static.html
|
||||
[copr]: https://copr.fedorainfracloud.org/
|
||||
[arch]: https://archlinux.org/
|
||||
[pacman]: https://wiki.archlinux.org/title/Pacman
|
||||
[arch_pkgs]: https://archlinux.org/packages/
|
||||
[aur_pkgs]: https://aur.archlinux.org/packages?SB=l&SO=d
|
||||
[debian]: https://www.debian.org/
|
||||
[ubuntu]: https://ubuntu.com/
|
||||
[apt]: https://ubuntu.com/server/docs/package-management
|
||||
[deb_pkgs]: https://packages.debian.org/stable/
|
||||
[ubuntu_pkgs]: https://packages.ubuntu.com/
|
||||
[ppa]: https://launchpad.net/ubuntu/+ppas
|
||||
[osuse]: https://get.opensuse.org/
|
||||
[zypper]: https://documentation.suse.com/smart/systems-management/html/concept-zypper/index.html
|
||||
[osuse_pkgs]: https://search.opensuse.org/packages/
|
||||
[void]: https://voidlinux.org/
|
||||
[xbps]: https://docs.voidlinux.org/xbps/index.html
|
||||
[void_pkgs]: https://voidlinux.org/packages/
|
||||
[alpine]: https://www.alpinelinux.org/
|
||||
[apk]: https://wiki.alpinelinux.org/wiki/Alpine_Package_Keeper
|
||||
[alpine_pkgs]: https://pkgs.alpinelinux.org/packages
|
@ -1,75 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2636", "fetched_at": "2024-09-03 16:43:08.564302+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# What is Flatpak?
|
||||
|
||||
![Flatpak|100x100, 100%](../img/Flatpak.png)
|
||||
|
||||
Flatpak is a universal containerized package format that tries to sandbox applications through flexible permissions that the application has access to on your system.
|
||||
|
||||
> Flatpak is 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.
|
||||
|
||||
![Discover|50x50, 100%](../img/Discover_icon.png)
|
||||
**KDE**: _Discover_
|
||||
|
||||
![GNOME Software|50x50, 100%](../img/Gnome_Software.png)
|
||||
**GNOME**: _GNOME Software_
|
||||
|
||||
![Discover|659x500, 100%](../img/Discover.png)
|
||||
![GNOME Software Center](../img/Gnome_Software_Center.png)
|
||||
|
||||
**Alternatively open a host terminal and enter**:
|
||||
|
||||
```
|
||||
flatpak install <application>
|
||||
```
|
||||
|
||||
# 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|690x376](../img/Flatseal.png)
|
||||
|
||||
**Flatseal** is for changing [application permissions](https://github.com/tchx84/Flatseal/blob/92e675e5ad2129f2aabf324261570eef442494f6/DOCUMENTATION.md) if necessary.
|
||||
|
||||
Alternatively, use KDE Plasma's system settings which has application permissions to adjust as well on KDE Plasma images.
|
||||
|
||||
Sometimes a project's website or [Github repository](<https://github.com/flathub/com.discordapp.Discord/wiki/Rich-Precense-(discord-rpc)#flatpak-applications>) contain information on what permissions need to be changed to perform certain functionality.
|
||||
|
||||
## Warehouse
|
||||
|
||||
![Warehouse|690x376](../img/Warehouse.png)
|
||||
|
||||
**Warehouse** is a utility that gives users a graphical interface to downgrade applications, add other Flatpak sources outside of Flathub, and backup application user data. Its also a helpful tool for installing Flatpaks outside of Flathub, **at your own risk**.
|
||||
|
||||
# Project Website
|
||||
|
||||
https://www.flatpak.org/
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
|
@ -1,30 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2639", "fetched_at": "2024-09-03 16:43:07.277727+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# What is Homebrew?
|
||||
|
||||
![Homebrew|332x500, 15%](../img/Homebrew.png)
|
||||
|
||||
> **Note**: Any package that requires root privileges will either need a rootful Distrobox container or has to be layered with `rpm-ostree`.
|
||||
|
||||
Homebrew is a package manager that installs packages to their own prefix, and is used strictly for command-line interface (CLI) and terminal user interface (TUI) applications. Do **not** install graphical applications or anything that may override system-level packages with Homebrew.
|
||||
|
||||
Install packages in a host terminal with this **command**:
|
||||
|
||||
```
|
||||
brew install <package>
|
||||
```
|
||||
|
||||
# Project Website
|
||||
|
||||
https://brew.sh/
|
||||
|
||||
<hr>
|
||||
|
||||
[ **← Back to Installing and Managing Software on Bazzite**](./index.md)
|
@ -1,41 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2647", "fetched_at": "2024-09-03 16:43:17.164020+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![Bazzite Rollback Helper Command|636x500](../../img/Bazzite_Rollback_Helper_Command.png)
|
||||
|
||||
> **Note**: Read the [rollback](./rolling_back_system_updates.md) and [rebasing](./rebase_guide.md) guides to understand the terms and what they do.
|
||||
|
||||
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**.
|
||||
|
||||
# Video Guide
|
||||
|
||||
https://www.youtube.com/watch?v=XvljabnzgVo
|
||||
|
||||
> # Key Takeaways:
|
||||
>
|
||||
> **Updates**: Upgrades both system and installed software.
|
||||
> **Rollbacks**: Return to a previous deployment after a bad system upgrade.
|
||||
> **Rebasing**: Use the `bazzite-rollback-helper` command in the terminal.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
|
@ -1,42 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=36", "fetched_at": "2024-09-03 16:43:15.473615+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Updates
|
||||
|
||||
Updates are automatic on Desktop images and manually done on Handheld/HTPC images, and both Bazzite variants upgrade everything at both a system-level and user-installed applications during the updating process.
|
||||
|
||||
> **Full Documentation**:
|
||||
> [Updating guide](./updating_guide.md)
|
||||
|
||||
# Rollbacks
|
||||
|
||||
Swap back to a previous system update if there are major issues after updating via the GRUB menu or the `rpm-ostree rollback` command.
|
||||
|
||||
> **Full Documentation**:
|
||||
> [Rollbacks guide](./rolling_back_system_updates.md)
|
||||
|
||||
# Rebasing
|
||||
|
||||
> **Important**: Do **not** rebase to a different desktop environment than the one you are currently using, please backup and reinstall instead.
|
||||
|
||||
Rebase to Bazzite builds from the last 90 days, change Bazzite update channels, swap between the Desktop and Handheld/HTPC images, or move completely to a different Fedora Atomic Desktop image.
|
||||
|
||||
> **Full Documentation**:
|
||||
> [Rebase guide](./rebase_guide.md)
|
||||
|
||||
## Rollback Helper
|
||||
|
||||
Utility to assist with rolling back and rebasing to older Bazzite images.
|
||||
|
||||
> **Full Documentation**:
|
||||
> [Rollback Helper](./bazzite_rollback_helper.md)
|
||||
|
||||
<hr>
|
||||
|
||||
← [**View all Bazzite documentation**](../../index.md)
|
@ -1,135 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2646", "fetched_at": "2024-09-03 16:43:14.912897+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![Docker's OCI Icon|200x200, 100%](../../img/Dockers_OCI_Icon.png)
|
||||
|
||||
# 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**](./bazzite_rollback_helper.md).
|
||||
|
||||
# Rebase Scenarios
|
||||
|
||||
- Rebase to specific images of older builds within the last 90 days if issues are occurring on the newest build of Bazzite.
|
||||
- Rebase to other Fedora Atomic Desktop images including other Bazzite images.
|
||||
- Do **not** rebase between different desktop environments.
|
||||
|
||||
# How do I swap between Bazzite (and other Fedora Atomic Desktop) images?
|
||||
|
||||
See what channel or build you are on by **entering this command in a host terminal**:
|
||||
|
||||
```command
|
||||
rpm-ostree status
|
||||
```
|
||||
|
||||
Check under "Deployments:" and the output should be similar to:
|
||||
|
||||
> **● ostree-image-signed:docker://ghcr.io/ublue-os/[*image*]:[*channel*]**
|
||||
|
||||
Switch to another Bazzite variant by entering the command for each specific image.
|
||||
|
||||
Open the terminal and **enter**:
|
||||
|
||||
```
|
||||
rpm-ostree rebase <image>
|
||||
```
|
||||
|
||||
**Example**:
|
||||
|
||||
```command
|
||||
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/bazzite-deck:stable
|
||||
```
|
||||
|
||||
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`)](https://github.com/ublue-os/bazzite/compare/main...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**:
|
||||
|
||||
```command
|
||||
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**:
|
||||
|
||||
```command
|
||||
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/IMAGE-NAME:VERSION-YEARMONTHDAY
|
||||
```
|
||||
|
||||
**Example**:
|
||||
|
||||
```command
|
||||
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/ublue-os/bazzite-deck:39-20240113
|
||||
```
|
||||
|
||||
For the _Jan. 13th 2024_ `bazzite-deck` (_Fedora 39_) build.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
|
@ -1,92 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2644", "fetched_at": "2024-09-03 16:43:14.300522+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![GRUB Menu|690x402](../../img/GRUB_Menu.png)
|
||||
|
||||
# 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**:
|
||||
|
||||
```command
|
||||
rpm-ostree rollback
|
||||
```
|
||||
|
||||
Rollback can also be done in the GRUB menu (the menu you see before booting into Bazzite on Desktop images) by choosing the previous boot entry before booting to the desktop. It shows your current (`:0`) and your previous (`:1`) deployments, but due to a bug upstream there may be duplicates below them. Your personal files will **not** be affected by this, and you can still update to the newest builds after rolling back.
|
||||
|
||||
> If you need to rollback to a different OS image, use the [`bazzite-rollback-helper`](./bazzite_rollback_helper.md) to do so.
|
||||
|
||||
## Unhide The GRUB Menu
|
||||
|
||||
If you opted to hide the GRUB menu:
|
||||
|
||||
Unhide GRUB on Handheld/HTPC images with this **command**:
|
||||
|
||||
```
|
||||
ujust configure-grub
|
||||
```
|
||||
|
||||
Select the "**unhide**" opiton to have GRUB appear on boot.
|
||||
|
||||
> Controls may vary with different handheld or HTPC navigate the menu and an external physical keyboard may be needed.
|
||||
|
||||
# How do I save my **current** deployment?
|
||||
|
||||
You can pin your **current** deployment with this **command**:
|
||||
|
||||
```command
|
||||
sudo ostree admin pin 0
|
||||
```
|
||||
|
||||
In a host terminal for a backup save state of your **current** deployment to rollback to if a new system update causes issues.
|
||||
|
||||
# How do I save my **previous** deployment?
|
||||
|
||||
You can pin your **previous** deployment with this **command**:
|
||||
|
||||
```command
|
||||
sudo ostree admin pin 1
|
||||
```
|
||||
|
||||
In a host terminal for a backup save state of your **previous** deployment to rollback if the current deployment has issues.
|
||||
|
||||
# How do I unpin a deployment if I saved it?
|
||||
|
||||
Unpin saved **current** deployment:
|
||||
|
||||
```command
|
||||
sudo ostree admin pin --unpin 0
|
||||
```
|
||||
|
||||
Unpin saved **previous** deployment:
|
||||
|
||||
```command
|
||||
sudo ostree admin pin --unpin 1
|
||||
```
|
||||
|
||||
View all deployment index numbers:
|
||||
|
||||
```command
|
||||
rpm-ostree status -v
|
||||
```
|
||||
|
||||
Unpin **saved** deployment:
|
||||
|
||||
```command
|
||||
sudo ostree admin pin --unpin <index number>
|
||||
```
|
||||
|
||||
# Application Update Downgrades
|
||||
|
||||
**Read about the pre-installed Warehouse application to downgrade applications in this doc**:
|
||||
|
||||
Read about the pre-installed Warehouse application to downgrade applications in this [documentation](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Flatpak/).
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
|
@ -1,107 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2637", "fetched_at": "2024-09-03 16:43:13.297624+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![System Updates|200x200, 100%](../../img/System_Updates.png)
|
||||
|
||||
# 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](../../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md).
|
||||
|
||||
# How do I update manually on Desktop images?
|
||||
|
||||
> **Note**: This manual method also works in Desktop Mode on Handheld/HTPC images in Desktop Mode.
|
||||
|
||||
**Note**: `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:
|
||||
|
||||
```command
|
||||
ujust update
|
||||
```
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
Alternatively, you can subscribe to the [RSS feed](https://universal-blue.discourse.group/t/tutorial-subscribing-to-bazzite-news-for-major-update-information/3672) for major announcements regarding the project.
|
||||
|
||||
# How often is there a new Bazzite build?
|
||||
|
||||
Usually Bazzite is built twice a week which includes the new changes from us, but it can also be built more than this. Updates may happen multiple times a day regardless due to updates from upstream (Universal Blue and Fedora), applications installed, firmware upgrades, and any containers that exist on your system updating their packages.
|
||||
|
||||
# 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**
|
||||
|
||||
Open a host terminal and **enter**:
|
||||
|
||||
```command
|
||||
sudo nano /etc/ublue-update/ublue-update.toml
|
||||
```
|
||||
Change this line inside of the file:
|
||||
`dbus_notify = false` to `dbus_notify = true`
|
||||
|
||||
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?
|
||||
|
||||
Read the [upstream documentation](https://universal-blue.discourse.group/docs?topic=80#manually-for-bazzite-and-bluefin-3) to disable automatic updates.
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md)
|
@ -1,163 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=32", "fetched_at": "2024-09-03 16:43:06.740654+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![Google Play Store|650x500](../img/Google_Play_Store.jpeg)
|
||||
|
||||
> **Note**: Waydroid does **not** work on Nvidia's proprietary drivers, and requires an AMD or Intel GPU for the best results.
|
||||
|
||||
# What is Waydroid?
|
||||
|
||||
![Waydroid](../img/Waydroid.jpeg)
|
||||
|
||||
[Waydroid](https://waydro.id/) is an Android container that runs on Linux. Bazzite users can run Android applications using this method.
|
||||
|
||||
# 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**:
|
||||
|
||||
```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
|
||||
|
||||
#### Available Waydroid Extras:
|
||||
|
||||
- [GApps](https://github.com/opengapps/opengapps/wiki/FAQ) (Default Android applications including the **Google Play Store)** or [microG](https://microg.org/) (Free alternatives to Google applications)
|
||||
|
||||
- ARM Translation (_libndk_ for **AMD CPUs only** & _libhoudini_ for **Intel CPUs only**)
|
||||
|
||||
- [Magisk](https://github.com/topjohnwu/Magisk) (Android power user suite)
|
||||
|
||||
- [Logitech Smartdock Support](https://support.logi.com/hc/en-us/articles/360023201574-What-is-SmartDock) (Currently broken)
|
||||
|
||||
- [F-Droid Privileged Extension](https://f-droid.org/packages/org.fdroid.fdroid.privileged/) (Proper [F-Droid](https://f-droid.org/en/packages/) support)
|
||||
|
||||
- [`widevine`](https://widevine.com/) (Support for video streaming DRM)
|
||||
|
||||
### Get Google Device ID to Get Certified (**GApps**)
|
||||
|
||||
![Waydroid_DeviceID|690x182](../img/Waydroid_DeviceID.png)
|
||||
|
||||
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.](../Handheld_and_HTPC_edition/Steam_Gaming_Mode.md)
|
||||
|
||||
Make sure to add `/usr/bin/waydroid-launcher` to Steam as a non-Steam game for Waydroid to work properly in Steam Gaming Mode.
|
||||
|
||||
<hr>
|
||||
|
||||
# Disable Inputs to Waydroid When Unfocused
|
||||
|
||||
Waydroid has an [issue](https://github.com/waydroid/waydroid/issues/135) where it will register inputs from controllers, keyboards, and other input devices even when the window is not focused.
|
||||
|
||||
Disable this functionality:
|
||||
|
||||
> Note: **Waydroid must be running**!
|
||||
|
||||
In a host terminal, **run this command**:
|
||||
|
||||
```command
|
||||
waydroid prop set persist.waydroid.uevent false
|
||||
```
|
||||
|
||||
If you ever want to undo this change, run the same steps but set `true` instead of `false` with the same command.
|
||||
|
||||
# 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.
|
||||
|
||||
<hr>
|
||||
|
||||
# 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 all Bazzite documentation**](../index.md)
|
@ -1,57 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=35", "fetched_at": "2024-09-03 16:43:05.697052+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# Linux Package Formats
|
||||
|
||||
> **Package formats ranked from most recommended for daily usage**:
|
||||
>
|
||||
> 1. [Flatpak](./Flatpak.md) - Universal package format using a permissions-based model; use for most graphical applications.
|
||||
> 2. [`ujust`](./ujust.md) - Custom scripts maintained by Bazzite & Universal Blue contributors that can install applications.
|
||||
> 3. [Homebrew](./Homebrew.md) - Install applications intended to run inside of the terminal (CLI/TUI).
|
||||
> 4. [Distrobox](./Distrobox.md) - Intended for legacy applications that do not support Flatpak and Homebrew, or for use as development boxes.
|
||||
> 5. [AppImage](./AppImage.md) - Portable universal package format that relies on specific host libraries at a system-level, usually obtained from a project's website.
|
||||
> 6. [`rpm-ostree`](./rpm-ostree.md) - Layer Fedora packages at a system-level (**not recommended, use as a last resort**)
|
||||
|
||||
# How do I run Windows applications?
|
||||
|
||||
> **Use a [WINE](https://www.winehq.org/) front-end**:
|
||||
>
|
||||
> - [Steam](https://store.steampowered.com/) (_pre-installed_) has a Windows compatibility layer built-in.
|
||||
> - [Lutris](https://lutris.net/about) (_pre-installed_) for non-Steam video games.
|
||||
> - [Heroic](https://heroicgameslauncher.com/) for Epic Games, GOG, and Amazon Games integration.
|
||||
> - [Bottles](https://usebottles.com/) for general-purpose applications or as an alternative to Lutris.
|
||||
> - [itch](https://flathub.org/apps/io.itch.itch) for games on itch.io.
|
||||
> - [WineZGUI](https://github.com/fastrizwaan/WineZGUI) (_pre-installed_) for Windows applications that don’t require special considerations for their prefix.
|
||||
|
||||
# How do I install Android applications?
|
||||
|
||||
Follow the [Waydroid Setup Guide](./Waydroid_Setup_Guide.md) to install Android applications on Bazzite.
|
||||
|
||||
> **Note**: Waydroid is **not supported** on other Universal Blue images like Aurora and Bluefin.
|
||||
|
||||
# Tutorials for Installing Other Software
|
||||
|
||||
- [Plex Media Server](https://universal-blue.discourse.group/t/video-tutorial-how-to-install-plex-media-server-using-distrobox-on-bazzite/1999) (**Note**: Podman or Docker is recommended over Distrobox)
|
||||
- [Flash Games](https://universal-blue.discourse.group/t/how-to-run-old-browser-games-with-web-apps/486)
|
||||
|
||||
<hr>
|
||||
|
||||
# Video Showcase of Installing Software
|
||||
|
||||
> **Note**: This video is missing Homebrew.
|
||||
|
||||
https://www.youtube.com/watch?v=ITuT23YrgPs
|
||||
|
||||
<hr>
|
||||
|
||||
**Documentation Contributors**: [HikariKnight](https://github.com/HikariKnight)
|
||||
|
||||
**See also**: [Updates, Rollbacks, & Rebasing](../Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/index.md)
|
||||
|
||||
<-- [**View all Bazzite documentation**](../index.md)
|
@ -1,109 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2642", "fetched_at": "2024-09-03 16:43:05.295995+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
![rpm-ostree|500x500, 30%](../img/rpm-ostree.png)
|
||||
|
||||
# `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 possible, so be aware there are risks associated with it including broken updates until removed.
|
||||
|
||||
1. Download the .repo file and save it to `/etc/yum.repos.d/`
|
||||
|
||||
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**:
|
||||
|
||||
```command
|
||||
rpm-ostree status
|
||||
```
|
||||
|
||||
# Project Website
|
||||
|
||||
https://coreos.github.io/rpm-ostree/
|
||||
|
||||
<hr>
|
||||
|
||||
**See also**: https://universal-blue.discourse.group/docs?topic=513
|
||||
|
||||
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
|
@ -1,94 +0,0 @@
|
||||
---
|
||||
authors:
|
||||
- "@nicknamenamenick"
|
||||
---
|
||||
|
||||
<!-- ANCHOR: METADATA -->
|
||||
<!--{"url_discourse": "https://universal-blue.discourse.group/docs?topic=2638", "fetched_at": "2024-09-03 16:43:04.643633+00:00"}-->
|
||||
<!-- ANCHOR_END: METADATA -->
|
||||
|
||||
# What is `ujust`?
|
||||
|
||||
![Shell Scripts (.sh)|96x96, 100%](../img/Shell_Scripts__sh.png)
|
||||
|
||||
Technically `ujust` is **not** a package format, but are convenience commands that automate tasks using scripts which can be utilized to install specific software. There are also commands for system configuration and maintenance included here, so run `ujust` commands **at your own risk.**
|
||||
|
||||
# Using `ujust`
|
||||
|
||||
![ujust command list|690x411](../img/ujust_command_list.png)
|
||||
|
||||
Open a host terminal and **enter**:
|
||||
|
||||
```
|
||||
ujust
|
||||
```
|
||||
|
||||
> This will output a list of available commands.
|
||||
|
||||
![ujust TUI|690x403](../img/ujust_TUI.png)
|
||||
|
||||
```
|
||||
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`
|
||||
|
||||
> This directory also shows **hidden** `ujust` commands.
|
||||
|
||||
# Uninstalling Applications Installed Through `ujust`
|
||||
|
||||
Most applications installed via a `ujust` script would have to be uninstalled manually. Follow the instructions found on the project's website or README file in the source code to uninstall it properly.
|
||||
|
||||
This **command** Shows layered packages that may be installed from the Bazzite Portal / `ujust`:
|
||||
|
||||
```
|
||||
rpm-ostree status
|
||||
```
|
||||
|
||||
# Project Website
|
||||
|
||||
https://just.systems/
|
||||
|
||||
<hr>
|
||||
|
||||
[**<-- Back to Installing and Managing Software on Bazzite**](./index.md)
|
Before Width: | Height: | Size: 67 KiB |
Before Width: | Height: | Size: 55 KiB |
Before Width: | Height: | Size: 140 KiB |
Before Width: | Height: | Size: 161 KiB |
Before Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 116 KiB |
Before Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 3.3 KiB |
Before Width: | Height: | Size: 110 KiB |
Before Width: | Height: | Size: 72 KiB |
Before Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 159 KiB |
Before Width: | Height: | Size: 8.2 KiB |
Before Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 9.2 KiB |
Before Width: | Height: | Size: 72 KiB |
Before Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 172 KiB |
Before Width: | Height: | Size: 145 KiB |
Before Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 5.4 KiB |
Before Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 52 KiB |
Before Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 124 KiB |
Before Width: | Height: | Size: 3.7 KiB |
Before Width: | Height: | Size: 172 KiB |
Before Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 2.8 KiB |
Before Width: | Height: | Size: 136 KiB |
Before Width: | Height: | Size: 283 KiB |
Before Width: | Height: | Size: 390 KiB |
Before Width: | Height: | Size: 188 KiB |
Before Width: | Height: | Size: 167 KiB |
Before Width: | Height: | Size: 158 KiB |