diff --git a/Containerfile b/Containerfile index 50b0167b..f926c3c5 100644 --- a/Containerfile +++ b/Containerfile @@ -784,6 +784,7 @@ RUN --mount=type=cache,dst=/var/cache/rpm-ostree \ hhd \ hhd-ui \ adjustor \ + acpica-tools \ vpower \ ds-inhibit \ steam_notif_daemon \ diff --git a/docs/README.md b/docs/README.md index db7471f6..509bdf97 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ This is a guide that will show you how to write, or transcribe documentation fro **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 cant be missing in a mdBook is the `mkdocs.yml` file. +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. @@ -44,94 +44,14 @@ You will need other tools as well, like: - A markdown compatible code editor (ex.: **Visual Studio Code**) - **git** (comes preinstalled in most Linux distributions) -## Transcribe Discourse docs to MkDocs - -Best way to learn is with a real life example. We will transcribe , which at the time of writting is a post called _Managing and Modding Games_. - -### 1. Basic preparation - -We will start with getting our utilities ready: - -1. A web browser with the Discourse doc page we want to transcribe. We will use for this example. -2. Our code editor. -3. A terminal open in the `docs` directory - - ```sh - $ cd docs - ``` - - Get sure we have `fetch_discourse_md.py` in there, we will need it - - ```sh - $ ls ./utils/fetch_discourse_md.py - ./utils/fetch_discourse_md.py - ``` - -### 2. Copy the post - -`fetch_discourse_md.py` is your friend for this task. - -1. Copy the URL of the document -2. In the terminal, pass the URL to `fetch_discourse_md.py` - - ```sh - $ ./utils/fetch_discourse_md.py "https://universal-blue.discourse.group/docs?topic=2657" | wl-copy - ``` - - Normally, `fetch_discourse_md.py` would dump the resulting markdown doc in the terminal output, with `wl-copy` we store it in our clipboard for now. - -3. Create the markdown file where we will store our document. The title of the post is "_Dual Boot Preliminary Setup and Post-Setup Guide_", so somewhere under "Advanced" should be fitting. +### 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 `_` - ![](./src/img/doc_guide_filename.jpg) - -### 4. Paste the document in the file - -![](./src/img/doc_guide_paste.jpg) - -### 5. Rewrite URLs - -We are almost done. The problem is `fetch_discourse_md.py` only will give us a dumped version of the Discourse document. - -There is posibly URLs that are pointing to other documentation posts in Discourse that we might have already in our MkDocs. - -![](./src/img/doc_guide_discourse_url.jpg) - -The url in the image above is pointing to the _Steam Gaming Mode Overview (Handheld/HTPC)_ post. -At the time of writting this, we have that post avaliable in our MkDocs, so we can simply replace that URL with ours - -![](./src/img/doc_guide_rewrite_url.jpg) - -In our case, the post is located in `../Handheld_and_HTPC_edition/Steam_Gaming_Mode/index.md` - -### 6. Add our page to navigation bar - -> [!TIP] -> You can skip this step if you dont need to show the page in the navigation bar - -We can check how our post looks in MkDocs, run in the terminal - -```sh -just mkdocs serve -``` - -Now, more likely you wont find our new added post. - -![](./src/img/doc_guide_where_did_go.jpg) - -If you take a look at [the brief explanation](#what-is-mkdocs), you will read about `mkdocs.yml`. Files not listed in there wont be added to the navigation bar, though still will be accessible with the search bar. - -Lets add our file there. Look for the `nav` field in there and add the new file as shown: - -![](./src/img/doc_guide_add_summary.jpg) - -And now our post should be visible in the nav bar. - -### 7. (Bonus) Set a proper page name +### 2. Set a proper page name You can add more explicit page titles (used by the browser tab names) by using YAML metadata. @@ -145,14 +65,10 @@ title: "Hello world" ## Translate documentation -> ⚠️ WARNING -> -> It is better to start translation once [transcription](#transcribe-discourse-docs-to-mkdocs) in a post is settled to keep up. - 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 cant see your translation with `just mkdocs serve`. +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: @@ -178,4 +94,4 @@ languages: build: true ``` -And now MkDocs should show a language selector in the top bar. +MkDocs should show a language selector in the top bar. diff --git a/docs/src/Advanced/Contributing_to_bazzite.md b/docs/src/Advanced/Contributing_to_bazzite.md index a09084ce..7db8a257 100644 --- a/docs/src/Advanced/Contributing_to_bazzite.md +++ b/docs/src/Advanced/Contributing_to_bazzite.md @@ -6,9 +6,9 @@ # **Preliminary Reading**: -https://universal-blue.discourse.group/docs?topic=51 + - [**Universal Blue Project Governance**](https://universal-blue.discourse.group/docs?topic=51) -https://universal-blue.discourse.group/docs?topic=81 +- [**Contributing Guide**](https://universal-blue.discourse.group/docs?topic=81)
@@ -29,10 +29,9 @@ Check out the Bazzite's [issue tracker](https://github.com/ublue-os/bazzite/issu # Building Your Own Bazzite for Testing -https://universal-blue.discourse.group/docs?topic=43 +>**[Bazzite Template](https://github.com/ublue-os/image-template)** -**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. @@ -44,4 +43,4 @@ Using the unaffiliated [BlueBuild](https://blue-build.org/learn/universal-blue/)
-<-- [**View all Bazzite documentation**](../index.md) \ No newline at end of file +<-- [**View all Bazzite documentation**](../index.md) diff --git a/docs/src/Advanced/Reset_Forgotten_User_Password.md b/docs/src/Advanced/Reset_Forgotten_User_Password.md index 7292b99a..34d5893b 100644 --- a/docs/src/Advanced/Reset_Forgotten_User_Password.md +++ b/docs/src/Advanced/Reset_Forgotten_User_Password.md @@ -2,6 +2,8 @@ +>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) diff --git a/docs/src/Advanced/creating_custom_image.md b/docs/src/Advanced/creating_custom_image.md index 82722a46..c7af6dd1 100644 --- a/docs/src/Advanced/creating_custom_image.md +++ b/docs/src/Advanced/creating_custom_image.md @@ -4,12 +4,12 @@ # Making your own image -**Containerfile template**: -https://github.com/ublue-os/image-template +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.** -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 Cases +# 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 @@ -22,4 +22,4 @@ Sometimes you don't want to make a whole new image from scratch, you just want t
-**See also**: [Community Created Custom Images](https://universal-blue.discourse.group/docs?topic=340) \ No newline at end of file +**See also**: [Community Created Custom Images](https://universal-blue.discourse.group/docs?topic=340) diff --git a/docs/src/Gaming/Common_gaming_issues.md b/docs/src/Gaming/Common_gaming_issues.md index 592818d6..e4d3e361 100644 --- a/docs/src/Gaming/Common_gaming_issues.md +++ b/docs/src/Gaming/Common_gaming_issues.md @@ -32,7 +32,7 @@ This has also been confirmed to cause issues joining and hosting custom maps in **At your own risk** -1. Open a host terminal and **enter these 4 commands**: +Open a host terminal and **enter these 4 commands**: ```command sudo su @@ -48,8 +48,7 @@ ausearch -c 'hl2_linux' --raw | audit2allow -M my-hl2linux ```command semodule -X 300 -i my-hl2linux.pp ``` - -2. Reboot your device +Reboot your device ### If you want to undo this change eventually: @@ -73,11 +72,11 @@ The `.pp` file should be in `/root` if you want to remove that. If a 32-bit Source 1 engine game is not opening due to [tmalloc libraries issues](https://github.com/ValveSoftware/csgo-osx-linux/issues/3229), then open a host terminal and **enter**: -1. Add the following as a **launch option** to the affected game in Steam: +Add the following as a **launch option** to the affected game in Steam: ```command LD_PRELOAD=/usr/lib/libtcmalloc_and_profiler.so.4 %command% ``` -2. Delete `libtcmalloc_minimal.so.x` in the game's bin folder if present. +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. @@ -85,4 +84,4 @@ If this fails to fix it, then try forcing Proton Experimental in the game's prop **Documentation Contributors**: [M2](https://github.com/m2Giles) -[**<-- Back to Gaming Guide**](./index.md) \ No newline at end of file +[**<-- Back to Gaming Guide**](./index.md) diff --git a/docs/src/Gaming/Managing_and_modding_games.md b/docs/src/Gaming/Managing_and_modding_games.md index 06d2a583..8c2ad17f 100644 --- a/docs/src/Gaming/Managing_and_modding_games.md +++ b/docs/src/Gaming/Managing_and_modding_games.md @@ -15,8 +15,14 @@ Windows games need to run through a **compatibility layer** (like Proton) on Baz ![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). @@ -96,4 +102,4 @@ Bazzite users can use templates for some of the pre-installed tools which can be
-[**<-- Back to Gaming Guide**](./index.md) \ No newline at end of file +[**<-- Back to Gaming Guide**](./index.md) diff --git a/docs/src/General/Installation_Guide/dual_boot_setup_guide.md b/docs/src/General/Installation_Guide/dual_boot_setup_guide.md index b193cee5..4b353310 100644 --- a/docs/src/General/Installation_Guide/dual_boot_setup_guide.md +++ b/docs/src/General/Installation_Guide/dual_boot_setup_guide.md @@ -52,8 +52,8 @@ If you need a tutorial video for manual partitioning, watch this [tutorial]( htt 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 @@ -76,7 +76,7 @@ If you need a tutorial video for manual partitioning, watch this [tutorial]( htt 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. @@ -99,4 +99,4 @@ If the `OS Boot Manager` has set `Windows Boot Manager` to be the first boot pri
-**Documentation Contributors**: [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Aarron Lee](https://github.com/aarron-lee) \ No newline at end of file +**Documentation Contributors**: [ChaiQi](https://github.com/atimeofday), [Damian Korcz](https://github.com/damiankorcz), and [Aarron Lee](https://github.com/aarron-lee) diff --git a/docs/src/General/reporting_bugs.md b/docs/src/General/reporting_bugs.md index b9631e46..81939e83 100644 --- a/docs/src/General/reporting_bugs.md +++ b/docs/src/General/reporting_bugs.md @@ -7,10 +7,9 @@ Report bugs experienced with Bazzite in our [**issue tracker**](https://github.c # Before submitting an issue -**Read how to file an issue properly before proceeding**: -https://universal-blue.discourse.group/docs?topic=1470 +**Read [how to file an issue properly](https://universal-blue.discourse.group/docs?topic=1470) before proceeding!** -## Bazzite Issue Template Walkthrough +### **Bazzite Issue Template Walkthrough** ![Bug report|690x174](../img/Bug_report.png) @@ -39,4 +38,4 @@ ujust logs-last-boot
-[**<-- View all Bazzite documentation**](https://docs.bazzite.gg) \ No newline at end of file +[**<-- View all Bazzite documentation**](https://docs.bazzite.gg) diff --git a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md index cab8e1c3..bab56293 100644 --- a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md +++ b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md @@ -8,6 +8,10 @@ **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 @@ -53,7 +57,11 @@ ujust install-hhd-controller-glyph-theme
-# TDP Controls +# Additional Information + +This applies to most handhelds running Bazzite. + +## TDP Controls ![TDP|690x431, 75%](../../img/TDP.jpeg) @@ -65,7 +73,7 @@ There are a few options for TDP Controls that work with Bazzite: * [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings. * Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed. -# How do I open the HHD Overlay? +## How do I open the HHD Overlay? ![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg) @@ -76,7 +84,7 @@ Press, hold, or double-tap the Quick Access Menu button. >**Note**: ASUS ROG Ally does not support **holding** for the QAM button! -# Controller Information +## Controller Information For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality. @@ -84,7 +92,7 @@ If your device has paddles, you will want to use the DualSense Edge controller. Some games and emulators may need Steam Input **disabled** to work correctly with your controls. -## Desktop Controls +### Desktop Controls Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings. @@ -96,7 +104,7 @@ Desktop Mode Controller Layout: It may not exist by default if Steam doesn't se Make sure to **apply** the desktop controls when you select them. -# Force reboot device to prevent drive corruption if Steam crashes +## Force reboot device to prevent drive corruption if Steam crashes >**Note**: This is only for the ASUS ROG Ally and Lenovo Legion Go. Hold down the "**select**" button on your device to force a reboot. This feature can be disabled in the overlay settings. @@ -109,4 +117,4 @@ This page and all of the links to each specific handheld are **wikis**, edit it **See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md) -**<-- Back to [Handheld Wiki](./index.md)** \ No newline at end of file +**<-- Back to [Handheld Wiki](./index.md)** diff --git a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md index 7f8fbc84..9c8b87e5 100644 --- a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md +++ b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md @@ -7,10 +7,10 @@ **Status**: Silver -**You will need this command for functional HHD**: -```command -sudo systemctl enable --now hhd@$(whoami) -``` +## 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 @@ -28,7 +28,12 @@ sudo systemctl enable --now hhd@$(whoami) - 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. +- 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: @@ -39,7 +44,7 @@ sudo systemctl enable --now hhd@$(whoami) - In order to boot with eGPU attached you need to add a kernel parameter, seems to be related to [this kernel issue](https://lore.kernel.org/lkml/20240415163056.GP223006@ziepe.ca/). There are many other issues opened and according to [this](https://gitlab.freedesktop.org/drm/amd/-/issues/3182) it could be potentially fixed in kernel 6.9. As a temporary solution booting with eGPU connected works when launching the command `rpm-ostree kargs --append-if-missing=video=pci=nommconf` or editing the kernel command line with `rpm-ostree kargs --editor`. - **NVIDIA**: currently untested and probably doesn't work. -### Suspend workaround +## Suspend workaround > Thanks to ChimeraOS for the [original suspend workaround](https://github.com/ChimeraOS/chimeraos/wiki/Community-Guides#enabling-modern-sleep-on-7000-series-amd-hardware), and SteamFork for the [updated writeup](https://wiki.steamfork.org/troubleshooting/#enabling-modern-sleep-on-7000-series-amd-based-devices) of this workaround. @@ -53,7 +58,7 @@ sudo systemctl enable --now hhd@$(whoami) > > Bazzite takes no responsibility for any harm caused by following these steps. By following this guide you acknowledge that you are solely responsible for the outcome. -#### Modern Standby Enablement Methods +## Modern Standby Enablement Methods * Enter your bios/firmware settings to see if you already have the options listed in the steps for the [Enabling Modern Standby](https://universal-blue.discourse.group/t/ayaneo-handheld-compatibility/2417#p-5599-enabling-modern-standby-7) section of this guide. If so, skip the rest of this section. * If the options are not available, follow the next few steps to create boot media. @@ -63,7 +68,7 @@ sudo systemctl enable --now hhd@$(whoami) * Boot your device and select the USB stick from the boot menu. * Navigate to the `Front Page` tab and select `Device Manager`. -#### Enabling Modern Standby +### Enabling Modern Standby 1. Select `AMD PBS` then `Power Saving Configurations`. 2. Under `S3/Modern Standby Support` change the entry to `Modern Standby` (or `Modern Standby Enable` on some devices). @@ -78,7 +83,11 @@ Check out the [original thread](https://universal-blue.discourse.group/t/ayaneo-
-# TDP Controls +# Additional Information + +This applies to most handhelds running Bazzite. + +## TDP Controls ![TDP|690x431, 75%](../../img/TDP.jpeg) @@ -90,14 +99,14 @@ There are a few options for TDP Controls that work with Bazzite: * Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed. * [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices. -# How do I open the HHD Overlay? +## How do I open the HHD Overlay? ![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg) ![Settings Example|690x432, 75%](../../img/HHD_Settings_Example.jpeg) Press, hold, or double-tap the Quick Access Menu button. -# Controller Information +## Controller Information For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality. @@ -105,7 +114,7 @@ If your device has paddles, you will want to use the DualSense Edge controller. Some games and emulators may need Steam Input **disabled** to work correctly with your controls. -## Desktop Controls +### Desktop Controls Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings. @@ -125,4 +134,4 @@ This page is a **wiki**, edit it to add any relevant information you may have re **See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md) -**<-- Back to [Handheld Wiki](./index.md)** \ No newline at end of file +**<-- Back to [Handheld Wiki](./index.md)** diff --git a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md index a76fec32..aa8df64f 100644 --- a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md +++ b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md @@ -8,6 +8,10 @@ **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 @@ -39,6 +43,10 @@ ujust install-hhd-controller-glyph-theme **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 @@ -68,7 +76,11 @@ ujust install-hhd-controller-glyph-theme
-# TDP Controls +# Additional Information + +This applies to most handhelds running Bazzite. + +## TDP Controls ![TDP|690x431, 75%](../../img/TDP.jpeg) @@ -79,14 +91,14 @@ There are a few options for TDP Controls that work with Bazzite: * [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings. * Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed. -# How do I open the HHD Overlay? +## How do I open the HHD Overlay? ![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg) ![RGB|690x431, 75%](../../img/HHD_RGB.jpeg) Press, hold, or double-tap the Quick Access Menu button. -# Controller Information +## Controller Information For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality. @@ -94,7 +106,7 @@ If your device has paddles, you will want to use the DualSense Edge controller ( Some games and emulators may need Steam Input **disabled** to work correctly with your controls. -## Desktop Controls +### Desktop Controls Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings. @@ -114,4 +126,4 @@ This page is a **wiki**, edit it to add any relevant information you may have re **See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md) -**<-- Back to [Handheld Wiki](./index.md)** \ No newline at end of file +**<-- Back to [Handheld Wiki](./index.md)** diff --git a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md index f8ea972f..e203ee93 100644 --- a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md +++ b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md @@ -6,9 +6,12 @@ ![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 @@ -51,6 +54,10 @@ For more information, check out the [GPD Win Tips and Tricks guide](https://gith **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 @@ -91,7 +98,11 @@ For more information, check out the [GPD Win Tips and Tricks guide](https://gith
-# TDP Controls +# Additional Information + +This applies to most handhelds running Bazzite. + +## TDP Controls ![TDP|690x431, 75%](../../img/TDP.jpeg) @@ -103,7 +114,7 @@ There are a few options for TDP Controls that work with Bazzite: * Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed. * [PowerControl](https://github.com/mengmeet/PowerControl) supports TDP, GPU, and fan controls on select devices. -# How do I open the HHD Overlay? +## How do I open the HHD Overlay? ![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg) ![Emulation Mode|690x434, 75%](../../img/HHD_Emulation_Mode.jpeg) @@ -112,7 +123,7 @@ Press, hold, or double-tap the Quick Access Menu button. >**Note**: GPD devices do not support double-tapping the QAM button! -# Controller Information +## Controller Information For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality. @@ -120,7 +131,7 @@ If your device has paddles, you will want to use the DualSense Edge controller. Some games and emulators may need Steam Input **disabled** to work correctly with your controls. -## Desktop Controls +### Desktop Controls Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings. @@ -140,4 +151,4 @@ This page is a **wiki**, edit it to add any relevant information you may have re **See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md) -**<-- Back to [Handheld Wiki](./index.md)** \ No newline at end of file +**<-- Back to [Handheld Wiki](./index.md)** diff --git a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md index da6758c9..1ecb7f58 100644 --- a/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md +++ b/docs/src/Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md @@ -8,6 +8,10 @@ **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**: @@ -46,7 +50,7 @@ mv ~/.config/kwinoutputconfig.json ~/.config/kwinoutputconfig.json.old ## BIOS Update Information -https://universal-blue.discourse.group/docs?topic=3064 +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 @@ -54,7 +58,11 @@ For more information, check out the [Legion Go Tips and Tricks guide](https://gi
-# TDP Controls +# Additional Information + +This applies to most handhelds running Bazzite. + +## TDP Controls ![TDP|690x431, 75%](../../img/TDP.jpeg) @@ -65,7 +73,7 @@ There are a few options for TDP Controls that work with Bazzite: * [SimpleDeckyTDP](https://github.com/aarron-lee/SimpleDeckyTDP) supports TDP, GPU, Power Governor, and among other settings. * Also has a [graphical application](https://github.com/aarron-lee/SimpleDeckyTDP-Desktop), but needs to be manually installed. -# How do I open the HHD Overlay? +## How do I open the HHD Overlay? ![Overlay|690x431, 75%](../../img/HHD_Overlay.jpeg) @@ -76,7 +84,7 @@ Press, hold, or double-tap the Quick Access Menu button. >**Example**: Legion R for the Lenovo Legion Go. -# Controller Information +## Controller Information For most handheld hardware, besides the Steam Deck, emulation of a DualSense controller is used for full functionality. Double tap or hold the side menu button to access settings for controller emulation including switching to an Xbox controller with reduced functionality. @@ -84,7 +92,7 @@ If your device has paddles, you will want to use the DualSense Edge controller. Some games and emulators may need Steam Input **disabled** to work correctly with your controls. -## Desktop Controls +### Desktop Controls Desktop Mode Controller Layout: It may not exist by default if Steam doesn't setup your handheld controller properly. This can be fixed in Steam's controller settings. @@ -96,7 +104,7 @@ Desktop Mode Controller Layout: It may not exist by default if Steam doesn't se Make sure to **apply** the desktop controls when you select them. -# Force reboot device to prevent drive corruption if Steam crashes +## Force reboot device to prevent drive corruption if Steam crashes >**Note**: This is only for the ASUS ROG Ally and Lenovo Legion Go. @@ -110,4 +118,4 @@ This page is a **wiki**, edit it to add any relevant information you may have re **See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode.md) -**<-- Back to [Handheld Wiki](./index.md)** \ No newline at end of file +**<-- Back to [Handheld Wiki](./index.md)** diff --git a/docs/src/Handheld_and_HTPC_edition/Steam_Gaming_Mode.md b/docs/src/Handheld_and_HTPC_edition/Steam_Gaming_Mode.md index dd747c8e..2fa92e5b 100644 --- a/docs/src/Handheld_and_HTPC_edition/Steam_Gaming_Mode.md +++ b/docs/src/Handheld_and_HTPC_edition/Steam_Gaming_Mode.md @@ -96,8 +96,9 @@ This works on desktop mode including running Nested Gamescope and also works for ## Why do specific Decky Loader plugins not function on Bazzite? -- Bazzite does not provide the functionality. - - [PauseGames](https://github.com/popsUlfr/SDH-PauseGames) requires a swapfile while Bazzite utilizes zram for example. +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? @@ -106,9 +107,10 @@ You cannot use SteamDeckGyroDSU outside of the Steam Deck, but you can try disab ## 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. + +- 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**: @@ -217,7 +219,7 @@ Save it and place it in the `Desktop` directory. >**Note**: Not all of the information will be accurate in regards to Bazzite. -https://help.steampowered.com/en/faqs/view/7DD4-C618-182E-0E49 +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.
@@ -225,4 +227,4 @@ https://help.steampowered.com/en/faqs/view/7DD4-C618-182E-0E49 **See also**: [Gaming Guide](../Gaming/index.md) -<-- [**View all Bazzite documentation**](../index.md) \ No newline at end of file +<-- [**View all Bazzite documentation**](../index.md) diff --git a/docs/src/Installing_and_Managing_Software/Distrobox.md b/docs/src/Installing_and_Managing_Software/Distrobox.md index 409b41f9..26b3a78c 100644 --- a/docs/src/Installing_and_Managing_Software/Distrobox.md +++ b/docs/src/Installing_and_Managing_Software/Distrobox.md @@ -2,13 +2,13 @@ -## What is Distrobox? +# 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**: +# **Important Notes**: - Containers are **not** virtual machines. - Containers are intended to be **disposable** and may run into issues where they need to be recreated. @@ -17,7 +17,11 @@ Run other minimal variants of popular Linux distributions in Bazzite inside of a 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**: @@ -30,17 +34,17 @@ Distrobox containers run sub-systems of other popular [Linux distributions](http | [Void Linux][void] | [`xbps`][xbps] | [Void Linux Packages][void_pkgs] | | [Alpine Linux][alpine] | [`apk`][apk] | [Alpine Linux Packages][alpine_pkgs] | -## Use Cases +# Use Cases Distrobox containers can be used for both **development environments** and **installing applications that are not available in any of the other installation methods** which can be exclusive to specific package managers. -### Distrobox Graphical Interface +# Distrobox 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 +# Desktop Integration Applications with a graphical user interface can integrate with your system with an application shortcut **entering this command inside of the container**: @@ -50,7 +54,7 @@ distrobox-export --app > [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 +# Manually Create Pre-Configured Distrobox Containers ```command ujust distrobox-assemble @@ -60,7 +64,7 @@ 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 +## Entering The Container Swap between different containers in your host with the terminal or alternatively **enter**: @@ -68,7 +72,7 @@ Swap between different containers in your host with the terminal or alternativel distrobox enter ``` -### Removing Distrobox Containers +# Removing Distrobox Containers Delete containers graphically with BoxBuddy. @@ -82,11 +86,11 @@ distrobox stop distrobox rm -f ``` -## Distrobox Video Guide +# Distrobox Video Guide https://youtu.be/5m0YfIiypwA -## Project Website +# Project Website https://distrobox.it/ diff --git a/docs/src/Installing_and_Managing_Software/Homebrew.md b/docs/src/Installing_and_Managing_Software/Homebrew.md index 795d24c8..be68db3d 100644 --- a/docs/src/Installing_and_Managing_Software/Homebrew.md +++ b/docs/src/Installing_and_Managing_Software/Homebrew.md @@ -9,7 +9,7 @@ >**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 brew. +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**: @@ -23,4 +23,4 @@ https://brew.sh/
-[ **← Back to Installing and Managing Software on Bazzite**](./index.md) \ No newline at end of file +[ **← Back to Installing and Managing Software on Bazzite**](./index.md) diff --git a/docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md b/docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md index 3ccb2cf8..a3509159 100644 --- a/docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md +++ b/docs/src/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/rolling_back_system_updates.md @@ -14,9 +14,9 @@ Rollback can also be done in the GRUB menu (the menu you see before booting into >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 on Handheld/HTPC Images +## Unhide The GRUB Menu -Handheld/HTPC images may **not** show the GRUB menu at boot by default, and controls may vary with different handheld or HTPC hardware to unhide the menu. +If you opted to hide the GRUB menu: Unhide GRUB on Handheld/HTPC images with this **command**: @@ -25,6 +25,8 @@ 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**: @@ -70,8 +72,8 @@ sudo ostree admin pin --unpin **Read about the pre-installed Warehouse application to downgrade applications in this doc**: -https://universal-blue.discourse.group/docs?topic=2636 +Read about the pre-installed Warehouse application to downgrade applications in this [documentation](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Flatpak/).
-[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md) \ No newline at end of file +[**<-- Back to Updates, Rollback, and Rebasing Guide**](./index.md) diff --git a/docs/src/Installing_and_Managing_Software/ujust.md b/docs/src/Installing_and_Managing_Software/ujust.md index a2393d01..9438b217 100644 --- a/docs/src/Installing_and_Managing_Software/ujust.md +++ b/docs/src/Installing_and_Managing_Software/ujust.md @@ -45,8 +45,7 @@ You can search for specific commands by **entering**: ujust | grep "" ``` -``` -*`install-`: Install program, there is no configuration or uninstall commands at this time +* `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 @@ -58,7 +57,6 @@ ujust | grep "" * `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**: diff --git a/docs/src/index.md b/docs/src/index.md index 992a291e..b63ad499 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -21,8 +21,7 @@ A quick list of stuff you might be interested in checking out: - [Ayn Handhelds][ayn] - [Ayaneo Handhelds][ayaneo] - -- [:material-download-circle: **Install software**][installing_software]{ style="font-size: 1.1rem" } +- [:material-download-circle: **Install Software**][installing_software]{ style="font-size: 1.1rem" } Order reflects the recommendation degree @@ -39,7 +38,7 @@ A quick list of stuff you might be interested in checking out: You can as well install regular Fedora packages with [`rpm-ostree`][rpm-ostree] but we [advise avoiding it if possible][rpm-ostree_caveats]. -- [:fontawesome-brands-windows: **Run Windows games**][run_win_game]{ style="font-size: 1.1rem" } +- [:fontawesome-brands-windows: **Run Windows Games**][run_win_game]{ style="font-size: 1.1rem" } Bazzite comes bundled with :fontawesome-brands-steam: Steam\* and [Lutris](Gaming/Game_Launchers.md#lutris-setup). @@ -51,6 +50,20 @@ A quick list of stuff you might be interested in checking out: \* Desktop images require [**enabling Proton for all Steam games**][enable_proton]. +- [:fontawesome-solid-circle-arrow-down: **Updates, Rollbacks, and Rebasing**][updateindex]{ style="font-size: 1.1rem" } + + - [Updating Guide][updates] + - [Rollback System Updates][rollbacks] + - [Rebasing to Other Images][rebasing] + - [`bazzite-rollback-helper`][rollback-helper] + +- [:fontawesome-brands-android: **Android Applications**][waydroid]{ style="font-size: 1.1rem" } + + Run Android applications in a container using [Waydroid](https://waydro.id/)! + + - Launch anything from productivity software to games! + - Support for the Google Play Store and [F-Droid](https://f-droid.org/). + - [:fontawesome-solid-handshake: **Contribute**][contrib]{ style="font-size: 1.1rem" } One of the strengths of Bazzite (inherited from [Universal Blue](https://universal-blue.org/)) is how easy is to contribute. @@ -62,7 +75,7 @@ A quick list of stuff you might be interested in checking out: [install_pc_laptop]: General/Installation_Guide/Installing_Bazzite_for_Desktop_or_Laptop_Hardware.md [install_handheld]: General/Installation_Guide/Installing_Bazzite_for_Handheld_PCs.md -[deck]: General/Installation_Guide/Installing_Bazzite_for_Steam_Deck.md#installation-guide +[deck]: General/Installation_Guide/Installing_Bazzite_for_Steam_Deck.md [frame_13]: General/Installation_Guide/Installing_Bazzite_Framework_Laptop_13.md [frame_16]: General/Installation_Guide/Installing_Bazzite_for_Framework_Laptop_16.md [htpc]: General/Installation_Guide/Installing_Bazzite_for_HTPC_Setups.md @@ -83,3 +96,9 @@ A quick list of stuff you might be interested in checking out: [rpm-ostree_caveats]: Installing_and_Managing_Software/rpm-ostree.md#major-caveats-using-rpm-ostree [steam_game_mode]: Handheld_and_HTPC_edition/Steam_Gaming_Mode.md#what-is-steam-gaming-mode [appimage]: Installing_and_Managing_Software/AppImage.md +[updateindex]: Installing_and_Managing_Software/Updates_Rollbacks_&_Rebasing/index.md +[updates]: Installing_and_Managing_Software/Updates_Rollbacks_&_Rebasing/updating_guide.md +[rollbacks]: Installing_and_Managing_Software/Updates_Rollbacks_&_Rebasing/rolling_back_system_updates.md +[rebasing]: Installing_and_Managing_Software/Updates_Rollbacks_&_Rebasing/rebase_guide.md +[rollback-helper]: Installing_and_Managing_Software/Updates_Rollbacks_&_Rebasing/bazzite_rollback_helper.md +[waydroid]: Installing_and_Managing_Software/Waydroid_Setup_Guide.md diff --git a/docs/theme_overrides/main.html b/docs/theme_overrides/main.html index d01a34ff..63e2e989 100644 --- a/docs/theme_overrides/main.html +++ b/docs/theme_overrides/main.html @@ -2,7 +2,5 @@ {% block announce %} ⚠️ -This new documentation is in development and may have issues. -Refer to the old Bazzite documentation if you -experience major issues. +Welcome to the new home for Bazzite documentation! {% endblock %}