How to make a dedicated MAME Appliance on a Raspberry Pi 4B

Note: the following steps are written in French. Feel free to translate to English.

Comment réaliser un système MAME dédié sur un Raspberry Pi 4B

Pour la génération comme la mienne qui a connu l’époque des arcades, où nous nous retrouvions dans un local sombre, bruyant et souvent enfumé abritant des dizaines de cabinets de jeux vidéos de tous les styles, cette époque a laissée des traces dans la mémoire de plusieurs d'entre nous. Nous en gardons en général de bons souvenirs, parfois même avec une pointe de nostalgie d'une jeunesse, de son innocence ou de son insouciance et du sentiment de liberté qui y était jadis associé.

Aujourd’hui, beaucoup d’entre nous rêvent de pouvoir un jour ressusciter l’ambiance unique de ces lieux et pouvoir jouer à nouveau aux jeux de leur jeunesse avec comme avantage de pouvoir partager ce plaisir et ce bonheur avec leur famille et amis.

Avec l’arrivé du Raspberry Pi, petit ordinateur abordable au format carte de crédit, et tout particulièrement depuis la disponibilité de la version 4B (sortie à l’été 2019), il s’avère désormais possible de faire tourner, sur un système optimisé adéquatement, la grande majorité des jeux des années 80 et 90 et même certains jeux des années 2000 et plus récents.

La problématique ?

J'ai longtemps cherché une solution tout-en-un, simple et robuste qui serait dédiée exclusivement à l'émulation des systèmes d'arcade et basée sur le célèbre émulateur Multiple Arcade Machine Emulator (MAME). Pour répondre à mes besoins, cette solution se devait d'être compacte et optimisée. Malheureusement pour moi et à mon grand désarroi, rien de tel n'existait. D'un côté, on retrouve les solutions d'émulation rétro (RetroPie, Lakka, Recalbox) qui émulent des consoles de jeux domestiques et qui permettent également d'émuler les jeux d'arcades à l'aide de versions de MAME adaptées, mais qui toutefois introduisent, de mon opinion personnelle, leur lot de contraintes (devoir posséder les versions de ROMs précises, la configuration des manettes d'arcades n'est pas native, l'interface de navigation n'est pas adaptée spécifiquement à l'émulation d'arcade, etc.). D'un autre côté, on a AdvanceMAME qui est optimisé pour le Raspberry Pi, mais aucune mise à jour n'a été effectuée depuis novembre 2018. De plus, ce dernier est basé sur une version de MAME (0.106) remontant à 2006.

La solution ?

Le faire soi-même : utiliser un OS minimal, compiler la toute dernière version de MAME (0.230 au moment d'écrire ces lignes) satisfaire ses dépendances et configurer le système de sorte qu'il démarre directement dans MAME, rien de plus, rien de moins. De cette façon, on peut utiliser les versions de ROMs les plus récentes, le soutien pour les manettes d'arcade est non seulement possible, mais facile et on utilise l'interface de sélection des ROMs native à MAME, qui est simple et efficace (nul besoin de prévoir un quelconque frontend pour lancer les ROMs).

Ce projet s’inspire de la philosophie du Just Enough Operating System (JeOS) : un système compact et minimal pour faire tourner, de manière la plus optimisée possible, une application. À titre d’exemples de JeOS, mentionnons LibreELEC (media center Kodi), Lakka (émulation de consoles de jeux) et Volumio (lecteur de musique Hi-Fi pour audiophiles).

L’objectif de ce tutoriel est de vous guider à partir de zéro pour monter, étape par étape, un système tout-en-un, minimal, optimisé et dédié qui fera tourner exclusivement la plus récente version de MAME.

Caractéristiques et fonctionnalités :

Basé sur Raspberry Pi OS Lite (anciennement Raspbian Lite, édition de Linux minimale basée sur Debian) ;
Au démarrage, affichage d'un splash personnalisé (par exemple, le logo de MAME) ;
La version courante de l'émulateur MAME démarre automatiquement, puis affiche l'écran de sélection des ROMs (GUI) ;
Lorsque l'on quitte MAME, le système initie un arrêt (shutdown) ;
Pendant l'arrêt (shutdown), affichage d'un splash personnalisé (par exemple, le logo de MAME) ;
Lorsque les opérations d'arrêt sont complétées, le système s'éteint (power off) ;
Pour préserver la durée de vie de la carte SD, le système de fichiers racine (root filesystem) est maintenu en mode lecture-seule ;
Les meilleurs pointages (hiscores) de chaque ROMs sont sauvegardés et sont donc persistants ;
Un mode pour la maintenance est proposé (appelé le mode Service) afin de permettre les mises à jour du système et effectuer la gestion des ROMs et des Snapshots (via un partage de fichiers Samba).
Gestion automatisée du matériel graphique associé aux ROMs dès l'ajout ou le retrait de ceux-ci au sein du système.

À noter que grâce aux optimisations proposées à travers ce guide, un Raspberry Pi 4B muni d'aussi peu que 1 Go de mémoire vive peut être considéré comme adéquat. À noter toutefois que si vous compilez MAME depuis le Pi 4B lui-même, vous devrez posséder les 4 Go de mémoire vive afin que la compilation puisse s'effectuer correctement.

Bien que je crois me débrouiller pas trop mal avec Linux, je ne me considère pas pour autant un expert. Dans ce contexte, il est toujours possible que des erreurs ou incohérences se soient glissées au sein de ce guide. Ce document est le fruit de deux mois d'expérimentations, d'essais et d'optimisations de manière itérative. Si vous relevez des incohérences ou des erreurs, n'hésitez pas à me le laisser savoir, question que je puisse apporter la ou les corrections.

En terminant, si vous décidez de suivre cette procédure, vous le faites à vos propres risques et je ne peux nullement être tenu responsable pour quelque préjudice que ce soit (notamment les pertes de données, mais sans s'y limiter).

Voici ci-dessous une brève démonstration :

-------------- DÉBUT DE LA PROCÉDURE --------------

Téléchargement de Raspberry Pi OS (32-bit) Lite (anciennement Raspbian Lite) et écriture sur carte microSD :

Page de téléchargement : https://www.raspberrypi.org/downloads/raspberry-pi-os/

Les étapes ci-dessous sont destinées à un ordinateur tournant sous Linux :

wget https://downloads.raspberrypi.org/raspios_lite_armhf_latest -O raspios-buster-lite-armhf-latest.zip

Pour déterminer le nom du block device associé à la carte microSD :

lsblk

Si la carte était déjà formatée, il est possible que vous deviez démonter la (les) partition(s) présentes :

sudo umount /dev/sdd1	# Exemple : Carte SD détectée comme /dev/sdd, partition #1
sudo umount /dev/sdd2	# Exemple : Carte SD détectée comme /dev/sdd, partition #2

Décompression de l’archive .zip qui contient le fichier-image (.img)

unzip raspios-buster-lite-armhf-latest.zip

Écriture de l’image sur la carte microSD (remplacez /dev/sdd par le block device associé à votre carte) :

sudo dd if=$(echo *-raspios-buster-armhf-lite.img) of=/dev/sdd bs=8192

Ajustement de la taille du système de fichiers racine à 10 Go

Si tout s'est bien déroulé à l'étape précédente, il est possible que votre système Linux monte automatiquement à nouveau les deux partitions boot et rootfs.

Si tel est le cas, vous devrez démonter ces partitions (boot et rootfs) à l'aide des commandes suivantes (remplacez /dev/sdd par le block device de votre carte) :

sudo umount /dev/sdd1
sudo umount /dev/sdd2

Ouverture du gestionnaire de partitions fdisk :

sudo fdisk /dev/sdd

Afficher la table des partitions (p)
Supprimer la seconde partition (d, 2)
Re-créer la partition (n, p, 2)
À l'étape First sector, spécifier l'ancienne valeur du premier secteur (vous référer à la table précédamment affichée)
À l'étape Last sector, inscrire +10G (valeur de 10 Go recommandée) ou toute autre taille que vous jugez appropriée
À la question Do you want to remove the signature?, répondez par non (N)
Afficher la table des partitions (p)
Créer une nouvelle partition (n, p, 3)
À l'étape First sector, spécifier la valeur End de la partition #2, en y additionnant le nombre 1
À l'étape Last sector, accepter la valeur par défaut afin d'allouer tout l'espace non-partitionné
Sauvegarder la table des partitions et quitter (w).

Forcez le système à relie la nouvelle table des partitions (remplacez /dev/sdd par le block device de votre carte) :

sudo partprobe /dev/sdd

Effectuez une vérification du système de fichiers, puis ajustez-le à la nouvelle taille de partition (remplacez /dev/sdd par le block device de votre carte) :

sudo e2fsck -f /dev/sdd2
sudo resize2fs /dev/sdd2
sync

Premier démarrage

À ce stade, les périphériques suivants doivent avoir été branchés à votre Raspberry Pi 4B :

Un clavier USB dans un port USB libre ;
Un écran (téléviseur ou moniteur d'ordinateur) via un câble micro-HDMI vers HDMI ;
Un câble Ethernet branché au connecteur RJ-45.

Insérer la carte microSD dans la fente de votre Raspberry Pi 4B et mettez l'unité sous tension.

Lors du premier démarrage, le système vous indiquera le message suivant :

Root partition should be last partition

Ceci est normal, nous avons créé une partition qui est positionnée après la partition du système de fichiers racine (root filesystem). Veuillez simplement ignorer ce message et le système redémarrera.

Première ouverture de session sur la console

login: pi
password: raspberry

Changement du mot de passe pour le compte pi

passwd

Activation de l’accès via SSH

sudo systemctl enable ssh
sudo systemctl start ssh

Pour obtenir l’adresse IP courante du système :

hostname -I

À partir de ce point, vous pouvez poursuivre à partir d’une session SSH.

Mise à jour des paquets

Le noyau (kernel) 5.10 incorpore des ajouts de foncitonnalités au niveau USB (soutien pour USB4) et introduit un bug intermittent sur le bus USB : le bus gèle momentanément (durée d'environ 4 ou 5 secondes), puis redevient disponible. Les événements survenus pendant le gel sont perdus. Pour contourner ce problème, je recommande de rester sur le noyau 5.4 jusqu'à ce que le noyau 5.10 soit plus mature. Nous allons utiliser une version récente du noyau 5.4 qui n'est pas impactée par ce bug, soit la version 5.4.77.

Mise à niveau à la version 5.4.77 du noyau :

sudo rpi-update cc9ff6c7d1b9be5465c24c75941b049f94a6bd32

Mise sur hold de la version du noyau :

sudo apt-mark hold raspberrypi-kernel

Mise à jour des paquets du système :

sudo apt-get update && sudo apt-get upgrade -y

Création des alias

L’idée, c’est de créer deux modes :

Le mode Arcade (alias arcademode) : ce mode démarre automatiquement et directement l’émulateur MAME (et rien d'autre).
Le mode Service (alias servicemode) :
- Aucun démmarrage automatique de MAME ;
- Permet le login depuis la console ;
- Active le partage de fichier réseau (via Samba) de la partition /data pour permettre la gestion des ROMs et Snapshots.
- Surveille l'emplacement des fichiers de ROM et :
  - télécharge automatiquement le matériel graphique associé lors d'un ajout ;
  - supprime automatiquement le matériel graphique associé lors d'un retrait/suppression.

Édition du fichier de définition des alias du shell Bash :

nano ~/.bash_aliases

Ajouter ces lignes pour créer les alias dont nous avons besoin :

alias update='sudo apt-get update && sudo apt-get upgrade -y'
alias temp='/opt/vc/bin/vcgencmd measure_temp'
alias frontend='_frontend(){ if [[ "$1" =~ ^(mame|attract|advance)$ ]]; then sudo sed -i "s/FRONTEND=.*$/FRONTEND="$1"/g" /etc/environment && echo "Frontend set to: "$1" (reboot to apply)."; else echo "Invalid or missing argument. Try: mame, attract or advance"; fi;}; _frontend'

# Aliases to switch between Arcade Mode and Service Mode
alias arcademode='sudo systemctl enable mame-autostart.service'
alias servicemode='sudo systemctl disable mame-autostart.service'

Sauvegarder, logout et login à nouveau pour appliquer les nouveaux alias.

Supprimer l’avertissement (disclaimer) ci-dessous au login :

The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.

Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law.

À l’aide de cette commande :

sudo rm /etc/motd

Script de vérification de la plus récente version de MAME

nano ~/mame-versioncheck.sh

Coller les lignes ci-dessous, puis sauvegarder :

#!/bin/bash

# This script check the latest available version of MAME and display a notice if the current version is older.

CHECKURL=https://github.com/mamedev/mame/releases/latest
HTMLTAG='<title>Release MAME'

if [ ! -z $MAMEVER ]; then
    LATESTMAMEVER=$(wget -q -O - $CHECKURL | grep "$HTMLTAG" | awk '{print $3}')
    if [ ${LATESTMAMEVER//./} -gt ${MAMEVER//[^0-9]/} ]; then
        echo "A new version of MAME is available ($LATESTMAMEVER)."
    fi
fi

Ajustement des permissions pour permettre l’exécution du script :

chmod +x ~/mame-versioncheck.sh

Affichage des notices au login

sudo nano /etc/bash.bashrc

Pour afficher le mode actif (Service ou Arcade), coller les lignes ci-dessous à la fin du fichier :

if (systemctl -q is-active mame-autostart.service) then
    echo "The system is currently in ARCADE mode."
else
    echo "The system is currently in SERVICE mode."
fi

Pour afficher un message lorsqu'une nouvelle version de MAME est disponible, coller les lignes ci-dessous à la suite de celles ci-dessus, puis sauvegarder :

if [ -f ~/scripts/mame-versioncheck.sh ]; then
    ~/scripts/mame-versioncheck.sh
fi

Ajouter la mention indiquant que le mode Service est en fonction lorsque le getty de la console ([email protected]) est actif :

sudo nano /etc/issue

Ajouter la mention "SERVICE MODE" (tel qu'indiqué ci-dessous) sous le texte déjà présent (laisser deux lignes vides en dessous), puis sauvegarder :

Raspbian GNU/Linux 10 \n \l

S E R V I C E      M O D E

Personnalisations du système

Réglage du fuseau horaire :

sudo dpkg-reconfigure tzdata

[Optionnel] Configuration de la langue du clavier et de l'emplacement :

sudo dpkg-reconfigure keyboard-configuration
sudo dpkg-reconfigure locales

[Optionnel] Configuration du serveur de synchronisation de l'heure sur internet (NTP) :

sudo nano /etc/systemd/timesyncd.conf

À la ligne NTP=, spécifier le nom du serveur NTP (ou du pool de serveurs, selon NTP Pool Project) à utiliser, puis sauvegarder :

NTP=ca.pool.ntp.org

Changement du nom d’hôte :

sudo nano /etc/hostname
sudo nano /etc/hosts

Repérer la ligne qui débute par 127.0.0.1 et remplacer raspberrypi à droite par le nom désiré (par exemple : arcade), puis redémarrer à l'aide de la commande ci-dessous :

sudo reboot

Ajustement des privilèges du compte pi

Afin que SDL2 puisse accéder directement au noeud de rendu graphique DRM /dev/dri/renderD128, nous devons ajouter le groupe render au compte pi. Pour ce faire :

sudo usermod -a -G render pi

[Optionnel] Désactivation du Wi-Fi

Comme je ne compte utiliser que l’interface Ethernet filaire, je désactive Wi-Fi.

sudo nano /etc/modprobe.d/raspi-blacklist.conf

Coller les lignes ci-dessous :

# WiFi
blacklist brcmfmac
blacklist brcmutil

Désactiver WPA Supplicant (lié au Wi-Fi) :

sudo apt-get remove wpasupplicant -y

[Optionnel] Désactivation de Bluetooth

Comme je ne compte pas utiliser de périphériques Bluetooth, je le désactive et le désinstalle.

sudo nano /etc/modprobe.d/raspi-blacklist.conf

Coller les lignes ci-dessous :

# Bluetooth
blacklist btbcm
blacklist hci_uart

Retrait des paquets liés à Bluetooth :

sudo apt-get remove bluez pi-bluetooth -y

[Optionnel] Désactivation de IPv6

Si vous n'utilisez pas IPv6, vous pouvez le désactiver comme suit :

sudo nano /boot/cmdline.txt

Ajoutez la commande suivante à la ligne de commande du kernel (sur la même ligne que les autres commandes), puis sauvegardez :

ipv6.disable=1

Nous devons également ajuster le drop-in du client DHCP afin d'ignorer complètement IPv6 :

sudo nano /etc/systemd/system/dhcpcd.service.d/wait.conf

À la ligne :

ExecStart=/usr/lib/dhcpcd5/dhcpcd -q -w

Ajoutez -4 après dhcpcd, puis sauvegardez :

ExecStart=/usr/lib/dhcpcd5/dhcpcd -4 -q -w

Désactivation de Avahi (mDNS)

sudo apt-get remove avahi-daemon -y

Augmentation des performances (Overclocking)

IMPORTANT : votre Raspberry Pi 4B doit être adéquatement refroidi (soit passivement par des dissipateurs de chaleur ou encore par un boîtier en métal spécialement adapté avec contact sur le CPU et qui agit à titre de dissipateur, soit par une ventilation adéquate).

À NOTER que si vous décidez de faire ce changement, vous le faites à vos propres risques et périls, je ne peux être tenu responsable de quoi que ce soit.

sudo nano /boot/config.txt

Ajouter ce bloc à la fin du fichier, puis sauvegarder :

# Overclocking
over_voltage=2
arm_freq=1750

Pour appliquer le changement, redémarrer le système à l'aide de cette commande :

sudo reboot

Bascule du CPU Governor en mode Performance

Afin de prévenir l'abaissement automatique de la fréquence du CPU lorsque celui-ci est moins sollicité (c'est le comportement du mode On Demand), nous devons ajuster le réglage du Governor et l'affecter à la valeur Performance.

Pour ce faire :

sudo apt-get install cpufrequtils -y
grep -q GOVERNOR= /etc/init.d/cpufrequtils && sudo sed -i "s/GOVERNOR=.*$/GOVERNOR=\"performance\"/g" /etc/init.d/cpufrequtils

Appliquer les changements :

sudo systemctl daemon-reload
sudo systemctl restart cpufrequtils.service

Valider les changements :

cat /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor

La commande ci-dessus devrait retourner la valeur performance à 4 reprises (une pour chaque coeur de CPU).

vcgencmd measure_clock arm

La commande ci-dessus devrait retourner la valeur 1750412160, dont les quatres premiers chiffres correspondent à la fréquence d'overclocking que nous avons spécifiée plus haut.

Activation du pilote DRM VC4 V3D

sudo nano /boot/config.txt

Ajouter ce bloc à la fin du fichier, puis sauvegarder :

[pi4]
# Enable DRM VC4 V3D driver on top of the dispmanx display stack
dtoverlay=vc4-fkms-v3d
max_framebuffers=2

Compilation de SDL2 (optimisé, sans X11)

Comme nous utilisons un système Linux minimal sans gestionnaire de fenêtres graphique comme X11 et que nous voulons tirer parti au maximum des ressources du Raspberry Pi 4, nous devons compiler la librairie graphique SDL2 sans le soutien pour X11 et également lui indiquer d’offrir le soutien pour les pilotes de type Kernel Mode-Setting/Direct Rendering Manager (KMS/DRM).

Installer les dépendances pour pouvoir compiler :

sudo apt-get install build-essential -y

Selon la page Compile SDL2 from source, installer les dépendances SDL2 :

sudo apt-get install libfreetype6-dev libdrm-dev libgbm-dev libudev-dev libdbus-1-dev libasound2-dev liblzma-dev libjpeg-dev libtiff-dev libwebp-dev -y

Installer les dépendance OpenGL ES 2 :

sudo apt-get install libgles2-mesa-dev -y

Un bug a été introduit à partir de la version 2.0.11 de SDL2 dans le scénario que nous utilisons (sans soutien pour X11 et avec l'utilisation de KMS/DRM). Puisque le correctif n’est toujours pas disponible au moment d’écrire ces lignes, nous contournerons le bug en utilisant la version juste avant, soit 2.0.10 :

wget https://libsdl.org/release/SDL2-2.0.10.tar.gz
tar xvf SDL2-2.0.10.tar.gz
cd SDL2-2.0.10

./configure --disable-video-opengl --disable-video-opengles1 --disable-video-x11 --disable-pulseaudio --disable-esd --disable-video-wayland --disable-video-rpi --disable-video-vulkan --enable-video-kmsdrm --enable-video-opengles2 --enable-alsa

Le sommaire du programme de configuration devrait afficher ceci :

SDL2 Configure Summary:
Building Shared Libraries
Building Static Libraries
Enabled modules : atomic audio video render events joystick haptic sensor power filesystem threads timers file loadso cpuinfo assembly
Assembly Math   :
Audio drivers   : disk dummy oss alsa(dynamic)
Video drivers   : dummy kmsdrm(dynamic) opengl_es2
Input drivers   : linuxev linuxkd
Using libsamplerate : NO
Using libudev       : YES
Using dbus          : YES
Using ime           : YES
Using ibus          : NO
Using fcitx         : NO

Confirmer qu’on a bien le soutien pour KMS/DRM (ligne Video drivers) et Alsa (ligne Audio drivers) et lancer la compilation et l’installation :

Démarrer la compilation optimisée et l'installation à l'aide de ces commandes :

make -j $(nproc) CFLAGS='-mtune=cortex-a72 -mfpu=neon-fp-armv8 -mfloat-abi=hard'

sudo make install

Compilation de SDL2_ttf

MAME utilise les polices True Type. Le soutien dans SDL2 réside dans un module à part nommé SDL2_ttf. Nous allons le télécharger, le compiler et l’installer à l’aide des commandes suivantes :

cd ~
wget https://libsdl.org/projects/SDL_ttf/release/SDL2_ttf-2.0.15.tar.gz

tar zxvf SDL2_ttf-2.0.15.tar.gz
cd SDL2_ttf-2.0.15
./configure
make -j $(nproc)
sudo make install
sudo ldconfig -v

Retrait du code source de SDL2 :

cd ~
rm SDL2-2.0.10.tar.gz
rm SDL2_ttf-2.0.15.tar.gz
rm -R SDL2-2.0.10
rm -R SDL2_ttf-2.0.15

Compilation de MAME (optimisé, sans X11)

Nous devons d'abord créer une patch pour ajuster un fichier source de MAME (dans BGFX, une référence est effectuée à X11, même lorsqu’on passe NO_X11=1 au compilateur -- un bug a été soumis à cet effet).

Création du fichier de patch pour drawbgfx.cpp :

nano ~/drawbgfx.cpp.patch

Coller les lignes ci-dessous dans l'éditeur, puis sauvegarder :

--- a/src/osd/modules/render/drawbgfx.cpp	2020-10-05 15:49:54.000000000 -0400
+++ b/src/osd/modules/render/drawbgfx.cpp	2020-10-05 21:50:49.178789472 -0400
@@ -169,7 +169,8 @@
 	}
 
 #   if BX_PLATFORM_LINUX || BX_PLATFORM_BSD || BX_PLATFORM_RPI
-	return (void*)wmi.info.x11.window;
+	// return (void*)wmi.info.x11.window;
+	return (void*)_window;
 #   elif BX_PLATFORM_OSX
 	return wmi.info.cocoa.window;
 #   elif BX_PLATFORM_WINDOWS
@@ -192,8 +193,10 @@
 
 	bgfx::PlatformData pd;
 #   if BX_PLATFORM_LINUX || BX_PLATFORM_BSD
-	pd.ndt          = wmi.info.x11.display;
-	pd.nwh          = (void*)(uintptr_t)wmi.info.x11.window;
+	// pd.ndt          = wmi.info.x11.display;
+	// pd.nwh          = (void*)(uintptr_t)wmi.info.x11.window;
+	pd.ndt = NULL;
+	pd.nwh = _window;
 #   elif BX_PLATFORM_OSX
 	pd.ndt          = NULL;
 	pd.nwh          = wmi.info.cocoa.window;

Création du script automatisé de compilation de MAME :

mkdir ~/scripts
nano ~/scripts/mame-updater.sh

Coller les lignes ci-dessous dans l'éditeur, puis sauvegarder :

#!/bin/bash

# This script update MAME to the specified version.

# GCC compiler optimization for ARM-based systems : https://gist.github.com/fm4dd/c663217935dc17f0fc73c9c81b0aa845
#ARCHOPTS='-march=armv8-a+crc+simd -mcpu=cortex-a72 -mtune=cortex-a72 -mfpu=neon-fp-armv8 -mfloat-abi=hard -mneon-for-64bits -funsafe-math-optimizations -munaligned-access -fexpensive-optimizations'

# A tester.....
ARCHOPTS='-march=armv8-a+crc+simd -mcpu=cortex-a72 -mtune=cortex-a72 -mfpu=neon-fp-armv8 -mfloat-abi=hard -funsafe-math-optimizations -fprefetch-loop-arrays -fexpensive-optimizations'
MAKEOPTS='TARGETOS=linux NO_X11=1 NOWERROR=1 NO_USE_XINPUT=1 NO_USE_XINPUT_WII_LIGHTGUN_HACK=1 NO_OPENGL=1 USE_QTDEBUG=0 DEBUG=0 REGENIE=1 NO_BGFX=1 FORCE_DRC_C_BACKEND=1 NO_USE_PORTAUDIO=1'
MAXTHREAD=3  # From MAME version 0.227 and up, we should use a max. of 3 threads to avoid an out of memory error.

secs_to_human() {
    echo "$(( ${1} / 3600 ))h $(( (${1} / 60) % 60 ))m $(( ${1} % 60 ))s"
    }

fs_unlock() {	# Put root filesystem in read/write mode
    if [ $(findmnt -no OPTIONS /) = 'ro,noatime' ]; then
        sudo mount -o remount,rw /
        FSWASRO=1
    fi
    }

fs_lock() {	# Put root filesystem in read-only mode
    if [ "$FSWASRO" = "1" ]; then
        sleep 5
        sudo mount -o remount,ro /
    fi
    }

set_env() {	# Make an environment variable persistent
    local KEY=$(echo $1 | awk -F '=' '{print $1}')
    local VALUE=$(echo $1 | awk -F '=' '{print $2}')
    grep -q $KEY= /etc/environment && sudo sed -i "s%$KEY=.*$%$KEY=$VALUE%g" /etc/environment
    grep -q $KEY= /etc/environment || echo "$KEY=$VALUE" | sudo tee -a /etc/environment
    }

get_history() {      # Grab the latest history.xml file
    local BASEURL=https://www.arcade-history.com
    local BASETAG='<a class="noir" rel="nofollow" href="../dats/'
    local REGEX='[^*]*(<a class="noir" rel="nofollow" href="../dats/)(.*?)("><img src="images/design/download1.gif" height="40px" /><br />History XML )[^*]*'

    HISTORYFILE=$(wget -q -O - $BASEURL/index.php?page=download | grep "$BASETAG" | sed -nE "s%$REGEX%\2%p")
    wget -q $BASEURL/dats/$HISTORYFILE -P ~    # Download the file
    unzip -o ~/$HISTORYFILE history.xml -d ~/.mame  # From MAME 0.228 and up, we use history.xml, instead of history.dat
    if [ -L ~/.mame/history ]; then	           # Symlink is present
        mv ~/.mame/history.xml ~/.mame/history
    fi
    rm ~/$HISTORYFILE                          # Cleanup
    }

if (systemctl -q is-active mame-autostart.service) then
    echo "The system must be put in SERVICE Mode first."
    exit
fi

if [ ! $1 ]; then
    echo Usage: $0 VER
    echo '  Where VER is the 4-digit version number of MAME to update (for example: 0224).'
else
    if [ $(free -g | awk '/^Mem:/{print $2}') -lt 3 ]; then
        echo You need 4 GB of RAM to compile MAME with multithread support.
        exit
    fi
    SCRIPTPATH=${0%/*}
    MAMEVER=$1
    MAMEBINPATH=/home/pi/mame$MAMEVER

    fs_unlock

    if [ ! -d $MAMEBINPATH ]; then
        cd ~
        if [ ! -f ~/mame$MAMEVER.zip ]; then	# Not already downloaded
            wget https://github.com/mamedev/mame/archive/mame$MAMEVER.zip
        fi

        if [ -f ~/mame$MAMEVER.zip ]; then	# If download successful, uncompress ...
            unzip mame$MAMEVER.zip
            mv mame-mame$MAMEVER mame$MAMEVER
            rm mame$MAMEVER.zip
        fi
    fi

    if [ ! -f $MAMEBINPATH/mame ]; then		# We build only if not already built
        # Build of MAME

        # Dependencies
        # Swap requirement
        sudo apt-get install dphys-swapfile -y
        if [ "$(cat /etc/dphys-swapfile | grep '^CONF_SWAPSIZE' | awk -F '=' '{print $2}')" != "2048" ]; then
            sudo sed -i 's/^\(#\)\{0,1\}\( \)\{0,8\}CONF_SWAPSIZE=.*$/CONF_SWAPSIZE=2048/g' /etc/dphys-swapfile
        fi
        # The swap value should be 2048

        # Activate the swap...
        sudo systemctl stop dphys-swapfile.service
        sudo systemctl start dphys-swapfile.service
        # Build dependencies
        sudo apt-get install build-essential -y

        # Patching drawbgfx.cpp...
        if [ -f $SCRIPTPATH/drawbgfx.cpp.patch ]; then
            patch -r - -Ni $SCRIPTPATH/drawbgfx.cpp.patch $MAMEBINPATH/src/osd/modules/render/drawbgfx.cpp
        fi
        cd $MAMEBINPATH
        echo MAKE CMDLINE=make -j $MAXTHREAD ARCHOPTS=\"$ARCHOPTS\" $MAKEOPTS
        BUILDSTART=$(date +%s)
        echo Build start time: $(date +"%T")
        echo -----------------------------------------------------------------------------------
        echo Please wait until the build is compledted \(about 5 hours\)...
        echo -----------------------------------------------------------------------------------
        make -j $MAXTHREAD ARCHOPTS="$ARCHOPTS" $MAKEOPTS
        echo Build time took: $(secs_to_human "$(($(date +%s) - ${BUILDSTART}))").

        if [ -f $MAMEBINPATH/mame ]; then
            echo -----------------------------------------------------------------------------------
            echo Build Success!
            echo -----------------------------------------------------------------------------------
            # Successful build!
            # We make sure the MAME environment variables are persistent...
            set_env MAMEVER=$MAMEVER
            set_env SDL_VIDEODRIVER=kmsdrm
            set_env SDL_RENDER_DRIVER=opengles2
            set_env SDL_RENDER_VSYNC=1
            set_env SDL_GRAB_KEYBOARD=1
            set_env SDL_VIDEO_GLES2=1
            
            # MAME data path creation
            if [ ! -d ~/.mame ]; then mkdir ~/.mame; fi
            
            # MAME binary symlink creation or update
            if [ -L ~/mame ]; then rm ~/mame; fi
            ln -s $MAMEBINPATH ~/mame
            
            if [ ! -f ~/.mame/mame.ini ]; then	# If mame.ini does not exist, let's create it
                cd ~/.mame
                $MAMEBINPATH/mame -cc
            fi
            
            if [ -z $FRONTEND ]; then set_env FRONTEND=mame; fi

            # Get the latest history.xml file
            echo Applying latest history.xml...
            get_history

            # Freeing some space...
            for f in src build 3rdparty
            do
                rm -Rf $MAMEBINPATH/$f
            done
        else
            echo -----------------------------------------------------------------------------------
            echo Build FAILED.
            echo -----------------------------------------------------------------------------------
        fi
        # Removing dependencies
        echo Removing dependencies...
        # Removing swap...
        sudo systemctl stop dphys-swapfile.service
        sudo rm /var/swap
        sudo apt-get remove dphys-swapfile build-essential -y
        sudo apt-get autoremove -y
    fi
    fs_lock
fi

Ajustement des permissions pour permettre l’exécution du script :

chmod +x ~/scripts/mame-updater.sh

Installer les dépendances de MAME :

sudo apt-get install fontconfig libfontconfig-dev libx11-dev libpulse-dev -y

Compilation de MAME 0.231 :

./scripts/mame-updater.sh 0231

Patienter environ 5 heures et demie (ce temps est obtenu avec un Raspberry Pi 4B overclocked), afin que la compilation se complète…

À noter que des avertissements (de couleur cyan) apparaîtront, ici et là, lors de la compilation : il suffit de les ignorer, ils ne compromettent pas le processus.

Installation de la police TTF « Liberation Sans » pour MAME

Exécuter ces commandes :

cd ~
wget http://dl.dafont.com/dl/?f=liberation_sans -O liberation_sans.zip
sudo mkdir /usr/share/fonts/truetype/liberation-fonts
sudo unzip /home/pi/liberation_sans.zip *.ttf -d /usr/share/fonts/truetype/liberation-fonts
rm liberation_sans.zip

Redémarrer le système à ce stade afin de mettre en force les variables d'environnement propres à MAME :

sudo reboot

Configuration de MAME

Spécifier les réglages ci-dessous dans le fichier mame.ini :

nano ~/.mame/mame.ini

Externalisation des dossiers vers le profil. Coller les lignes ci-dessous aux endroits appropriés, puis sauvegarder :

rompath                   $HOME/.mame/roms
inipath                   $HOME/.mame/ini
artpath                   $HOME/.mame/artwork
ctrlrpath                 $HOME/.mame/ctrlr
homepath                  $HOME/.mame/lua
samplepath                $HOME/.mame/samples
hashpath                  $HOME/mame/hash
pluginspath               $HOME/mame/plugins
languagepath              $HOME/mame/language

state_directory           $HOME/.mame/sta
cfg_directory             $HOME/.mame/cfg
nvram_directory           $HOME/.mame/nvram
memcard_directory         $HOME/.mame/memcard
snapshot_directory        $HOME/.mame/snap
input_directory           $HOME/.mame/inp
diff_directory            $HOME/.mame/diff

Réglages divers - Coller les lignes ci-dessous aux endroits appropriés et sauvegarder :

#
# OSD VIDEO OPTIONS
#
video                     accel

#
# OSD INPUT OPTIONS
#
multimouse                1

#
# CORE SOUND OPTIONS
#
samplerate                22050

#
# CORE MISC OPTIONS
#

skip_gameinfo             1

#
# SDL LOW-LEVEL DRIVER OPTIONS
#
videodriver               kmsdrm
renderdriver              opengles2
audiodriver               alsa

[Optionnel] Personnalisations additionnelles de MAME

J’ajoute personnellement un filtre pour créer un effet semblable aux écrans cathodiques (scanlines). De plus, pour tester je possè un contrôleur X-Arcade Solo pour lequel je spécifie le fichier de mappings associé :

nano ~/.mame/mame.ini

Coller ces lignes :

effect                    scanlines
ctrlr                     xarcade

[Optionnel] Personnalisations X-Arcade Solo

J'apporte certains ajustements au fichier de mappings de ma manette X-Arcade Solo de sorte qu'aucun clavier ne soit nécessaire pour naviguer dans les menus et quitter MAME.

nano ~/mame/ctrlr/xarcade.cfg

Coller le texte ci-dessous pour UI_FOCUS_NEXT, UI_PAUSE et ajuster les éléments déjà présents UI_CONFIGURE et UI_CANCEL, puis sauvegarder :

                        <port type="UI_FOCUS_NEXT">     <!-- Custom remap to cycle through each section in main selection screen -->
                            <newseq type="standard">KEYCODE_TAB OR KEYCODE_LALT KEYCODE_4</newseq>
                        </port>

                        <port type="UI_PAUSE">          <!-- Custom remap to pause the game -->
                                <newseq type="standard">KEYCODE_P OR KEYCODE_3 KEYCODE_4</newseq>
                        </port>

                        <port type="UI_CONFIGURE">      <!-- Custom remap to get the in-game menu -->
                                <newseq type="standard">KEYCODE_TAB OR KEYCODE_LALT KEYCODE_4</newseq>
                        </port>

                        <port type="UI_CANCEL">         <!-- Custom remap to quit emulation and exit MAME if in the main selection screen -->
                                <newseq type="standard">KEYCODE_ESC OR KEYCODE_LALT KEYCODE_1</newseq>
                        </port>

Ajustements d'emplacements additionnels

Édition du fichier plugin.ini pour activer deux plugins (data et hiscore) :

nano ~/.mame/plugin.ini

Coller les lignes ci-dessous, puis sauvegarder :

#
# PLUGINS OPTIONS
#
cheat                     0
cheatfind                 0
console                   0
data                      1
dummy                     0
gdbstub                   0
hiscore                   1
layout                    0
portname                  0
timer                     0

Création du fichier hiscore.ini pour pouvoir ajuster le chemin des sauvegardes :

nano ~/.mame/hiscore.ini

Coller la ligne ci-dessous, puis sauvegarder :

hi_path                   $HOME/.mame/hi

Externalisation de dossiers additionnels au sein de ui.ini vers le profil :

nano ~/.mame/ui.ini

Ajuster les chemins ci-dessous en spécifiant le préfixe $HOME/.mame/ suivi du nom du dossier :

cabinets_directory        $HOME/.mame/cabinets
cpanels_directory         $HOME/.mame/cpanels
pcbs_directory            $HOME/.mame/pcb
flyers_directory          $HOME/.mame/flyers
historypath               $HOME/.mame/history
titles_directory          $HOME/.mame/titles
marquees_directory        $HOME/.mame/marquees
icons_directory           $HOME/.mame/icons
ui_path                   $HOME/.mame/ui

Script de démarrage de MAME/Front-end

Le script de démarrage de MAME ou d'un Front-end relancera l’exécutable sélectionné tant et aussi longtemps que l’applicatif ne sera pas quitté de façon normale (code de sortie à 0).

Création du script :

nano ~/scripts/autostart.sh

Coller les lignes ci-dessous et sauvegarder :

#!/bin/bash

# This script launch the selected application (front-end or MAME emulator) and respawn it if quit unexpectedly.

if [ ! -z $FRONTEND ]; then
  while
    case ${FRONTEND,,} in
      attract)
        /usr/local/bin/attract --loglevel silent
        ;;
      advance)
        /home/pi/frontend/advance/advmenu
        ;;
      mame)
        /home/pi/mame/mame >/dev/null 2>/dev/null
        ;;
    esac
    (( $? != 0 ))
  do
    :
  done
else
    echo $0 - Variable FRONTEND is not defined!
    read -n 1 -s -r -p "Press any key to continue..."
    echo
fi

Ajustement des permissions pour permettre l’exécution du script :

chmod +x ~/scripts/autostart.sh

Démarrage automatique de l'émulateur MAME/Front-end

L'objectif est de créer un service systemd qui sera responsable de démarrer automatiquement l'émulateur MAME ou le Front-end sélectionné.

Lorsque ce service est activé, nous sommes en mode Arcade :

Désactivation du getty de la console ([email protected])
Désactivation du serveur Samba (smbd.service) afin maximiser les ressources pour l'émulation
Désactivation d'autres services pour maximiser les ressources
Démarrage automatique de l'émulateur MAME ou du Frond-end sélectionné

Lorsque ce service est désactivé, nous sommes en mode Service :

Activation du getty de la console ([email protected])
Activation du serveur Samba (smbd.service) afin de permettre la gestion des ROMs ainsi que le matériel graphique associé
Activation du service de gestion automatisé (mame-artwork-mgmt.service) du matériel graphique associé aux fichiers de ROM

Création du service systemd :

sudo systemctl edit mame-autostart.service --force --full

Coller les lignes ci-dessous et sauvegarder :

[Unit]
Description=MAME Appliance Autostart service
[email protected] smbd.service nmbd.service rng-tools.service cron.service mame-artwork-mgmt.service
Requires=local-fs.target
After=local-fs.target

[Service]
User=pi
Group=pi
PAMName=login
Type=simple
ExecStart=/home/pi/scripts/autostart.sh
Restart=on-abort
RestartSec=5
TTYPath=/dev/tty1
StandardInput=tty

[Install]
WantedBy=multi-user.target
Also=shutdown.service

Puisque nous n'avons pas complété toutes les étapes, nous allons pour le moment désactiver le service :

sudo systemctl disable mame-autostart.service

Réactivation du curseur dans la console lorsque le getty@tty1 est activé (Service Mode) :

nano ~/.bashrc

Ajouter la ligne suivante à la fin, puis sauvegarder :

setterm --cursor on

Shutdown automatique du système dès qu’on quitte MAME

Dès que le service mame-autostart.service est arrêté, ceci déclenche le shutdown...

Création du service systemd :

sudo systemctl edit shutdown.service --force --full

Coller les lignes ci-dessous et sauvegarder :

[Unit]
Description=Shutdown and poweroff service
After=mame-autostart.service

[Service]
TTYPath=/dev/tty1
ExecStart=/sbin/poweroff
StandardInput=tty

[Install]
WantedBy=multi-user.target

Désactivation du service (pour le moment) :

sudo systemctl disable shutdown.service

Préparatifs pour l’écran de démarrage au logo de MAME

Retrait du splash en arc-en-ciel lors de la mise sous tension :

sudo nano /boot/config.txt

Ajouter cette ligne à la fin du fichier, puis sauvegarder :

disable_splash=1

Éditer le fichier associé à la ligne de commande passée au kernel :

sudo nano /boot/cmdline.txt

Ajouter les options ci-dessous à la ligne de commande passée au kernel :

Rediriger l’affichage des messages sur la console (tty1) vers tty3. Pour ce faire, changer console=tty1 pour console=tty3.

Cacher le logo du Raspberry Pi, ajouter :

logo.nologo

Cacher le curseur qui clignote, ajouter :

vt.global_cursor_default=0

Cacher l’affichage des messages et démarrage rapide, ajouter :

quiet fsck.mode=skip

Ce qui nous donne au final les options suivantes à ajouter à la ligne de commande :

console=tty3 logo.nologo vt.global_cursor_default=0 quiet fsck.mode=skip

Affichage de l’écran de démarrage (Custom Boot Splash)

Installation du binaire FIM qui permet d’afficher une image :

sudo apt-get install fim -y

Création du dossier des images de splash et copie de l’image du logo de MAME (mame.jpg) :

mkdir ~/splash
sudo mv ~/mame.jpg ~/splash

Pour le moment j’utilise le même splash pour le boot et le shutdown :

ln -s ~/splash/mame.jpg ~/splash/mame-boot.jpg
ln -s ~/splash/mame.jpg ~/splash/mame-shutdown.jpg

Création du service systemd :

sudo systemctl edit mame-bootsplash.service --force --full

Coller le texte ci-dessous et sauvegarder :

[Unit]
Description=MAME boot splash screen service
DefaultDependencies=no
After=local-fs.target

[Service]
Type=simple
StandardInput=tty
StandardOutput=tty
ExecStart=/usr/bin/fim -q --no-history /home/pi/splash/mame-boot.jpg
SuccessExitStatus=42

[Install]
WantedBy=sysinit.target

Activation du service :

sudo systemctl enable mame-bootsplash.service

Affichage de l’écran du shutdown (Custom Shutdown Splash)

Création du service systemd :

sudo systemctl edit mame-shutdownsplash.service --force --full

Coller le texte ci-dessous et sauvegarder :

[Unit]
Description=MAME Shutdown/Poweroff/Reboot Splash Screen service
DefaultDependencies=no
Before=halt.target
Conflicts=mame-bootsplash.service

[Service]
Type=simple
ExecStart=/usr/bin/fim -q --no-history /home/pi/splash/mame-shutdown.jpg
SuccessExitStatus=42

[Install]
WantedBy=reboot.target halt.target poweroff.target

Activation et démarrage du service :

sudo systemctl enable mame-shutdownsplash.service
sudo systemctl start mame-shutdownsplash.service

Pour afficher sommaire des unit files de systemd (avec hiérarchie) :

systemd-analyze critical-chain

Création de la partition séparée en lecture-écriture

La partition /data sera en lecture/écriture et utilisera le système de fichiers F2FS (Flash-Friendly File System).

Installer les binaires pour le système de fichiers F2FS :

sudo apt-get install f2fs-tools -y

Puisque la partition de données a été créée au début de la procédure, il ne nous reste plus qu'à la formater avec le système de fichiers F2FS :

sudo mkfs.f2fs -l data /dev/mmcblk0p3

Création du point de montage /data (et des sous-dossiers), ajustement des permissions, du propriétaire (owner) et du groupe :

sudo mkdir /data

Tester pour s'assurer qu'il n'y a pas eu d'erreur en montant manuellement la partition, puis valider le remontage :

sudo mount -t f2fs -o rw /dev/mmcblk0p3 /data
sudo mount -o remount,rw /data

Montage automatique dans fstab :

sudo nano /etc/fstab

Ajouter cette ligne à fstab :

/dev/mmcblk0p3        /data           f2fs    defaults,noatime,discard    0    2

Ajustements au fichier de montage automatique systèmes de fichiers

Afin que le montage de /boot et / s'effectuent sans dépendre d'un identifiant, nous allons basculer l'identification des partitions par leur nom de device.

Pour ce faire, nous éditons /etc/fstab :

sudo nano /etc/fstab

Assurez-vous que /boot et / soient référencés par leur nom de device (/dev/mmcblk0pX) au lieu de l'identifiant PARTUUID :

/dev/mmcblk0p1        /boot           vfat    defaults,rw                 0    2
/dev/mmcblk0p2        /               ext4    defaults,noatime,rw         0    1

Éditer la ligne de commande du kernel Linux :

sudo nano /boot/cmdline.txt

Repérer sur la ligne de commande le paramètre root=PARTUUID=xxxxxxxx et le remplacer par :

root=/dev/mmcblk0p2

Partage de /data via Samba

Installation du serveur Samba et des binaires associés :

sudo apt-get install samba samba-common-bin -y

À la question ci-dessous, répondez par Oui :

Modify smb.conf to use WINS settings from DHCP?

À ce point, il est possible que le système effectue un shutdown, ceci est normal.

Dû au redémarrage, la configuration de Samba ne s'est pas complétée. Pour la compléter, exécutez la commande ci-dessous :

sudo dpkg --configure -a

Configuration du serveur Samba :

sudo nano /etc/samba/smb.conf

À la section [global], retirer le commentaire «;» au début de la ligne suivante :

interfaces = 127.0.0.0/8 eth0

Sous la directive server role = standalone server, ajouter les lignes suivantes :

local master = no
domain master = no
preferred master = no

Comme le partage de fichiers n’est activé qu’en mode Service, j’autorise les connexions au partage en mode anonyme (sans authentification).

Toujours à la section [global], ajouter ces deux lignes :

security = user
guest account = nobody

Commenter (désactiver) en préfixant avec «;» les sections qui définissent les partage suivants :

[homes] [netlogon] [profiles] [printers] [print$]

À la fin de la section des partages, coller ce bloc pour partager /data et sauvegarder :

[Data]
  path = /data
  comment = Raspberry Pi MAME Appliance - Persistent data share.
  available = yes
  browsable = yes
  writable = yes
  guest ok = yes
  create mask = 0644
  directory mask = 0755
  force user = pi

Application des nouveaux réglages en basculant en mode Service :

servicemode
sudo reboot

Valider que le service Samba est bien en exécution à l'aide de la commande suivante :

systemctl status smbd

Tester le partage Samba en tentant d'accéder au partage depuis un ordinateur distant (par exemple : \\arcade\data depuis Windows ou smb://arcade/data depuis Linux). Vous devriez être en mesure de copier des fichiers depuis/vers le partage, ainsi que de les supprimer sans devoir vous authentifier (accès de type anonyme).

Déplacement des données vers la partition persistante /data

Création des dossiers et ajustement des permissions sur la partition persistante :

cd /data
sudo mkdir mame attract advance
cd mame
sudo mkdir artwork cabinets cfg cpanels ctrlr diff flyers hi history icons ini inp lua marquees memcard pcb nvram roms samples snap sta titles ui
sudo chown -R pi:pi /data
sudo chmod -R 3774 /data

Déplacement des fichiers de configuration de MAME (ui.ini, mame.ini, plugin.ini et hiscore.ini) vers /data/ini (rw)

cd ~/.mame
mv mame.ini ui.ini plugin.ini hiscore.ini /data/mame/ini

Si applicable, déplacer les autres éléments vers /data (rw)

mv ~/.mame/history.xml /data/mame/history
mv ~/mame/roms/*       /data/mame/roms/
mv ~/mame/snap/*       /data/mame/snap/
mv ~/mame/artwork/*    /data/mame/artwork/
mv ~/mame/ctrlr/*      /data/mame/ctrlr/

mv ~/.advance/*        /data/advance/
mv ~/.attract/*        /data/attract/

Création des symlinks…

Pour assurer la persistance des différents réglages liés à MAME :

ln -s /data/mame/ini/mame.ini    ~/.mame/mame.ini

Redirection des dossiers vers /data afin de permettre la persistence des réglages et données des jeux ainsi qu'une gestion facilitée des ROMs et du matériel graphique associé :

cd ~/mame
rm -R roms ctrlr snap nvram history artwork
cd ~; rmdir .mame/; rmdir .advance/; rmdir .attract/

ln -s /data/mame    ~/.mame
ln -s /data/attract ~/.attract
ln -s /data/advance ~/.advance

Script de téléchargement du matériel graphique de chaque ROMs

Je vous propose le script ci-dessous qui parcourt l'emplacement des fichiers de ROMs et tente de télécharger le matériel graphique associé à chaque ROM (snapshots, écran du titre, marquees, panneaux de commandes, cabinet).

nano ~/scripts/mame-scraper.sh

#!/bin/bash

# This script download the missing artwork files (snapshots, titles screens, marquees,
# control panels and cabinet pictures) based on the content of the ROMs path (ROM files).

# Usage: when a romname is passed (without the .zip extension), only the artwork for this
#        rom is downloaded.

URLPREFIX1=http://mamedb.blu-ferret.co.uk
URLPREFIX2=http://adb.arcadeitalia.net/media/mame.current

get_artworks() {
    # $1 is romname (without .zip)
    if [ ! $1 ]; then
        exit
    fi
    if [ -t 0 ]; then  echo -ne "\e[2K\rProcessing $1..."; fi
    for t in snap titles marquees cpanels cabinets
      do
        if [ ! -f /home/pi/.mame/$t/$1.png ]; then
          wget -q $URLPREFIX1/$t/$1.png -P /home/pi/.mame/$t
          if [ $? = 0 ]; then	# Download OK
              echo -n .
          else		# Download failed, let's try with the 2nd URL...
              case $t in
                  snap)
                      wget -q $URLPREFIX2/ingames/$1.png -P /home/pi/.mame/$t && echo -n .
                      ;;
                  titles)
                      wget -q $URLPREFIX2/$t/$1.png -P /home/pi/.mame/$t && echo -n .
                      ;;
              esac
          fi
        fi
      done
    }

shopt -s nullglob
cd /home/pi/.mame/roms

if [ $1 ]; then
    f=$1.zip
    if [ -f $f ]; then
        get_artworks ${f%.zip}
    fi
else
    for f in *.zip
        do
            get_artworks ${f%.zip}
        done
fi
if [ -t 0 ]; then echo -e '\e[2K\rCompleted!'; fi

Ajustement des permissions pour permettre l'exécution du script :

chmod +x mame-scraper.sh

Utilitaire de nettoyage des ROMs invalides

Je vous propose le script ci-dessous pour nettoyer les ROMs (fichiers .zip) qui sont invalides pour MAME, c'est à dire qu'une version plus récente est nécessaire (un dump de meilleure qualité existe).

nano ~/scripts/mame-badromspurge.sh

Coller le texte ci-dessous, puis sauvegarder :

#!/bin/bash

# This script delete/purge bad or invalid ROMs files.

shopt -s nullglob

for r in $(/home/pi/mame/mame -verifyroms | grep 'is bad' | awk '{print $2 ".zip"}')
  do
    if [ -f /home/pi/.mame/roms/$r ]; then
      sudo rm /home/pi/.mame/roms/$r
      echo -n .
    fi
  done
echo Completed!

Ajustement des permissions pour permettre l'exécution du script :

chmod +x ~/scripts/mame-badromspurge.sh

Utilitaire de nettoyage des fichiers graphiques (artworks)

Je vous propose le script ci-dessous pour nettoyer les fichiers .png des fichiers graphiques (artworks) lorsque le fichier ROM correspondant n'existe pas.

nano ~/scripts/mame-delartwork.sh

Coller le texte ci-dessous, puis sauvegarder :

#!/bin/bash

# This script delete unused Artwork files if the corresponding ROM .zip file does not exist.

shopt -s nullglob

if [ $1 ]; then
  if [ ! -f /home/pi/.mame/roms/$1.zip ]; then
    for t in snap titles marquees cpanels cabinets icons
      do
          if [ -f /home/pi/.mame/$t/$1.png ]; then
            sudo rm /home/pi/.mame/$t/$1.png
          fi
      done
  fi
else	# Batch mode
  if [ -t 0 ]; then echo -ne "\e[2K\rProcessing $1..."; fi
  for t in snap titles marquees cpanels cabinets icons
    do
      cd /home/pi/.mame/$t
      for f in *.{png,ico}
        do
          if [ ! -f /home/pi/.mame/roms/${f%.*}.zip ]; then
            sudo rm /home/pi/.mame/$t/$f
            echo -n .
          fi
        done
    done
  if [ -t 0 ]; then echo -e '\e[2K\rCompleted!'; fi
fi

Ajustement des permissions pour permettre l'exécution du script :

chmod +x ~/scripts/mame-delartwork.sh

Gestion automatisée du matériel graphique des ROMs

Un service systemd ainsi qu'un script surveillera l'emplacement des fichiers de ROMs. Dès qu'un changement survient (ajout ou suppression), le matériel graphique associé sera automatiquement mis à jour.

Installation des dépendances :

sudo apt-get install inotify-tools -y

Création du script :

nano ~/scripts/mame-artwork-mgmt.sh

Coller le texte ci-dessous, puis sauvegarder :

#!/bin/bash

# This script watch the ROMs folder and add/remove the corresponding artwork automatically.

inotifywait -m /home/pi/.mame/roms -e create -e moved_to -e delete -e moved_from |
  while read dir action file; do
    case ${action,,} in
      create | moved_to)
        if [ ${file##*.} = zip ]; then /home/pi/scripts/mame-scraper.sh ${file%.zip}; fi
        ;;
      delete | moved_from)
        if [ ${file##*.} = zip ]; then /home/pi/scripts/mame-delartwork.sh ${file%.zip}; fi
        ;;
    esac
  done

Ajustement des permissions pour permettre l'exécution du script :

chmod +x ~/scripts/mame-artwork-mgmt.sh

Création du service systemd associé :

sudo systemctl edit mame-artwork-mgmt.service --force --full

Coller le texte ci-dessous, puis sauvegarder :

[Unit]
Description=MAME Automatic Artwork Management service
After=network.target

[Service]
Type=simple
EnvironmentFile=/etc/environment
ExecStart=/home/pi/scripts/mame-artwork-mgmt.sh
KillSignal=SIGINT
TimeoutStopSec=5
Restart=always

[Install]
WantedBy=sysinit.target

Activer le service :

sudo systemctl enable mame-artwork-mgmt.service

Ajustement de la mémoire vidéo à 128 Mo

Ajuster la taille de la mémoire vidéo à 128 Mo en éditant le fichier /boot/config.txt :

sudo nano /boot/config.txt

Ajouter la ligne ci-dessous à la fin du fichier, puis sauvegarder :

gpu_mem=128

Mise en lecture-seule du Root FileSystem (Read-Only)

Afin de prolonger la vie la carte SD, nous allons mettre en lecture-seule les partitions suivantes :

/boot (vfat)
/     (ext4)

Pour ce faire, suivre les instructions décrites au sein de la page ci-dessous :

Make your Raspberry Pi file system read-only (Raspbian Buster)

Tel que décrit dans la procédure, deux alias (rw et ro) sont créés afin de basculer du mode lecture-écriture vers lecture-seule et vice-versa.

Ajustements (suite à la procédure de mise en lecture-seule)

Certains ajouts et ajustements s’avèrent nécessaires suite à l’application de la procédure ci-dessus.

Ajustez le fichier bash.bash_logout auquel il manque sudo comme préfixe :

sudo nano /etc/bash.bash_logout

Préfixez la commande mount de sudo, puis sauvegarder :

sudo mount -o remount,ro /
sudo mount -o remount,ro /boot

Ajustement des alias pour basculer du mode Arcade au mode Service et vice-versa :

nano ~/.bash_aliases

Préfixez la définition des deux alias par rw; et suffixez par ; ro, puis sauvegardez :

alias arcademode='rw; sudo systemctl enable mame-autostart.service; ro'
alias servicemode='rw; sudo systemctl disable mame-autostart.service; ro'

Suppression du fichier de swap (swap file) :

sudo rm /var/swap

Purge du contenu des points de montage qui basculeront vers tmpfs :

sudo systemctl stop smbd.service nmbd.service systemd-timesyncd.service

sudo rm -R /var/lib/samba/*
sudo rm -R /var/cache/samba/*
sudo rm -R /tmp/*
sudo rm -R /var/lib/systemd/timesync/*

Le contenu de l'emplacement /var/log/ quant à lui, ne peut être supprimé en ligne, car il est activement utilisé par le système. Une suppression hors-ligne (offline) sera nécessaire en fermant le système et en insérant la carte SD au sein d'un ordinateur hôte et en exécutant la commande suivante :

cd <rootfs mount point>
sudo rm -R ./var/log/*

Ajustement pour le Wi-Fi (configuration hors-ligne)

Un service nommé raspberrypi-net-mods.service permet la configuration du réseau Wi-Fi en plaçant un fichier nommé wpa_supplicant.conf dans /boot. Ce service déplace ce fichier vers /etc/wpa_supplicant et a par conséquent besoin d'écrire dans /etc/wpa_supplicant et /boot (pour supprimer wpa_supplicant.conf une fois déplacé).

Nous allons ajouter un drop-in systemd pour ajuster la configuration du service :

sudo mkdir /etc/systemd/system/raspberrypi-net-mods.service.d
sudo nano /etc/systemd/system/raspberrypi-net-mods.service.d/readonlyfs-fixup.conf

Coller le texte ci-dessous, puis sauvegarder :

[Service]
ExecStartPre=/bin/sh  -c "mount -o remount,rw /boot; mount -o remount,rw /"
ExecStartPost=/bin/sh -c "mount -o remount,ro /boot; mount -o remount,ro /"

Ajustement pour le service SSH (activation hors-ligne)

Un service nommé sshswitch.service permet l'activation du service SSH, simplement en plaçant un fichier vide nommé ssh dans /boot. Lorsque présent, ce service supprime le fichier et active le service SSH, nécessitant temporairement l'écriture dans /boot et /.

Nous allons ajouter un drop-in systemd pour ajuster la configuration du service :

sudo mkdir /etc/systemd/system/sshswitch.service.d
sudo nano /etc/systemd/system/sshswitch.service.d/readonlyfs-fixup.conf

Coller le texte ci-dessous, puis sauvegarder :

[Service]
ExecStartPre=/bin/sh  -c "mount -o remount,rw /boot; mount -o remount,rw /"
ExecStartPost=/bin/sh -c "mount -o remount,ro /boot; mount -o remount,ro /"

Ajustement pour le service de mise à jour du firmware

Un service nommé rpi-eeprom-update.service permet de mettre à jour le firmware du Raspberry Pi. Ce service travaille dans /boot et doit pouvoir supprimer les fichiers une fois la mise à jour terminée. Nous devons donc temporairement autoriser l'écriture dans /boot.

Nous allons ajouter un drop-in systemd pour ajuster la configuration du service :

sudo mkdir /etc/systemd/system/rpi-eeprom-update.service.d
sudo nano /etc/systemd/system/rpi-eeprom-update.service.d/readonlyfs-fixup.conf

Coller le texte ci-dessous, puis sauvegarder :

[Service]
ExecStartPre=/bin/sh  -c "mount -o remount,rw /boot"
ExecStartPost=/bin/sh -c "mount -o remount,ro /boot"

Ajustements pour le service de synchronisation de l'heure

Le service de synchronisation de l'heure via NTP (systemd-timesyncd.service) n'est pas adapté aux systèmes de fichiers racine (root filesystem) en lecture-seule. Certaines adaptations s'avèrent nécessaires.

Ajouter à /etc/fstab, puis sauvegarder :

tmpfs    /var/lib/private           tmpfs   nosuid,mode=0755,nodev     0   0
tmpfs    /var/lib/systemd/timesync  tmpfs   nosuid,mode=0755,nodev     0   0

Nous allons ajouter un drop-in systemd pour ajuster la configuration du service :

sudo mkdir /etc/systemd/system/systemd-timesyncd.service.d
sudo nano /etc/systemd/system/systemd-timesyncd.service.d/readonlyfs-fixup.conf

Coller le texte ci-dessous, puis sauvegarder :

[Service]
PrivateTmp=no
RestartSec=5

Ajustement pour le service de mise à jour automatique

Puisque le système de fichiers racine (root filesystem) est en lecture-seule, il est inutile dans ce contexte de laisser en fonction les unités systemd qui téléchargent automatiquement les mises à jour de paquets. Vous devrez plutôt utiliser la commande update (après avoir fait passer le système en lecture/écriture avec la commande rw) lorsque vous aurez démarré le système en mode Service (commande servicemode).

sudo systemctl stop systemd-tmpfiles-clean.timer apt-daily.timer apt-daily-upgrade.timer man-db.timer systemd-tmpfiles-clean.service apt-daily-upgrade.service
sudo systemctl disable systemd-tmpfiles-clean.timer systemd-tmpfiles-clean apt-daily.timer apt-daily-upgrade.timer man-db.timer systemd-tmpfiles-clean.service apt-daily-upgrade.service
sudo systemctl mask systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service apt-daily-upgrade.service

Ajustements pour le service Random Seed

Nous allons ajouter un drop-in systemd pour ajuster la configuration de ce service :

sudo mkdir /etc/systemd/system/systemd-random-seed.service.d
sudo nano /etc/systemd/system/systemd-random-seed.service.d/readonlyfs-fixup.conf

Coller le texte ci-dessous, puis sauvegarder :

[Service]
ExecStartPre=/bin/echo "" >/tmp/random-seed

Application des changements au sein de systemd :

sudo systemctl daemon-reload

Ajustements pour le spooler

Les permissions de /tmp sont changées quand on utilise un lien symbolique pour /var/spool. Pour faire en sorte que les permissions de /tmp ne soient pas changées :

Ajout d'un point de montage dédié pour /var/spool :

Au lieu de ces deux commandes (dans la procédure ci-dessus) :

sudo rm -rf /var/spool
sudo ln -s /tmp /var/spool

Si celles-ci ont déjà été exécutées, retirer le lien symbolique (sudo rm /var/spool) et récréer l'emplacement (mkdir /var/spool).

Ajouter plutôt à /etc/fstab l’entrée suivante :

tmpfs        /var/spool         tmpfs   nosuid,nodev            0    0

Ajustements pour Samba

Pour faire tourner correctement le serveur Samba avec un rootfs en lecture-seule :

Ajouter à /etc/fstab :

tmpfs     /var/lib/samba             tmpfs   nosuid,mode=0755,nodev    0   0
tmpfs     /var/lib/samba/private     tmpfs   nosuid,mode=0755,nodev    0   0
tmpfs     /var/log/samba             tmpfs   nosuid,mode=0755,nodev    0   0
tmpfs     /var/cache/samba           tmpfs   nodev,nosuid              0   0
tmpfs     /var/spool/samba           tmpfs   nodev,nosuid              0   0
tmpfs     /var/run/samba             tmpfs   nodev,nosuid              0   0

Redémarrer le système :

sudo reboot

Une fois redémarré, valider que celui-ci est bien en lecture-seule :

Ouvrez une session (console ou SSH)
Une fois logué, l'invite de commande devrait indiquer le suffixe (ro) (pour read-only)

Bascule en mode Arcade

Activer temporairement le mode lecture/écriture du Root FileSystem, basculer en mode Arcade (mode normal) et redémarrer :

arcademode
sudo reboot

Ajustements pour périphérique de sortie (TV ou moniteur)

[Optionnel/TV] Changement de l'identifiant CEC

Si vous utilisez un téléviseur branché via HDMI et que plusieurs sources y sont reliées, vous pouvez personnaliser l'identifiant CEC (Consumer Electronics Control) qui sera affiché pour la source (entrée HDMI) associée au Raspberry Pi :

sudo nano /boot/config.txt

Ajouter la ligne suivante (où Arcade est le nom/identifiant CEC qui sera affiché), puis sauvegarder :

cec_osd_name=Arcade

[Optionnel/Audio] Bascule de l'audio vers la sortie analogique

Si vous voulez utiliser la sortie analogique (audio jack 3.5mm) du Raspberry Pi pour l'aiguiller vers un amplificateur, procédez comme suit.

sudo nano /etc/asound.conf

Coller les lignes ci-dessous, puis sauvegarder :

pcm.!default {
type hw
card 1
}

ctl.!default {
type hw
card 1
}

[Optionnel/Audio] Réglage du volume de sortie audio

Pour régler (ajuster selon vos besoins) le volume de la sortie audio, exécutez la commande suivante :

alsamixer

Faites glisser le curseur du volume selon votre préférence, puis quittez (à l'aide de la touche ESC).

Pour sauvegarder de manière persistante le changement, exécutez :

sudo alsactl store

[Optionnel/TV] Désactivation des bordures noires (Overscan)

sudo nano /boot/config.txt

Décommenter la ligne ci-dessous :

disable_overscan=1

[Optionnel] Rotation de l'écran à 90 degrés

Si vous comptez utiliser votre système d'arcade pour les jeux verticaux (shoot 'em up, par exemple), suivez ces étapes.

Le fait d'utiliser le pilote DRM VC4 V3D (vc4-fkms-v3d) ne nous permet malheureusement pas (du moins en ce moment) d'utiliser la fonctionnalité de rotation de l'écran au niveau du pilote (par le biais du réglage display_hdmi_rotate= dans /boot/config.txt). Nous devrons contourner ce problème en appliquant la rotation à chacune des composantes individuellement (console en mode texte, splash de boot et shutdown et interface graphique de MAME).

Rotation de la console à 90 degrés :

sudo nano /boot/cmdline.txt

Ajouter ceci à la fin de ligne de commande du kernel, puis sauvegarder :

fbcon=rotate:1

Rotation des images de splash (boot et shutdown) :

sudo systemctl edit mame-bootsplash.service --force --full

Ajustez la ligne ExecStart en ajoutant -C _orientation=1, puis sauvegardez :

ExecStart=/usr/bin/fim -q --no-history -C _orientation=1 /home/pi/splash/mame-boot.jpg

sudo systemctl edit mame-shutdownsplash.service --force --full

Ajustez la ligne ExecStart en ajoutant -C _orientation=1, puis sauvegardez :

ExecStart=/usr/bin/fim -q --no-history -C _orientation=1 /home/pi/splash/mame-shutdown.png

Rotation de l'interface graphique de MAME :

nano ~/.mame/mame.ini

Ajustez la section ci-dessous, puis sauvegardez :

#
# CORE ROTATION OPTIONS
#
rotate                    1
ror                       1

Pour maximiser la visibilité du nom des ROMS, nous devons cacher le panneau de gauche qui affiche le filtre actif :

nano ~/.mame/ini/ui.ini

Ajustez le réglage ci-dessous à la valeur 1, puis sauvegardez :

hide_main_panel           1

Amélioration du rendu vidéo pour les téléviseurs

Afin d'améliorer le rendu vidéo, de permettre le bon fonctionnement de la synchronisation verticale (VSync) qui est activée au sein de cette procédure et également de minimiser le délai de latence des contrôles (manette, boutons), assurez-vous de sélectionner le Mode Jeu / Game Mode (ou équivalent) sur votre téléviseur.

C'est complété !

Voilà, c'est terminé ! Vous pouvez maintenant passer à l'étape de l'intégration de votre Raspberry Pi 4B à un projet d'arcade pour la maison : un cabinet de type comptoir (Bartop) ou encore pleine hauteur/format original.

Je vous souhaite la meilleure des chances pour votre projet d'arcade !

-------------- FIN DE LA PROCÉDURE --------------

Si vous appréciez le travail et le soin que j'ai mis à monter cette solution, je vous propose de m'offrir un café, ceci m'encouragera à maintenir cette procédure bien vivante et à jour. :-)

Buy me a coffee

Turkzilla/RPi4.MAME.Appliance.md

How to make a dedicated MAME Appliance on a Raspberry Pi 4B

Comment réaliser un système MAME dédié sur un Raspberry Pi 4B

-------------- DÉBUT DE LA PROCÉDURE --------------

Création des symlinks…

Mise en lecture-seule du Root FileSystem (Read-Only)

Bascule en mode Arcade

Ajustements pour périphérique de sortie (TV ou moniteur)

Rotation de la console à 90 degrés :

Rotation des images de splash (boot et shutdown) :

Rotation de l'interface graphique de MAME :

C'est complété !

-------------- FIN DE LA PROCÉDURE --------------