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
ef80d31746
commit
141d415598
|
|
@ -20,6 +20,7 @@
|
|||
* Added an entry to the Utilities menu for rescanning the ROM directory
|
||||
* Added an entry to the Utilities menu for creating/updating the game system directories
|
||||
* Added support for a %PRECOMMAND% launch command variable (useful for launching emulators via Wine or Proton)
|
||||
* Added support for placing images in a "custom" folder in the downloaded_media directory and view these using the media viewer
|
||||
* Enabled the setting "Show hidden files and folders" to be changed without requiring an application restart
|
||||
* Enabled the setting "Show hidden games" to be changed without requiring an application restart
|
||||
* Enabled the setting "Only show ROMs from gamelist.xml files" to be changed without requiring an application restart
|
||||
|
|
@ -28,10 +29,12 @@
|
|||
* Added support for the Acorn Archimedes (archimedes) game system
|
||||
* Added support for the Bit Corporation Gamate (gamate) game system
|
||||
* Added support for the Sega NAOMI 2 (naomi2) game system
|
||||
* Added support for the PC Arcade Systems (pcarcade) game system
|
||||
* Added support for the Commodore Plus/4 (plus4) game system
|
||||
* Added support for the Sega Titan Video Game System (stv) game system
|
||||
* Added support for the Funtech Super A'Can (supracan) game system
|
||||
* Added support for the Namco-Sega-Nintendo Triforce (triforce) game system
|
||||
* Added support for the Taito Type X (type-x) game system
|
||||
* Added support for the Microsoft Windows 3.x (windows3x) game system
|
||||
* Added support for the Microsoft Windows 9x (windows9x) game system
|
||||
* Removed support for the MAME4ALL (mame-mame4all) system
|
||||
|
|
@ -43,6 +46,7 @@
|
|||
* Added QUASI88 standalone as an alternative emulator for the pc88 system
|
||||
* Added the .88d, .cmt and .t88 file extensions to the pc88 system
|
||||
* Removed the .7z and .zip file extensions from the pc88 system
|
||||
* Removed the .cdi, .cue, .gdi, .m3u and .iso file extensions from the atomiswave, naomi and naomigd systems
|
||||
* (Linux) Added support for the Microsoft Xbox 360 (xbox360) game system by running xenia via Wine and Proton
|
||||
* (Linux) Added support for the Atari Jaguar CD (atarijaguarcd) game system by running BigPEmu via Wine and Proton
|
||||
* (Linux) Added BigPEmu Wine and BigPEmu Proton as alternative emulators for the atarijaguar system
|
||||
|
|
@ -89,7 +93,7 @@
|
|||
* Added "iterationCount" and "onIterationsDone" properties to the video element
|
||||
* Changed the "path" property for the video element to consider the set value even if it points to a non-existing file
|
||||
* Made it possible to set the defaultImage property for the carousel and grid elements using variables
|
||||
* Added theme support for the "manual" metadata type for the text element
|
||||
* Added theme support for the "manual", "physicalName" and "physicalNameExtension" metadata types for the text element
|
||||
* Added support for binding multiple texture units for use in the shaders
|
||||
* Added the device serial number to the es_log.txt entries when adding or removing controllers
|
||||
* Changed the application updater to not use the scraper's transfer and connection timeout settings
|
||||
|
|
|
|||
|
|
@ -2502,6 +2502,8 @@ Properties:
|
|||
- `controller` - The controller for the game. Will be blank if none has been selected.
|
||||
- `altemulator` - The alternative emulator for the game. Will be blank if none has been selected.
|
||||
- `emulator` - The emulator used to launch the game, could as such be a per-game alternative emulator entry, a system wide alternative emulator entry or the system's default emulator. This requires that the command tag in es_systems.xml has a label defined, otherwise this value will be blank. Folders will always have blank values as these can't be launched directly.
|
||||
- `physicalName` - The physical name of the game file or folder, excluding its extension. Note that for folders with dots in their names any text after the last dot will get removed. Although this is not technically correct as folders can't have extensions, it makes the name appear consistent if the _directories interpreted as files_ functionality has been used.
|
||||
- `physicalNameExtension` - The physical name of the game file or folder, including its extension.
|
||||
- `systemName` - The short system name of the game.
|
||||
- `systemFullname` - The full system name of the game.
|
||||
- `sourceSystemName` - The source short system name of the game. For regular systems this value will be identical to `systemName` but for collections it will show the actual system that the game is located in instead of the collection system name.
|
||||
|
|
|
|||
|
|
@ -1172,7 +1172,7 @@ These systems are generally straightforward to setup. For regular Atari Jaguar g
|
|||
|
||||
The only emulator that can run Atari Jaguar CD games is [BigPEmu](https://www.richwhitehouse.com/jaguar/) and while it's officially only available for the Windows operating system it's still possible to run it on Linux. To accomplish this you need to run it via the Wine (or Proton) translation layer.
|
||||
|
||||
How to setup Wine is covered [here](USERGUIDE-DEV.md#running-windows-emulators-on-linux-using-wine-or-proton).
|
||||
How to setup Wine is covered in the [Running Windows emulators on Linux using Wine or Proton](USERGUIDE-DEV.md#running-windows-emulators-on-linux-using-wine-or-proton) section.
|
||||
|
||||
Once Wine or Proton has been setup, download BigPEmu and unzip it into `~/Applications/BigPEmu` \
|
||||
You should now have something similar to this on your filesystem:
|
||||
|
|
@ -1644,7 +1644,7 @@ _Note that xenia does not seem to run on the Steam Deck using the approach descr
|
|||
|
||||
Although xenia is officially only available for the Windows operating system it's still possible to run it on Linux. To accomplish this you need to run it via the Wine (or Proton) translation layer.
|
||||
|
||||
How to setup Wine is covered [here](USERGUIDE-DEV.md#running-windows-emulators-on-linux-using-wine-or-proton).
|
||||
How to setup Wine is covered in the [Running Windows emulators on Linux using Wine or Proton](USERGUIDE-DEV.md#running-windows-emulators-on-linux-using-wine-or-proton) section.
|
||||
|
||||
Once Wine or Proton has been setup, download xenia and unzip it into `~/Applications/xenia`. Also create an empty file named `portable.txt` inside this directory. You should now have something similar to this on your filesystem:
|
||||
```
|
||||
|
|
@ -1793,7 +1793,7 @@ For this guide it's assumed that you have purchased the emulator via Steam. ES-D
|
|||
|
||||
As 3dSen is a Windows-only emulator you'll need Wine (or Proton) to run it.
|
||||
|
||||
How to setup Wine is covered [here](USERGUIDE-DEV.md#running-windows-emulators-on-linux-using-wine-or-proton).
|
||||
How to setup Wine is covered in the [Running Windows emulators on Linux using Wine or Proton](USERGUIDE-DEV.md#running-windows-emulators-on-linux-using-wine-or-proton) section.
|
||||
|
||||
Once Wine or Proton has been setup, move or copy all 3dSen files to `~/Applications/3dSen`
|
||||
|
||||
|
|
@ -2353,6 +2353,7 @@ The media directories per game system are:
|
|||
* 3dboxes
|
||||
* backcovers
|
||||
* covers
|
||||
* custom
|
||||
* fanart
|
||||
* manuals
|
||||
* marquees
|
||||
|
|
@ -2364,6 +2365,8 @@ The media directories per game system are:
|
|||
|
||||
The miximages are generated by ES-DE. Normally that takes place automatically when scraping, but in this example of manually copying existing media files, the miximage offline generator should be used instead. This tool can generate the miximages for the complete game collection in one go. How that works is explained elsewhere in this guide.
|
||||
|
||||
The `custom` directory is not created automatically, it's an optional folder where it's possible to place an image per game that can be viewed as the last entry in the media viewer. It's intended for things like diagrams of game controller mappings that you may want to consult before starting a game. These files have to be saved with the .jpg or .png extension and they follow the same naming logic as all other media files.
|
||||
|
||||
The media files must correspond exactly to the game files. Take for example this game:
|
||||
|
||||
```
|
||||
|
|
@ -3321,7 +3324,9 @@ The game media viewer displays videos, images and PDF manuals in fullscreen mode
|
|||
|
||||
If a game video is available, then this will be played automatically when launching the viewer. The _left_ and _right_ buttons are used to navigate betweeen media files one at a time, and the trigger buttons can be used to jump to the first and last entries. By default the video will continue to play when browsing the images, but this can be changed with a setting as described earlier in this document.
|
||||
|
||||
The following media can be displayed: _video, box cover, box back cover, title screen, screenshot_, _fan art_ and _miximage_.
|
||||
The following media can be displayed: _video, box cover, box back cover, title screen, screenshot, fan art, miximage_ and _custom_.
|
||||
|
||||
The _custom_ image is not scraped, but can be manually added to the downloaded_media directory. This is useful for diagrams of game controller mappings and similar.
|
||||
|
||||
If the game has a downloaded PDF manual then you can view it by pressing the _up_ button which will change the media viewer to PDF viewing mode. To get back to displaying videos and images when in this mode, press the _down_ button. When in PDF viewing mode it's possible to zoom in and out using the shoulder buttons. When zoomed in, the left, right, up and down buttons will pan the view. So in order to re-enable page navigation either zoom out completely or reset the view by pressing the left or right trigger button.
|
||||
|
||||
|
|
@ -3575,6 +3580,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| pc | IBM PC | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** | No | See the specific _DOS / PC_ section elsewhere in this guide |
|
||||
| pc88 | NEC PC-8800 Series | QUASI88 | QUASI88 **(Standalone)** | Yes | |
|
||||
| pc98 | NEC PC-9800 Series | Neko Project II Kai | Neko Project II | | |
|
||||
| pcarcade | PC Arcade Systems | Wine **(Standalone)** [U],<br>_Shortcut or script_ [MW] | Proton **(Standalone)** [U],<br>_AppImage_ [U],<br>_Shortcut or script_ [U] | No | |
|
||||
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [UW],<br>ares **(Standalone)** | No | Single archive or ROM file |
|
||||
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [UW],<br>ares **(Standalone)** | Yes | |
|
||||
| pcfx | NEC PC-FX | Beetle PC-FX | Mednafen **(Standalone)** | Yes | |
|
||||
|
|
@ -3624,6 +3630,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| to8 | Thomson TO8 | Theodore | | | |
|
||||
| triforce | Namco-Sega-Nintendo Triforce | Triforce **(Standalone)** [UW] | | No | |
|
||||
| trs-80 | Tandy TRS-80 | sdl2trs DOS Diskette **(Standalone)** [UW] | sdl2trs Bootable Diskette **(Standalone)** [UW],<br>sdl2trs CMD File **(Standalone)** [UW] | Yes | See the specific _Tandy TRS-80_ section elsewhere in this guide |
|
||||
| type-x | Taito Type X | Wine **(Standalone)** [U],<br>_Shortcut or script_ [MW] | Proton **(Standalone)** [U],<br>_AppImage_ [U],<br>_Shortcut or script_ [U] | No | |
|
||||
| uzebox | Uzebox Open Source Console | Uzem | | | |
|
||||
| vectrex | Smith Engineering Vectrex | vecx | | No | |
|
||||
| vic20 | Commodore VIC-20 | VICE xvic | VICE xvic **(Standalone)** | No | Single archive or tape, cartridge or diskette image file |
|
||||
|
|
|
|||
Loading…
Reference in a new issue