From 72d6f88a6128427727f5682db9932eb612e6b945 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Mon, 9 May 2022 20:57:42 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 3 +++ USERGUIDE-DEV.md | 4 ++++ USERGUIDE.md | 4 ++++ 3 files changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 69c067adc..b94c9edfd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -156,6 +156,9 @@ v1.2 maintenance release. ### Bug fixes +* Chinese characters would sometimes not render correctly +* The "Jump to.." quick selector didn't work correctly with multi-byte Unicode characters +* (Linux) Flatpak directories were missing for user installations of the standalone emulators BlastEm, Play! and Snes9x * (Windows) Fixed an issue where symlinking game media directories would crash the application * (Windows) Scripts and links executed using cmd.exe could not contain the special characters &()^=;, * (Windows) ROM directories could not be created in the root of a device such as D:\ or E:\ diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index ce3cd67b5..96d673d57 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -518,6 +518,8 @@ Therefore all bundled emulator configuration entries that support AppImages will ~/bin/ ``` +It's generally recommended to go for the ~/Applications/ directory, but depending on your Linux distribution this may or may not exist by default. If the directory doesn't exist, then just go ahead and create it. Keep in mind that Linux is case-sensitive so make sure to spell it with a capital A. + As AppImages often embed version information into the actual filename, the bundled configuration uses wildcards to locate the files, such as `rpcs3*.AppImage` which would match the filename `rpcs3-v0.0.19-13103-cc21d1b3_linux64.AppImage` for instance. Note that if multiple files match the wildcard pattern, the first file returned by the operating system will be selected. This approach also works when using [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) which is recommended as it properly integrates AppImages into the application menu and such. When first launching an AppImage with AppImageLauncher installed a question will be asked whether to integrate the application. If accepting this, the AppImage will be moved to the `~/Applications` directory and a hash will be added to the filename, like in this example: @@ -560,6 +562,8 @@ For these situations ES-DE looks for emulators in the same directories where it ~/bin/ ``` +It's generally recommended to go for the ~/Applications/ directory, but depending on your Linux distribution this may or may not exist by default. If the directory doesn't exist, then just go ahead and create it. Keep in mind that Linux is case-sensitive so make sure to spell it with a capital A. + So placing a manually downloaded emulator binary in either of these directories will make ES-DE able to locate it during game launch. The following manually downloaded emulators are supported when using the bundled configuration: diff --git a/USERGUIDE.md b/USERGUIDE.md index 02c5efc32..b8b18540c 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -516,6 +516,8 @@ As such all bundled emulator configuration entries that support AppImages will l ~/bin/ ``` +It's generally recommended to go for the ~/Applications/ directory, but depending on your Linux distribution this may or may not exist by default. If the directory doesn't exist, then just go ahead and create it. Keep in mind that Linux is case-sensitive so make sure to spell it with a capital A. + But even if the directory is known, another issue is that many AppImages contain version information in the filename, such as: ``` rpcs3-v0.0.19-13103-cc21d1b3_linux64.AppImage @@ -576,6 +578,8 @@ For these situations ES-DE looks for emulators in the same directories where it ~/bin/ ``` +It's generally recommended to go for the ~/Applications/ directory, but depending on your Linux distribution this may or may not exist by default. If the directory doesn't exist, then just go ahead and create it. Keep in mind that Linux is case-sensitive so make sure to spell it with a capital A. + So placing a manually downloaded emulator binary in either of these directories will make ES-DE able to locate it during game launch. The following manually downloaded emulators are supported when using the bundled configuration: