Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
93 commits
Select commit Hold shift + click to select a range
ebce41a
feat: add mdbook docs
Zeglius Jul 31, 2024
f6c7356
chore: add several articles to docs
Zeglius Jul 31, 2024
f1d000b
docs: add documentation at surface level
Zeglius Jul 31, 2024
e3be3c6
docs: Add missing chapter emojis
Zeglius Aug 1, 2024
94c47fa
docs: Realocate 'Gaming' section under 'General'
Zeglius Aug 1, 2024
07a18e9
docs: Add 'Introduction' section
Zeglius Aug 1, 2024
8b50d6e
docs: Add unstable documentation warning
Zeglius Aug 1, 2024
46aa4f4
docs: Add missing github url
Zeglius Aug 1, 2024
8cbce1f
docs: Add discourse scrapper utility
Zeglius Aug 2, 2024
c3538ea
docs: minor discourse scrapper docs changes
Zeglius Aug 2, 2024
c17c783
docs: Add youtube embeding preprocessor
Zeglius Aug 3, 2024
1ce22b4
minor reformat for youtube-embed
Zeglius Aug 3, 2024
ec27cc9
docs: Add mdbook preprocessor template
Zeglius Aug 3, 2024
68d5eed
docs: add format-author preprocessor
Zeglius Aug 4, 2024
433dd2d
docs: add git lib to mdbook toolset
Zeglius Aug 4, 2024
74130ee
docs: Always fetch the highest quality image by fetch_discourse_md
Zeglius Aug 4, 2024
63c6164
docs: fix youtube-embed ignoring new line requirement
Zeglius Aug 4, 2024
b887ebe
docs: Add documentation transcription guide
Zeglius Aug 4, 2024
4eae894
docs: Missing url in transcription guide
Zeglius Aug 4, 2024
cd989d0
Merge remote-tracking branch 'upstream/main' into feat/mdbook
Zeglius Aug 5, 2024
ec24162
docs: Remove YAML header from doc guide
Zeglius Aug 5, 2024
ad6587a
docs: Minor tweaks to transcription guide
Zeglius Aug 5, 2024
48a57c1
docs: Add utilities preprocessor module
Zeglius Aug 6, 2024
53ee1e7
docs: tweak debug function
Zeglius Aug 6, 2024
a6bf1f3
docs: Add 'replace-urls' preprocessor
Zeglius Aug 6, 2024
d42769a
chore: Move mappings parameter in replace-urls preprocessor
Zeglius Aug 6, 2024
04f97c1
docs: add ignore field to replace-urls
Zeglius Aug 6, 2024
32e3096
docs: add Mdbook python types
Zeglius Aug 7, 2024
c27ac01
docs: Add ignore field to replace-urls
Zeglius Aug 7, 2024
3644edf
chore(ci): add deploy_docs
Zeglius Aug 9, 2024
3a58a7c
chore(ci): Add dynamic edit url template to deploy_docs
Zeglius Aug 9, 2024
eee1d96
chore(ci): Add html.site-url to deploy_docs
Zeglius Aug 9, 2024
6a781c6
chore(readme): Use relative paths for repo_content
Zeglius Aug 9, 2024
5b08f1c
chore(ci): Add README to included paths for deploy_docs
Zeglius Aug 9, 2024
396b972
chore(ci): Disable deploy_docs
Zeglius Aug 9, 2024
2ed0929
chore(ci): Use main in deploy_docs.on.push.branches
Zeglius Aug 9, 2024
0000de0
docs: Rephrase unstable docs warning
Zeglius Aug 9, 2024
3f21af7
chore(ci): Exclude docs from triggering build workflow
Zeglius Aug 9, 2024
761be1f
chore(ci): Enable deploy_docs
Zeglius Aug 9, 2024
f23182a
fix(docs): Remove unnecessary imports in preprocessors
Zeglius Aug 9, 2024
8b8f414
docs: Move unstable docs warning to index.hbs
Zeglius Aug 9, 2024
3eeb9a3
docs: Add page metadata inclusion with fetch_discourse_md.py
Zeglius Aug 10, 2024
e059865
docs: Move fetch_discourse_md.py to docs/utils
Zeglius Aug 10, 2024
8400049
docs: Add 'fetched_at' metadata field in fetch_discourse_md.py
Zeglius Aug 10, 2024
68eec7e
docs: Update fetch_discourse_md.py to format metadata in json
Zeglius Aug 10, 2024
68c5dc2
Revert "chore(readme): Use relative paths for repo_content"
Zeglius Aug 12, 2024
207a71e
docs: Replace include with an url to repo README
Zeglius Aug 12, 2024
3063d20
ci(docs): Add multilanguage doc build support
Zeglius Aug 12, 2024
adca5af
docs: add Justfile utility
Zeglius Aug 12, 2024
682d3eb
docs: update Justfile utility
Zeglius Aug 12, 2024
4342e9b
ci(docs): Add stricter workflow trigger to deploy_docs
Zeglius Aug 12, 2024
e0ed1bd
docs: add 'preview_translation' to Justfile
Zeglius Aug 13, 2024
00d6f9b
docs: add documentation translation guide
Zeglius Aug 13, 2024
25b860e
ci(docs): Add mdbook cache
Zeglius Aug 13, 2024
023d259
Merge remote-tracking branch 'upstream/main' into feat/mdbook
Zeglius Aug 13, 2024
0ad731e
ci(docs): Add i18n-report
Zeglius Aug 14, 2024
b1a2640
Merge remote-tracking branch 'upstream/main' into feat/mdbook
Zeglius Aug 14, 2024
772f7e5
ci(docs): tweak deploy_docs workflow triggers
Zeglius Aug 14, 2024
7a474c8
ci(docs): remove unnecessary slash at build.yml
Zeglius Aug 14, 2024
b100f60
ci(docs): remove unnecessary slash at deploy_docs.yml
Zeglius Aug 14, 2024
d91bb70
ci(docs): add docs/book.toml to deploy_docs trigger
Zeglius Aug 14, 2024
eaea38d
ci(docs): Add schedule trigger
Zeglius Aug 14, 2024
47b2ede
ci(docs): add github-pages cleaning
Zeglius Aug 14, 2024
fd7538d
ci(docs): Exclude docs from generate_changelog
Zeglius Aug 14, 2024
0f7d087
docs: Add dependencies installation script
Zeglius Aug 14, 2024
73e0fa7
ci(docs): Add mdbook pdf build
Zeglius Aug 15, 2024
15eac53
docs: Tweak Justfile to support pdf generation
Zeglius Aug 15, 2024
f5053b5
Revert "docs: Always fetch the highest quality image by fetch_discour…
Zeglius Aug 15, 2024
617f46d
ci(docs): Exclude deploy_docs.yml from cache-mdbook keys
Zeglius Aug 16, 2024
fafb234
docs: Add 'mdbook_build' to Justfile
Zeglius Aug 16, 2024
35ecbab
docs: Add 'mdbook_serve' to Justfile
Zeglius Aug 16, 2024
fa1069e
docs: Add debug flag to fetch_discourse_md
Zeglius Aug 16, 2024
d42a29c
docs: Automate discourse documentation scrapping
Zeglius Aug 16, 2024
6b1e215
docs: Add flock to fetch_discourse_md
Zeglius Aug 16, 2024
3f94944
docs: Add translation file generation with Justfile
Zeglius Aug 16, 2024
a685de4
docs: Prefix url replacements with site-url in replace-urls.py prepro…
Zeglius Aug 17, 2024
3483730
docs: Add installation guides
Zeglius Aug 17, 2024
777d805
Revert "docs: Prefix url replacements with site-url in replace-urls.p…
Zeglius Aug 17, 2024
1dd65ad
Reapply "docs: Prefix url replacements with site-url in replace-urls.…
Zeglius Aug 17, 2024
e8668d6
docs: fix replace-urls.py
Zeglius Aug 17, 2024
cda3246
Merge remote-tracking branch 'upstream/main' into feat/mdbook
Zeglius Aug 17, 2024
cadbbfe
docs: fix fetch_discourse_md.py hitting discourse ip_10_secs_limit
Zeglius Aug 18, 2024
aea8528
ci(docs): Remove duplicate '/' in build translation step
Zeglius Aug 18, 2024
fed53ae
ci(docs): Update actions/cache
Zeglius Aug 18, 2024
06bf7d2
ci(docs): Reduce deploy_docs schedule timespan between triggers
Zeglius Aug 18, 2024
7b4fda9
Merge remote-tracking branch 'upstream/main' into feat/mdbook
Zeglius Aug 18, 2024
02abbbd
docs: update install-deps.sh
Zeglius Aug 18, 2024
63f9897
docs: Update Advanced docs
Zeglius Aug 18, 2024
d371750
docs: Add favicon
Zeglius Aug 18, 2024
c197eb3
docs: Reword unstable documentation warning
Zeglius Aug 18, 2024
31ee415
docs: Change default theme to 'navy'
Zeglius Aug 18, 2024
48098a6
ci(docs): Move permisions to job scope
Zeglius Aug 19, 2024
c3e2893
Merge remote-tracking branch 'upstream/main' into feat/mdbook
Zeglius Aug 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
10 changes: 10 additions & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[book]
authors = ["nicknamenamenick","Zeglius"]
language = "en"
multilingual = false
src = "src"
title = "Bazzite Documentation"
use-default-preprocessors = false

[build]
create-missing = false
376 changes: 376 additions & 0 deletions docs/src/Bazzite's README.md

Large diffs are not rendered by default.

66 changes: 66 additions & 0 deletions docs/src/Gaming/Game Launchers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Game Launchers

# **Steam Setup**

Steam can run Windows games on Linux. It utilizes a wide range of projects and patches all packed into a piece of software built-in to Steam called [Proton](https://github.com/ValveSoftware/Proton) for Windows compatibility.

## Enabling Proton For All Steam Games

> **Note**: Skip this section if you're using a [_Handheld/HTPC_](https://universal-blue.discourse.group/docs?topic=37) 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_settings.png)
![Compatibility|589x499, 75%](../img/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%](upload://zo1TyrRxr8Fu48ACJg34pWKvF7P.png)
![Compatibility tab|690x492, 75%](upload://iiTx9285kbPupqLDGX4ak4RIvdm.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**.
- [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%](upload://3s2iqYP1Q1ZeCpMaQapqhG4gR1V.png)

![Example of Lutris installers|623x500, 75%](upload://1WR6qGSLGJ0oRkdwvCFwhCZllq0.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.

![manually|632x496, 75%](upload://9NC0GjEllRMgpuaLmB2d5pcihgz.png)

![Lutris manually adding games|690x342, 75%](upload://yszYNbYIAwCw4otGldSK6C29Jus.png)

### Lutris Shortcuts

![Lutris_Right_Click_Menu|421x447, 75%](upload://qvbF55nS5md6nMp7L5w0V97EBLR.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).

# Auto-Mounting Secondary Gaming Drives

View this [guide](https://universal-blue.discourse.group/docs?topic=970) for forcing secondary drives to automatically mount on boot. This is useful if you have games on this drive and do not want to manually mount it before starting Steam on Desktop images.

<hr>

[**<-- Back to Gaming Guide**](README.md)
41 changes: 41 additions & 0 deletions docs/src/Gaming/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 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%20Launchers.md)

- Setting Up Steam
- Non-Steam Games
- Available Options
- Configuring Lutris
- Gamepass Using Xbox Cloud Gaming

- # [Managing & Modding Games](https://universal-blue.discourse.group/docs?topic=2657)
- Compatibility Layers
- Proton Prefix Information
- Hidden Files in File Manager
- Modding Quick-Start
- Pre-Installed Enhancements
- # [Common Issues](https://universal-blue.discourse.group/docs?topic=2658)
- Proton Logs
- Native Linux Builds vs. Proton
- Issues with Valve/Source Games
- # [Hardware Compatibility for Gaming](https://universal-blue.discourse.group/docs?topic=2659)
- Vulkan Version Diagnostic
- 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 useful external resources
- [**PC Gaming Wiki**](https://www.pcgamingwiki.com/wiki/Home) - General information, workarounds, and enhancements for PC games
- [**General Emulation Wiki**](https://emulation.gametechwiki.com/index.php/Main_Page) - Emulation resources

<hr>

**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](https://universal-blue.discourse.group/docs?topic=37)

<-- [**View all Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=561)
43 changes: 43 additions & 0 deletions docs/src/General/Contributing to Bazzite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# **Preliminary Reading**:

<https://universal-blue.discourse.group/docs?topic=51>

<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

**Instructions found here:**

<https://github.com/ublue-os/image-template>

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>

**See also**: [Fork Your Own Image](https://universal-blue.discourse.group/docs?topic=43)

<-- [**View all Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=561)
61 changes: 61 additions & 0 deletions docs/src/General/Desktop Environment Tweaks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Customizing KDE Plasma

> A fantastic resource on KDE themes can be found [here](https://itsfoss.com/properly-theme-kde-plasma/) for more information.

KDE Plasma is the default Bazzite desktop environment and is highly customizable. One of the various customization that can be done is installing custom styles, cursors, and icons to your system with custom themes made by the community.

Do **not** install themes with the built-in KDE system settings installer since it may not install properly because the filesystem is slightly different than most Linux operating systems. Install themes manually into your Home directory and follow instructions from the author if necessary.

![Directory|401x207, 75%](../img/desktop_tweaks_1.png)

## Universal instructions for most custom themes

1. Download the theme manually from the [KDE Store](https://store.kde.org/browse/)
2. Extract the contents to `~/.local/share/plasma/` (you may need to make this directory)
2a. "Global themes" are placed in `~/.local/share/plasma/look-and-feel/` (you may need to make this directory)
2b. "Plasma themes" are placed in `~/.local/share/plasma/desktoptheme/` (you may need to make this directory)
2c. SDDM* themes are placed in `/etc/sddm/themes` (you may need to make this directory)
2c1. SDDM* themes can also be layered at your own risk if they are available as RPM packages
2d. "Icon/Cursor themes" are placed in `~/.icons`
2da. Some Flatpaks need filesystem permissions for applications that have issues with cursor themes (`~/.icons/:ro` in "Filesystem" in each problematic application or globally in Flatseal)
3. Open system settings and select your theme, style, cursor, etc. as it now should appear

\*_SDDM is the login manager_.

### Themes that require `kvantum`

Some themes require [`kvantum`](https://github.com/tsujan/Kvantum/blob/master/Kvantum/README.md) to be installed on the host system.

Install it with this **command**:

```
rpm-ostree install kvantum
```

## Wallpaper Engine Guide (_Only on KDE Images_)

> **Note**: Not all wallpapers are compatible and may even cause issues since most are not intended for use on the Linux desktop.

![KDE Wallpaper Settings|682x500, 75%](../img/kde_wallpaper_settings.png)

![Wallpaper settings|549x500, 75%](../img/wallpaper_settings.png)

[Wallpaper Engine](https://www.wallpaperengine.io/en) is a live wallpaper application intended for Windows.

Read this [guide](https://github.com/catsout/wallpaper-engine-kde-plugin/blob/main/README.md#usage) on how to set it up on KDE Plasma.

<hr>

# Manage GNOME Extensions (`-gnome` Images)

View the [Bluefin documentation](https://universal-blue.discourse.group/docs?topic=166) since most of the information will be relevant to Bazzite as well.

<hr>

# Steam Gaming Mode Tweaks (`-deck` Images)

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](https://universal-blue.discourse.group/docs?topic=37) to resolve common issues if you run into them after using Decky Loader.

<hr>

[**<-- See all Bazzite documentation**](https://docs.bazzite.gg)
Loading