Hyperspin Partie 1, Présentation du frontend et de ses composants

Après avoir détaillé en 3 chapitres la préparation de base de sa MameBox (voir dans la section "Hardware"), nous allons maintenant attaquer le second gros morceau du travail, à savoir la mise en place du frontend HyperSpin et sa configuration.
Avant de commencer, je voudrais préciser une chose très importante si vous avez dans l’idée de tout configurer vous-même, à savoir que sans aucun doute possible, Hyperspin est le frontend le plus compliqué à configurer, ce qui ne l’empêche pas d’être un des meilleurs, mais il nécessite une autonomie certaine de votre part. Jamais nous ne serions arrivé à un tel niveau de compréhension de ce système sans avoir cherché sur internet et bidouiller pendant des heures (plutôt des mois) les fichiers qui le compose.
La chose qu’il faut avoir à l’esprit, c’est que malgré les tutoriaux disponibles ici même, il vous arrivera toujours des petits problèmes qui ne devraient pas survenir mais qu’il existe toujours une solution, il suffit juste de chercher par soi même soit sur internet ou soit en plongeant directement dans les fichiers ini, ahk ,xml et j’en passe, d’essayer de nouvelles choses et de tester, en gros de s’investir vraiment à fond la dedans sans attendre que la réponse vous tombe dans le bec comme ca.
Toute la communauté d'HyperFreeSpin sera la pour aider ainsi que certains autres sur d'autres forums comme Neo Arcadia ou Gamoover.
Allez, en route !
 

Qu’est ce qu’Hyperspin ?

 
Hyperspin (noté souvent HS par la suite) est un frontend.
Qu’est ce qu’un frontend ? C’est une interface qui vous permettra de vous passer de clavier, de souris et ainsi de contrôler le lancement de vos jeux par votre control panel en remplaçant l’environnement bureautique de Windows par une interface graphique beaucoup plus sympa et intuitive qui colle parfaitement à l’esprit d’une borne d’arcade. Il en existe beaucoup mais aucun n’est aussi personnalisable et abouti graphiquement qu’HS.
L’interface d’Hyperspin se présente sous forme de roues appelées « Wheels » que l’on tourne pour accéder à tel émulateur, puis à tel jeu, le tout étant animé par des thèmes, images et vidéos que l’on aura préalablement installés. Ce qui nous donne par exemple ce résultat :

 
Vous voyez par exemple la roue à droite et les émulateurs présents sur le système mais ce n’est juste que le thème par défaut d’HS. Il en existe des centaines différents, vous pouvez même créer les votre, mettre la roue à gauche, en bas en haut… La roue peut avoir autant d'entrées que vous le souhaitez et tous les thèmes graphiques d'HyperSpin que ce soit pour les jeux ou pour les émulateurs sont externes à l'exécutable pour une personnalisation maximale de l'apparence de votre interface.
Un autre exemple avec le thème d’un jeu (pas n'importe lequel) :

 
Voici un des thèmes disponibles avec une vidéo, une image de fond, le nom du jeu et l’année de sortie, etc…
Ce qui est vraiment génial, c'est que chaque élément du menu ou de sous-menu peut être modifié, de la simple image de Wheel à la vidéo d’intro au lancement d’Hyperspin. Vous pourrez aussi les changer par un autre média que vous aurez trouvé ou créer les votre pour avoir votre interface ! On peut aussi se faire un système entièrement vertical. Tout ou presque est possible avec HS, ce qui le rend vraiment top !
Alors loin de moi l’idée de vous décourager dans ce projet, mais sachez qu’avant d’en arriver à ce genre de résultat, il y a énormément de pain sur la planche et ne comptez pas les heures de tri, de configuration et de réglages sinon crise cardiaque garantie !^^

 

Installation

 
Premièrement l’installation d’Hyperspin. Vous aurez besoin de plusieurs choses pour avoir le frontend le plus à jour possible. Pour pouvoir télécharger les liens suivants, vous devez vous inscrire gratuitement sur le site officiel d’Hyperspin. Voici les liens pour la dernière version, prenez bien les tous les fichiers, tout sera expliqué ensuite :
Hyperspin 1.0 : http://www.hyperspin-fe.com/forum/downloads.php?do=file&id=3231
Hyperspin 1.3.0 : http://www.hyperspin-fe.com/downloads/HyperSpin/HyperSpin_1_3.zip
HyperTheme : http://rapidshare.com/files/876714319/HyperTheme115.zip
HyperLaunch 2.25c : http://www.hyperspin-fe.com/forum/attachment.php?attachmentid=19849&d=1345955595
Il n’y a pas vraiment d’installation, dans l’ordre :
- Dezipper l’archive d’HS 1.0 dans un dossier sur votre disque dur ;
- Extraire l’archive d’HS 1.3.0 dans le même dossier et écraser les anciens .exe par les nouveaux ;
- Extraire HyperTheme dans le même dossier qu’Hyperspin et écraser l’ancien ;
- Extraire l’archive d’HyperLaunch dans le même dossier et écraser l’ancien ;
- Dans le dossier d’HS, créez les dossiers « Emulators » et « Modules »
- Vous pouvez supprimer le fichier « EULA – READ ME .txt »
L'installation se compose de 6 dossiers principaux, l'exécutable Hyperspin est à la racine, ainsi que HyperLaunch, HyperHQ, HyperTheme et HyperBrite.
 
Normalement, cela devrait vous donner ca :

 
Tout ceci ne vous dit pour l’instant rien donc je vais décortiquer chaque dossier et fichier pour y voir plus clair.
D’abord quelques termes que j’utiliserai dorénavant pour désigner certaines choses :
Wheel : roue en anglais, désigne la roue ou l’image servant a identifier la sub wheel suivante.
Sub Wheel : une roue qui se trouve après une autre. Par exemple, le système Mame est dans la Wheel principal et quand on entre dedans pour sélectionner sa rom, on entrera dans sa Sub Wheel, c'est-à-dire sa Wheel de roms.
XML : Désigne un ou des fichiers XML présents dans le dossier « Databases ».
AHK : Désigne un ou des fichiers AHK présents dans le dossier « Modules ».
INI : Désigne un ou des fichiers INI présents dans le dossier « Settings ».
HQ : Désigne Hyper HQ.
 

Les dossiers

 
 

Databases

 
Le dossier « Databases » comporte des bases de données XML qui contiennent les informations que HyperSpin va afficher dans son interface, les systèmes et leurs roms donc. Chaque Wheel (roue) est en fait une base de données. Nous verrons plus tard comment il est possible de faire le tri dans ce que vous voulez afficher ou non, comment éditez un fichier xml ou même éditer automatique un xml avec toutes vos roms pour chaque système.
 

Emulators

 
C’est simplement le dossier où vous mettrez tous vos émulateurs avec leurs roms. Je vous conseille de créer un dossier pour chaque émulateur afin d'éviter gros bordel dans la suite de votre configuration.
 

HyperTheme

 
Ce dossier comprend vos thèmes créés avec HyperThme (voir plus bas) et une licence 7-zip autonome pour compresser les thèmes. HyperTheme placera votre thème, avec les artwork renommés, dans un sous-dossier nommé d'après le thème. Le logiciel compresse deux thèmes en .zip. L'un sera nommé selon la charte mise en place par le créateur d'Hyperspin (GameName - créateur (AAAAMMJJ).zip). L'autre copie sera à placer directement dans votre dossier de thèmes (gamename.zip).
Nous en parlons en détail un peu plus bas.
 

Media

 
« Media » est l’endroit où vos stockerez toutes vos images, vidéos, thèmes, sons… En gros tous les détails de votre interface. Dans chaque dossier d’un système sera présent 4 sous dossiers qui sont :

 
Le dossier « Themes » sera celui qui accueillera les thèmes de vos roms et le dossier « Video » contiendra leurs vidéos propres, nous y reviendrons dans un autre tuto.
Attardons nous juste sur les dossiers restants. Commençons par « Images » :

 
Ces différents sous dossiers serviront à classer vos images en fonction de leurs natures pour qu’Hyperspin puisse bien les afficher. Vous verrez que le plus important d’entre eux sera le dossier « Wheel » qui contiendra les images designant vos jeux dans la Sub Wheel rom du système.
Passons au dossier « Sound » :

 
Ces sous dossiers vous serviront à classer les sons que vous voudrez ajouter à Hyperspin selon leurs natures encore une fois.
Nous reviendrons sur le classement des médias dans un futur tuto.
 

Modules

 
« Modules » est l’endroit où vos stockerez tous les modules, les fichiers AHK donc, servant à Hyperlaunch pour lancer puis quitter les émulateurs. Je reviens en détails sur les modules un peu en dessous avec Hyperlaunch.
 

Settings

 
Le dossier « Settings » contiendra tous vos fichiers de paramétrage par système. Chaque Wheel est contrôlé par ces fichiers ini. Les fichiers settings sont des fichiers texte avec l'extension.ini que vous pourrez modifier avec NotePad ++. Mais vous pouvez également gérer vos settings avec HyperHQ, ce qui est le plus simple et ce qui se fera de manière général mais vous verrez qu’il est des fois bien avisé de venir mettre son nez dans les ini en eux même que de passer par HQ.
Pour résumé avec un petit tableau:
--------------------------------------------------------------------------------------------------------------------------------------
La mécanique de fonctionnement est la suivante (Etape -----> Commentaire):
1 - Lancement de HyperSpin.exe -----> Programme Principal
2 - HyperSpin lance le thème du système sélectionné -----> Utilise le répertoire média et affiche le thème correspondant
3 - Sélection d’un thème -----> Affichage de la liste des jeux du répertoire database et du fichier XML correspondant
4 - Sélection d’un jeu -----> Affichage du thème du jeu s’il existe
5 - Vérification du jeu -----> Utilise le fichier INI du système pour trouver l’exécutable de l’émulateur et les répertoires définis pour trouver les jeux
6 - Vérification du jeu -----> Vérification de l’existence du jeu selon le nom déclaré dans le fichier XML et de l’extension déclarée dans le fichier IN
7 - Lancement du jeu -----> Transmission des paramètres HyperLaunch.exe à l’exécutable
En résumé, la déclaration du répertoire des jeux pour un système donné est unique, comme pour les extensions des fichiers des jeux. Généralement les émulateurs utilisent des fichiers roms qui sont des extensions Zip...
--------------------------------------------------------------------------------------------------------------------------------------

 

Les soft annexes

 

Hyperlaunch et ses fichiers (voir photo précédente)

 
Hyperlaunch est le programme qui permet de dire à Hyperspin de lancer tel ou tel émulateur avec tel rom, de faire tourner le jeu en premier plan et ensuite de quitter l’émulateur pour revenir sur le frontend directement. Pour schématiser, HyperSpin serait le chef d’orchestre et Hyperlaunch serait les musiciens. Et pour que les musiciens puissent jouer, il s leurs faut bien sur des instruments et dans ce cas, ces instruments seront les modules qui sont des fichiers au format AHK que vous mettrez dans le dossier « Modules ».
Un module est en fait un fichier AutoHotKey qui contient des informations comme « démarrer cet émulateur avec ce jeu » ou encore « quitter l’émulateur et revenir sur Hyperspin »par exemple, des données lisibles par HyperLaunch pour que l’émulateur fonctionne correctement avec Hyperspin.
Il faut savoir qu’un module n’est pas propre à un système (Megadrive par exemple) mais à un émulateur (Kega Fusion, Mess, Haze MD…), comprenez par la qu’en fonction de l’émulateur que vous choisirez, vous aurez besoin d’un module différent. L’explication vient du fait que tous les émulateurs ne sont pas fait de la même façon et que le fichier AHK ne contiendra pas les mêmes informations à donner à Hyperlaunch, logique.
Nous reviendrons de façon beaucoup plus approfondie sur l’utilisation d'HyperLaunch et l’édition des modules dans la 4ème partie de ce dossier.
 

Hyperbrite

 
Hyperbrite ne sera pas utile pour la quasi-totalité d’entre nous mais son intérêt est très intéressant. C’est un soft qui permet à Hyperspin d’afficher des données sur des afficheurs à leds externes. Par exemple, le nom d’un système ou d’une rom, des données sur le jeu que l’utilisateur aura paramétré, voir même les High Scores du jeu !
Une petite vidéo sera plus parlante.
 
http://www.youtube.com/watch?feature=player_embedded&v=IpcBQFQu6gQ

HyperHQ

 
Sans doute votre meilleure ami dans cette aventure, cet exécutable permet en effet d'éviter aux allergiques de la bidouille au bloc notes, de longues heures de configurations. C’est en fait une interface de configuration d’Hyperspin. Entre beaucoup d’autres, il vous permettra d’afficher vos systèmes sous HS, de lier vos émulateurs au frontend pour qu’ils puissent se lancer, etc…
Comme nous le disons, voyez-le comme le menu "Options" de votre Hyperspin.
Nous détaillerons entièrement le fonctionnement d'HyperHQ dans la seconde partie de ce dossier.
 

HyperSpin

 
Tout simplement l’exécutable de notre frontend !
 

HyperTheme

 
HyperTheme est un logiciel de création de thème pour HS. Vous pourrez donc par son biais exprimer votre créativité en créant de nouveaux thèmes pour vos jeux si le cœur vous en dit. Seul petit bémol, il n’est qu’en anglais mais, rassurez vous, nous nous sommes déjà ocuppé de tout ici et avons réalisé deux tutoriels ultra complet sur cet éditeur, l'un écrit et l'autre vidéo, entièrement en français.
Ca se passe ici :
-
-
 
Pour conclure cette première partie, je me permettrai de citer Hervéni du forum Gamoover qui résume parfaitement un des points essentiels de ce frontend.
 
En effet, un des premiers trucs à piger, c'est qu'Hyperspin comme la plupart des frontend fonctionne sur 2 plans qu'on va appeler "la forme" et "le fond".
La forme, c'est tout ce qui se rapporte au menu en lui-même :
- Le nombre de roues affichées ;
- Quels seront les jeux affichés par système ;
- S'il y a des vidéos/images/animations flash disponibles pour illustrer tel menu ou tel jeu ;
- Etc …
Les répertoires concernés sont "Databases" (pour les listes de roms en xml avec plus ou moins d'infos complémentaires à afficher comme l'éditeur ou l'année de sortie du jeu) et "Media" (pour y coller tous les médias liés à votre liste de jeux).
Le fond, c'est ce qu'il se passe avec entre l’émulateur et Hyperspin dès que vous lancez ou stoppez un jeu :
- Lancer tel ému, avec tels paramètres ;
- Charger un iso dans un lecteur virtuel ;
- Lancer un logiciel tiers pour ajouter par exemple le support des fichiers 7zip alors que de base l'émulateur ne les reconnait pas ;
- Sauvegarder les hi-scores en quittant le jeu ;
- Etc …
Les répertoires concernés sont "Modules" (pour y coller les fichiers ahk de chaque émulateur spécifique) et " Settings" (qui stocke les paramètres de base pour chaque roue).
Ces 2 parties sont plus ou moins indépendantes. Vous pouvez donc avoir un joli menu sans la moindre rom, ni même le moindre émulateur (c'est par exemple la config de base après avoir téléchargé Hyperspin), ou vous pouvez également ajouter pléthore de roms et systèmes supplémentaires dans l'arborescence d'Hyperspin sans que ce dernier n'en tienne compte (tant que la database en xml ne correspond pas avec les noms des roms présentes).
Pour que tout fonctionne, il faut donc agir de concert sur ces 2 tableaux.
 
Voila un premier jet complet sur ce qu’est Hyperspin et comment il s’articule. La seonde partie de ce dossier portera uniquement sur HyperHQ et détaillera tous ses menus et options.
 

Enjoy !