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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-06-28 23:07:26 +02:00
parent b847b15e07
commit f3fee630e8
3 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CHANGELOG.md
View file

@ -6,10 +6,13 @@
### Detailed list of changes
* Added support for changing between light and dark color schemes for the menu system
* Added an option to scrape game manuals using ScreenScraper
* Added a PDF game manual viewer, accessible from the media viewer
* Added an option to scrape game manuals using ScreenScraper
* Added a separate es-pdf-convert binary to render PDF pages using Poppler (needed due to the restrictive GPL license for this library)
* Added help prompts to the media viewer
* Added trigger button support to the media viewer for jumping to the first and last entries
* Added trigger button support to the theme downloader screenshot viewer for jumping to the first and last entries
* Added support for changing between light and dark color schemes for the menu system
* Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions
* Added support for a dedicated es_systems_sorting.xml file to change systems sorting without having to modify es_systems.xml
* Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file
@ -23,6 +26,7 @@
* Removed the custom SDL patch for the Linux AppImage builds that prevented the device virtual keyboard from being automatically displayed
* If the SDL library release is higher than 2.28.0, then the automatic popup of the device's virtual keyboard is now disabled
* The SDL library version is now printed to es_log.txt on application startup
* (Windows) A check is now performed on startup that OpenGL is actually supported by the GPU driver, to avoid crashes if it isn't
* Added a setRawImage function to ImageComponent to load raw pixel data into textures (needed by PDFViewer)
* Added the Poppler PDF rendering library as a dependency
* Updated FFmpeg to 6.0, FreeType to 2.13.0, libgit2 to 1.6.4 and pugixml to 1.13 on Windows and macOS
@ -34,6 +38,7 @@
### Bug fixes
* (Windows) The log output time stamp was missing in es_log.txt when built using MinGW
* The scraper auto-retry functionality was triggered when scraping manually
* TextureResource::initFromPixels() was not setting the source size correctly

4
INSTALL-DEV.md
View file

@ -550,10 +550,6 @@ Running `make -j6` (or whatever number of parallel jobs you prefer) speeds up th
Running ES-DE from the build directory may be a bit flaky as there is no Info.plist file available which is required for setting the proper window mode and such. It's therefore recommended to run the application from the installation directory for any more in-depth testing. But normal debugging can of course be done from the build directory.
**Building for the M1 (ARM) processor**
The build steps detailed above should in theory work identically on an M1 processor but possibly some of the dependencies will not build correctly and may need manual patching. Cross-compiling using an Intel processor has been attempted but failed due to multiple issues with dependencies refusing to build.
**Code signing**
Due to the Apple notarization requirement implemented as of macOS 10.14.5 a build with simple code signing is needed for versions up to 10.13 and another build with both code signing and notarization is required for version 10.14 and higher.

14
USERGUIDE-DEV.md
View file

@ -2396,6 +2396,10 @@ Activates or deactivates the built-in help system that provides contextual infor
Settings for the media viewer that is accessible from the gamelist views.
**Help prompts**
Controls positioning of the navigation help prompts. The available options are _top_, _bottom_ or _disabled_.
**Keep videos running when viewing images**
With this option enabled, the video will continue to run when viewing the images for the game. If disabling this setting, the video will stop immediately when browsing to the first image, and it will restart when navigating back to the video.
@ -2918,16 +2922,16 @@ This will remove the actual game file, its gamelist.xml entry, its entry in any
The game media viewer displays videos, images and PDF manuals in fullscreen mode and is launched from the gamelist view by pressing the _X_ button.
If a game video is available, this will be played automatically when launching the viewer. The _left_ and _right_ buttons are used to navigate betweeen the game media files. 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.
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 media viewer can display the following media: _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_ and _miximage_.
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 viewing PDF manuals you navigate the pages with the _left_ and _right_ buttons and you can also jump to the first and last page using the trigger buttons.
The other settings for the media viewer are similar to what is available for the screensavers; the audio can be enabled or disabled, the video can be stretched to fill the entire screen and scanlines and blur can be rendered on top of it. For screenshots and title screens, scanlines can be rendered. All these options are configurable via the _UI Settings_ menu.
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. The navigation for this mode is identical to the game media mode.
Pressing any other button than those mentioned above closes the media viewer.
The settings for the media viewer are similar to what is available for the screensavers; the audio can be enabled or disabled, the video can be stretched to fill the entire screen and scanlines and blur can be rendered on top of it. For screenshots and title screens, scanline rendering can be enabled or disabled. It's also possible to change the positioning of the help prompts to the top or bottom, or to disable them entirely. All these options are configurable via the _UI Settings_ menu and are described in more detail elsewhere in this document.
## Screensaver
There are four types of screensavers built into ES-DE: **Dim**, **Black**, **Slideshow** and **Video**.