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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2023-02-12 23:13:48 +01:00
parent a2183b9743
commit 7cad629240
4 changed files with 27 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -203,8 +203,10 @@ Overall application speed and performance has been greatly improved with faster
* Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack * Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack
* Reduced CPU usage significantly by only rendering the necessary systems in SystemView * Reduced CPU usage significantly by only rendering the necessary systems in SystemView
* Added support for dimming components (fade to black) * Added support for dimming components (fade to black)
* Added logging of the display refresh rate on startup
* Added support for rotating the application screen contents 0, 90, 180 or 270 degrees * Added support for rotating the application screen contents 0, 90, 180 or 270 degrees
* Added support for offsetting the screen contents within the application window
* Added support for running the application at a lower resolution in padded fullscreen mode
* Added logging of the display refresh rate on startup
* Made many improvements to GUI sizing and positioning when running in vertical screen resolutions * Made many improvements to GUI sizing and positioning when running in vertical screen resolutions
* The application startup can now be aborted via an OS signal or using the configured keyboard quit shortcut * The application startup can now be aborted via an OS signal or using the configured keyboard quit shortcut
* Improved the behavior and consistency for the virtual keyboard when using non-standard keyboard mappings * Improved the behavior and consistency for the virtual keyboard when using non-standard keyboard mappings

2
CONTRIBUTING.md
View file

@ -68,7 +68,7 @@ The roadmap is under constant review so expect it to change from time to time. S
* New theme engine with generalized views (only System and Gamelist) and theme variants support * New theme engine with generalized views (only System and Gamelist) and theme variants support
* Multiple new components (carousel support for the Gamelist view, grid component etc.) * Multiple new components (carousel support for the Gamelist view, grid component etc.)
* Support for Tate mode, i.e. portrait orientation for arcade cabinets and similar * Support for Tate mode, i.e. vertical screen orientation for arcade cabinets and similar
* Lottie animation (vector graphics) and GIF animation support * Lottie animation (vector graphics) and GIF animation support
* OpenGL ES 3.0 renderer for use on the Raspberry Pi * OpenGL ES 3.0 renderer for use on the Raspberry Pi
* Replace the OpenGL fixed function pipeline renderer with a shader-based renderer * Replace the OpenGL fixed function pipeline renderer with a shader-based renderer

43
INSTALL-DEV.md
View file

@ -1057,33 +1057,34 @@ The input configuration is described in the [User guide](USERGUIDE-DEV.md#input-
You can use **--help** or **-h** to view the list of command line options, as shown here. You can use **--help** or **-h** to view the list of command line options, as shown here.
``` ```
--display [1 to 4] Display/monitor to use --display [1 to 4] Display/monitor to use
--resolution [width] [height] Application resolution --resolution [width] [height] Application resolution
--screenrotate [0, 90, 180 or 270] Rotate screen contents within application window --screenoffset [horiz.] [vert.] Offset screen contents within application window
--vsync [1/on or 0/off] Turn VSync on or off (default is on) --screenrotate [0, 90, 180 or 270] Rotate screen contents within application window
--max-vram [size] Max VRAM to use (in mebibytes) before swapping --fullscreen-padding [1/on or 0/off] Padding if --resolution is lower than display resolution
--anti-aliasing [0, 2 or 4] Set MSAA anti-aliasing to disabled, 2x or 4x --vsync [1/on or 0/off] Turn VSync on or off (default is on)
--no-splash Don't show the splash screen during startup --max-vram [size] Max VRAM to use (in mebibytes) before swapping
--gamelist-only Skip automatic game ROM search, only read from gamelist.xml --no-splash Don't show the splash screen during startup
--ignore-gamelist Ignore the gamelist.xml files (useful for troubleshooting) --gamelist-only Skip automatic game ROM search, only read from gamelist.xml
--show-hidden-files Show hidden files and folders --ignore-gamelist Ignore the gamelist.xml files
--show-hidden-games Show hidden games --show-hidden-files Show hidden files and folders
--force-full Force the UI mode to Full --show-hidden-games Show hidden games
--force-kiosk Force the UI mode to Kiosk --force-full Force the UI mode to Full
--force-kid Force the UI mode to Kid --force-kiosk Force the UI mode to Kiosk
--force-input-config Force configuration of input devices --force-kid Force the UI mode to Kid
--create-system-dirs Create game system directories --force-input-config Force configuration of input devices
--home [path] Directory to use as home path --create-system-dirs Create game system directories
--debug Print debug information --home [path] Directory to use as home path
--version, -v Display version information --debug Print debug information
--help, -h Summon a sentient, angry tuba --version, -v Display version information
--help, -h Summon a sentient, angry tuba
``` ```
_The --anti-aliasing option is not available if ES-DE is built using the OpenGL ES renderer._ _The --anti-aliasing option is not available if ES-DE is built using the OpenGL ES renderer._
As you can see above, you can override the home directory path using the `--home` flag. So by running for instance the command `emulationstation --home ~/games/emulation`, ES-DE will use `~/games/emulation/.emulationstation` as its application home directory. Be aware that this option completely replaces what is considered the home directory, meaning the default ROM directory ~/ROMs would be resolved to ~/games/emulation/ROMs. The same is true for the emulator core locations if es_find_rules.xml is configured to look for them relative to the home directory. So of course RetroArch and other emulators would also need to be configured to use ~/games/emulation as its base directory in this instance. As you can see above, you can override the home directory path using the `--home` flag. So by running for instance the command `emulationstation --home ~/games/emulation`, ES-DE will use `~/games/emulation/.emulationstation` as its application home directory. Be aware that this option completely replaces what is considered the home directory, meaning the default ROM directory ~/ROMs would be resolved to ~/games/emulation/ROMs. The same is true for the emulator core locations if es_find_rules.xml is configured to look for them relative to the home directory. So of course RetroArch and other emulators would also need to be configured to use ~/games/emulation as its base directory in this instance.
Setting the resolution to a lower or higher value than the display resolution will add a border to the application window. Setting --resolution to a lower or higher value than the display resolution will add a border to the application window. The exception is if defining a lower resolution than the display resolution in combination with the --fullscreen-padding flag as this will pad the screen contents on a black background. This can be combined with the --screenoffset option for exact positioning on displays where bezels or similar may obstruct part of the viewable area.
Running with the --create-system-dirs option will generate all the game system directories in the ROMs folder. This is equivalent to starting ES-DE with no game ROMs present and pressing the _Create directories_ button. Detailed output for the directory creation will be available in es_log.txt and the application will quit immediately after the directories have been created. Running with the --create-system-dirs option will generate all the game system directories in the ROMs folder. This is equivalent to starting ES-DE with no game ROMs present and pressing the _Create directories_ button. Detailed output for the directory creation will be available in es_log.txt and the application will quit immediately after the directories have been created.

2
USERGUIDE-DEV.md
View file

@ -2216,7 +2216,7 @@ Multiple languages are supported by ScreenScraper, and this affects translations
**Automatic retries on error** **Automatic retries on error**
How many times to automatically retry scraping if an error is encountered, from 1 to 10 tries. How many times to automatically retry scraping if an error is encountered, from 0 to 10.
**Retry attempt timer** **Retry attempt timer**