From 964f9fabff1c71d4a2bb3257ec3694195d9d7e8b Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Fri, 18 Aug 2023 20:34:47 +0200 Subject: [PATCH] Documentation update --- CHANGELOG.md | 2 ++ CREDITS.md | 5 ++++- USERGUIDE-DEV.md | 38 +++++++++++++++++++++++++++++++++----- 3 files changed, 39 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c1a2a88f..1cb047c73 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,6 +47,8 @@ * Made the miximage offline generator GUI sizing more consistent across different display aspect ratios * Removed the es_log.txt entry when an es_systems.cfg legacy systems configuration file was found on startup * Improved menu system font rendering on GPUs without proper texture filtering support +* Improved the blur shaders to run faster at higher resolutions and to look identical regardless of display resolution +* Improved the blur shaders rendering quality when rotating the screen 90 or 270 degrees * Added a "stationary" property to all secondary elements to set them as stationary during slide transitions * Added a "containerType" property to the text element to select between vertical and horizontal containers * Added a number of carousel, grid, textlist and text properties to control horizontally scrolling text diff --git a/CREDITS.md b/CREDITS.md index da3487630..3fde92c63 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -85,9 +85,12 @@ https://batocera.org The MD5 hash functions were adapted from code by the BZFlag project \ https://www.bzflag.org -A couple of GLSL shaders were borrowed from the RetroArch project \ +The scanline GLSL shader was adapted from code by the RetroArch project \ https://www.retroarch.com +The blur GLSL shaders were based on code from the following repository \ +https://github.com/Jam3/glsl-fast-gaussian-blur + # Resources Akrobat font \ diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index d17c059c4..0ee8be1d0 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -968,7 +968,7 @@ Note that _Kid Icarus_ will only show up once since there is a name collision pr ## Platform-specific setup -Not all systems are as simple to setup as what is described in the previous section, and in some cases there may be multiple ways to perform the configuration. Specifics for such systems will be covered here. Consider this a work in progress as there are many platforms supported by ES-DE. +Not all systems are as simple to setup as what was described in the previous section, and in some cases there may be multiple ways to perform the configuration. Specifics for such platforms are covered below. ### Apple II @@ -1483,13 +1483,41 @@ As an alternative you can add Lutris games to the Ports system using the procedu ### Microsoft Xbox 360 -_This section currently only covers the xenia setup on Linux._ +This system is emulated using [xenia](https://xenia.jp/), and although there are a lot of topics to consider for this emulator such as how to handle multi-disc games, DLCs etc. this section will only cover the basics on how to run single-disc ISO images and XBLA games. For the remaining details there are many resources available online. -**Note that xenia does not seem to run on the Steam Deck using the approach described below.** +**General** -The only Xbox 360 emulator that can run commercial games is [xenia](https://xenia.jp/) and while it's officially only available for the Windows operating system it's still possible to run it on Linux. +Single-disc ISO images can simply be placed in the root of the `~/ROMs/xbox360` system directory, like the following: +``` +~/ROMs/xbox360/Gears of War.iso +~/ROMs/xbox360/Gears of War 3.iso +``` -To accomplish this you need to run it via the Wine translation layer. More specifically you need the AppImage release of Wine which can be downloaded from here:\ +Xbox Live Arcade (XBLA) games work quite differently, these are generally shipped in directory structures with quite cryptic filenames that are also extensionless. Here's an example: +``` +Castle Crashers/ +Castle Crashers/584108B7/ +Castle Crashers/584108B7/000D0000/ +Castle Crashers/584108B7/000D0000/F9432A7FE407A3C196C95D0FFD4A540937FD4EEC58 +``` + +For this example it's F9432A7FE407A3C196C95D0FFD4A540937FD4EEC58 that is the actual game. It's recommended to move this file to the root of the `~/ROMs/xbox360` system directory and to rename it to the game name followed by _(XBLA)_ to make it clear that it's an Xbox Live Arcade game. After doing this our example directory structure would look like the following: +``` +~/ROMs/xbox360/Castle Crashers (XBLA) +~/ROMs/xbox360/Gears of War.iso +~/ROMs/xbox360/Gears of War 3.iso +``` + +Note again that the Castle Crashers game does not have a file extension, this is correct and the game can still be launched from inside ES-DE. + +There is also a handy tool available to automate the XBLA renaming process, you can find it here:\ +https://github.com/cmclark00/XBLA-Automation + +**Running xenia on Linux** + +_Note that xenia does not seem to run on the Steam Deck using the approach described below._ + +Although xenia is officially only available for the Windows operating system it's still possible to run it on Linux. To accomplish this you need to run it via the Wine translation layer. More specifically you need the AppImage release of Wine which can be downloaded from here:\ https://github.com/mmtrt/WINE_AppImage/releases Make sure to get the stable x86_64 release, for this example we assume that the file `wine-stable_8.0.2-x86_64.AppImage` has been downloaded.