Merge pull request #976 from RogueScholar/update-linux-install

Fix failure to load embedded video following libretro#973
This commit is contained in:
Ömercan Kömür 2024-08-30 17:40:13 +03:00 committed by GitHub
commit 224ff3c54a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
76 changed files with 327 additions and 370 deletions

BIN
.DS_Store vendored

Binary file not shown.

6
.gitignore vendored
View File

@ -1,7 +1,3 @@
/site
.DS_Store
**/.DS_Store
.DS_Store
docs/.DS_Store
.DS_Store
.venv
.venv

View File

@ -5,5 +5,6 @@ install:
- pip install mkdocs
- pip install mkdocs-material
- pip install pymdown-extensions
- pip install pygments
script:
- mkdocs build

BIN
docs/.DS_Store vendored

Binary file not shown.

View File

@ -1,136 +1,174 @@
# Downloading, Installing and Updating RetroArch
---
title: Downloading, Installing and Updating RetroArch on GNU/Linux
description: Instructions for setting up RetroArch on GNU/Linux systems.
---
<iframe allow="accelerometer; ambient-light-sensor; autoplay; clipboard-write;
display-capture; encrypted-media; execution-while-out-of-viewport; fullscreen;
geolocation; gyroscope; hid; magnetometer; picture-in-picture;
screen-wake-lock; speaker-selection; web-share;" aria-label="YouTube video"
height="315" loading="lazy" name="YouTube embedded player"
referrerpolicy="strict-origin-when-cross-origin" role="application"
sandbox="allow-orientation-lock; allow-presentation;"
src="https://www.youtube-nocookie.com/embed/kCyTlMjvzWA"
style="border-collapse: collapse; border-style: hidden; margin: 1rem auto;"
title="RetroArch - How to Install : Sega Genesis Mini" width="560"></iframe>
# Installing RetroArch on Linux
## GNU/Linux
This page contains descriptions of several officially-supported methods of
installing RetroArch on systems running the GNU/Linux kernel.
### Flatpak
<iframe allow="accelerometer 'self'; clipboard-write *; display-capture 'self'; encrypted-media 'src';
fullscreen *; geolocation 'src'; gyroscope 'self'; hid 'self'; picture-in-picture *; screen-wake-lock *;
web-share *;" aria-label="YouTube video" height="315" width="560" loading="lazy" role="application"
name="YouTube embedded player" title="RetroArch - How to Install: Linux" referrerpolicy="strict-origin-when-cross-origin"
sandbox="allow-orientation-lock allow-popups allow-presentation allow-same-origin allow-scripts"
src="https://www.youtube-nocookie.com/embed/7ZSPR2eYULU?origin=docs.libretro.com&playsinline=1"
style="border-collapse: collapse; border-style: hidden; display: block; margin: 1.5rem auto 2rem; position: relative;"></iframe>
---
## Flatpak (suitable for most Linux distributions)
Flatpak is a distribution-agnostic packaging format with broad support
throughout the Linux ecosystem. An official
[RetroArch flatpak][retroarch-flatpak] is published in the Flathub repository,
and can be installed in just three easy steps:
throughout the Linux ecosystem. An official [RetroArch
flatpak][retroarch-flatpak] is published in the Flathub repository, and can be
installed in just three easy steps:
#### Installation
### Installation
1. Ensure that Flatpak is [enabled on your system][flatpak-setup] by opening the
terminal and confirming that the following command exits with no errors:
```sh
flatpak --installations
```
``` shell
flatpak --installations
```
1. Confirm that the Flathub repository is configured as a
[flatpak remote][flatpak-remote], so that packages may be installed from it.
You can examine the flatpak remotes currently enabled on your system with
this terminal command (shown with default output):
1. Confirm that the Flathub repository is configured as a [flatpak
remote][flatpak-remote], so that packages from it may be installed. You can
examine the flatpak remotes currently enabled on your system with this
terminal command (shown with default output):
```console
$ flatpak remotes --columns=name,url,homepage
``` shell-session hl_lines="4"
ra@libretro:~$ flatpak remotes --columns=name,url,homepage
Name URL Homepage
flathub https://dl.flathub.org/repo/ https://flathub.org/
```
Name URL Homepage
flathub https://dl.flathub.org/repo/ https://flathub.org/
```
If Flathub is not among the remotes shown, this command will add it to your
system:
If Flathub is not among the remotes shown, this command will add it to your
system:
```sh
sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
```
``` shell
sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
```
1. Finally, install the RetroArch Flatpak. You have the option of making it
available to only the current user, with this command:
```sh
flatpak install -y --user --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref
```
``` shell
flatpak install -y --user --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref
```
Or for all users with this command:
Or for all users with this command:
```sh
sudo flatpak install -y --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref
```
``` shell
sudo flatpak install -y --from https://dl.flathub.org/repo/appstream/org.libretro.RetroArch.flatpakref
```
#### Launching the Flatpak
### Launching the Flatpak
RetroArch should now be listed in your app launcher and can also be executed
from the terminal with the command:
```sh
``` shell
flatpak run org.libretro.RetroArch
```
#### Updates
### Updates
You should keep RetroArch updated by running this command periodically from the
terminal:
```sh
``` shell
flatpak update -y --app org.libretro.RetroArch
```
### Ubuntu-based
## Ubuntu(-based)
If you're using Ubuntu, an official [Ubuntu flavor][ubuntu-flavors], or one of
the many Linux distributions based on Ubuntu (such as Linux Mint, Zorin OS, Pop!
OS, elementary OS, etc.), you can install RetroArch and many of the most popular
Libretro cores as native APT packages by simply enabling one (or both) of the
two official Libretro [Personal Package Archives (PPAs)][help-ppas] hosted on
[Launchpad](https://launchpad.net/~libretro), namely:
Ubuntu provides RetroArch as a Debian [package in their official "universe"
archive][ubuntu-package], which is maintained by the community with no promise
of support or regular update schedule. Nevertheless, for the casual user of
Ubuntu or a derivative distribution, it represents the simplest method for
installing RetroArch. All that is required is to open a terminal and issue this
single command:
- [**Stable**][ppa-stable] (recommended), which includes only official releases
(as announced on libretro.com / retroarch.com), and
- [**Testing**][ppa-testing], which provides nightly builds of RetroArch and
most Libretro cores that allow you to test new features as soon as they're
added.
#### Installation
In order to add PPAs to your system's package sources, some tools from the
official package repositories are needed. Open the terminal and run this command
to ensure they are installed:
```sh
sudo apt -y install software-properties-common
``` shell
sudo apt --upgrade --yes install retroarch
```
One command is needed to add a PPA to your system's package sources. To add the
[**Stable PPA**][ppa-stable], use:
### Personal Package Archives (PPAs)
```sh
sudo add-apt-repository -ysnP libretro/stable
```
In an effort to improve the experience of RetroArch users on Ubuntu, official
[Ubuntu flavors][ubuntu-flavors], and all of the many Linux distributions based
on Ubuntu (such as Linux Mint, Zorin OS, Pop! OS, elementary OS, etc.), the
Libretro Team has long been committed to producing its own Debian packages as an
alternative to the ones supplied by Ubuntu in the "universe" package archive.
These packages are updated much faster to keep pace with each new RetroArch
version, and compiled with a greater range of features than the Ubuntu package.
In addition, Debian packages are created for the vast majority of popular
Libretro cores, simplifying their installation and allowing them to be updated
by the system package manager on the same schedule as all other package updates.
Or to add the [**Testing PPA**][ppa-testing], use:
These packages are built and distributed using the [Launchpad
platform][launchpad-team] operated by Canonical itself (the company which
distributes Ubuntu), and split into two channels called "Personal Package
Archives" (PPAs) that each cater to a specific type of user. By simply [enabling
one (or both) the PPAs][help-ppas] listed below, users can seamlessly replace
the Ubuntu RetroArch package on their system with those provided by the Libretro
team.
```sh
sudo add-apt-repository -ysnP libretro/testing
```
- [**Stable**][ppa-stable] (recommended) — includes only official releases
(as announced on libretro.com / retroarch.com)
You can now install the RetroArch package from the PPAs with this command:
- [**Testing**][ppa-testing] — builds of RetroArch and most Libretro cores from
the latest source code, for test new fixes and features as soon as they're
added
```sh
sudo apt -Uy install retroarch
```
### Installation
You can verify that the PPA package was installed rather than the one from the
official distribution repositories with the `apt show` command (shown with
expected output for the Testing PPA package):
Follow these steps to enable the Libretro PPAs on your Ubuntu(-based) system.
```console
$ apt show retroarch
1. In order to add PPAs to your system's package sources, some tools from the
official package repositories are needed. Open the terminal and run this
command to ensure they are installed:
``` shell
sudo apt --update --yes install software-properties-common
```
1. Just a single command is needed to add a PPA to your system's package
sources.
- To add the [**Stable PPA**][ppa-stable], run this command in your
terminal:
``` shell
sudo add-apt-repository --yes --no-update --ppa libretro/stable
```
- Or to add the [**Testing PPA**][ppa-testing], run:
``` shell
sudo add-apt-repository --yes --no-update --ppa libretro/testing
```
1. You can now install the RetroArch package from the PPAs with this command:
``` shell
sudo apt --update --yes install retroarch
```
#### Verifying PPA package installation
You can verify that the PPA package is installed (rather than the one from the
official distribution repositories) with the `apt show retroarch` command (shown
with expected output for the Testing PPA package):
``` shell-session hl_lines="14"
ra@libretro:~$ apt show retroarch
Package: retroarch
Version: 1.19.1+r202408170734~bf25bd9149-179~ubuntu24.04.1
Version: {{ unit.stable }}+r202408170734~bf25bd9149-179~ubuntu24.04.1
Priority: optional
Section: games
Maintainer: Libretro Team <libretro@gmail.com>
@ -154,51 +192,91 @@ Description: Simple frontend for the libretro library
Notice: There is 1 additional record. Please use the '-a' switch to see it
```
Look at the **`APT-Sources:`** line in the output. If one of the PPA packages is
installed, its value will begin with
`https://ppa.launchpadcontent.net/libretro/`.
!!! tip "What to look for"
Look at the **`APT-Sources:`** line in the output. If one of the PPA
packages is installed, its value will begin with
`https://ppa.launchpadcontent.net/libretro/`.
#### Updates
### Updates
With this installation method, RetroArch updates will automatically be included
with your systems regular package upgrades. However, you are always able to
trigger an update specifically for RetroArch with the terminal command:
with your system's regular package upgrades. However, you are always able to
trigger an update specifically for RetroArch (if one is available) with the
command:
```sh
sudo apt -y upgrade retroarch
``` shell
sudo apt --update --yes upgrade retroarch
```
### Arch Linux-based
## Arch Linux(-based)
Arch Linux provides a [`retroarch`][arch-package] package for x86_64 systems in
their official [Extra repository][arch-extra-repo]. You can install it by
### Installation
#### Official package
Arch Linux provides a [**`retroarch`**][arch-package] package for x86_64 systems
in their official [Extra repository][arch-extra-repo]. You can install it by
searching for RetroArch by name in a graphical package manager like
[Octopi][octopi], or from the terminal with the command:
```sh
``` shell
sudo pacman -S retroarch
```
A "git" package named [`retroarch-git`][aur-git-package] which offers prerelease
builds (similar to the Testing PPA described above) is also available on the
[AUR][arch-aur]. As above, it can be installed from a package manager GUI or in
the terminal using an "[AUR helper][aur-helpers]" like [`yay`][aur-yay], as in:
#### Arch User Repository (AUR) package
```sh
A "git" package named [**`retroarch-git`**][aur-git-package] which offers
prerelease builds (similar to the Testing PPA described above) is also available
in the [AUR][arch-aur]. As above, it can be installed from a package manager GUI
or in the terminal using an "[AUR helper][aur-helpers]" like [`yay`][aur-yay],
as in:
``` shell
yay retroarch-git
```
!!! tip "Installing an AUR helper"
If you wish to install the AUR package but don't yet have an AUR helper
installed on your system, the following shell "one-liner" will download,
compile and install `yay` for you:
``` shell
pacman -S --needed git base-devel && git clone https://aur.archlinux.org/yay-bin.git &&
cd yay-bin && makepkg -si
```
### Updates
With this installation method, RetroArch updates will automatically be included
with your system's regular package upgrades. However, you are always able to
trigger an update specifically for RetroArch (if one is available) with the
following commands.
#### Official package
``` shell
pacman -Syyuu retroarch
```
#### AUR package
``` shell
yay -Syyuu retroarch-git
```
[arch-aur]: https://aur.archlinux.org/ "Arch User Repository (AUR)"
[arch-extra-repo]: https://wiki.archlinux.org/title/Official_repositories#extra
[arch-package]: https://archlinux.org/packages/extra/x86_64/retroarch/
[aur-git-package]: https://aur.archlinux.org/packages/retroarch-git
[aur-helpers]: https://wiki.archlinux.org/title/AUR_helpers
[aur-yay]: https://github.com/Jguer/yay
[flatpak-remote]: https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak-remotes
[flatpak-setup]: https://flatpak.org/setup/
[help-ppas]: https://help.launchpad.net/Packaging/PPA/InstallingSoftware
[octopi]: https://tintaescura.com/projects/octopi/
[ppa-stable]: https://launchpad.net/~libretro/+archive/ubuntu/stable
[ppa-testing]: https://launchpad.net/~libretro/+archive/ubuntu/testing
[retroarch-flatpak]: https://flathub.org/apps/org.libretro.RetroArch
[ubuntu-flavors]: https://ubuntu.com/desktop/flavours
[arch-extra-repo]: https://wiki.archlinux.org/title/Official_repositories#extra "Official repositories - ArchWiki"
[arch-package]: https://archlinux.org/packages/extra/x86_64/retroarch/ "Arch Linux - retroarch {{ unit.stable }}-1 (x86_64)"
[aur-git-package]: https://aur.archlinux.org/packages/retroarch-git "AUR (en) - retroarch-git"
[aur-helpers]: https://wiki.archlinux.org/title/AUR_helpers "AUR helpers - ArchWiki"
[aur-yay]: https://github.com/Jguer/yay "Jguer/yay: Yet another Yogurt - An AUR Helper written in Go (GitHub)"
[flatpak-remote]: https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak-remotes "Flatpak Command Reference - Flatpak documentation"
[flatpak-setup]: https://flatpak.org/setup/ "Flatpak—the future of application distribution"
[help-ppas]: https://help.launchpad.net/Packaging/PPA/InstallingSoftware "Packaging/PPA/Installing Software - Launchpad Help"
[launchpad-team]: https://launchpad.net/~libretro "Libretro in Launchpad"
[octopi]: https://tintaescura.com/projects/octopi/ "Octopi - Tinta escura"
[ppa-stable]: https://launchpad.net/~libretro/+archive/ubuntu/stable "Libretro Stable : “Libretro” team"
[ppa-testing]: https://launchpad.net/~libretro/+archive/ubuntu/testing "Libretro Testing/Nightly : “Libretro” team"
[retroarch-flatpak]: https://flathub.org/apps/org.libretro.RetroArch "Install RetroArch on Linux &verbar; Flathub"
[ubuntu-flavors]: https://ubuntu.com/desktop/flavours "Ubuntu flavours &verbar; Ubuntu"
[ubuntu-package]: https://packages.ubuntu.com/search?keywords=retroarch&searchon=names "Ubuntu Package Search Results -- retroarch"

View File

@ -1,77 +0,0 @@
# Navigating
Navigating on RetroArch is as easy as you can imagine. Depending on the device you have, the control scheme is determined automatically. For example, if you are going to use it on a computer, the basic key combinations of the keyboard will apply. You move with the arrow keys and select with the *Enter* key, and you return with the *Backspace* key. If you plug a controller, you can also move with the D-Pad buttons.
The default [GUI](GUI) for RetroArch is [Ozone](ozone.md). While the "skin" may differ on certain platforms, basic layout and navigation remains broadly the same.
## PC
By default the keyboard should be ready to use.
Using the *left* and *right* arrow keys, you move to a different tab, each tab will relate to an aspect of the RetroArch experience (main menu for game loading, settings for settings etc.). Once the desired tab is selected, use the *up* and *down* arrow to move to an option.
To advance in the menu press *Enter* (or *Return*). To go back to the previous menu push *Backspace*.
Whilst in a game use the *F1* key to open the [Quick Menu](quick-menu.md).
Pushing *Esc* twice will quit the program.
### Main Menu
![Ozone's Main Menu](../image/retroarch/ozone/first_run.webp)
Welcome to the main menu. This is where you will launch games, download and update cores, and have access to freely available content. *Load Core*, *Load Content* and the *Online Updater* are the menu items you will probably be using the most.
*See [Starting a Game](starting-a-game.md)*
### Settings
![Settings](../image/retroarch/ozone/settings.png)
Here you will find all the options available to configure RetroArch, from Graphics, Input, Sound and everything else.
### Favorites
![Favorites](../image/retroarch/ozone/favorites.png)
Favorites allow yous to maintain a short list of games for quick access. You can add content to this playlist from the [Quick Menu](quick-menu.md) or before launching it.
### History
![History](../image/retroarch/ozone/history.png)
Recently launched content will be added to this Playlist. The content you ran last will be at the top.
### Image, Music and Video
These tabs will handle all your media. Images will contain any screenshots you've made.
### Netplay
RetroArch relies on peer-to-peer networking to reduce network latency and ensure the best possible experience. It allows multiplayer over the internet. The user can host or join a network gaming session, or use the Spectator mode to watch others play. RetroArch has a built-in netplay lobby.
### Import content
![import-content](../image/retroarch/ozone/import-content.png)
Either you scan automatically, so that any content that matches the internal database will be added to Playlists, or you scan manually, not being dependent on the database so you can freely add your content to Playlists.
## Mobile
The mobile interface, [GLUI](glui.md), is much more minimalistic compared to the PC's interface. Touch is the default input, although depending on device other options may be available. There are three different tabs, which can be switched at the bottom of the menu.
### Main Menu
![GLUI's Main Menu](../image/retroarch/glui/glui-main.png)
The main menu will be where you launch games, download and update cores, start or join netplay sessions and pretty much anything to do with gaming.
*See [Starting a Game](starting-a-game.md)*
### Playlists
Handles anything to do with creating and maintaining playlists. It gives you scanning options to recognise your game collection. It also provides access to your images, music and videos.
### Settings
Here you will find all the options available to configure RetroArch, from Graphics, Input, Sound and everything else.

View File

@ -1,95 +1,9 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="320"
height="240"
viewBox="0 0 320 240"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="rgui_wallpaper_template.svg"
inkscape:export-filename="rgui_wallpaper_template.png"
inkscape:export-xdpi="90"
inkscape:export-ydpi="90">
<defs
id="defs4" />
<sodipodi:namedview
id="base"
pagecolor="#000000"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="1"
inkscape:pageshadow="2"
inkscape:zoom="2.0444393"
inkscape:cx="119.46118"
inkscape:cy="104.88772"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
units="px"
inkscape:window-width="1920"
inkscape:window-height="1027"
inkscape:window-x="0"
inkscape:window-y="0"
inkscape:window-maximized="1" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
<cc:license
rdf:resource="http://creativecommons.org/licenses/by/3.0/" />
</cc:Work>
<cc:License
rdf:about="http://creativecommons.org/licenses/by/3.0/">
<cc:permits
rdf:resource="http://creativecommons.org/ns#Reproduction" />
<cc:permits
rdf:resource="http://creativecommons.org/ns#Distribution" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#Notice" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#Attribution" />
<cc:permits
rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
</cc:License>
</rdf:RDF>
</metadata>
<g
inkscape:groupmode="layer"
id="layer2"
inkscape:label="image" />
<g
inkscape:label="menu border"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-812.36216)"
style="display:inline">
<rect
style="opacity:1;fill:none;fill-opacity:1;stroke:#ff0000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect4136"
width="300"
height="220"
x="10"
y="822.36218" />
<rect
style="opacity:1;fill:none;fill-opacity:0.58823529;stroke:#ff0000;stroke-width:1.03332639;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect4969"
width="318.96667"
height="238.96667"
x="0.51666319"
y="812.87885" />
<svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"
id="wallpaper1" width="320" height="240" version="1.1" viewBox="0 0 320 240">
<g id="layer1" style="display: inline;">
<rect id="rect1" width="300" height="220" x="10" y="10"
style="opacity: 1; fill: none; stroke: red; stroke-width: 1; stroke-linecap: round; stroke-linejoin: miter; stroke-miterlimit: 4; stroke-dasharray: none; stroke-dashoffset: 0;" />
<rect id="rect2" width="320" height="240" x="0" y="0"
style="opacity: 1; fill: none; stroke: red; stroke-width: 1; stroke-linecap: round; stroke-linejoin: miter; stroke-miterlimit: 4; stroke-dasharray: none; stroke-dashoffset: 0;" />
</g>
</svg>

Before

Width:  |  Height:  |  Size: 3.1 KiB

After

Width:  |  Height:  |  Size: 717 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.8 KiB

After

Width:  |  Height:  |  Size: 2.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 879 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.5 KiB

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.0 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 893 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 846 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 172 KiB

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 248 KiB

After

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 944 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 888 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.0 MiB

After

Width:  |  Height:  |  Size: 951 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 MiB

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

@ -1,2 +1,3 @@
mkdocs-macros-plugin
mkdocs-git-revision-date-plugin
mkdocs-git-revision-date-plugin
pygments

View File

@ -1,12 +1,15 @@
%YAML 1.2
---
site_name: Libretro Docs
site_url: 'https://docs.libretro.com/'
site_description: >-
This is RetroArch's document page, modification or development information outside of this repo may be incorrect.
site_description: >-2
This is the official RetroArch documentation for users and developers.
Information from sources outside of this website may be dated or incorrect.
repo_name: 'libretro/docs'
repo_url: 'https://github.com/libretro/docs'
edit_uri: 'edit/master/docs'
copyright: >
Copyright &copy; 2010-2024 Libretro
copyright: >2
Copyright &copy; 20102024 Libretro.
<a href="#__consent">Change cookie settings</a>
nav:
- 'About': 'index.md'
@ -48,12 +51,15 @@ nav:
- 'User Guides':
- 'User Interface': 'guides/navigating.md'
- 'Input and Controls': 'guides/input-and-controls.md'
- 'Starting a Game': 'guides/starting-a-game.md'
- 'Controller Auto-Configuration': 'guides/controller-autoconfiguration.md'
- 'Installing Cores': 'guides/download-cores.md'
- 'Core List': 'guides/core-list.md'
- 'Directory Configuration': 'guides/change-directories.md'
- 'File Browser': 'guides/file-browser.md'
- 'Launching Content': 'guides/launch-content.md'
- 'Menu Styles': 'guides/gui.md'
- 'Quick Menu': 'guides/quick-menu.md'
- 'Importing Content': 'guides/import-content.md'
- 'Shaders': 'guides/shaders.md'
- 'Overrides: Content/Folder/Core-Specific Settings': 'guides/overrides.md'
@ -66,6 +72,7 @@ nav:
- 'Getting Started': 'guides/netplay-getting-started.md'
- 'Multiple Controllers': 'guides/netplay-multiple-controllers.md'
- 'RetroAchievements': 'guides/retroachievements.md'
- 'Disc Swapping': 'guides/disc-swapping.md'
- 'Softpatching ROMs': 'guides/softpatching.md'
- 'Accessibility':
- 'Quick Start': 'guides/accessibility.md'
@ -75,10 +82,13 @@ nav:
- 'Generating Logs': 'guides/generating-retroarch-logs.md'
- 'RetroArch Cloud Sync (Apple Devices)': 'guides/retroarch-cloud-sync.md'
- 'Appearance & Customization':
- 'Interface Styles':
- 'GLUI Interface': 'guides/glui.md'
- 'Ozone Interface': 'guides/ozone.md'
- 'RGUI Interface': 'guides/rgui.md'
- 'XMB Interface': 'guides/xmb.md'
- 'Creating a Theme': 'guides/themes.md'
- 'Playlists and Thumbnails': 'guides/roms-playlists-thumbnails.md'
- 'RGUI Interface': 'guides/rgui.md'
- 'Ozone Interface': 'guides/ozone.md'
- 'XMB Menu Map': 'guides/xmb-menu-map.md'
- 'Advanced':
- 'AI Service': 'guides/ai-service.md'
@ -422,78 +432,50 @@ nav:
- 'Privacy Policy': 'support/privacy-policy.md'
- 'Quick informations': 'support/quick-informations.md'
- 'Developing Cores': 'tech/developing-cores.md'
extra:
adsense: "ca-pub-9447404270680650"
analytics:
provider: google
property: G-MT11L3F6EZ
consent:
title: Cookie consent
description: >-
description: >-2
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
version: '0.1.0'
adsense: "ca-pub-9447404270680650"
title: Cookie consent
font:
text: 'Roboto'
code: 'Roboto Mono'
text: 'Noto Sans'
code: 'Noto Sans Mono'
i18n:
prev: 'Previous'
next: 'Next'
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/libretro
- icon: fontawesome/brands/twitter
link: https://twitter.com/libretro
name: Libretro on GitHub
- icon: fontawesome/brands/x-twitter
link: https://x.com/libretro
name: Libretro on X
- icon: fontawesome/brands/discord
link: https://discord.gg/C4amCeV
name: RetroArch Discord server
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@Libretro
name: Libretro YouTube channel
- icon: fontawesome/brands/facebook
link: https://facebook.com/libretro
- icon: fontawesome/brands/youtube
link: https://youtube.com/libretro
analytics:
provider: google
property: G-MT11L3F6EZ
theme:
name: material
custom_dir: docs/overrides/
palette:
- scheme: retroarch
toggle:
icon: material/weather-sunny
name: Switch to light mode
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to dark mode
primary: black
accent: deep purple
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
- navigation.tabs
- navigation.top
- tables
- content.code.annotate
- content.action.edit
font:
text: Roboto
code: Roboto Mono
logo: 'image/branding/invader.png'
favicon: 'image/branding/invader.png'
plugins:
- search
- git-revision-date
- macros
extra:
name: Libretro on Facebook
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/libretro
name: Libretro/RetroArch on Instagram
status:
fixed: The information on this page never changes
stable: The information on this page changes infrequently, or not at all
unit:
stable: 1.19.1
version: '0.2.0'
extra_css:
- stylesheets/extra.css
@ -504,40 +486,102 @@ markdown_extensions:
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- markdown.extensions.admonition
- markdown.extensions.codehilite:
linenums: true
guess_lang: false
- markdown.extensions.nl2br
- markdown.extensions.toc:
permalink: true
- meta
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.caret:
insert: true
smart_insert: true
superscript: true
- pymdownx.critic:
mode: accept
- pymdownx.details
- pymdownx.highlight
# linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
auto_title: false
guess_lang: block
line_spans: __span
linenums: false
linenums_style: pymdownx-inline
pygments_lang_class: true
stripnl: false
use_pygments: true
- pymdownx.inlinehilite:
style_plain_text: true
- pymdownx.keys:
camel_case: true
strict: true
- pymdownx.magiclink:
repo: docs
repo_url_shorthand: true
user: libretro
repo: docs
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.mark:
smart_mark: true
- pymdownx.smartsymbols:
arrows: false
- pymdownx.snippets:
check_paths: true
dedent_subsections: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
- pymdownx.tasklist:
clickable_checkbox: false
custom_checkbox: true
- pymdownx.tilde
- pymdownx.tilde:
delete: true
smart_delete: true
subscript: true
- toc:
permalink: true
permalink_title: Reference link to this section
toc_depth: 6
plugins:
- git-revision-date
- macros
- search
theme:
custom_dir: docs/overrides/
favicon: 'image/branding/invader.png'
features:
- content.action.edit
- content.code.annotate
- content.code.copy
- navigation.tabs
- navigation.top
- tables
font:
text: 'Noto Sans'
code: 'Noto Sans Mono'
# Don't include MkDocs' JavaScript
include_search_page: false
language: en
logo: 'image/branding/invader.png'
name: material
palette:
- scheme: retroarch
toggle:
icon: material/weather-sunny
name: Switch to light mode
- scheme: slate
accent: deep purple
primary: black
toggle:
icon: material/weather-night
name: Switch to dark mode
search_index_only: true
static_templates:
- 404.html
...