Installing the Safe Shutdown and OSD Software on the PiBoy DMG

Installing the Safe Shutdown and OSD Software on the PiBoy DMG



Figure 1: The files in the boot directory of a freshly flashed RetroPie image.

This tutorial explains how to install the safe shutdown script and on screen display software to a newly flashed image on a micro SD card. Our installer does not currently support Lakka due to the nature of it's file system. Support for Lakka is currently being worked on.
1. After flashing RetroPie or any Raspbian-based distro to a micro SD card insert the card in to a computer.
2. Open the card on the computer and you should be in the /boot directory.
3. Download the custom software zip file and unzip it. The software can be downloaded here.
4. Move all of the files in the inner folder to the /boot directory on the sd card. In config.txt file will be overwritten, if prompted allow it.
5. open the cmdline.txt file with a text editor
6. Delete the init= section and all the text following it.
7. Insert the following in it's place:
logo.nologo snd_bcm2835.enable_compat_alsa=1 init=/bin/bash -c "mount -t proc proc /proc; mount -t sysfs sys /sys; mount /boot; source /boot/unattended"
Remember no newline are allowed in the file, all of the text must be on one line. The text to add can also be found in the README.txt file in the folder unzipped earlier.
Below is a before and after example of adding the new text. The first part of the entry will be unique to each emulation suite so do not directly copy the text below. It is simply an example of what the edit will look like.
Before:
console=serial0,115200 console=tty1 root=PARTUUID=e22bcd10-02 rootfstype=ext4 elevator=deadline fsck.repair=yes rootwait quiet loglevel=3 consoleblank=0 plymouth.enable=0 quiet init=/usr/lib/raspi-config/init_resize.sh
After:
console=serial0,115200 console=tty1 root=PARTUUID=e22bcd10-02 rootfstype=ext4 elevator=deadline fsck.repair=yes rootwait quiet loglevel=3 consoleblank=0 plymouth.enable=0 quiet logo.nologo snd_bcm2835.enable_compat_alsa=1 init=/bin/bash -c "mount -t proc proc /proc; mount -t sysfs sys /sys; mount /boot; source /boot/unattended"
8. If the image you're installing these mods on is based around RetroPie 4.6 or later you can continue on with this tutorial. If you are using another image you'll need to add the dkms and raspberrypi-kernel-headers packages.
9. Safely eject the sd card from your computer.
10. Insert the sd card in to the PiBoy and turn it on. The PiBoy will go through several boot/reboot cycles before it is ready. This process can take several minutes. If the PiBoy DMG is connected to an external screen via the HDMI out feature you can watch the boot cycling process. Optionally, you can hold down the Start button when turning the PiBoy DMG on to force the display to show the installation process.

Updating the OSD Software

Occasionally changes will be made to the OSD software to enhance exisiting features or enable new ones. When this happens you might want to update to the latest software. The instructions below explain how to do this.
1. Download the latest version of the OSD software from here.
2. Connect to the PiBoy over your local network using WinSCP. See this article for instructions on connecting to the PiBoy with WinSCP.
3. Unzip the contents of the new software and navigate to the "/payload/home/pi/osd" directory. This is where the new software and configuation file is found.
4. In WinSCP navigate to the "/home/pi/osd" directory.
5. Using WinSCP, replace the "OSD" executable on the PiBoy with the "OSD" from the new software folder. Next, replace "osd.cfg" file on the PiBoy with the "osd.cfg" file from the new software folder.
6. Disconnect WinSCP from the PiBoy and turn the PiBoy off.
7. Restart the PiBoy and the new software is now installed.