Aller au contenu

Premiers pas

Installer APIExpose tient en un installateur : on télécharge, on lance, on active.

Avant de commencer

  • une installation RetroBat fonctionnelle ;
  • une connexion Internet si .NET 8 n'est pas encore installé : l'installateur télécharge et installe lui-même ce qui manque (ASP.NET Core Runtime 8 et .NET Desktop Runtime 8), Windows vous demande simplement l'autorisation ;
  • une sauvegarde de votre dossier RetroBat si votre installation compte pour vous - APIExpose modifie gamelists et réglages.

Installation

  1. Téléchargez APIExpose-Cabinet-Setup.exe depuis la page des releases - il contient le programme, les outils (ImageMagick, translateLocally) et le Data Pack complet.
  2. Lancez l'installateur : il vérifie .NET 8, installe le plugin dans RetroBat\plugins\ et pose le hook de démarrage EmulationStation - vous obtenez :

    RetroBat\plugins\APIExpose\
    
  3. Relancez RetroBat normalement : APIExpose démarre automatiquement, fait ses traitements de démarrage, puis laisse EmulationStation continuer.

Que fait le hook ?

L'installateur enregistre uniquement ce script côté EmulationStation, sans modifier updatestores.bat ni le reste de RetroBat :

emulationstation\.emulationstation\scripts\start\APIExpose-start-wait.bat

Il fait patienter EmulationStation le temps qu'APIExpose soit prêt, deux minutes au plus, et pas du tout si APIExpose ne peut pas démarrer : RetroBat ne reste jamais bloqué. Ce qui s'est passé au dernier démarrage est écrit dans plugins\APIExpose\.log\es-start-hook.log.

Vérifier que ça marche

APIExpose lancé, ouvrez dans un navigateur :

http://127.0.0.1:12345/api/v1/health

Réponse attendue :

{ "status": "healthy", "version": "1.0.0+..." }

L'état du démarrage est sur /api/v1/startup/ready, et la liste complète des endpoints sur http://127.0.0.1:12345/swagger/index.html.

Vos réglages, directement dans RetroBat

APIExpose ajoute ses options dans les menus d'EmulationStation, traduites - pas de fichier à éditer pour l'usage courant :

EXTENDED OPTIONS
API SETTINGS
AUTO SCRAPING MANAGER
LOCAL MEDIA MANAGER
ROMS PACK MANAGER
THEMES MANAGER
COLLECTIONS PACK MANAGER

Arrêter ou désinstaller

Action Comment
Arrêter APIExpose Double-clic sur stop.bat
Retirer le lancement automatique Double-clic sur uninstall-es-start-hook.bat
Tout désinstaller Paramètres Windows, Applications, « APIExpose (borne RetroBat) » : le hook est retiré aussi

Les fichiers restent dans plugins\APIExpose - relancer le hook réactive tout.

Conseils simples

Installez le hook une seule fois, puis lancez RetroBat normalement. Ne supprimez pas les dossiers media\, resources\, tools\ ou wrapper\ : APIExpose en a besoin.