mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 13:45:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
e36b679d5e
commit
9af37ededc
|
|
@ -38,6 +38,7 @@
|
|||
* Added theme support for setting the TextListComponent indicators to symbols, ascii or none
|
||||
* Added theme support for setting the TextListComponent custom collection indicators to symbols or ascii
|
||||
* Removed the "Use plain ASCII for special gamelist characters" menu option as it's now theme-controlled
|
||||
* Removed the "Enable menu scroll indicators" menu option
|
||||
* Changed the badges default lines property value from 2 to 3
|
||||
* Made it possible to set any text element as a scrollable container using either metadata values or literal strings
|
||||
* Added support for defining the scrollable container speed, start delay and reset delay from the theme configuration
|
||||
|
|
@ -69,7 +70,7 @@
|
|||
* Added support for dimming components (fade to black)
|
||||
* Added logging of the display refresh rate on startup
|
||||
* Added a command line option to rotate the application screen 180 degrees
|
||||
* Added support for the platform pico8 (only platform and scraper support, no system or theme configuration added yet)
|
||||
* Improved the behavior and consistency for the virtual keyboard when using non-standard keyboard mappings
|
||||
* Improved the theme loading error logging to make it consistent and easier to understand
|
||||
* Added a log warning for unthemed systems during theme set loading
|
||||
* Changed the warning log level for missing theme files to debug level if the paths are set using variables
|
||||
|
|
@ -156,6 +157,7 @@ v1.2 maintenance release.
|
|||
* Added support for launching .app directories and alias files to the desktop, epic, kodi, ports and steam systems on macOS
|
||||
* Changed the ps3 system to use shortcuts and created an alternative emulator entry for backward compatibility with symlinks
|
||||
* Added the .lnk file extension to the epic system on Windows
|
||||
* Added support for the PICO-8 (pico8) game system
|
||||
* Added support for the Capcom Play System (cps) game system
|
||||
* Added support for the Sega Model 2 and 3 (model2 and model3) game systems on Windows
|
||||
* Added support for asterisks/wildcards for emulator name matching, usable both in es_find_rules.xml and es_systems.xml
|
||||
|
|
@ -167,6 +169,7 @@ v1.2 maintenance release.
|
|||
* Changed the default quit shortcut from F4 to Command + Q on macOS
|
||||
* Added Ctrl + Q as a user-selectable quit shortcut
|
||||
* Added support for placing a noload.txt file in the root of a system/ROM directory to keep it from getting loaded
|
||||
* (Windows) Added support for creating a portable installation in the root of a device, such as E: or F:
|
||||
* Increased the window width slightly for the Alternative emulators interface when displaying long system names
|
||||
* Added size restrictions to the "size" and "maxSize" theme properties for the image and video elements
|
||||
* Changed to a new API key for TheGamesDB
|
||||
|
|
@ -178,6 +181,7 @@ v1.2 maintenance release.
|
|||
* Thumbnails were not included in theme sets that used them for the Detailed view style
|
||||
* Game images were not included in theme sets that used them for the Video view style
|
||||
* Themes with large pixelated fonts sometimes displayed too many textlist rows
|
||||
* When entering the text edit field for the virtual keyboard, a navigation key repeat would sometimes continue to run
|
||||
* The menu scroll indicators and title sometimes overlapped (e.g. seen in the Alternative emulators interface)
|
||||
* There was a small rounding error that caused a minimal distortion when rendering menu titles
|
||||
|
||||
|
|
|
|||
13
CREDITS.md
13
CREDITS.md
|
|
@ -2,14 +2,15 @@
|
|||
|
||||
# Programming
|
||||
|
||||
Alec Lofquist (original version) \
|
||||
http://www.aloshi.com
|
||||
**Original version**\
|
||||
Alec Lofquist
|
||||
|
||||
RetroPie Community (RetroPie fork) \
|
||||
https://retropie.org.uk
|
||||
**RetroPie Fork**\
|
||||
RetroPie community
|
||||
|
||||
Leon Styhre (Desktop Edition fork, based on the RetroPie version) \
|
||||
https://gitlab.com/es-de/emulationstation-de
|
||||
**Desktop Edition fork**\
|
||||
Leon Styhre \
|
||||
Sophia Hadash
|
||||
|
||||
# UI Art & Design
|
||||
|
||||
|
|
|
|||
|
|
@ -466,7 +466,9 @@ _The help system is displayed at the bottom of the screen, indicating the variou
|
|||
|
||||
The built-in help system will provide a contextual summary of the available navigation options, but here's still a general overview. These are the buttons mappings automatically applied by ES-DE, but they can be customized using the input configurator as described earlier in this document. It's not an exhaustive list, but it covers most situations. The button names are based on the Xbox 360 controller as that is the naming convention used by the SDL library which handles the controller input in ES-DE.
|
||||
|
||||
The default keyboard mappings are shown in brackets.
|
||||
When editing text using the virtual keyboard but using a physical keyboard as input device instead of a controller, then there are some slight exceptions to the normal input logic. The _Enter_ key will always apply the changes and the _Escape_ key will always go back. As well, if you have mapped any regular keys to the _left_, _right_ or _down_ buttons or to the _shoulder_ or _trigger_ buttons, then these will not be usable in the text input field. You will instead have to use the virtual keyboard buttons to enter these characters. Note that this is not an issue if using the default keyboard configuration as the buttons just mentioned are then mapped to special keys only, as detailed below.
|
||||
|
||||
Default keyboard mappings are shown in brackets.
|
||||
|
||||
**Up and down**\
|
||||
_(Arrow up / Arrow down)_
|
||||
|
|
@ -626,6 +628,7 @@ The following manually downloaded emulators are supported when using the bundled
|
|||
| :----------- | :------------ | :------------------------------ |
|
||||
| daphne | Hypseus Singe | hypseus-singe/hypseus.bin |
|
||||
| dreamcast | Redream | redream/redream |
|
||||
| pico8 | PICO-8 | pico-8/pico8 |
|
||||
| switch | Ryujinx | publish/Ryujinx |
|
||||
|
||||
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:
|
||||
|
|
@ -1326,6 +1329,29 @@ Starting ES-DE and launching the game should now work fine, but a further improv
|
|||
|
||||
Doing this will make the game show up as if it was a single file inside ES-DE and it can be included in automatic collections, custom collections and so on.
|
||||
|
||||
#### PICO-8
|
||||
|
||||
PICO-8 Fantasy Console is a game engine developed by [Lexaloffle Games](https://www.lexaloffle.com/pico-8.php) that you need to buy a license to use. Doing so will provide you with download links to releases for Linux, macOS and Windows. On macOS and Windows the installation is straightforward, but on Linux you need to place PICO-8 in a location recognized by ES-DE. See the [Using manually downloaded emulators on Linux](USERGUIDE-DEV.md#using-manually-downloaded-emulators-on-linux) section of this guide for more details.
|
||||
|
||||
After the emulator has been installed you are ready to add some games. There are two ways to play games using PICO-8, either to add them to ES-DE as for any other system, or using the built-in Splore tool to explore and run games all through the PICO-8 user interface.
|
||||
|
||||
For the first approach you can download games from the [PICO-8 forum](https://www.lexaloffle.com/bbs/?cat=7) and these are quite uniquely distributed as .png images. You just download these and place them inside the ~/ROMs/pico8 directory, for example:
|
||||
```
|
||||
~/ROMs/pico8/c_e_l_e_s_t_e-0.p8.png
|
||||
~/ROMs/pico8/xzero-3.p8.png
|
||||
```
|
||||
|
||||
After this you just launch them like any regular game. You can also scrape many of these games using ScreenScraper, but you will need to refine the game names in most instances since most have filenames that the scraper service won't recognize. It's therefore recommended to run the scraper in interactive mode for these games or to scrape them one by one from the metadata editor.
|
||||
|
||||
The second alternative for playing PICO-8 games is to run Splore to browse and launch games from inside the game engine user interface. To do this, first add a dummy game file to the `ROMs/pico8` directory. It can be named anything but `splore.png` is recommended. The file content doesn't matter, it can even be an empty file. Following this, change to the alternative emulator _PICO-8 Splore (Standalone)_ for this specific entry using the metadata editor. If you now launch the file, you will be brought straight to the Splore browser inside PICO-8.
|
||||
|
||||
This is what the complete setup could look like:
|
||||
```
|
||||
~/ROMs/pico8/c_e_l_e_s_t_e-0.p8.png
|
||||
~/ROMs/pico8/splore.png
|
||||
~/ROMs/pico8/xzero-3.p8.png
|
||||
```
|
||||
|
||||
## Scraping
|
||||
|
||||
Scraping means downloading metadata and game media files (images and videos) for the games in your collection.
|
||||
|
|
@ -1758,10 +1784,6 @@ With this option enabled, there will be an overlay displayed when scrolling the
|
|||
|
||||
This enables a virtual (on-screen) keyboard that can be used at various places throughout the application to input text and numbers using a controller. The Shift and Alt keys can be toggled individually or combined to access many special characters. The general use of the virtual keyboard should hopefully be self-explanatory.
|
||||
|
||||
**Enable menu scroll indicators**
|
||||
|
||||
With this option enabled, "up and down" scroll indicators will be displayed in the upper right corner of menus (including the metadata editor and scraper) if there are more entries available than can be shown on the screen at the same time. These indicators will change dynamically as the list is scrolled. If the setting is disabled, a simplified static indicator will be displayed instead.
|
||||
|
||||
**Enable toggle favorites button**
|
||||
|
||||
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.
|
||||
|
|
@ -2558,6 +2580,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
|
||||
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST | Yes | |
|
||||
| pcfx | NEC PC-FX | Beetle PC-FX | | | |
|
||||
| pico8 | PICO-8 Fantasy Console | PICO-8 **(Standalone)** | PICO-8 Splore **(Standalone)** | No | See the specific _PICO-8_ section elsewhere in this guide |
|
||||
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
|
||||
| ports | Ports | N/A | | No | Shortcut in root folder or shell/batch script in separate folder (possibly combined with game data) |
|
||||
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW],<br>PCSX2 Qt **(Standalone)** [W*],<br>PCSX2 wxWidgets **(Standalone)** [W*],<br>Play! **(Standalone)** [UMW*],<br>AetherSX2 **(Standalone)** [M] | Yes (No for Play!) | |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ EmulationStation Desktop Edition (ES-DE) - Portable installation on Windows
|
|||
---------------------------------------------------------------------------
|
||||
|
||||
ES-DE release:
|
||||
1.2.4
|
||||
1.2.5
|
||||
|
||||
Instructions:
|
||||
|
||||
|
|
@ -43,6 +43,7 @@ Emulators\mupen64plus\mupen64plus-ui-console.exe
|
|||
Emulators\PCSX2\pcsx2.exe
|
||||
Emulators\PCSX2-Qt\pcsx2-qtx64.exe
|
||||
Emulators\PCSX2-wxWidgets\pcsx2x64.exe
|
||||
Emulators\PICO-8\pico8.exe
|
||||
Emulators\Play\Play.exe
|
||||
Emulators\PPSSPP\PPSSPPWindows64.exe
|
||||
Emulators\redream\redream.exe
|
||||
|
|
|
|||
Loading…
Reference in a new issue