Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-24 23:25:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-02-22 23:12:49 +01:00
parent 70a9029dfd
commit d41a228093
2 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
INSTALL-DEV.md
View file

@ -1731,19 +1731,16 @@ You should end up with something like this:
``` ```
F:\EmulationStation-DE\ F:\EmulationStation-DE\
F:\EmulationStation-DE\dosbox-staging\ F:\EmulationStation-DE\dosbox-staging\
F:\EmulationStation-DE\PCSX2\
F:\EmulationStation-DE\RetroArch-Win64\ F:\EmulationStation-DE\RetroArch-Win64\
F:\EmulationStation-DE\ROMs\ F:\EmulationStation-DE\ROMs\
F:\EmulationStation-DE\RPCS3\ F:\EmulationStation-DE\RPCS3\
F:\EmulationStation-DE\xemu\ F:\EmulationStation-DE\xemu\
F:\EmulationStation-DE\xenia\
F:\EmulationStation-DE\yuzu\
F:\EmulationStation-DE\portable.txt F:\EmulationStation-DE\portable.txt
``` ```
This is just an example, you may not have all these emulators installed and as well there will of course be many more files and directories than those listed above inside the F:\EmulationStation-DE directory. This is just an example as you may of course not use these specific emulators. There are also many more emulators supported as described below. As well there will be many more files and directories than those listed above inside the F:\EmulationStation-DE directory.
How the portable setup works is that when ES-DE finds a file named portable.txt in its executable directory, it will by default locate the .emulationstation directory directly inside this folder. It's also possible to modify portable.txt with a path relative to the ES-DE executable directory. For instance if two dots `..` are placed inside the portable.txt file, then the .emulationstation directory will be located in the parent folder, which would be directly under F:\ in this example. How the portable setup works is that when ES-DE finds a file named portable.txt in its executable directory, it will by default locate the .emulationstation directory directly inside this folder. It's also possible to modify portable.txt with a path relative to the ES-DE executable directory. For instance if two dots `..` are placed inside the portable.txt file, then the .emulationstation directory will be located in the parent folder, which would be directly under F:\ for this example.
If the --home command line parameter is passed when starting ES-DE, that will override the portable.txt file. If the --home command line parameter is passed when starting ES-DE, that will override the portable.txt file.
@ -1752,7 +1749,11 @@ By default the emulators that will be automatically searched for by ES-DE are (r
``` ```
RetroArch-Win64\retroarch.exe RetroArch-Win64\retroarch.exe
RetroArch\retroarch.exe RetroArch\retroarch.exe
Citra\canary-mingw\citra.exe
Citra\nightly-mingw\citra.exe
Dolphin-x64\Dolphin.exe
dosbox-staging\dosbox.exe dosbox-staging\dosbox.exe
mame\mame.exe
PCSX2\pcsx2.exe PCSX2\pcsx2.exe
RPCS3\rpcs3.exe RPCS3\rpcs3.exe
xemu\xemu.exe xemu\xemu.exe
@ -1760,7 +1761,11 @@ xenia\xenia.exe
yuzu\yuzu-windows-msvc\yuzu.exe yuzu\yuzu-windows-msvc\yuzu.exe
..\RetroArch-Win64\retroarch.exe ..\RetroArch-Win64\retroarch.exe
..\RetroArch\retroarch.exe ..\RetroArch\retroarch.exe
..\Citra\canary-mingw\citra.exe
..\Citra\nightly-mingw\citra.exe
..\Dolphin-x64\Dolphin.exe
..\dosbox-staging\dosbox.exe ..\dosbox-staging\dosbox.exe
..\mame\mame.exe
..\PCSX2\pcsx2.exe ..\PCSX2\pcsx2.exe
..\RPCS3\rpcs3.exe ..\RPCS3\rpcs3.exe
..\xemu\xemu.exe ..\xemu\xemu.exe

15
USERGUIDE-DEV.md
View file

@ -497,8 +497,11 @@ At the moment the following emulators are supported in AppImage format when usin
| System name | Emulator | Filename configuration | | System name | Emulator | Filename configuration |
| :----------- | :-------- | :------------------------------ | | :----------- | :-------- | :------------------------------ |
| _Multiple_ | RetroArch | RetroArch-Linux-x86_64.AppImage | | _Multiple_ | RetroArch | RetroArch-Linux-x86_64.AppImage |
| gc | Dolphin | Dolphin_Emulator*.AppImage |
| ps3 | RPCS3 | rpcs3*.AppImage | | ps3 | RPCS3 | rpcs3*.AppImage |
| xbox | xemu | Xemu*.AppImage |
| switch | Yuzu | yuzu*.AppImage | | switch | Yuzu | yuzu*.AppImage |
| wii | Dolphin | Dolphin_Emulator*.AppImage |
RetroArch does not embed any version information into the filename so no wildcard is required. RetroArch does not embed any version information into the filename so no wildcard is required.
@ -2004,7 +2007,7 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
| android | Google Android | _Placeholder_ | | | | | android | Google Android | _Placeholder_ | | | |
| apple2 | Apple II | _Placeholder_ | | | | | apple2 | Apple II | _Placeholder_ | | | |
| apple2gs | Apple IIGS | _Placeholder_ | | | | | apple2gs | Apple IIGS | _Placeholder_ | | | |
| arcade | Arcade | MAME - Current | MAME 2000,<br>MAME 2003-Plus,<br>MAME 2010,<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder | | arcade | Arcade | MAME - Current | MAME 2000,<br>MAME 2003-Plus,<br>MAME 2010,<br>FinalBurn Neo,<br>FB Alpha 2012,<br>MAME **(Standalone)** [UW*] | Depends | Single archive file following MAME name standard in root folder |
| astrocade | Bally Astrocade | _Placeholder_ | | | | | astrocade | Bally Astrocade | _Placeholder_ | | | |
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder | | atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
| atari5200 | Atari 5200 | Atari800 | | | | | atari5200 | Atari 5200 | Atari800 | | | |
@ -2041,7 +2044,7 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
| gb | Nintendo Game Boy | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | | | gb | Nintendo Game Boy | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | |
| gba | Nintendo Game Boy Advance | mGBA | VBA-M,<br>VBA Next,<br>gpSP | | | | gba | Nintendo Game Boy Advance | mGBA | VBA-M,<br>VBA Next,<br>gpSP | | |
| gbc | Nintendo Game Boy Color | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | | | gbc | Nintendo Game Boy Color | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | |
| gc | Nintendo GameCube | Dolphin | | | | | gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)** [UMW*] | No | Single ISO file in root folder |
| genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm | No | Single archive or ROM file in root folder | | genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm | No | Single archive or ROM file in root folder |
| gx4000 | Amstrad GX4000 | _Placeholder_ | | | | | gx4000 | Amstrad GX4000 | _Placeholder_ | | | |
| intellivision | Mattel Electronics Intellivision | FreeIntv | | | | | intellivision | Mattel Electronics Intellivision | FreeIntv | | | |
@ -2050,7 +2053,7 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder | | lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
| lutro | Lutro Game Engine | Lutro | | | | | lutro | Lutro Game Engine | Lutro | | | |
| macintosh | Apple Macintosh | _Placeholder_ | | | | | macintosh | Apple Macintosh | _Placeholder_ | | | |
| mame | Multiple Arcade Machine Emulator | MAME 2003-Plus | MAME 2000,<br>MAME 2010,<br>MAME - Current,<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder | | mame | Multiple Arcade Machine Emulator | MAME 2003-Plus | MAME 2000,<br>MAME 2010,<br>MAME - Current,<br>FinalBurn Neo,<br>FB Alpha 2012,<br>MAME **(Standalone)** [UW*] | Depends | Single archive file following MAME name standard in root folder |
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder | | mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder | | mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
| mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive | No | Single archive or ROM file in root folder | | mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive | No | Single archive or ROM file in root folder |
@ -2067,7 +2070,7 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
| multivision | Othello Multivision | Gearsystem | | | | | multivision | Othello Multivision | Gearsystem | | | |
| naomi | Sega NAOMI | Flycast | | | | | naomi | Sega NAOMI | Flycast | | | |
| naomigd | Sega NAOMI GD-ROM | Flycast | | | | | naomigd | Sega NAOMI GD-ROM | Flycast | | | |
| n3ds | Nintendo 3DS | Citra [UW] | Citra 2018 [UW] | | | | n3ds | Nintendo 3DS | Citra [UW],<br>Citra **(Standalone)** [M] | Citra 2018 [UW],<br>Citra **(Standalone)** [UW*] | No | Single ROM file in root folder |
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW],<br>Mupen64Plus **(Standalone)** [M] | No | Single archive or ROM file in root folder | | n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW],<br>Mupen64Plus **(Standalone)** [M] | No | Single archive or ROM file in root folder |
| nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>melonDS | | | | nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>melonDS | | |
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder | | neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
@ -2126,13 +2129,13 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
| vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder | | vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder |
| videopac | Philips Videopac G7000 | O2EM | | | | | videopac | Philips Videopac G7000 | O2EM | | | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | | | | | virtualboy | Nintendo Virtual Boy | Beetle VB | | | |
| wii | Nintendo Wii | Dolphin | | | | | wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*] | | |
| wiiu | Nintendo Wii U | _Placeholder_ | | | | | wiiu | Nintendo Wii U | _Placeholder_ | | | |
| wonderswan | Bandai WonderSwan | Beetle Cygne | | | | | wonderswan | Bandai WonderSwan | Beetle Cygne | | | |
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | | | | wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | | |
| x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder | | x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder |
| x68000 | Sharp X68000 | PX68k | | | | | x68000 | Sharp X68000 | PX68k | | | |
| xbox | Microsoft Xbox | xemu **(Standalone)** [UW*] | | Yes | Single ISO file in root folder | | xbox | Microsoft Xbox | xemu **(Standalone)** [UMW*] | | Yes | Single ISO file in root folder |
| xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W*] | | No | | | xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W*] | | No | |
| zmachine | Infocom Z-machine | _Placeholder_ | | | | | zmachine | Infocom Z-machine | _Placeholder_ | | | |
| zx81 | Sinclair ZX81 | EightyOne | | | | | zx81 | Sinclair ZX81 | EightyOne | | | |