From 9c65faff286e339e6a2217599b9b7a5f0f2823f1 Mon Sep 17 00:00:00 2001 From: RGS <102905084+RetroGameSets@users.noreply.github.com> Date: Thu, 31 Jul 2025 20:55:29 +0200 Subject: [PATCH] Update README.md --- README.md | 67 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 40 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index a5718d9..bbd0c26 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,47 @@ # 🎼 Retro Game Sets Xtra (RGSX) -RGSX est une application Python basĂ©e sur Pygame. +RGSX est une application developpĂ©e en Python basĂ©e sur Pygame pour la partie graphique pour la communautĂ©e par RetroGameSets. Elle est entiĂšrement gratuite. + +L'application prend en charge plusieures sources comme myrient, 1fichier. Ces sources pourront ĂȘtre mises Ă  jour frĂ©quemment. --- ## ✹ FonctionnalitĂ©s -- **TĂ©lĂ©chargement de jeux** : Prise en charge des fichiers ZIP et gestion des extensions non supportĂ©es grĂące au fichier `info.txt` dans chaque dossier. +- **TĂ©lĂ©chargement de jeux** : Prise en charge des fichiers ZIP et gestion des extensions non supportĂ©es grĂące au fichier `info.txt` dans chaque dossier (batocera), qui extrait automatiquement si le systeme ne supporte pas les archives. - Les tĂ©lĂ©chargements ne nĂ©cessitent aucune authentification ni compte pour la plupart. - Les systĂšmes notĂ©s `(1fichier)` dans le nom ne seront accessibles que si vous renseignez votre clĂ© API 1fichier (voir plus bas). - **Historique des tĂ©lĂ©chargements** : Consultez et retĂ©lĂ©chargez les anciens fichiers. -- **Personnalisation des contrĂŽles** : Remappez les touches du clavier ou de la manette Ă  votre convenance avec dĂ©tection automatique des noms de boutons depuis EmulationStation. +- **Personnalisation des contrĂŽles** : Remappez les touches du clavier ou de la manette Ă  votre convenance avec dĂ©tection automatique des noms de boutons depuis EmulationStation(beta). +- **Changement de taille de police** : Si vous trouvez les ecritures trop petites/trop grosses, vous pouvez le changer dans le menu. - **Mode recherche** : Filtrez les jeux par nom pour une navigation rapide avec clavier virtuel sur manette. -- **Support multilingue** : Interface disponible en plusieurs langues. -- **Gestion des erreurs** avec messages informatifs. -- **Interface rĂ©active** : L'interface s'adapte Ă  toutes rĂ©solutions de 800x600 Ă  4K (non testĂ© au-delĂ  de 1920x1080). -- **Mise Ă  jour automatique** (bug d'affichage Ă  amĂ©liorer lors d'une mise Ă  jour) : l'application doit ĂȘtre relancĂ©e aprĂšs sa fermeture automatique. +- **Support multilingue** : Interface disponible en plusieurs langues. Vous pourrez choisir la langue dans le menu +- **Gestion des erreurs** avec messages informatifs et fichier de LOG +- **Interface adaptatative** : L'interface s'adapte Ă  toutes rĂ©solutions de 800x600 Ă  4K (non testĂ© au-delĂ  de 1920x1080). +- **Mise Ă  jour automatique** : l'application doit ĂȘtre relancĂ©e aprĂšs une mise Ă  jour. --- ## đŸ–„ïž PrĂ©requis ### SystĂšme d'exploitation -- Batocera ou Knulli +- Batocera / Knulli ou Retrobat ### MatĂ©riel +- PC, Raspberry, console portable .... - Manette (optionnelle, mais recommandĂ©e pour une expĂ©rience optimale) ou Clavier. +- Connexion internet active ### Espace disque -- Espace suffisant pour stocker les ROMs, images et fichiers de configuration. +- 100 mo pour l'application. --- ## 🚀 Installation -### MĂ©thode 1 : Ligne de commande +### MĂ©thode 1 : Installation automatique en ligne de commande pour Batocera/Knulli -- Sur batocera PC acceder Ă  F1>Applications>xTERM ou +- Sur batocera x86 PC acceder Ă  F1>Applications>xTERM ou - Depuis un autre pc sur le rĂ©seau avec application Putty, powershell SSH ou autre Entrez la commande : @@ -48,10 +53,10 @@ Vous trouverez RGSX dans le systĂšme "PORTS" ou "Jeux Amateurs et portages" et d --- -### MĂ©thode 2 : Copie manuelle +### MĂ©thode 2 : Copie manuelle (Methode obligatoire sur retrobat) - TĂ©lĂ©chargez le contenu du dĂ©pĂŽt en zip : https://github.com/RetroGameSets/RGSX/archive/refs/heads/main.zip -- Extrayez le tout dans `roms/ports/RGSX` (le dossier RGSX devra ĂȘtre crĂ©Ă© manuellement). Attention de bien respecter la structure indiquĂ©e plus bas. +- Extrayez le fichier zip dans le dossier ROMS (pour Batocera, seul le dossier PORTS sera utilisĂ© pour Retrobat il faudra extraire PORTS et WINDOWS) - Mettez Ă  jour la liste des jeux via le menu : `ParamĂštres de jeux > Mettre Ă  jour la liste`. @@ -60,16 +65,17 @@ Vous trouverez RGSX dans le systĂšme "PORTS" ou "Jeux Amateurs et portages" et d --- > ## IMPORTANT > Si vous avez une clĂ© API 1Fichier, vous devez la renseigner dans -> `/saves/ports/RGSX/1FichierAPI.txt` +> `/saves/ports/rgsx/1FichierAPI.txt` > si vous souhaitez tĂ©lĂ©charger depuis des liens 1Fichier. --- -- Lancez RGSX depuis ports. +- Lancez RGSX depuis ports sur batocera, depuis Windows sur Retrobat. - Au premier lancement, l'application importera automatiquement la configuration des contrĂŽles depuis EmulationStation si disponible. - Configurez les contrĂŽles si nĂ©cessaire. Ils pourront ĂȘtre reconfigurĂ©s via le menu pause par la suite. -- Supprimez le fichier `/saves/ports/RGSX/controls.json` en cas de problĂšme puis relancez l'application. +- Supprimez le fichier `/saves/ports/rgsx/controls.json` en cas de problĂšme puis relancez l'application. - L'application tĂ©lĂ©chargera toutes les donnĂ©es nĂ©cessaires automatiquement ensuite. +INFO : pour retrobat au 1er lancement, l'application tĂ©lĂ©chargera Python dans le dossier /system/tools/python qui est necessaire pour faire fonctionner l'application. Le fichier fait environ 50mo et va assez vite a tĂ©lĂ©charger mais il n'y a aucun retour visuel a l'ecran, qui va rester figĂ© sur le chargement de RGSX pendant quelques secondes. --- ## đŸ•č Utilisation @@ -78,8 +84,8 @@ Vous trouverez RGSX dans le systĂšme "PORTS" ou "Jeux Amateurs et portages" et d - Utilisez les touches directionnelles (D-Pad, flĂšches du clavier) pour naviguer entre les plateformes, jeux et options. - Appuyez sur la touche configurĂ©e comme start (par dĂ©faut, **P** ou bouton Start sur la manette) pour ouvrir le menu pause. -- Depuis le menu pause, accĂ©dez Ă  l'historique, Ă  l'aide des contrĂŽles (l'affichage des contrĂŽles change suivant le menu oĂč vous ĂȘtes) ou Ă  la reconfiguration des touches. -- Vous pouvez aussi, depuis le menu, rĂ©gĂ©nĂ©rer la liste des systĂšmes/jeux/images pour ĂȘtre sĂ»r d'avoir les derniĂšres mises Ă  jour. +- Depuis le menu pause, accĂ©dez Ă  l'historique, Ă  l'aide des contrĂŽles (l'affichage des contrĂŽles change suivant le menu oĂč vous ĂȘtes) ou Ă  la reconfiguration des touches, des langues, de la taille de la police. +- Vous pouvez aussi, depuis le menu, rĂ©gĂ©nĂ©rer le cache de la liste des systĂšmes/jeux/images pour ĂȘtre sĂ»r d'avoir les derniĂšres mises Ă  jour. --- @@ -87,13 +93,13 @@ Vous trouverez RGSX dans le systĂšme "PORTS" ou "Jeux Amateurs et portages" et d - SĂ©lectionnez une plateforme, puis un jeu. - Appuyez sur la touche configurĂ©e confirm (par dĂ©faut, **EntrĂ©e** ou bouton **A**) pour lancer le tĂ©lĂ©chargement. -- Suivez la progression dans le menu `download_progress`. +- Suivez la progression dans le menu `HISTORIQUE`. --- ### Personnalisation des contrĂŽles -- Dans le menu pause, sĂ©lectionnez **Remap controls**. +- Dans le menu pause, sĂ©lectionnez **Reconfigurer controls**. - Suivez les instructions Ă  l'Ă©cran pour mapper chaque action en maintenant la touche ou le bouton pendant 3 secondes. - Les noms des boutons s'affichent automatiquement selon votre manette (A, B, X, Y, LB, RB, LT, RT, etc.). - La configuration est compatible avec toutes les manettes supportĂ©es par EmulationStation. @@ -102,22 +108,28 @@ Vous trouverez RGSX dans le systĂšme "PORTS" ou "Jeux Amateurs et portages" et d ### Historique -- AccĂ©dez Ă  l'historique des tĂ©lĂ©chargements via le menu pause ou en appuyant sur la touche history (par dĂ©faut, **H**). -- SĂ©lectionnez un jeu pour le retĂ©lĂ©charger si nĂ©cessaire. -- Videz l'historique via le bouton progress dans le menu historique. +- AccĂ©dez Ă  l'historique des tĂ©lĂ©chargements via le menu pause ou en appuyant sur la touche historique (par dĂ©faut, **H**). +- SĂ©lectionnez un jeu pour le retĂ©lĂ©charger si nĂ©cessaire en cas d'erreur ou annulation. +- Videz tout l'historique via le bouton **EFFACER** dans le menu historique. Les jeux ne sont pas effacĂ©s seulement la liste +- Annulez un tĂ©lĂ©chargement avec le bouton **RETOUR** --- ### Logs -Les logs sont enregistrĂ©s dans `/roms/ports/RGSX/logs/RGSX.log` pour diagnostiquer les problĂšmes. +Les logs sont enregistrĂ©s dans `roms/ports/RGSX/logs/RGSX.log` sur batocera et sur Retrobat pour diagnostiquer les problĂšmes et seront a partager pour tout support. --- ## 📁 Structure du projet ``` + +/roms/windows/RGSX +│ +├── RGSX Retrobat.bat #Raccourci pour lancer l'application RGSX pour retrobat uniquement, non necessaire pour batocera/knulli + /roms/ports/ -RGSX-INSTALL.log # LOG d'installation uniquement +RGSX-INSTALL.log # LOG d'installation uniquement pour une premiere installation en ligne de commande. RGSX/ │ ├── main.py # Point d'entrĂ©e principal de l'application. @@ -133,12 +145,13 @@ RGSX/ └── logs/ └── RGSX.log # Fichier de logs. -/saves/ports/ -RGSX/ +/saves/ports/RGSX/ │ ├── controls.json # Fichier de mappage des contrĂŽles (gĂ©nĂ©rĂ© aprĂšs le 1er demarrage) ├── history.json # Base de donnĂ©es de l'historique de tĂ©lĂ©chargements (gĂ©nĂ©rĂ© aprĂšs le 1er tĂ©lĂ©chargement) +├── language.json # Contient la langue configurĂ©e └── 1FichierAPI.txt # ClĂ© API 1fichier (compte premium et + uniquement) (vide par defaut) + ```