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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2023-03-06 19:44:32 +01:00
parent 03a44249af
commit 1b902311c5
2 changed files with 35 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -40,6 +40,7 @@ Overall application speed and performance has been greatly improved with faster
* Added support for mixed-case custom collection names * Added support for mixed-case custom collection names
* Added a startup progress bar to the splash screen * Added a startup progress bar to the splash screen
* Expanded the quick system select menu option from an on/off entry to a selection of different button combinations * Expanded the quick system select menu option from an on/off entry to a selection of different button combinations
* Expanded the random system or game button from an on/off entry to a selection between "Games only", "Games and systems" or "Disabled"
* Changed the order of the help system entries Y, X, B and A to instead be listed as A, B, X and Y * Changed the order of the help system entries Y, X, B and A to instead be listed as A, B, X and Y
* Changed the start button for the screensaver from "Back" to "X" * Changed the start button for the screensaver from "Back" to "X"
* Changed the help system description for the "A" button in the gamelist view from "Launch" to "Select" * Changed the help system description for the "A" button in the gamelist view from "Launch" to "Select"
@ -63,12 +64,15 @@ Overall application speed and performance has been greatly improved with faster
* Added ares standalone as an alternative emulator for many systems * Added ares standalone as an alternative emulator for many systems
* Added MAME standalone as the default emulator for the macintosh system (Mac SE and Mac Plus diskette images) * Added MAME standalone as the default emulator for the macintosh system (Mac SE and Mac Plus diskette images)
* Added MAME standalone as the default emulator for the gameandwatch system * Added MAME standalone as the default emulator for the gameandwatch system
* Added Stella standalone as an alternative emulator for the atari2600 system
* Added Gopher2600 standalone as an alternative emulator for the atari2600 system on Unix and Windows
* Added PrBoom+ standalone as an alternative emulator for the doom system * Added PrBoom+ standalone as an alternative emulator for the doom system
* Added openMSX standalone as an alternative emulator for the colecovision, msx, msx1, msx2 and msxturbor systems * Added openMSX standalone as an alternative emulator for the colecovision, msx, msx1, msx2 and msxturbor systems
* Added SameBoy standalone as an alternative emulator for the gb and gbc systems * Added SameBoy standalone as an alternative emulator for the gb and gbc systems
* Added Gearboy standalone as an alternative emulator for the gb and gbc systems on Unix and Windows * Added Gearboy standalone as an alternative emulator for the gb and gbc systems on Unix and Windows
* Added puNES standalone as an alternative emulator for the famicom and nes systems on Unix and Windows * Added puNES standalone as an alternative emulator for the famicom and nes systems on Unix and Windows
* Added Hatari standalone as an alternative emulator for the atarist system * Added Hatari standalone as an alternative emulator for the atarist system
* Added Fuse standalone as an alternative emulator for the zxspectrum system
* (Linux) Added support for the Sega Model 3 (model3) game system by adding the Supermodel standalone emulator * (Linux) Added support for the Sega Model 3 (model3) game system by adding the Supermodel standalone emulator
* (Linux) Added Supermodel standalone as an alternative emulator for the arcade and mame systems * (Linux) Added Supermodel standalone as an alternative emulator for the arcade and mame systems
* (Linux) Added support for the mGBA Qt and Snes9x GTK standalone emulators * (Linux) Added support for the mGBA Qt and Snes9x GTK standalone emulators

61
USERGUIDE-DEV.md
View file

@ -389,7 +389,7 @@ ES-DE automatically configures the keyboard and any connected controllers using
You can also force a run of this tool directly on startup via the command line argument `--force-input-config`. You can also force a run of this tool directly on startup via the command line argument `--force-input-config`.
The actual procedure to map the inputs should be self-explanatory, just follow the on-screen instructions. Note that custom button mappings will not change the help prompts. The actual procedure to map the inputs should be self-explanatory, just follow the on-screen instructions. Note that custom button mappings will not change the help system entries.
Any custom configuration is applied per unique device ID (GUID). So if two identical controllers are used with ES-DE, both will have the same configuration applied. If connecting controllers of the same type but of different revisions, the GUID may differ and therefore the custom configuration would need to be applied to each device individually. Any custom configuration is applied per unique device ID (GUID). So if two identical controllers are used with ES-DE, both will have the same configuration applied. If connecting controllers of the same type but of different revisions, the GUID may differ and therefore the custom configuration would need to be applied to each device individually.
@ -482,7 +482,7 @@ Jumps to the first or last entries in carousels, grids and textlists as well as
**Left and right thumbstick click**\ **Left and right thumbstick click**\
_(F2 / F3)_ _(F2 / F3)_
Jumps to a random game or system depending on whether pressed when in the system view or gamelist view. Only available if the _Enable random system or game button_ option has been enabled. Jumps to a random game or system depending on whether pressed when in the system view or gamelist view. Only applicable if the _Random entry button_ option has been configured accordingly.
**A button**\ **A button**\
_(Enter)_ _(Enter)_
@ -623,28 +623,29 @@ So placing a manually downloaded emulator binary in either of these directories
The following manually downloaded emulators are supported when using the bundled configuration: The following manually downloaded emulators are supported when using the bundled configuration:
| System name | Emulator | Filename configuration | | System name | Emulator | Filename configuration |
| :------------------------------- | :------------ | :------------------------------ | | :------------------------------- | :------------ | :-------------------------------- |
| amstradcpc | CPCemu | cpcemu/cpcemu | | amstradcpc | CPCemu | cpcemu/cpcemu |
| apple2 | LinApple | linapple/linapple | | apple2 | LinApple | linapple/linapple |
| coco/dragon32/tanodragon | XRoar | xroar/xroar | | atari2600 | Gopher2600 | gopher2600/gopher2600_linux_amd64 |
| daphne | Hypseus Singe | hypseus-singe/hypseus.bin | | coco/dragon32/tanodragon | XRoar | xroar/xroar |
| dreamcast | Redream | redream/redream | | daphne | Hypseus Singe | hypseus-singe/hypseus.bin |
| easyrpg | EasyRPG | easyrpg/easyrpg-player | | dreamcast | Redream | redream/redream |
| fbneo/neogeo/neogeocd/neogeocdjp | FinalBurn Neo | fbneo/fbneo | | easyrpg | EasyRPG | easyrpg/easyrpg-player |
| flash | Lightspark | lightspark/lightspark | | fbneo/neogeo/neogeocd/neogeocdjp | FinalBurn Neo | fbneo/fbneo |
| flash | Ruffle | ruffle/ruffle | | flash | Lightspark | lightspark/lightspark |
| fmtowns | Tsugaru | tsugaru/Tsugaru_CUI | | flash | Ruffle | ruffle/ruffle |
| gb/gbc | Gearboy | gearboy/gearboy | | fmtowns | Tsugaru | tsugaru/Tsugaru_CUI |
| model3 | Supermodel | Supermodel/supermodel | | gb/gbc | Gearboy | gearboy/gearboy |
| famicom/nes | puNES | punes/punes | | model3 | Supermodel | Supermodel/supermodel |
| oric | Oricutron | oricutron/Oricutron | | famicom/nes | puNES | punes/punes |
| pico8 | PICO-8 | pico-8/pico8 | | oric | Oricutron | oricutron/Oricutron |
| psvita | Vita3K | Vita3K/Vita3K | | pico8 | PICO-8 | pico-8/pico8 |
| samcoupe | SimCoupé | simcoupe/simcoupe | | psvita | Vita3K | Vita3K/Vita3K |
| switch | Ryujinx | publish/Ryujinx | | samcoupe | SimCoupé | simcoupe/simcoupe |
| trs-80 | sdl2trs | sdl2trs/sdl2trs | | switch | Ryujinx | publish/Ryujinx |
| wiiu | Cemu | Cemu/Cemu | | trs-80 | sdl2trs | sdl2trs/sdl2trs |
| wiiu | Cemu | Cemu/Cemu |
Note that the Ryujinx binary is not set as executable after unpacking the archive, so you need to do that once before ES-DE can run it: Note that the Ryujinx binary is not set as executable after unpacking the archive, so you need to do that once before ES-DE can run it:
``` ```
@ -2293,6 +2294,10 @@ This configures for how long to display the game launch screen when starting a g
Sets the user interface mode for the application to _Full, Kiosk_ or _Kid_. See the description [above](USERGUIDE-DEV.md#ui-modes) in this document for additional information. Sets the user interface mode for the application to _Full, Kiosk_ or _Kid_. See the description [above](USERGUIDE-DEV.md#ui-modes) in this document for additional information.
**Random entry button**
Whether to enable the selection of a random entry in the system or gamelist view via a button press, by default mapped to the click button of either thumbstick. The options are _Games only, Games and systems_ or _Disabled_. The help system will also visually indicate the status of this setting.
**Media viewer settings** **Media viewer settings**
Submenu containing all the settings for the media viewer. These are described in detail below. Submenu containing all the settings for the media viewer. These are described in detail below.
@ -2341,10 +2346,6 @@ This enables a virtual (on-screen) keyboard that can be used at various places t
This setting enables the _Y_ button for quickly toggling a game as favorite. Although this may be convenient at times, it's also quite easy to accidentally remove a favorite tagging of a game when using the application more casually. As such it could sometimes make sense to disable this functionality. It's of course still possible to mark a game as favorite using the metadata editor when this setting is disabled. The option does not affect the use of the _Y_ button to add or remove games when editing custom collections. This setting enables the _Y_ button for quickly toggling a game as favorite. Although this may be convenient at times, it's also quite easy to accidentally remove a favorite tagging of a game when using the application more casually. As such it could sometimes make sense to disable this functionality. It's of course still possible to mark a game as favorite using the metadata editor when this setting is disabled. The option does not affect the use of the _Y_ button to add or remove games when editing custom collections.
**Enable random system or game button**
This enables or disables the ability to jump to a random system or game. It's mapped to the thumbstick click button, either the left or right thumbstick will work. The help prompts will also visually indicate whether this option is enabled or not.
**Enable gamelist filters** **Enable gamelist filters**
Activating or deactivating the ability to filter your gamelists. This can normally be left enabled. Activating or deactivating the ability to filter your gamelists. This can normally be left enabled.
@ -3064,7 +3065,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| arcadia | Emerson Arcadia 2001 | MAME **(Standalone)** | | No | Single archive or ROM file | | arcadia | Emerson Arcadia 2001 | MAME **(Standalone)** | | No | Single archive or ROM file |
| arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file | | arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file |
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | | See the specific _Bally Astrocade_ section elsewhere in this guide | | astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | | See the specific _Bally Astrocade_ section elsewhere in this guide |
| atari2600 | Atari 2600 | Stella | Stella 2014,<br>ares **(Standalone)** | No | Single archive or ROM file | | atari2600 | Atari 2600 | Stella | Stella 2014,<br>Stella **(Standalone)**,<br>Gopher2600 **(Standalone)** [UW],<br>ares **(Standalone)** | No | Single archive or ROM file |
| atari5200 | Atari 5200 | a5200 | Atari800,<br>Atari800 **(Standalone)** | Yes | Single archive or ROM file | | atari5200 | Atari 5200 | a5200 | Atari800,<br>Atari800 **(Standalone)** | Yes | Single archive or ROM file |
| atari7800 | Atari 7800 ProSystem | ProSystem | | Yes | Single archive or ROM file | | atari7800 | Atari 7800 ProSystem | ProSystem | | Yes | Single archive or ROM file |
| atari800 | Atari 800 | Atari800 | Atari800 **(Standalone)** | No | | | atari800 | Atari 800 | Atari800 | Atari800 **(Standalone)** | No | |
@ -3219,4 +3220,4 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W] | | No | | | xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W] | | No | |
| zmachine | Infocom Z-machine | Gargoyle **(Standalone)** | | No | | | zmachine | Infocom Z-machine | Gargoyle **(Standalone)** | | No | |
| zx81 | Sinclair ZX81 | EightyOne | | | | | zx81 | Sinclair ZX81 | EightyOne | | | |
| zxspectrum | Sinclair ZX Spectrum | Fuse | | No | | | zxspectrum | Sinclair ZX Spectrum | Fuse | Fuse **(Standalone)** | No | |