This page describes the functioning of an experimental branch of EmulationStation (ES). This branch allows ES to be run in three different UI modes: Full, Kiosk and Kid mode. These modes have ever decreasing options available, and are meant for people who want to be able to leave the carefully set up installation alone with a group of friends/kids without having to re-flash the SD card afterwards. The Full mode offers the same functionality as the vanilla ES UI. The Kiosk mode only shows items in the game-lists that are not explicitly hidden. The Kid only shows items which are explicitly selected to be kid-friendly (and excludes almost all system options).
This is in the experimental packages for a reason, backup everything you cannot afford to lose!
- Features - UI modes
- Features - Switching UI modes
- Features - Favorites
- Features - Gamelist.xml
- Features - Random game selection
- Future developments
Video Guide: https://www.youtube.com/watch?v=1BWjNp7Br9c
The ES branch is located at: https://github.com/zigurana/EmulationStation/tree/UI_modes_Kiosk_Kid_Full . It can be installed over your current installation of ES via the RetroPie-Setup script. It is located under
Experimental Packages > option 807: emulationstation-kids
To allow different levels of system 'lock-down', user modes were introduced with different sets of functionalities. These modes are Full, Kiosk and Kid. Generally speaking, kids do not need to edit system settings, nor will visiting friends. The full set of options also complicates the UI, and the kid and kiosk modes hide these when they are not needed.
Full user interface
Aka admin mode – This is the current UI, it has all the options, bells and whistles.
This mode hides most of the ui options, such as CONFIGURE INPUT, UI SETTINGS, SCRAPER, but also EDIT THIS GAMES METADATA, etc. In addition this mode also hides those entries in the gamelist which have their metadata-tag
hiddenset to true.
This mode has all the restrictions of Kiosk mode, but in addition -only- lists games which are explicitly white-listed. This can be done by setting the metadata-tag
Kid-game to true.
Switching UI modes
To switch the UI mode from Full to one of the limited modes, a new menu option was implemented under UI OPTIONS:
Switching back to the Full UI
Once you are in one of the restricted modes, the UI options (where I put the UI Mode selector), is not shown anymore. So how to return to the full UI once your in Kid/kiosk mode? Well one way, is to go to the
/home/pi/.emulationstation/es_settings.cfgfile and edit the UI_mode value manually:
<string name="UIMode" value="Full" />
Alternatively, you can use a pre-defined passkey sequence that you can enter while you are anywhere in the ES ui. The default passkey is [up,up, down, down, left, right, left, right, b, a] which some of you might recognize as the Konami cheat code from olden-times. This sequence can be changed in
es_settings.cfg if need be:
<string name="UIMode_passkey" value="uuddlrlrba" />
When succesfully entered, this will exit (and restart) ES.
This branch of ES has incorporated the pull request by Kaptainka to allow the setting of favorites in the game-list, and subsequent filtering of said list to show only the favorites. Setting a game to be a favorite can be done using the metadata editor (press select, then 'edit this games metadata', scroll down to 'favorite on/off'). If your theme allows it, you can also toggle the favorite state quickly by pressing 'x'.
So in all, three new tags have been introduced: favorites, kid game, and hidden (all boolean).
Of course, these new metadata tags are not present in the gamelists you have by default, but once you edit the metadata for a single game, they will be added for that specific system’s
gamelist.xml. If you want to edit your
gamelist.xml files in some other tools (for instance SSelphs excellent scraper), you will need to take these new tags into account.
The values can be set using the meta-data editor in the UI, or by directly editing the gamelist.xml file (make sure to exit ES first, as it will overwrite the file upon exit). https://dl.dropboxusercontent.com/u/859248/RetroPieES/metadata_resize.png
Random Game selection
The original plan was to get a random game starter that could be triggered as some sort of screensaver, and act as a stand-in for an actual attract-mode. I got it working up to the point where it is an option in the GameList Options menu (what you get when you press ‘select’ while in a game-list view): This will change the view focus to a new random game, in any of the systems that have games that are visible given the current UI mode. The implementation of the screensaver turned out to be very tricky and has been demoted to a someday-maybe project.
The visualization for these tags are NOT included in most of the current themes (which are specified by version 3). In his/her original pull request, kaptainkia suggested to increase the xml version to 4 to indicate the availability of the new favorite tag. This has been copied for the other tags as well. At least from the ES side of things, you can then keep on using the old themes, without anything breaking. You will just not be able to see the values at a glance.
If the theme supports it, the boolean status of metadata items Favorite, Hidden, and Kidgame is visualized using simple icons:
To see these changes, you will also need to update your theme(s). To make a start, I’ve updated the Carbon theme to include these new elements. You can download it here.
This theme will also allow you to toggle some values quickly using x for favorites and y for kidgames.
If you want in include this in your own theme, these are the items to add:
The corresponding images are in the folder
carbon_v4\art. Of course, the values for pos and sizes will depend on the theme.
The difference between the stock ES and this branch is rather large, with many small changes in a lot of files. Consequently, when any update occurs in the original ES branch (upstream), this might impact this branch as well. Therefore, the risk of a high maintenance burden for this branch was deemed too high to incorporate it into the RetroPie branch proper. Kid Mode ES will remain in the experimental packages menu, where it is available for users who wish to test it out.
For the foreseeable future this ES version will be maintained by https://github.com/zigurana, merging in all relevant changes when they occur (or when someone alerts him to it).
- Aloshi, of course.
- The RetroPie team: Buzz, Herb, Floob, for bringing this to the masses.
- Kaptainka, for the initial implementation of favorites in ES.
- Gizmo98, for creating the module in the RetroPie-setup script.
- The beta-testers who went bug hunting and helped make this better. See here for the original forum thread.