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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-05-19 00:01:11 +02:00
parent 6a0b1bad5b
commit 963ee0a465
3 changed files with 25 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -97,6 +97,7 @@
* Changed all occurances of "GameList" to "Gamelist" throughout the codebase
* Removed a huge amount of unnecessary Window* function parameters throughout the codebase
* Removed a lot of unnecessary applyTheme() calls when updating help prompts
* Removed the last remnants of the PowerSaver
* Changed the opacity data type and functions from unsigned char to float throughout the codebase
* Refactored the six gamelist classes into two new classes; GamelistBase and GamelistView
* Rewrote the gamelist logic to handle an arbitrary amount of components per type and split the legacy code into a separate file
@ -163,6 +164,7 @@ v1.2 maintenance release.
* Added a new pcwindows platform for scraping PC (Windows) games
* Changed the platform to pcwindows for the epic system
* Enabled screensaver controls when running in Kid UI mode
* Added custom event script triggers on application startup, screensaver start and screensaver end
* Added a --create-systemdirs command line option to generate the game system directories
* Added an Xbox Kinect controller badge icon
* (macOS) Categorized the application as a game so it shows up in the Launchpad games section
@ -180,6 +182,7 @@ v1.2 maintenance release.
* The "Jump to.." quick selector didn't work correctly with multi-byte Unicode characters
* All games were included in the video and slideshow screeensavers when in Kid UI mode
* The game-end event was triggered immediately on game launch if running in the background
* The "quit" custom event script trigger was not executed when quitting the application using the quit key combo
* (Linux) Flatpak directories were missing for user installations of the standalone emulators BlastEm, Play! and Snes9x
* (Windows) Fixed an issue where symlinking game media directories would crash the application
* (Windows) Scripts and links executed using cmd.exe could not contain the special characters &()^=;,

2
FAQ.md
View file

@ -42,7 +42,7 @@ ES-DE acts strictly as a frontend, it does not interfere with the emulator confi
## On game launch the screen just flashes black and the game won't start, how do I solve this?
This is almost always caused by missing emulator BIOS files which have to be installed separately from ES-DE. See the previous question.
This is almost always caused by either corrupt ROMs/disc images or by missing emulator BIOS files (which have to be installed separately from ES-DE).
## How do I exit back from the emulators to ES-DE?

25
INSTALL-DEV.md
View file

@ -1819,17 +1819,34 @@ Just make sure to not place the portable installation on a network share that us
## Custom event scripts
There are numerous locations throughout ES-DE where custom scripts will be executed if the option to do so has been enabled in the settings. You'll find the option on the Main menu under `Other settings`. By default it's deactivated so be sure to enable it to use this feature.
There are numerous locations throughout ES-DE where custom scripts will be executed if the option to do so has been enabled in the settings. You'll find the option on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files.
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files. There are up to four parameters that will be passed to these scripts, as detailed below:
| Event | Parameters* | Description |
| :----------------------- | :------------------------------------------------- | :-------------------------------------------------------------------------- |
| startup | | Application startup |
| quit | | Application quit/shutdown |
| reboot | | System reboot (quit event triggered as well) |
| poweroff | | System power off (quit event triggered as well) |
| config-changed | | On saving application settings or controller configuration |
| settings-changed | | On saving application settings (config-changed event triggered as well) |
| controls-changed | | On saving controller configuration (config-changed event triggered as well) |
| theme-changed | New theme name, old theme name | When manually changing theme sets in the UI Settings menu |
| game-start | ROM path, game name, system name, system full name | On game launch |
| game-end | ROM path, game name, system name, system full name | On game end (or on application wakeup if running in the background) |
| screensaver-start | _timer_ or _manual_ | Screensaver started via timer or manually |
| screensaver-end | _cancel_ or _game-jump_ or _game-start_ | Screensaver ends via cancellation, jump to game or start/launch of game |
***)** Parameters in _italics_ are literal strings.
We'll go through two examples:
* Creating a log file that will record the start and end time for each game we play, letting us see how much time we spend on retro-gaming
* Changing the system resolution when launching and returning from a game in order to run the emulator at a lower resolution than ES-DE
The following examples are for Unix systems, but it works the same way on macOS (which is also Unix after all), and on Windows (although .bat batch files are then used instead of shell scripts and any spaces in the parameters are not escaped as is the case on Unix).
The following examples are for Unix systems, but it works the same way on macOS and Windows (although .bat batch files are used on Windows instead of shell scripts and any spaces in the parameters are not escaped as is the case on Unix and macOS).
The events executed when a game starts and ends are named `game-start` and `game-end` respectively. Finding these event names is easily achieved by starting ES-DE with the `--debug` flag. If this is done, all attempts to execute custom event scripts will be logged to es_log.txt, including the event names.
As can be seen in the table above, the events executed when a game starts and ends are named _game-start_ and _game-end_
So let's create the folders for these events in the scripts directory. The location is `~/.emulationstation/scripts`