From 83af3c7d237b964757ac902b7c0386aea9d3d7df Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Mon, 11 Jan 2021 18:40:16 +0100 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 1 + INSTALL.md | 43 +++++++++++++++++++++---------------------- USERGUIDE.md | 4 +++- 3 files changed, 25 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d5301289..13f0b735f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -58,6 +58,7 @@ Many bugs have been fixed, and numerous features that were only partially implem * Per-game launch command override, so that different cores or emulators can be used on a per-game basis (saved to gamelist.xml) * The emulator core location can be defined relative to the emulator binary using the %EMUPATH% variable in es_systems.cfg (mostly useful on Windows) * Core locations can be searched from a configurable list of directories if defined in the es_systems.cfg file using the %COREPATH% variable (mostly useful on Unix where there are no standardized core directories) +* Clear notifications and logging have been added for missing emulator binaries and cores when attempting to launch games * Overhaul of the screensaver (the game info overlay now works correctly for instance) * Added support for jumping to the start and end of gamelists and menus using the controller trigger buttons (or equivalent keyboard mappings) * Many additional quality of life improvements and removal of GUI inconsistencies diff --git a/INSTALL.md b/INSTALL.md index 85e3d9d91..339eb7a57 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -944,49 +944,48 @@ It's possible to easily create a portable installation of ES-DE for Windows, for For the sake of this example, let's assume that the removable media has the device name `f:\`. * Copy the EmulationStation-DE installation directory to f:\ -* Create the directory `ES-Home` directly under f:\ -* Copy your game ROMs into `f:\ES-Home\ROMs` +* Create the directory `ES-DE_Home` directly under f:\ +* Copy your game ROMs into `f:\ES-DE_Home\ROMs` * Copy your emulators to f:\ (such as the RetroArch directory) * Create the file `start_es.bat` directly under f:\ Add the following lines to the start_es.bat file: ``` @echo off -EmulationStation-DE\EmulationStation.exe --home %CD:~0,3%ES-Home +EmulationStation-DE\EmulationStation.exe --home %CD:~0,3%ES-DE_Home ``` The contents of f:\ should now look something like this: ``` EmulationStation-DE -ES-Home +ES-DE_Home RetroArch start_es.bat - ``` Now run the batch script, ES should start and ask you to configure any attached controllers. Following this, check that everything works as expected, i.e. the gamelists are properly populated etc. -You can optionally skip the configuration of the controllers by copying any existing es_input.cfg file to f:\ES-Home\\.emulationstation\\` +You can optionally skip the configuration of the controllers by copying any existing es_input.cfg file to `f:\ES-DE_Home\.emulationstation\` -Exit ES and modify the file `f:\ES-Home\.emulationstation\es_systems.cfg` to point to the emulators on the portable media. +Exit ES-DE and modify the file `f:\ES-DE_Home\.emulationstation\es_systems.cfg` to point to the emulators on the portable media. For example, change from this: ``` -retroarch.exe -L "%EMUPATH%\cores\snes9x_libretro.dll" %ROM% +retroarch.exe -L %EMUPATH%\cores\snes9x_libretro.dll %ROM% ``` To this: ``` -%ESPATH%\..\RetroArch\retroarch.exe -L "%EMUPATH%\cores\snes9x_libretro.dll" %ROM% +%ESPATH%\..\RetroArch\retroarch.exe -L %EMUPATH%\cores\snes9x_libretro.dll %ROM% ``` The %ESPATH% variable is explained later in this document. -Following this, optionally copy any existing gamelists and game media files to the removable media. By default these files should be located here: +Following this, optionally copy any existing gamelist.xml and game media files to the removable media. By default these files should be located here: ``` -f:\ES-Home\.emulationstation\gamelists\ -f:\ES-Home\.emulationstation\downloaded_media\ +f:\ES-DE_Home\.emulationstation\gamelists\ +f:\ES-DE_Home\.emulationstation\downloaded_media\ ``` You now have a fully functional portable retro gaming installation! @@ -1218,8 +1217,8 @@ Below is an overview of the file layout with various examples. For a real system retroarch -L "~/my configs/retroarch/cores/snes9x_libretro.so" %ROM% --> retroarch -L ~/.config/retroarch/cores/snes9x_libretro.so %ROM% - + retroarch -L %COREPATH%/snes9x_libretro.so %ROM% + variable is used here to find the cores relative to the RetroArch binary. The emulator binary must be in the PATH environmental + variable or otherwise the complete path to the retroarch.exe file needs to be defined. Batch scripts (.bat) are also supported. --> retroarch.exe -L %EMUPATH%\cores\snes9x_libretro.dll %ROM% + in the directory name, so it needs to be surrounded by quotation marks. Quotation marks around the %EMUPATH% entry are optional + but in this example they're added. --> "C:\My Games\RetroArch\retroarch.exe" -L "%EMUPATH%\cores\snes9x_libretro.dll" %ROM%