From 72f2012c7e2bb4d14316bfbbbc0353a4a4345c38 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sun, 9 May 2021 18:14:08 +0200 Subject: [PATCH] Update doc --- README.md | 49 ++++++++++++++++++------------------------------- README_fr.md | 45 ++++++++++++++++----------------------------- 2 files changed, 34 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 3adcfbf..b17c731 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -##ON GOING DEVELOPMENT - DO NOT USE - # RetroArch Web Player for YunoHost [![Integration level](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) @@ -11,15 +9,10 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview -The RetroArch Web Player is RetroArch compiled through [Emscripten](http://kripken.github.io/emscripten-site/). RetroArch is the reference frontend for the libretro API. -Popular examples of implementations for this API includes video game system emulators and game engines as well as more generalized 3D programs. -These programs are instantiated as dynamic libraries. We refer to these as "libretro cores". In our case, these cores are emulators +RetroArch is a frontend for emulators, game engines and media players. +It enables you to run classic games on a wide range of computers and consoles through its slick graphical interface. Settings are also unified so configuration is done once and for all. -* cannot save game, in fact, cannot write at all... so configuration is lost each time you start again -* no user management -* some core are listed but not implemented : they do not work, the issue is from the upstream app. -* Games are located in `/opt/yunohost/retroarch/assets/cores`. A symbolic link is created to this folder in `/home/yunohost.multimedia/share/Games`, so that you can place your games from here -* cores have to be indexed to work : script `/opt/yunohost/retroarch/indexer.sh` run every 5 minutes to index all games in `opt/yunohost/retroarch/assets/cores` +The RetroArch Web Player is RetroArch compiled through [Emscripten](http://kripken.github.io/emscripten-site/). **Shipped version:** 1.9.1 @@ -31,21 +24,22 @@ These programs are instantiated as dynamic libraries. We refer to these as "libr * [Official demo](https://web.libretro.com/) -## Configuration - -How to configure this app: by an admin panel, a plain file with SSH, or any other way. ## Documentation - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - + * [Official Website](https://www.retroarch.com/) + * [Official web player documentation](https://github.com/libretro/RetroArch/tree/master/pkg/emscripten) (not much to see here...) + * [Official documentation](https://docs.libretro.com/) + ## YunoHost specific features -#### Multi-users support +### Use Shared ROMs library + +Although you can upload a ROM at runtime, retroarch may have access to the ROMs you already have on your server: + +* Games are located in `/opt/yunohost/retroarch/assets/cores`. A symbolic link is created to this folder in `/home/yunohost.multimedia/share/Games`, so that you can place your games from here +* cores have to be indexed to work : script `/opt/yunohost/retroarch/indexer.sh` run every 5 minutes to index all games in `opt/yunohost/retroarch/assets/cores` -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? #### Supported architectures @@ -54,22 +48,15 @@ Can the app be used by multiple users? ## Limitations -* Any known limitations. - - - -## Additional information - -* Other information you would add about this application - -**More information on the documentation page:** -https://yunohost.org/packaging_apps +* cannot save game, in fact, cannot write at all... so configuration is lost each time you start again +* no user management +* some core are listed but not implemented : they do not work, the issue is from the upstream app. ## Links * Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues - * App website: Link to the official website of this app - * Upstream app repository: Link to the official repository of the upstream app + * App website: [Official Website](https://www.retroarch.com/) + * Upstream app repository: https://github.com/libretro/RetroArch/tree/master/pkg/emscripten * YunoHost website: https://yunohost.org/ diff --git a/README_fr.md b/README_fr.md index 015ae07..b1c6896 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,5 +1,4 @@ -##DEVELOPPEMENT EN COURS - NE PAS UTILISER! -# App exemple pour YunoHost +# RetroArch Web Player pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) [![Installer retroarch avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=retroarch) @@ -10,16 +9,10 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -Le Web Player Retroarch utilise RetroArch compilé grace à [Emscripten](http://kripken.github.io/emscripten-site/).RetroArch est le frontend de référence pour l'API libretro. -Des exemple populaires d'implémentations de cette API incluent des émulateurs de jeux vidéos et de moteur de jeux ainsi que des programmes 3D plus généraux. -Ces programmes sont instanciés comme bibliothèques dynamiques, appelées "libretro cores". - -* On ne peut pas sauvegarder. En fait, on ne peut pas écrire dans les fichiers du tout, donc la configuration est perdue à chaque fois -* Pas de gestion d'utilisateurs -* certains cores sont listés mais ne sont pas implémentés : ils ne fonctionnent donc pas, le problème vient de l'application elle même. -* Les jeux sont situés dans `/opt/yunohost/retroarch/assets/cores`. Un lien symbolique est créé vers `/home/yunohost.multimedia/share/Games` de façon à ce que vous puissiez les y mettre facilement. -* Les cores doivent être indexés pour fonctionner : le script `/opt/yunohost/retroarch/indexer.sh` tourne toutes les 5 minutes pour indexer tous les jeux dans `opt/yunohost/retroarch/assets/cores` +RetroArch est un frontend pour des émulateurs, des moteurs de jeux et des lecteurs média. +Il vous permet de rejouer à des classiques du jeu vidéo sur une large gamme d'ordinateur et de console grace à son interface graphique légère. Les réglages sont unifiés afin de n'avoir a effectuer les réglages qu'une seule fois. +Le Web Player Retroarch utilise RetroArch compilé grace à [Emscripten](http://kripken.github.io/emscripten-site/). **Version incluse:** 1.9.1 @@ -32,21 +25,20 @@ Ces programmes sont instanciés comme bibliothèques dynamiques, appelées "libr * [Démo officielle](https://web.libretro.com/) -## Configuration - -Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH ou tout autre moyen. ## Documentation - * Documentation officielle: Lien vers la documentation officielle de cette application - * Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. + * [Website officiel](https://www.retroarch.com/) + * [Documentation officielle du web player](https://github.com/libretro/RetroArch/tree/master/pkg/emscripten) (c'est très très léger...) + * [Documentation officielle](https://docs.libretro.com/) ## Caractéristiques spécifiques YunoHost -#### Support multi-utilisateurs +#### Bibliothèque partagée -L'authentification LDAP et HTTP est-elle prise en charge? -L'application peut-elle être utilisée par plusieurs utilisateurs? +Même si vous pouvez uploader une ROM depuis l'application, RetroArch peut accéder à celle déjà sur votre serveur: +* Les jeux sont situés dans `/opt/yunohost/retroarch/assets/cores`. Un lien symbolique est créé vers `/home/yunohost.multimedia/share/Games` de façon à ce que vous puissiez les y mettre facilement. +* Les cores doivent être indexés pour fonctionner : le script `/opt/yunohost/retroarch/indexer.sh` tourne toutes les 5 minutes pour indexer tous les jeux dans `opt/yunohost/retroarch/assets/cores` #### Architectures supportées @@ -56,20 +48,15 @@ L'application peut-elle être utilisée par plusieurs utilisateurs? ## Limitations -* Limitations connues. - -## Informations additionnelles - -* Autres informations à ajouter sur cette application - -**Plus d'informations sur la page de documentation:** -https://yunohost.org/packaging_apps +* On ne peut pas sauvegarder. En fait, on ne peut pas écrire dans les fichiers du tout, donc la configuration est perdue à chaque fois... +* Pas de gestion d'utilisateurs +* certains cores sont listés mais ne sont pas implémentés : ils ne fonctionnent donc pas, le problème vient de l'application elle même. ## Liens * Signaler un bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues - * Site de l'application: Lien vers le site officiel de cette application - * Dépôt de l'application principale: Lien vers le dépôt officiel de l'application principale + * Site de l'application: [Official Website](https://www.retroarch.com/) + * Dépôt de l'application principale: https://github.com/libretro/RetroArch/tree/master/pkg/emscripten * Site web YunoHost: https://yunohost.org/ ---