diff --git a/docs/source/dzgui6.rst b/docs/source/dzgui6.rst deleted file mode 100644 index 1869fa5..0000000 --- a/docs/source/dzgui6.rst +++ /dev/null @@ -1,110 +0,0 @@ -Installation (DZGUI 6 legacy) -================== - -Basic runtime dependencies ---------------------------------- - -If not already installed, the below can be found in your system’s package manager. - -If any dependencies are missing when the application starts, it will warn you, so you need not take any preemptive measures here. - -- curl -- jq -- steam -- wmctrl or xdotool -- zenity - -.. note:: - All dependencies are installed out of the box on Steam Deck. - -UI dependencies (Python and PyGObject) ---------------------------------------- -.. important:: - As of version 6.0.0, you must have a valid Python 3.13 and matching PyGObject environment. - Depending on your distribution, this may require additional manual intervention. - -Arch Linux (vanilla variants) -^^^^^^^^^^^^^^^^^^^^^^ -You will need the ``python3.13`` package, if it is not already installed. - -Install the following build dependencies: - -.. code:: console - - sudo pacman -S cmake gcc pkgconf python-cairo - -.. include:: venv.rst - -CachyOS (Arch) -^^^^^^^^^^^^^^^^^^^^^^^ -Refer to the build instructions for Arch Linux first. -The ``python3.13`` package is not available on CachyOS, so it is recommended to -use ``uv`` to manage Python versions. - -.. code:: console - - sudo pacman -S uv - -.. include:: venv.rst - -Manjaro 26 (Arch) -^^^^^^^^^^^^^^^^^^^^^^^ -If Python 3.13 is not already available out of the box, refer to the build instructions for :ref:`Arch Linux (vanilla variants)`. - -Debian 13 variants -^^^^^^^^^^^^^^^^^^^^^^^ -Python 3.13 and PyGObject are available out of the box. No additional steps are necessary. -You can proceed to the :ref:`Installscript`. - -Fedora 43 variants -^^^^^^^^^^^^^^^^^^^^^^^ -Fedora 43 ships with a newer version of Python (3.14), so you must set up Python 3.13 in its own -virtual environment (venv) to prevent it from conflicting with the system package. - -Install the following build dependencies: - -.. code:: console - - sudo dnf install cairo cairo-devel cairo-gobject-devel gcc python3.13 python3.13-devel - -.. include:: venv.rst - -Ubuntu 24 variants -^^^^^^^^^^^^^^^^^^^^^^ -Ubuntu ships with an older version of Python (3.12). You must install additional dependencies. -Add the PPA below to add Python 3.13 to your sources: - -.. code:: console - - sudo add-apt-repository ppa:deadsnakes/ppa - -Install the following build dependencies: - -.. code:: console - - sudo apt install python3.13 python3.13-venv python3.13-dev build-essential python3-gi-cairo pkg-config libgirepository-2.0-dev libcairo2-dev - -.. include:: venv.rst - -Installscript ------------------------ - -Invoke the command below from a terminal. This script fetches the main DZGUI script from the repository, -makes it executable, and launches DZGUI's first-time setup. After running this installscript, you will -have the file ``dzgui.sh`` wherever you invoked the command. - -.. code:: console - - curl -s "https://codeberg.org/aclist/dztui/raw/branch/dzgui/install.sh" | bash - -nixOS installation ----------------------- -Two packages are independently maintained by other contributors. Each takes a slightly different approach. -nixOS packages are standalone and do not require cloning the git repository. - -- https://github.com/lelgenio/dzgui-nix -- https://github.com/jiriks74/dzgui.flake - -Next steps ---------------- -Proceed to the :doc:`setup` section for setup instructions. diff --git a/docs/source/dzgui7.rst b/docs/source/dzgui7.rst deleted file mode 100644 index b6a0e30..0000000 --- a/docs/source/dzgui7.rst +++ /dev/null @@ -1,33 +0,0 @@ -Installation (DZGUI 7 beta) -================== - -In order to make the first-time setup experience easier for end-users, DZGUI 7 no longer requires -the tool to be installed from source code into a working Python environment. All necessary dependencies and the -runtime environment are built-in. - -Turnkey installer ------------------------- - -- Visit the project's `Releases page `_. -- Extract the DZGUI tarball from the top of the **Assets** list. -- From a terminal, run the command ``./dzgui`` or double click on the extracted file in - a file explorer. -- Once the setup wizard opens, follow the steps at the bottom of this page. - -UI dependencies (Python and PyGObject) ---------------------------------------- -On most major distributions, GObject introspection libraries should be available by default. - -If you receive an error about a missing ``libgirepository-2.0`` dependency, install it via your system's package manager. - -On Debian-based distributions (Ubuntu, etc.), this package is not explicitly installed on the system. -You can install it via the following set of commands: - -.. code:: console - - sudo apt update - sudo apt install libgirepository-2.0-0 - -Next steps ---------------- -Proceed to the :doc:`setup` section for setup instructions. diff --git a/docs/source/steam.rst b/docs/source/steam.rst deleted file mode 100644 index 687c75d..0000000 --- a/docs/source/steam.rst +++ /dev/null @@ -1,94 +0,0 @@ -Steam integration -==================== - -.. note:: - - In :doc:`DZGUI 7 `, Steam shortcut creation and cover art setup are handled automatically during setup. You can skip this step unless you are using DZGUI 6. - -DZGUI can be added to Steam as a "non-Steam game" in order to facilitate integration with Steam Deck or desktop environments. - -First, launch Steam in the **Large** (default) view. - -.. attention:: - Steam Deck users: Gaming Mode has limited support for configuration of custom games. You will need to switch to **Desktop Mode** in order to add a non-Steam game. - -.. figure:: images/01.png - :scale: 70% - :alt: Adding a non-Steam game - -Select **Add a Game** > **Add a Non-Steam Game** from the bottom left corner of the Steam client. - -Navigate to ``$HOME/.local/share/applications`` and select ``dzgui.desktop``. - -Select **Add Selected Programs** to add a shortcut to DZGUI. - -Artwork -^^^^^^^^^^ - -DZGUI ships with custom artwork that provides various cover/splash images to allow it to integrate with the rest of your games library. - -.. figure:: images/02.png - :scale: 70% - :alt: Adding a non-Steam game - -From the main library view, navigate to the app’s details page and right-click the blank image header at the top. - -.. figure:: images/03.png - :scale: 70% - :alt: Adding a non-Steam game - - -Select **Set Custom Background** - -Select to display **All Files** from the **File type** dropdown - -Navigate to ``$HOME/.local/share/dzgui`` and select ``hero.png``. - -.. figure:: images/04.png - :scale: 70% - :alt: Adding a non-Steam game - -Next, right-click the image background and select **Set Custom Logo**. - -Navigate to ``$HOME/.local/share/dzgui`` and select ``logo.png``. - -.. figure:: images/05.png - :scale: 70% - :alt: Adding a non-Steam game - -Notice that this removes the redundant app name that occluded the image, as seen above. - -.. figure:: images/06.png - :scale: 70% - :alt: Adding a non-Steam game - -Next, navigate to your Library index (looks like a bookshelf of cover art) and find the DZGUI app. - -Right-click its cover and select **Manage** > **Set custom artwork**. - -Navigate to ``$HOME/.local/share/dzgui`` and select ``grid.png``. - -.. figure:: images/07.png - :scale: 70% - :alt: Adding a non-Steam game - -The final result will create box art looking like the above. - -.. figure:: images/08.png - :scale: 100% - :alt: Adding a non-Steam game - -Next, right-click the DZGUI entry in your Library and select **Properties** to open the properties dialog. Next to the **Shortcut** field, you will see a small square box which represents the game’s -icon. Click this to open a file explorer, navigate to ``$HOME/.local/share/dzgui``, and select ``icon.png``. This will add a small icon to the list view. - -Finally, after you launch DZGUI for the first time, you should quit the application and return to the Library view. Select the **Recent Games** dropdown on the right-hand side. - -Steam shows a collection of box art based on categories like "Play Next", "Recent Games", etc. Look for a **downward-pointing caret icon** and click it, then select the **Recent Games** category. - -.. figure:: images/09.png - :scale: 100% - :alt: Adding a non-Steam game - -If DZGUI was the last item played, it will be shown with a landscape, rather than portrait, orientation cover, which is initially blank. - -To customize this cover, right click it and select **Manage** > **Set custom artwork**, navigate to ``$HOME/.local/share/dzgui``, then select ``hero.png``.