Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
menu_tree [2021/12/26 00:56] – moved slideshow settings here (to be updated) atarimenu_tree [2023/12/22 13:52] (current) – [SCRAPE] Note use of screenscraper username vs. email maximumentropy
Line 7: Line 7:
 </WRAP> </WRAP>
  
-===== Main Menu Tree ===== +The **MAIN MENU** in Batocera can be opened from any list in EmulationStation by pressing ''[START]''.
-This is the one you access by pressing ''[START]'' in any list.+
  
-==== Kodi Media Center ==== +===== KODI MEDIA CENTER ===== 
-Start [[Kodi]] out of the menu if supported by your system.+Launch [[:kodi|Kodi Media Center]] (Kodi is disabled on some weaker devices).
  
-==== Retroachievements ==== +This can be disabled in the **SYSTEM SETTINGS** -> **KODI SETTINGS** menu.
-Show your [[:retroachievements_settings|RetroAchievements]] progress if you have enabled it from the **Games Settings** menu.+
  
-  * **RETROACHIEVEMENTS** {{:switch-button.png?20|}}   +===== RETROACHIEVEMENTS ===== 
-  * **HARDCORE MODE** {{:switch-button.png?20|}} with this mode on, special Libretro features like rewind, fast forward or cheat codes are disabled. Very much the real "console" experience, for hardcore fans. +Shows all the [[:retroachievements_settings|RetroAchievements]] you have for the games which you've played.
-  * **LEADERBOARDS** {{:switch-button.png?20|}} some games keep a ranking of all RetroAchievements players. Compete with the best players on the Internet! +
-  * **VERBOSE MODE** {{:switch-button.png?20|}} when you unlock an achievement, get details about the achievement you have unlocked, with a cute little badge in the upper left corner of your screen. +
-  * **AUTOMATIC SCREENSHOT** {{:switch-button.png?20|}} do you want to keep a screenshot of the moment you unlocked a RetroAchievement? They are stored in the Batocera screenshot directory. +
-  * **UNLOCK SOUND** if you want to play a sound, like the classic PS3 or Xbox360 success unlock sound. You have a selection of retrogaming-oriented sounds, but you can also add your own unlock sounds in ''/userdata/sounds/retroachievements/'' as long as they are in the **.ogg** format. +
-  * **USERNAME** and **PASSWORD** are the ones you have set up on [[https://www.retroachievements.org|the RetroAchievements website]]. +
-  * **SHOW IN MAIN MENU** {{:switch-button.png?20|}} if you want a shortcut to the RetroAchievement screen from the main menu (see the screenshot below) +
-  * **FIND ALL/NEW GAMES** in order to show a little icon in the Batocera menu for the games that have RetroAchievements, you have to use this option to calculate the MD5 checksums of your ROM files and make sure they match what [[https://www.retroachievements.org|the RetroAchievements database]] is expecting. You can do that for all games in your library, or games that haven't been indexed yet.+
  
-==== Games Settings ==== +Greyed out ones are currently not present on your system. The appearance of this menu can be toggled in the **GAME SETINGS** menu.
-The global settings that apply by default to all games. +
-  * //Tools// +
-  * **Update Games Lists** Choosing this option will perform a scan of your game folders and refresh the list of available games accordingly. +
-  * //Default Settings// +
-  * **Game Ratio** Set the aspect ratio used by the games. If not using Auto, Core Provided is recommended. Square Pixel will render pixels aligned to your screen, but is not recommended as most systems did not have perfectly square pixels with their displays. +
-  * **Video Mode** The output resolution sent to your display. This is (usually) independent of the emulated system's rendering resolution. +
-  * **Smooth Games** Enables [[emulationstation:shaders_set|bilinear filtering]] or the equivalent of that in the emulator. Not available on all emulators. Automatically disabled if the rendering resolution is set to the video mode resolution. +
-  * **Rewind** Lets you use the ''[HOTKEY]''+''[D-pad Left]'' shortcut to rewind time during a game. See other commands at [[:basic_commands|Hotkey shortcuts]]. +
-  * **Auto Save/Load** When enabled, will do a save state when quitting a game, and load it when starting it back, letting anyone quit and start a game without losing progress. +
-  * **Shaders Set** This is used to select a preset shader set for games. See [[emulationstation:shaders_set|Shader Sets]] for more info. +
-  * **Integer Scale (Pixel Perfect)** Older games are ordinarily expanded to fit a bigger screen, however, the pixel geometry may be warped if the image is scaled by a value that is not an integer. This forces the games to be scaled only by an integer factor, it will appear smaller on the display as a result (unless the display is exactly a multiple of the original resolution of the game). See [[anti-aliasing|Anti-aliasing]] for more. FIXME (change to relevant header when added in the future) +
-  * **Decoration** You can choose which bezel collections to use with this setting, Auto will use a per-system bezel. See [[:decoration|Decorations (and The Bezel Project)]] for more information. +
-  * **Stretch Bezels (4K & Ultrawide)** Overlays are typically designed for 16/9 1080p monitors. If your screen uses a higher resolution or a different aspect ratio, this option can be used to make the bezel correctly fit the screen. See [[:display_issues|Display Issues]] for more info. +
-  * **Latency Reduction** Enables run-ahead in libretro cores. See [[:run-ahead|Run-ahead input-lag reduction]] for more info. +
-  * **AI Game Translation** A menu used to set up the AI Translation. See [[:ai_game_translation|AI game translation]] for more info. +
-  * **Per System Advanced Configuration** This will let you set up most system specific configurations, refer to the system's page in [[systems]] for info on each particular system's settings. If you have games settings and system specific settings conflicting, the game-specific one will take priority. +
-  * //System Settings// +
-  * **RetroAchievements Settings** This submenu is used to set up RetroAchievements. See [[:retroachievements_settings|RetroAchievements]] for more information. +
-  * **Netplay** This submenu is used to set up netplay. See [[:netplay|Netplay]] for more information. +
-  * **Missing BIOS** Will list every missing BIOS. See [[:add_games_bios|BIOS files and how to add them]]. +
-  * **Check BIOSes before running a game {{::switch-multioption.png?20|}}** : When launching a game on a system requiring BIOSes, you can either tell batocera to warn you about missing ones, or not.+
  
-==== Controllers Settings ====+===== GAME SETTINGS ===== 
 +The global settings that apply if there are no per-system, per-folder or per-game settings. 
 + 
 +==== UPDATE GAMELISTS ==== 
 +Choosing this option will perform a scan of your game folders and refresh the list of available games accordingly. 
 + 
 +**//DEFAULT GLOBAL SETTINGS//** 
 + 
 +==== VIDEO MODE ==== 
 +Force the emulator to run at this resolution. 
 + 
 +This is the final output resolution sent to your display, as Batocera runs all emulators in full-screen. This is independent of the rendering resolution, which is an emulator-specific setting which changes the resolution of the game itself. Emulators will (usually) provide the ability to run with integer scaling or alternative aspect ratios so altering this setting for adjusting the geometry purposes is not required. 
 + 
 +==== GAME ASPECT RATIO ==== 
 +Force the game to render in this aspect ratio. This setting does not change the final output resolution. 
 + 
 +If not using the AUTO setting, CORE PROVIDED is recommended. SQUARE PIXEL will render pixels with the same geometry as the pixels on your screen, but is not recommended as most systems did not have perfectly square pixels with their displays. 
 + 
 +==== GAME RENDERING & SHADERS ==== 
 +=== SHADER SET === 
 +This is used to select a preset shader set for games. 
 + 
 +See [[emulationstation:shaders_set|the shader sets page]] for more info. 
 + 
 +=== SMOOTH GAMES (BILINEAR FILTERING) === 
 +Enables [[emulationstation:shaders_set|bilinear filtering]] or the equivalent of that in the emulator. 
 + 
 +Not available on all emulators. Automatically disabled if the rendering resolution is set to the video mode resolution, or if a shader set is being used. 
 + 
 +=== INTEGER SCALING (PIXEL PERFECT) === 
 +Only increase the image size in integer multiples. 
 + 
 +Retro games ran at a low resolution (typically 640x480 or 320x240), these are ordinarily expanded to fit a bigger screen. During this process, the pixel geometry may be warped if the image is scaled by a value that is not an integer. This forces the games to be scaled only by an integer multiple, using the largest integer multiple that does not cut off content of the screen. This may result in a black border around the image (unless the display is exactly a multiple of the original resolution of the game). See [[anti-aliasing|Anti-aliasing]] for more. 
 + 
 +==== DECORATIONS ==== 
 +Select which decoration set to use and alter the objects drawn on top of it. 
 + 
 +Decorations fill up the blank space resulting from using a thinner aspect ratio on a wider display. See [[:decoration|Decorations (and The Bezel Project)]] for more information. 
 + 
 +=== DECORATION SET === 
 +Choose which decoration set you'd like to use, with a little preview to go with it. 
 + 
 +AUTO will use the CONSOLE set, which has a unique decoration per system. 
 + 
 +=== STRETCH BEZELS (4K & ULTRAWIDE) === 
 +Stretch the decoration to the display's exact dimensions, potentially distorting the decoration. 
 + 
 +Overlays are typically designed for 16:9 1920x1080 monitors. If the display uses a higher resolution or a different aspect ratio, this option can be used to make the bezel correctly fit the screen. See [[:display_issues#emulation_with_4k_and_ultrawide_monitors_or_problems_when_your_screen_is_not_fully_displayed|the relevant section on the display issues page]] for more info. 
 + 
 +=== HEADS UP DISPLAY === 
 +Show context-sensitive info over the game. 
 + 
 +This utilizes MangoHUD to display in-game statistics of your machine or more information about the current game. See [[wiki:benchmarking_for_batocera#mangohud|the MangoHUD section on the benchmarking guide]] for more info. 
 + 
 +=== HEADS UP DISPLAY CORNER === 
 +Choose which corner to display the HUD in. 
 + 
 +=== SHOW TATTOO OVER BEZEL === 
 +Show an image overlaid on top of the bezel. 
 + 
 +This is what's used for the controller overlays. Unlike the HUD, this is a static image and is less resource-intensive. See [[:decoration#custom_tattoo_image_additional_overlays|the tattoo section on the decorations page]] for more info. 
 + 
 +=== TATTOO CORNER === 
 +Choose which corner to display the tattoo in. 
 + 
 +=== CUSTOM .PNG IMAGE PATH === 
 +When using the CUSTOM IMAGE option as the current tattoo, use this image. 
 + 
 +=== RESIZE TATTOO === 
 +Shrink/expand tattoo to fit within the bezel's border. {{:switch-button.png?20|}} 
 + 
 +==== AI GAME TRANSLATION ==== 
 +Connects to the internet to automatically translate the content of the current frame when activated. 
 + 
 +See [[:ai_game_translation|AI game translation]] for more info. 
 + 
 +=== ENABLE AI TRANSLATION SERVICE === 
 +During gameplay, press ''[HOTKEY]'' + ''[R1]'' to translate on-screen text. Only on libretro cores. 
 + 
 +=== TARGET LANGUAGE === 
 +The language to translate //into//. 
 + 
 +=== AI TRANSLATION SERVICE URL === 
 +Type in the preferred translation service. 
 + 
 +If none are specified, will use [[http://ztranslate.net/|ZTranslate]] by default. 
 + 
 +=== PAUSE ON TRANSLATED SCREEN === 
 +Halt the gameplay while translation is being shown. 
 + 
 +Useful for faster-paced games where text may only temporarily be shown on-screen. 
 + 
 +==== REWIND ==== 
 +Store past states to rewind to in realtime, if the core supports it. 
 + 
 +Lets you use the ''[HOTKEY]''+ D-pad left shortcut to rewind time during a game (sorry, no time-travel magic is involved, just memory states). See other commands at [[:basic_commands|the hotkey shortcuts page]]. 
 + 
 +==== LATENCY REDUCTION ==== 
 +Various options to help reduce input latency. See [[:latency_reduction_and_performance|the latency reduction page]]. 
 + 
 +=== RUN-AHEAD FRAMES === 
 +Enables run-ahead. High numbers can result in visible jitter. 
 + 
 +This usually doubles the CPU requirements for any given system, see [[:latency_reduction_and_performance#run-ahead|its section]] for more info. 
 + 
 +=== USE SECOND INSTANCE FOR RUN-AHEAD === 
 +Emulates a second system to jump to when utilizing run-ahead. 
 + 
 +Can prevent audio skips on button presses. See [[:latency_reduction_and_performance#use_second_instance|its section]] for more info. 
 + 
 +=== AUTOMATIC FRAME DELAY === 
 +Automatically decrease frame delay temporarily to prevent frame drops. 
 + 
 +This usually results in a reduction in input delay, but can also result in there not being enough time to render audio frames, which can introduce audible stuttering. See [[:latency_reduction_and_performance#auto-frame_delay|its section]] for more info. 
 + 
 +=== VARIABLE REFRESH RATE === 
 +Adjusts the display's refresh rate to match that of the content. 
 + 
 +Don't deviate from the core's requested timing. This requires the monitor to support a VRR standard such as G-Sync, Freesync or HDMI 2.1 VRR. See [[:latency_reduction_and_performance#g-sync_freesync_vrr|its section]] for more info. 
 + 
 +=== THREADED VIDEO === 
 +Runs the CPU logic and display logic on different dedicated cores. 
 + 
 +Improves performance at the cost of latency and more video stuttering. See [[:latency_reduction_and_performance#threaded_video|its section]] for more info. 
 + 
 +==== RUMBLE LEVEL ==== 
 +For emulators and controllers supporting force feedback. 
 + 
 +**//SAVESTATES//** 
 + 
 +==== AUTO SAVE/LOAD ==== 
 +Automatically load the latest savestate on game launch and automatically save the state when exiting the game. {{:switch-button.png?20|}} 
 + 
 +Only for emulators which support save states in the first place. 
 + 
 +==== INCREMENTAL SAVESTATES ==== 
 +Choose how the current save slot increments when launching games or saving states. 
 + 
 +==== SHOW SAVESTATE MANAGER ==== 
 +Display the savestate manager before launching a game. 
 + 
 +**//SYSTEM SETTINGS//** 
 + 
 +==== PER SYSTEM ADVANCED CONFIGURATION ==== 
 +This will let you set up most system specific configurations. 
 + 
 +Refer to the system's page in [[:systems|systems]] for info on each particular system's settings. Game-specific settings will take priority over settings made here. 
 + 
 +==== RETROACHIEVEMENT SETTINGS ==== 
 +This submenu is used to set up RetroAchievements. 
 + 
 +See [[:retroachievements_settings|RetroAchievements]] for more information. 
 + 
 +=== RETROACHIEVEMENTS === 
 +Enable the infamous [[https://www.retroachievements.org|RetroAchievements]]. {{:switch-button.png?20|}} 
 + 
 +Make sure to provide your sign-in details first! See [[:retroachievements_settings|the RetroAchievements page]] for more info. 
 + 
 +=== HARDCORE MODE === 
 +Disable certain emulator convenience features for more points. {{:switch-button.png?20|}} 
 + 
 +With this mode on, special features such as rewind, fast-forward and cheat codes are disabled, creating a similar environment to the original experience. For hardcore fans. 
 + 
 +=== LEADERBOARDS === 
 +Compete in high-score and best time leaderboards. {{:switch-button.png?20|}} 
 + 
 +Supported only by certain games. This setting requires **HARDCORE MODE** to be enabled. 
 + 
 +=== VERBOSE MODE === 
 +Show achievement progression on game launch and other notifications. {{:switch-button.png?20|}} 
 + 
 +When you unlock an achievement, get details about the achievement you have unlocked, with a cute little badge in the upper left corner of your screen. 
 + 
 +=== RICH PRESENCE === 
 +FIXME {{:switch-button.png?20|}} 
 + 
 +=== ENCORE MODE === 
 +Unlocked achievements can be earned again. {{:switch-button.png?20|}} 
 + 
 +This is only in regards to the notification. The actual achievements themselves won't become locked again on your account. 
 + 
 +=== AUTOMATIC SCREENSHOT === 
 +Automatically take a screenshot when an achievement is earned. {{:switch-button.png?20|}} 
 + 
 +Do you want to keep a screenshot of the moment you unlocked a RetroAchievement? They are stored in the Batocera screenshot directory. 
 + 
 +=== CHALLENGE INDICATORS === 
 +Shows icons in the bottom right corner when eligible achievements can be earned. {{:switch-button.png?20|}} 
 + 
 +Useful for seeing if you have failed the condition for earning a particular achievement or not. 
 + 
 +=== UNLOCK SOUND === 
 +Choose which sound will play when an achievement is unlocked. 
 + 
 +A few sounds to choose from are included, some you may already be familiar with. Custom sounds can also be selected, simply add the ''.ogg'' sound file to ''/userdata/sounds/retroachievements/'' (other formats are not compatible). 
 + 
 +=== USERNAME === 
 +The username for the [[https://www.retroachievements.org|RetroAchievements]] account. 
 + 
 +=== PASSWORD === 
 +The password for the [[https://www.retroachievements.org|RetroAchievements]] account. 
 + 
 +=== SHOW RETROACHIEVEMENTS ENTRY IN MAIN MENU === 
 +Shows a menu entry for your RetroAchievements right in the main menu. {{:switch-button.png?20|}} 
 + 
 +**//GAME INDEXES//** 
 + 
 +=== INDEX NEW GAMES AT STARTUP === 
 +Checks newly added games to see if they are compatible with RetroAchievements. {{:switch-button.png?20|}} 
 + 
 +This only affects the frontend, the actual achievements themselves are always earnable once the game is launched. 
 + 
 +=== INDEX GAMES === 
 +A tool to index the availability of achievements for games. 
 + 
 +In order to show a little icon in the Batocera menu for the games that have RetroAchievements. This tool calculates the MD5 checksums of your ROM files and checks them against [[https://www.retroachievements.org|the RetroAchievements database]]. This only affects the frontend, the actual achievements themselves are always earnable once the game is launched. 
 + 
 +=== GAMES TO INDEX === 
 +Filter to only scan achievements for games that haven't been scanned before. 
 + 
 +Useful to run this tool with the option set to ALL to ensure that games with achievements added recently are indexed. 
 + 
 +=== SYSTEMS INCLUDED === 
 +Filter to scan games of only particular systems. 
 + 
 +==== NETPLAY SETTINGS ==== 
 +This submenu is used to set up netplay. 
 + 
 +See [[:netplay|Netplay]] for more information. 
 + 
 +**//SETTINGS//** 
 + 
 +=== ENABLE NETPLAY === 
 +Allow for the launching and joining of netplay games from the menu. {{:switch-button.png?20|}} 
 + 
 +Once activated, pressing the {{:wiki:north.png?nolink&20|North button (X SNES)}} button now launches you into the netplay lobby menu. 
 + 
 +=== NICKNAME === 
 +Instead of appearing as player #42957, customize your nickname! 
 + 
 +This is how you will be presented in the netplay game rooms (useful for the other players to find you and make sure they join the right room). 
 + 
 +=== PORT === 
 +If you need to define a specific port to use. 
 + 
 +This is dependent on the current network's configuration. If the router has UPNP enabled, leaving this field empty will use the correct port automatically. Otherwise, the default port to use is ''55435''. 
 + 
 +=== USE RELAY SERVER === 
 +Enables use of a man-in-the-middle to assist in connecting to game lobbies. 
 + 
 +In case the network does not support UPNP. It does introduce a little more latency though, so use this option only if your network can't open UPNP ports automatically. 
 + 
 +=== SHOW UNAVAILABLE GAMES === 
 +Show rooms for games not present on this machine. {{:switch-button.png?20|}} 
 + 
 +**//GAME INDEXES//** 
 + 
 +=== INDEX NEW GAMES AT STARTUP === 
 +Checks newly added games to see if they are netplay-compatible. {{:switch-button.png?20|}} 
 + 
 +=== INDEX GAMES === 
 +FIXME 
 + 
 +=== GAMES TO INDEX === 
 +Filter to only scan for games compatible with netplay that haven't been scanned before. 
 + 
 +Useful to run this tool with the option set to ALL to ensure that netplay-compatible games on systems added to the netplay servers recently are indexed. 
 + 
 +=== SYSTEMS INCLUDED === 
 +Filter to scan games of only particular systems. 
 + 
 +==== MISSING BIOS CHECK ==== 
 +Checks the ''bios'' folder for currently missing or untested [[:add_games_bios#adding_bios_files|BIOS]] files. 
 + 
 +If no flaws are detected, nothing is shown. Congratulations! Keep in mind that not all BIOS files are required to run the emulators, just some. It's recommended to read the wiki for each particular [[:systems|system]] you intend to run to find proper explanations on what exactly is needed. 
 + 
 +==== CHECK BIOS FILES BEFORE RUNNING A GAME  
 +Pre-emptively display a warning if no BIOS is found when attempting to run a game for the first time. {{:switch-button.png?20|}} 
 + 
 +===== CONTROLLER AND BLUETOOTH SETTINGS =====
 Configure your [[supported_controllers]] and player order here. Configure your [[supported_controllers]] and player order here.
-  * **Configure A Controller** Clicking this option will show a window asking to hold a button on the gamepad to configure, it will then ask for a list of inputs. See [[configure_a_controller|Configure A Controller]] for more info. 
-  * **Pair A Bluetooth Controller** : Pressing this will make you able to pair a Bluetooth controller, for some unfortunately you might need to [[bluetooth_controllers_-_manual_setup|pair it manually using the command-line]]. 
-  * **Forget Bluetooth Controllers** : Choosing this will list your paired Bluetooth controllers, and let you unpair them. 
-  * **Gamepad order** : The list here can be used to affect specific gamepads to specific players. 
-  * **Show Controller Activity** {{:switch-button.png?20|}} : Checking this option shows the number of controllers connected with icons inside EmulationStation, and they will blink when used. 
  
-==== UI Settings ====+==== CONTROLLER MAPPING ==== 
 +Remap a controller. 
 + 
 +This process will automatically go through all buttons on the controller. The mapping can be altered after D-pad down and D-pad up have been assigned, by navigating to that button and pressing {{:wiki:south.png?nolink&20|South button (B SNES)}}. No two mappings can share the same button, and the D-pad buttons must be assigned. This limitation may be removed in the future. 
 + 
 +==== PAIR A BLUETOOTH DEVICE ==== 
 +Pair and connect to the first Bluetooth device seen in its pairing mode. 
 + 
 +If having difficulties, refer to [[:bluetooth_controllers_-_manual_setup|the manual Bluetooth setup]] page. If your Batocera is connecting to unwanted devices, that's [[https://github.com/batocera-linux/batocera.linux/issues/4634|too bad]]. 
 + 
 +==== FORGET A BLUETOOTH DEVICE ==== 
 +Choosing this will list the currently paired Bluetooth devices, and let you unpair any of them. 
 + 
 +==== SHOW CONTROLLER ACTIVITY ==== 
 +Show the number of controllers connected as icons in EmulationStation. {{:switch-button.png?20|}} 
 + 
 +Requires the theme to support the icon. Themes without an icon will use a placeholder square. 
 + 
 +==== SHOW CONTROLLER BATTERY LEVEL ==== 
 +Show the battery level of the controllers alongside the icons. {{:switch-button.png?20|}} 
 + 
 +There will then be a list of up to 8(?) available controllers and what player order they are in. 
 + 
 +===== USER INTERFACE SETTINGS ===== 
 +Settings to adjust the various aspects of the menu and theme. 
 + 
 +**//APPEARANCE//** 
 + 
 +==== THEME SET ==== 
 +Choose the theme to use. 
 + 
 +Additional themes can be downloaded from the [[:updates_and_downloads|Updates & Download]] category in the main menu. See [[:theme_set|Theme Set]] for more info. 
 + 
 +==== THEME CONFIGURATION ==== 
 +These options are specific to the theme currently being used. 
 + 
 +Options edited here will be saved per theme, so don't be afraid of trying out new themes as the settings for the previous theme will be remembered. Select **RESET CUSTOMIZATIONS** to revert back to the theme's default settings. 
 + 
 +**//DISPLAY OPTIONS//** 
 +==== SCREENSAVER SETTINGS ==== 
 +=== START SCREENSAVER AFTER === 
 +How long the system must stay unused before triggering the screensaver. 
 + 
 +=== SCREENSAVER TYPE === 
 +Choose what kind of screensaver to use. 
 + 
 +  * DIM/BLACK: Darkens the screen either a bit or a lot. There are no settings for these types of screensavers. 
 +  * RANDOM VIDEO/SLIDESHOW: Play videos/show screenshots from scraped games. 
 +  * SUSPEND: Puts the machine into a low-power state. 
 + 
 +This selection will affect the options available in the screensaver settings menu. 
 + 
 +=== STOP MUSIC ON SCREENSAVER === 
 +Stops the background music playing when the screensaver starts. {{:switch-button.png?20|}} 
 + 
 +Useful if you'd prefer to hear the video's audio instead for the video screensaver. 
 + 
 +**//RANDOM VIDEO/SLIDESHOW SCREENSAVER SETTINGS//** 
 +=== VIDEO/IMAGE DURATION (SECS) === 
 +How long to display the video/image for before automatically switching to the next one. {{:switch-slider.png?30|}} 
 + 
 +=== SHOW GAME INFO === 
 +Adds an overlay of the game's title or its marquee. {{:switch-button.png?20|}} 
 + 
 +=== USE MARQUEE AS GAME INFO === 
 +If the game has been scraped and has a marquee, use that instead of plain text for its info. {{:switch-button.png?20|}} 
 + 
 +=== DECORATION SET USED === 
 +Adds the system bezel or a random one for that system to the screensaver. 
 + 
 +The marquee is shown over the bezel, while the screenshot/video is shown inside the bezel. 
 + 
 +=== STRETCH VIDEOS/IMAGES === 
 +Distort videos/images to fill the space. {{:switch-button.png?20|}} 
 + 
 +=== MUTE VIDEO AUDIO === 
 +Keep the video silent. {{:switch-button.png?20|}} 
 + 
 +Useful if you'd prefer to keep listening to the background music. Only available for the video screensaver. 
 + 
 +=== SCREENSAVER CONTROLS === 
 +Change the controls during the screensaver: 
 + 
 +  * ''[START]'' launches the game currently being shown. 
 +  * D-pad right moves onto the next game. 
 +  * D-pad left moves back to the previous game. 
 + 
 +If disabled, then any button press instead just closes the screensaver. 
 + 
 +=== USE CUSTOM VIDEOS/IMAGES === 
 +Use a custom folder to grab videos/images from for the screensaver. {{:switch-button.png?20|}} 
 + 
 +By default, the folder is ''/userdata/screenshots/''. Drop a few videos for old video game commercials in there, and sit back for some nostalgia. 
 + 
 +=== CUSTOM VIDEO/IMAGE DIRECTORY === 
 +Define a custom path where videos/images should be retrieved from. 
 + 
 +If none is specified, will use ''/userdata/screenshots/''. 
 + 
 +=== USE VIDEOS/IMAGES IN SUBFOLDERS OF CUSTOM DIRECTORY === 
 +Scan for and use videos/images in subfolders of the specified directory too. {{:switch-button.png?20|}} 
 + 
 +=== CUSTOM VIDEO/IMAGE FILE EXTENSIONS === 
 +Manually edit the acceptable file extensions. 
 + 
 +Be careful of adding extensions for formats that cannot be played by EmulationStation. 
 + 
 +===== USER INTERFACE SETTINGS =====
  
-=== Appearance === 
-  * **Theme Set** : This is used to choose the theme you are using, additional themes can be downloaded from the Updates & Download category in the main menu, see [[:theme_set|Theme Set]] for reference. 
-  * **Theme Configuration** : This opens a submenu to customize your currently used theme, customization options are specific to the used theme. 
   * **UI Mode** : You can select different modes for batocera, Kiosk mode and Kid mode will reduce the amount of possibilities, see also [[:ui_mode|UI mode]].   * **UI Mode** : You can select different modes for batocera, Kiosk mode and Kid mode will reduce the amount of possibilities, see also [[:ui_mode|UI mode]].
  
Line 73: Line 421:
   * **Transition Style** : This is used to decide if the menu should have a fade-in transition effect, a moving effect, or change instantly when starting a game.   * **Transition Style** : This is used to decide if the menu should have a fade-in transition effect, a moving effect, or change instantly when starting a game.
   * **Carousel Transitions** {{:switch-button.png?20|}} Instantly show next/previous system   * **Carousel Transitions** {{:switch-button.png?20|}} Instantly show next/previous system
-  * Screen Saver Settings 
-    * **Screen Saver After** {{:switch-slider.png?30|}} : This is used to decide how long the system must stay unused before triggerring the screensaver. 
-    * **Screen Saver Behavior** : This is used to choose what the screensaver will do, see [[:screen_saver_behavior|ScreenSaver Behavior]]. 
-    * **Stop Music on Screensaver** {{:switch-button.png?20|}} : Enabling this will stop the main menu music from playing when the screensaver is used, if video files are used as a screensaver, their audio will be then used instead.  
-    * **Random Video Screensaver Settings** : see [[:random_video_screensaver_settings|Random Video Screensaver settings]] 
-    * **Slideshow Screensaver Settings** : see [[:slideshow_screensaver_settings|Slideshow Screensaver settings]] 
-      * **Swap image after** {{:switch-slider.png?30|}} indicates the time in seconds before switching to the next image when the screensaver takes over 
-      * **Show game info** adds an overlay of the game title and platform 
-      * **Use marquee as Game Info** {{:switch-button.png?20|}} if you scraped the game marquees and prefer to display a graphic image rather than plain text 
-      * **Decorations** - do you want to add a bezel to the picture? You can select between the default bezel for the **system** showed in the snap, a **random** bezel, or **none**. 
-      * **Stretch images** {{:switch-button.png?20|}}  
-      * **Use custom images** {{:switch-button.png?20|}} enable this option if you want to display custom images from a folder, rather than your scraped pictures 
-      * **Custom image dir** path where custom pictures will be fetched -- by default ''/userdata/screenshots'' 
-      * **Custom image dir recursive** in case you want to search for video files in subfolders of the previous path 
-      * **Custom image filter** extensions for videos -- by default ''.png,.jpg'' 
-    * **Screen Saver Controls** {{:switch-button.png?20|}} : Enable the use of the buttons to perform different actions during the screensaver. 
   * **Game Launch Transition** : auto, fade, slide or instant   * **Game Launch Transition** : auto, fade, slide or instant
   * **Show Clock** {{:switch-button.png?20|}} : Displays the hour on EmulationStation   * **Show Clock** {{:switch-button.png?20|}} : Displays the hour on EmulationStation
Line 101: Line 433:
   * **Show '..' parent folders** {{:switch-button.png?20|}} : When subfolders are shown, enabling this will show a ''..'' entry to go back one folder, this entry can be hidden.   * **Show '..' parent folders** {{:switch-button.png?20|}} : When subfolders are shown, enabling this will show a ''..'' entry to go back one folder, this entry can be hidden.
   * **Show Filenames in Lists** {{:switch-button.png?20|}} : Shows the filename instead of scrapped game name.   * **Show Filenames in Lists** {{:switch-button.png?20|}} : Shows the filename instead of scrapped game name.
 +===== GAME COLLECTION SETTINGS =====
 +
 +More information about custom collections at [[:game_collection_settings|its respective page]].
 +
 +Several options are available in this menu:
 +  * **AUTOMATIC GAME COLLECTIONS**: Batocera can create automatically some collections, based on the information scraped in your ''gamelist.xml'' files. You can create automatically collections for **2 and 4 players games**, **all games** (on all systems), **favorites** (across all systems) and the **never played** or **last played** games. For arcade systems, you can also have automatically created collections by editor or arcade system, like **sega**, **snk**, **namco** and so on.
 +  * **CUSTOM GAME COLLECTIONS**: to manage the personal collections you have created.
 +  * **CREATE NEW CUSTOM COLLECTION**: in order to create your personal collections. Once you have given a name to your new collection, you can add games from the menu by pressing the ''Y'' button on your controller. When you are done with adding games in your collection, a new item **FINISH EDITING COLLECTION** will appear in this menu to let you close it.
 +  * **GROUP UNTHEMED CUSTOM COLLECTIONS**: toggle on if you want your collections to all appeared in a dedicated **COLLECTIONS** item at the top level on the menu, otherwise each of your custom collection will appear at the top level. 
 +  * **SORT CUSTOM COLLECTIONS AND SYSTEMS**: in case you have set to "off" the previous option, do you want your collections to appear amongst the other systems, ordered from their alphabetical names among the other systems (toggled on), or would you prefer to see all your collections grouped together at the end of your systems list (off)?
 +  * **SHOW SYSTEM NAME IN COLLECTIONS**: toggle on if you want to see the ''[SYSTEM]'' added after the game names in your custom collections. Otherwise only the game name will appear. Useful if you have the same game name across multiple gaming consoles.
  
 == Game Collection Settings == == Game Collection Settings ==
Line 118: Line 461:
   * **Show System Name in Collections** {{:switch-button.png?20|}} Add a system description to a ROM file e.g. //Sonic [Megadrive]//   * **Show System Name in Collections** {{:switch-button.png?20|}} Add a system description to a ROM file e.g. //Sonic [Megadrive]//
  
-==== Sound Settings ====+===== SOUND SETTINGS ===== 
   * **Frontend Music** {{:switch-button.png?20|}} : Is used to enable or disable the music in EmulationStation.   * **Frontend Music** {{:switch-button.png?20|}} : Is used to enable or disable the music in EmulationStation.
   * **Display Song Titles** {{:switch-button.png?20|}} : Used to show the name of the music file in EmulationStation when it starts playing.   * **Display Song Titles** {{:switch-button.png?20|}} : Used to show the name of the music file in EmulationStation when it starts playing.
Line 129: Line 473:
   * **Enable Video Audio** {{:switch-button.png?20|}} : When you have a video played back in the EmulationStation menu -- either through a video thumbmail of a game that you scraped or when you use the video screensaver option -- you can toggle on/off this option so that it does not interfere with the **FRONTEND MUSIC** option that might have been set up above.   * **Enable Video Audio** {{:switch-button.png?20|}} : When you have a video played back in the EmulationStation menu -- either through a video thumbmail of a game that you scraped or when you use the video screensaver option -- you can toggle on/off this option so that it does not interfere with the **FRONTEND MUSIC** option that might have been set up above.
  
-==== Network Settings ====+===== NETWORK SETTINGS ===== 
   * //Informations//   * //Informations//
   * **IP Address** This displays your IP address which can be useful if you want to access your device over the network (you should be able to access your device in Windows through the file explorer. Type ''\\(IP address of Batocera)'' in the address bar to gain access to the share.)   * **IP Address** This displays your IP address which can be useful if you want to access your device over the network (you should be able to access your device in Windows through the file explorer. Type ''\\(IP address of Batocera)'' in the address bar to gain access to the share.)
Line 143: Line 488:
   * **WIFI Key** This is the password to your wireless network that you're attempting to connect to. Special characters may need to be escaped with a preceding ''\''.   * **WIFI Key** This is the password to your wireless network that you're attempting to connect to. Special characters may need to be escaped with a preceding ''\''.
  
-==== Scrape ====+===== SCRAPE ===== 
 Allows you to [[scrape_from|scrape boxart/marquees for your game collection]] from an online database. Allows you to [[scrape_from|scrape boxart/marquees for your game collection]] from an online database.
   * **Scrape From** Choose your database source. Remaining options will appear/disappear based on this. Read [[scrape_from|Scrape From]] for more info.   * **Scrape From** Choose your database source. Remaining options will appear/disappear based on this. Read [[scrape_from|Scrape From]] for more info.
Line 154: Line 500:
   * **Scrape Manual** {{:switch-button.png?20|}} Batocera 5.27+ offers you the ability to show game manuals (by hitting ''[Select]'' on a game) if you scraped the manuals.   * **Scrape Manual** {{:switch-button.png?20|}} Batocera 5.27+ offers you the ability to show game manuals (by hitting ''[Select]'' on a game) if you scraped the manuals.
   * **Scrape Pad2key settings** {{:switch-button.png?20|}} For Batocera v29+, you can automatically download a [[emulators:pad2key|pad2key profile to use the joypad to emulate a keyboard]].   * **Scrape Pad2key settings** {{:switch-button.png?20|}} For Batocera v29+, you can automatically download a [[emulators:pad2key|pad2key profile to use the joypad to emulate a keyboard]].
-  * **Username** if you use [[scrape_from|screenscraper as a source]], and you have an account with multiple threads, using your screenscraper username and password here will leverage scraping with as many parallel threads as you have access to. It's **a lot** faster.+  * **Username** if you use [[scrape_from|screenscraper as a source]], and you have an account with multiple threads, using your screenscraper username and password here will leverage scraping with as many parallel threads as you have access to. It's **a lot** faster.  <WRAP center round important 100%> 
 +**Be sure to enter the screenscaper username**, not the email address.</WRAP>
   * **Password**   * **Password**
   * **Scrape Now** Begin scraping. Your system may become unresponsive for a moment, but scraping will begin in the background. When done, be sure to **Update Games Lists** to see your boxart!   * **Scrape Now** Begin scraping. Your system may become unresponsive for a moment, but scraping will begin in the background. When done, be sure to **Update Games Lists** to see your boxart!
  
-==== Updates & Downloads ====+===== UPDATES & DOWNLOADS ===== 
 Download freely distributed content for Batocera! See [[updates_and_downloads|Content downloader/updates]] for more info. Download freely distributed content for Batocera! See [[updates_and_downloads|Content downloader/updates]] for more info.
   * //Downloads//   * //Downloads//
Line 169: Line 517:
   * **Start Updates** Start the update! You'll be asked for confirmation.   * **Start Updates** Start the update! You'll be asked for confirmation.
  
-==== System Settings ====+===== SYSTEM SETTINGS ===== 
   * //System//   * //System//
   * Information   * Information
-      * [[Your System Version]] ✔ +      * Your System Version ✔ 
-      * [[Disk Usage]] ✔+      * Disk Usage ✔
       * Temperature ✔       * Temperature ✔
       * Architecture ✔       * Architecture ✔
Line 180: Line 529:
       * CPU Number ✔       * CPU Number ✔
       * CPU Max Frequency       * CPU Max Frequency
-  * [[language|Language]] +  * Language 
-  * [[Power Saver Modes]] +  * Power Saver Modes: Reduce CPU consumption during idle time by reducing frequency of menu animation frames. 
-  * [[kodi_settings|Kodi Settings]]+      * **Default:**  Menu rendering is paused once Game Description animation completes. 
 +      * **Enhanced:** Menu rendering is paused once Game Name animation completes. Use when you don't need/read Description or Video previews. 
 +      * **Instant:** Menu rendering is paused immediately (few or no animations)  
 +      * **Disabled:**  Menu is re-rendered for every frame, even when static. 
 +  * Kodi Settings
       * **Enable Kodi**  {{:switch-button.png?20|}}        * **Enable Kodi**  {{:switch-button.png?20|}} 
       * **Kodi at Start**  {{:switch-button.png?20|}} Directly start Kodi on boot       * **Kodi at Start**  {{:switch-button.png?20|}} Directly start Kodi on boot
Line 188: Line 541:
   * //Hardware//   * //Hardware//
   * Brightness {{:switch-slider.png?30|}}    * Brightness {{:switch-slider.png?30|}} 
-  * [[Video Output]] +  * Video Output 
-  * [[output_device|Audio Output]]+  * Audio Output
   * Multimedia keys: if you have an Odroid Go Advance or its clone, do you want to enable the lower system keys?   * Multimedia keys: if you have an Odroid Go Advance or its clone, do you want to enable the lower system keys?
-  * [[overclock_setting|Overclock]] Only relevant for some SBC, not for PC+  * Overclock Only relevant for some SBC, not for PC
   * //Storage//   * //Storage//
-  * [[storage_device|Storage Device]] +  * Storage Device 
-  * [[Backup User Data]] +  * Backup User Data 
-  * [[Install Batocera on a new disk]]+  * Install Batocera on a new disk
   * //Advanced//   * //Advanced//
   * Security   * Security
Line 201: Line 554:
       * **Root Password** Set your custom root password for [[access_the_batocera_via_ssh|SSH Login]]        * **Root Password** Set your custom root password for [[access_the_batocera_via_ssh|SSH Login]] 
   * Developer   * Developer
-      * **VRAM Limit** {{:switch-slider.png?30|}} Setup max usage of Video RAM (Theme dependent!) +      * **VRAM Limit** {{:switch-slider.png?30|}} Setup max usage of Video RAM (Theme dependent!), the defaults are usually fine. To quote the original EmulationStation FAQ: "A good rule of thumb for how much memory you should allocate to the GPU on a 1080p setup using the default themes is 8 MB + 25 MB + 10 MB * (number of systems with games). The framebuffer, fonts and high quality system art can have a dramatic affect on this." 
-      * [[Show Framerate]] {{:switch-button.png?20|}} show how many FPS you can get on each emulator+      * Show Framerate {{:switch-button.png?20|}} show how many FPS you can get on each emulator
       * **VSYNC**  {{:switch-button.png?20|}}        * **VSYNC**  {{:switch-button.png?20|}} 
       * **Overscan**  {{:switch-button.png?20|}} Use Overscan feature for SBCs that support it (not PC)       * **Overscan**  {{:switch-button.png?20|}} Use Overscan feature for SBCs that support it (not PC)
Line 221: Line 574:
       * **Format disk** Lets you format disks (exfat, ext4, btrfs)       * **Format disk** Lets you format disks (exfat, ext4, btrfs)
       * **Use OMX Player (HW accelerated)** {{:switch-button.png?20|}}       * **Use OMX Player (HW accelerated)** {{:switch-button.png?20|}}
 +
 +===== QUIT =====
 +
 +<WRAP center round todo>
 +to do
 +</WRAP>
  
 ===== Quick Access ===== ===== Quick Access =====
 Pressing ''[SELECT]'' at the system list (top level) will give you access to the following shortcuts: Pressing ''[SELECT]'' at the system list (top level) will give you access to the following shortcuts:
   * //Quick Access//   * //Quick Access//
-  * **Launch screensaver** that you configured, for [[random_video_screensaver_settings|videos]] or [[slideshow_screensaver_settings|pictures display]]+  * **Launch screensaver** that you configured, for video or picture display
   * **Skip to next song** when you play a [[emulationstation:music|background music]] in EmulationStation   * **Skip to next song** when you play a [[emulationstation:music|background music]] in EmulationStation
   * **View Batocera Manual** you next best friend when you don't have access to this fantastic wiki ;-)   * **View Batocera Manual** you next best friend when you don't have access to this fantastic wiki ;-)
   * //Quit//   * //Quit//
   * **Restart System** Reboot the machine. The #1 troubleshooting procedure. If Batocera isn't the default boot drive, this will return you to your main operating system.   * **Restart System** Reboot the machine. The #1 troubleshooting procedure. If Batocera isn't the default boot drive, this will return you to your main operating system.
-  * **Shutdown System** Powers down the device. By default, will send the ''halt'' signal to your device, so that you can [[add_powerdevices_rpi_only|power it back on again using a button]].+  * **Shutdown System** Powers down the device. By default, will send the ''halt'' signal to your device, so that you can [[:add_powerdevices_rpi_only|power it back on again using a button]].
   * **Fast Shutdown System** Shuts down the system without first saving modifications made to ''gamelist.xml''. Only use this for troubleshooting purposes, as it can undo changes made during the session.   * **Fast Shutdown System** Shuts down the system without first saving modifications made to ''gamelist.xml''. Only use this for troubleshooting purposes, as it can undo changes made during the session.
  
  • menu_tree.1640480179.txt.gz
  • Last modified: 5 years ago
  • by atari