{"id":212,"date":"2017-10-02T00:35:34","date_gmt":"2017-10-02T00:35:34","guid":{"rendered":"https:\/\/retroberryblog.wordpress.com\/?page_id=212"},"modified":"2019-10-30T15:06:12","modified_gmt":"2019-10-30T15:06:12","slug":"rbz-user-guide","status":"publish","type":"page","link":"https:\/\/shop.boejaker.com\/index.php\/page\/rbz-user-guide\/","title":{"rendered":"Retroberry Zero User Guide"},"content":{"rendered":"<h1 class=\"western\" style=\"text-align: center;\">Retroberry Zero User Guide<\/h1>\n<p>Much of this guide is paraphrasing the RetroPie wiki.Each section has links to the respctive retropie wiki page. For a much more in-depth guide on using RetroPie visit <a href=\"https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\">https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki<\/a>.<\/p>\n<p>Any controls specified in this document only apply when using the default button configuration. Buttons &amp; combinations of, will be denoted by encompassing square brackets.<\/p>\n<h1>Index<\/h1>\n<hr \/>\n<p><span style=\"font-size: 1.125rem; font-weight: 800;\">First boot<\/span><\/p>\n<p>In the box<br \/>\nConfiguration<\/p>\n<h4 class=\"western\">Basics<\/h4>\n<p>Bluetooth connection setup<br \/>\nWIFI connection setup<br \/>\nUploading ROMs<br \/>\nEnabling SFTP (wifi file transfer)<br \/>\nWeb scraping<br \/>\nEnabling achivements<br \/>\nPower saving<br \/>\nFactory settings recovery<\/p>\n<h4 class=\"western\">Intermediate<\/h4>\n<p>SSH<br \/>\nCustom Splashscreen<br \/>\nEnable play from remote NAS<br \/>\nFlashing SD cards<\/p>\n<h4 class=\"western\">Advanced<\/h4>\n<p>Per game configuration<br \/>\nControl configuration<br \/>\nAchievement configuration<br \/>\nCustom themes<br \/>\nGame development<br \/>\nManual WIFI setup<\/p>\n<h4 class=\"western\">External resources<\/h4>\n<p>Retroberry.tk<br \/>\nRetropie wiki<br \/>\nSudomod<\/p>\n<h1 class=\"western\">First Boot<\/h1>\n<hr \/>\n<h4 class=\"western\">In the Box<\/h4>\n<p>In the box with your console will be a charging cable and a compatible HDMI cable. For first boot we recommend connecting the Retroberry Zero to a power source and display using the provided cables. If you want to connect to WIFI you must\u00a0also connect a Bluetooth or USB keyboard to complete the setup process. Once the following setup process is complete you may disconnect any unneeded peripherals and play.<\/p>\n<h4 class=\"western\">Configuration<\/h4>\n<p>Whilst setting the device up a keyboard will be required and we recommend connecting the device to a HDMI display. A micro USB adapter and mini HDMI cable are provided. Once connected turn the device on.<\/p>\n<p>Once the boot process is complete, you will notice you only have one menu option. Settings. Thats because you need to upload some ROM\u2019s before console options appear in the menu. But before that there is a small bit of configuration to do.<\/p>\n<p>The first thing to do is pair the RBZ with any Bluetooth devices you need for setup i.e. keyboard. See the \u2018Bluetooth connection setup\u2019 section of this guide for full instructions.<br \/>\nIf you don&#8217;t need to pair any Bluetooth devices move on to the next step.<\/p>\n<p>Now you should set up the WIFI, it doesnt need to be on all the time but its useful for scraping cover art and transferring roms wirelessly. See the \u2018WIFI connection setup\u2019 section of this guide for full instructions.<\/p>\n<p>Once all of the prior steps are complete, if you would like, you can remove the USB keyboard and HDMI display.<\/p>\n<p>After that you are going to want to upload some ROMs and get playing. To do that use one of the methods in the \u2018uploading roms\u2019 section of this guide. Then restart emulationstation. Now once you get to the main menu you will see options for consoles. When selected your roms for that device will be listed.<\/p>\n<h1 class=\"western\">Basics<\/h1>\n<hr \/>\n<h4 class=\"western\">Bluetooth connection setup<\/h4>\n<p>Please note: Connection to an external monitor is advised and a keyboard wired or otherwise is required to complete this setup.<br \/>\nCurrently the software lacks support for Bluetooth audio. There are hardware workarounds (see the mods section).<\/p>\n<p>Bluetooth can be set up in the main settings menu, under Bluetooth. To pair with a device select pair in this menu, then it will ask for an authentication style. Try the first, then the second, and so on, one of them will work.<\/p>\n<p>Once paired, when booting the Retroberry Zero will automatically<br \/>\ndiscover &amp; connect-to available devices.<\/p>\n<h4 class=\"western\">WIFI connection setup<\/h4>\n<p>https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/Wifi<\/p>\n<p>Please note: A keyboard, wired or otherwise, is required to complete this setup. Connection to an external monitor is advised.<\/p>\n<p>WIFI can be set up in two ways.<\/p>\n<p>The graphical interface, available in the main settings menu under WIFI. Then select connect to a wifi network. Select your access point and enter your credentials. Press &#8216;ok&#8217;. It will notify you that it is connecting and then take you back to the first screen. To confirm you are connected your ip should be displayed in the top left, if you plan on using ssh or sftp now would be a good time to note it down. If it is connected, hit [B] then [A] to exit.<\/p>\n<p>Alternatively you can manually edit the \/etc\/network\/interfaces file. See manual WIFI setup in the advanced section.<\/p>\n<h4 class=\"western\">Uploading ROMs<\/h4>\n<p>ROMs must be transfered to console-specific folders on the SD card, located at \/home\/pi\/Retropie\/roms\/(Retro console name).<br \/>\nThe last section of that directory is the name of the retro console the ROM is for.Uploading ROMs has a three methods, SD tranfer, USB transfer &amp; FTP transfer.<\/p>\n<h4 class=\"western\">SD Transfer<\/h4>\n<p>SD transfer is the simplest method.<br \/>\nAll you do is press the micro SD and it will eject. Then insert it into the device that has the ROMs you want to transfer. Emulationstation must be restarted before new ROMs become visible in the menu.<\/p>\n<h4 class=\"western\">SFTP Transfer<\/h4>\n<p>SFTP transfer, achieved using a network connection. We recommend plugging the device into a power supply when transferring allot of data . First the RBZ must have FTP transfer enabled (disabled by default for security). Next acquire the IP address of the RBZ, this can be seen on the WIFI settings menu.<\/p>\n<p>Then using your file browser select connect to server and when prompted for an address type sftp:\/\/xxx.xxx.xx.xx replace the xs with the address of the pi. You will then be prompted for the user and password and if you haven&#8217;t altered these it will be (pi) user (retroberry) password.<\/p>\n<p>The file browser will then open the home directory of pi. From here navigate to \/Retropie\/roms\/(Retro console name)<\/p>\n<h4 class=\"western\">USB Transfer<\/h4>\n<p>USB transfer is done by putting your ROMs onto a USB drive, plugging the USB drive into the RBZ and then using the file browser in the setting menu to transfer them.<\/p>\n<h4 class=\"western\">Enable SFTP access (NAS)<\/h4>\n<p class=\"western\"><span style=\"font-size: medium;\">Navigate to the Retropie settings menu, then select raspberry pi setup. In the next menu select XXXX then select XXXX to enable file sharing via SFTP<\/span><\/p>\n<h4 class=\"western\">Web scraping<\/h4>\n<p>https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/scraper<\/p>\n<p>Web scraping can be done by pressing [select] then selecting \u2018scrape now\u2019, here you can set your scrape settings.<\/p>\n<p>We recommend you select \u2018user decides conflicts\u2019 otherwise you can end up with many mis-labled games. Selecting this means you have to oversee the scraping process, when it cant decide what the ROM is, you pick from a list of possibilities.<\/p>\n<h4 class=\"western\">Enabling achivements<\/h4>\n<p>Please note: Connection to an external monitor is advised and a keyboard wired or otherwise is required to complete this setup.<\/p>\n<p>To enable achivements you must first have an account with <a href=\"http:\/\/retroachievements.org\/\">http:\/\/retroachievements.org\/<\/a> , which is free.<\/p>\n<p>Next, make sure your RBZ is connected to the internet.<\/p>\n<p>Now in the retropie settings menu select \u2018retroArch\u2019, select achivements, log-in, enter your credentials for retroachivements.org and thats it, achivements are now enabled.<\/p>\n<h4 class=\"western\">Updates<\/h4>\n<p>https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/Updating-RetroPie<\/p>\n<p>DO NOT use sudo apt-get update, upgrade or anything similar.<\/p>\n<p>DO NOT select update in the raspberry pi settings manager<\/p>\n<p>Doing so will require you re-install the OS and use our recovery tool to restore the configs.<\/p>\n<p>Only update Retropie &amp;\u00a0 the libretro emulators<\/p>\n<h4 class=\"western\">Power Saving<\/h4>\n<p>There are a few ways to optimize power saving;<br \/>\nretropie setup script, run commands, core profile.<br \/>\ndisable WIFI &amp; Bluetooth<br \/>\ndisable audio driver<\/p>\n<h4 class=\"western\">Factory settings recovery<\/h4>\n<p>Please note: Connection to an external monitor is advised. A<br \/>\nkeyboard, wired or otherwise, is required to complete the recovery\/setup process.<\/p>\n<p>We have a free recovery tool, it is for resetting messed up or buggy configurations. It overwrites all configuration files leaving your ROMs intact. You can also use this tool to quikly setup a fresh install of RetroPie.<\/p>\n<p>To recover to factory settings download our RBZ recovery tool.<\/p>\n<p>Upload it to your RBZ drop to the prompt [ALT+F4], execute the tool, reboot. Your device will now have the default configs again.<\/p>\n<p>You will have to setup WIFI and anything else you had configured, again.<\/p>\n<h1 class=\"western\">Intermediate<\/h1>\n<hr \/>\n<h4 class=\"western\">SSH<\/h4>\n<p>SSH can be used to access the RBZs command line remotely with a remote device on a local network.<\/p>\n<p><span style=\"font-size: medium;\">Connecting over SSH takes system resources and therefore reduces the performance of the RBZ whilst connected. We recommend disconnecting from the RBZ before using the device <\/span><span style=\"font-size: medium;\">heavily<\/span><span style=\"font-size: medium;\">.<\/span><\/p>\n<h4 class=\"western\">Connecting to the Retroberry zero over SSH<\/h4>\n<p class=\"western\"><span style=\"font-size: medium;\">First install an SSH terminal, for the purposes of this guide we will be using putty.<\/span> <span style=\"font-size: medium;\">Next, find out the IP address of your RBZ. It is available in the settings menu under ip address. Alternatively you can use a command line app to find it.<\/span><br \/>\n<span style=\"font-size: medium;\">sudo nmap -sP 192.168.0.0-24 | grep -B 2 $YOUR_RBZ_MAC_ADDRESS | grep -Eo &#8216;[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}&#8217;<\/span><br \/>\n<span style=\"font-size: medium;\">will usually suffice under Debian. Or you can use an android app like fing to map your network.<\/span> <span style=\"font-size: medium;\">Now open your SSH terminal, ensure connection type is set to SSH, enter the IP address and then click \u2018connect\u2019. <\/span> <span style=\"font-size: medium;\">A warning may pop up, click \u2018connect\u2019 again. <\/span> <span style=\"font-size: medium;\">You will then see a login prompt for the RBZ. The default login credentials are (pi) user &amp; (retroberry) password. <\/span><\/p>\n<h4 class=\"western\">Using SSH<\/h4>\n<p class=\"western\">\n<h4 class=\"western\">Opening the retropie_setup GUI<\/h4>\n<p class=\"western\"><span style=\"font-size: medium;\">It is possible to change many settings using SSH and the retropie setup GUI. This allows you to change settings whilst a game is running on the device giving you an instant view of the effects.<\/span> <span style=\"font-size: medium;\">Once logged in type.<\/span> <span style=\"font-size: medium;\">sudo .\/RetroPie-setup.sh\/retropie_setup.sh<\/span> <span style=\"font-size: medium;\">Once the blue menu loads, select option C \u2018Configuration \\ tools\u2019<\/span> <span style=\"font-size: medium;\">This will display a chomprehensive list of settings and options.<\/span><\/p>\n<h4 class=\"western\">Custom Splash Screen<\/h4>\n<p><a href=\"https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/splashscreen\">https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/splashscreen<\/a><\/p>\n<p>To add custom splash screen files (JPEG or MP4) upload them to \/home\/pi\/Retropie\/splashscreens\/yoursplashscreens\/<\/p>\n<p>The Splash Screen Menu can be accessed from the RetroPie Menu in EmulationStation<\/p>\n<p>Ensure \u2018<strong>Enable Custom Splashscreen On Boot<\/strong>\u2019 is selected.<br \/>\nFrom here you can either create a list of splash screens or select just one.<\/p>\n<h4 class=\"western\">Flashing SD cards with alternate operating systems<\/h4>\n<p>If your flashing retropie to an sd card and would like the factory configuration, use our factory recovery tool to get everything configured as quicly as possible.<\/p>\n<h1 class=\"western\">Advanced<\/h1>\n<hr \/>\n<h4 class=\"western\">Custom configuration<\/h4>\n<p>Many different user configurations can be made. It is advised that you dont alter the default configuration. However here are a list of usefull modifications that can be made.<\/p>\n<h4 class=\"western\">Control configuration<\/h4>\n<p>The controls can be re-mapped in two ways. Firstly they are mapped from GPIO press signals to keyboard presses which in turn is mapped to a in-game button.<\/p>\n<p>An extensive guide on setting up the custom controls can be found here<b> <\/b><a href=\"https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/RetroArch-Configuration\">https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\/RetroArch-Configuration<\/a>.<\/p>\n<p>You can also modify button to keyboard mapping in \/boot\/retrogame.cfg. We recommend you do not edit the port numbers in this file just the keypress action.<\/p>\n<h4 class=\"western\">Achievement configuration<\/h4>\n<h4 class=\"western\">Hardcore Mode<\/h4>\n<p>disables the savestates and is optional. If you want to enable it add this line to retroarch.cfg:<\/p>\n<p class=\"western\"><code class=\"western\"><span style=\"font-size: medium;\">cheevos_hardcore_mode_enable = true<\/span><\/code><\/p>\n<p><code class=\"western\"><span style=\"font-size: medium;\"><b>More\/<\/b><\/span><\/code><code class=\"western\"><span style=\"font-size: medium;\"><b>Less<\/b><\/span><\/code><code class=\"western\"><b> <\/b><\/code><code class=\"western\"><span style=\"font-size: large;\"><b>Achievement<\/b><\/span><\/code><code class=\"western\"><span style=\"font-size: medium;\"><b><br \/>\nInfo<\/b><\/span><\/code><\/p>\n<p><code class=\"western\">If<br \/>\nyou want to see some more RetroAchievements related message right<br \/>\nafter launching a game (such as successfull login and the number of<br \/>\ncheevos you have unlocked) you can use the Achievements Verbose Mode:<\/code><\/p>\n<p><code class=\"western\">cheevos_verbose_enable<br \/>\n= true<br \/>\n<\/code><\/p>\n<h4 class=\"western\">Game development<\/h4>\n<p><code class=\"western\">SDKs<br \/>\n(source devlopment kits) are availible for many of the old school<br \/>\nplatforms allowing you to program &amp; distribute your own roms.<br \/>\nHere is a list of those kits, many thanks to the people that spent<br \/>\nmany hours reverse-engineering them.<\/code><\/p>\n<h4 class=\"western\"><code class=\"western\"><b>Mounting<br \/>\na network share<\/b><\/code><\/h4>\n<h4 class=\"western\">Manual WIFI setup<\/h4>\n<p>The following are four different templates for \/etc\/networking\/conf. Pick the template you need based on the security mode of the access point you are connecting to.<\/p>\n<table width=\"100%\" cellspacing=\"0\" cellpadding=\"4\">\n<colgroup>\n<col width=\"128*\" \/>\n<col width=\"128*\" \/> <\/colgroup>\n<tbody>\n<tr valign=\"top\">\n<td width=\"50%\">\n<h4 class=\"western\">WPA\/WPA2<\/h4>\n<pre class=\"western\"><span style=\"font-size: small;\">auto lo<\/span>\n\n<span style=\"font-size: small;\">iface lo inet loopback<\/span>\n<span style=\"font-size: small;\">iface eth0 inet dhcp<\/span>\n\n<span style=\"font-size: small;\">allow-hotplug wlan0<\/span>\n<span style=\"font-size: small;\">auto wlan0<\/span>\n<span style=\"font-size: small;\">iface wlan0 inet dhcp<\/span>\n   <span style=\"font-size: small;\">wpa-ssid \"NETWORK_NAME\"<\/span>\n   <span style=\"font-size: small;\">wpa-psk \"NETWORK_PASSWORD\"<\/span><\/pre>\n<h4 class=\"western\"><a name=\"user-content-wep\"><\/a><span style=\"font-size: medium;\">WEP<\/span><\/h4>\n<pre class=\"western\"><span style=\"font-size: small;\">auto lo<\/span>\n\n<span style=\"font-size: small;\">iface lo inet loopback<\/span>\n<span style=\"font-size: small;\">iface eth0 inet dhcp<\/span>\n\n<span style=\"font-size: small;\">allow-hotplug wlan0<\/span>\n<span style=\"font-size: small;\">auto wlan0<\/span>\n<span style=\"font-size: small;\">iface wlan0 inet dhcp<\/span>\n   <span style=\"font-size: small;\">wireless-essid NETWORK_NAME<\/span>\n   <span style=\"font-size: small;\">wireless-key NETWORK_PASSWORD<\/span><\/pre>\n<\/td>\n<td width=\"50%\">\n<h4 class=\"western\">Hidden SSID<\/h4>\n<pre class=\"western\"><code class=\"western\"><span style=\"font-size: small;\">auto lo<\/span><\/code> <code class=\"western\"><span style=\"font-size: small;\">\niface lo inet loopback<\/span><\/code> <code class=\"western\"><span style=\"font-size: small;\">iface eth0 inet dhcp<\/span><\/code> <code class=\"western\"><span style=\"font-size: small;\">\n\nallow-hotplug wlan0<\/span><\/code> <code class=\"western\"><span style=\"font-size: small;\">\nauto wlan0<\/span><\/code> <code class=\"western\"><span style=\"font-size: small;\">\niface wlan0 inet dhcp<\/span><\/code> <code class=\"western\">   <\/code><code class=\"western\"><span style=\"font-size: small;\">wpa-ssid \"NETWORK_NAME\"<\/span><\/code> <code class=\"western\">\n   <\/code><code class=\"western\"><span style=\"font-size: small;\">wpa-psk \"NETWORK_PASSWORD\"<\/span><\/code> <code class=\"western\">   <\/code><span style=\"font-size: large;\"><code class=\"western\"><span style=\"font-size: small;\">wpa-scan-ssid 1<\/span><\/code><\/span><\/pre>\n<h4 class=\"western\">Open Network<\/h4>\n<pre class=\"western\"><span style=\"font-size: small;\">auto lo<\/span>\n\n<span style=\"font-size: small;\">iface lo inet loopback<\/span>\n<span style=\"font-size: small;\">iface eth0 inet dhcp<\/span>\n\n<span style=\"font-size: small;\">allow-hotplug wlan0<\/span>\n<span style=\"font-size: small;\">auto wlan0<\/span>\n<span style=\"font-size: small;\">iface wlan0 inet dhcp<\/span>\n  <span style=\"font-size: small;\">wireless-essid NETWORK_NAME<\/span>\n<code class=\"western\">  <\/code><span style=\"font-size: small;\"><code class=\"western\">wireless-mode managed<\/code><\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 class=\"western\"><\/h4>\n<h1 class=\"western\">External resources<\/h1>\n<hr \/>\n<p>RetroPie Wiki (Operating system):<\/p>\n<p><a href=\"https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki\">https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Retroberry Zero User Guide Much of this guide is paraphrasing the RetroPie wiki.Each section has links to the respctive retropie wiki page. For a much more in-depth guide on using RetroPie visit https:\/\/github.com\/RetroPie\/RetroPie-Setup\/wiki. Any controls specified in this document only apply when using the default button configuration. Buttons &amp; combinations of, will be denoted by &hellip; <\/p>\n<p class=\"link-more\"><a href=\"https:\/\/shop.boejaker.com\/index.php\/page\/rbz-user-guide\/\" class=\"more-link\">Continue reading<span class=\"screen-reader-text\"> &#8220;Retroberry Zero User Guide&#8221;<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":9,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/pages\/212"}],"collection":[{"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/comments?post=212"}],"version-history":[{"count":2,"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/pages\/212\/revisions"}],"predecessor-version":[{"id":1204,"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/pages\/212\/revisions\/1204"}],"up":[{"embeddable":true,"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/pages\/9"}],"wp:attachment":[{"href":"https:\/\/shop.boejaker.com\/index.php\/wp-json\/wp\/v2\/media?parent=212"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}