diff --git a/README.md b/README.md index 89cf61c..d6f0ae1 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,33 @@ -# RetroArch Web Player for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) -[![Install RetroArch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=retroarch) +# Retroarch Web Player for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) ![](https://ci-apps.yunohost.org/ci/badges/retroarch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/retroarch.maintain.svg) +[![Install Retroarch Web Player with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=retroarch) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install RetroArch quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install Retroarch Web Player quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -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. -The RetroArch Web Player is RetroArch compiled through [Emscripten](http://kripken.github.io/emscripten-site/). +Emulate videogames system and play videogames through your web browser... and more! -**Shipped version:** 1.9.6 +**Shipped version:** 1.9.7 + +**Demo:** https://web.libretro.com/ ## Screenshots -![](https://github.com/libretro/RetroArch/blob/master/docs/ozone-main-menu.jpg) +![](./doc/screenshots/XMB-main-menu.jpg) +![](./doc/screenshots/ozone-main-menu.jpg) +![](./doc/screenshots/rgui-main-menu.jpg) -## Demo - -* [Official demo](https://web.libretro.com/) - - -## Documentation - - * [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 +## Disclaimers / important information ### Use Shared ROMs library @@ -41,32 +37,29 @@ Although you can upload a ROM at runtime, retroarch may have access to the ROMs * 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` -#### Supported architectures +### Supported architectures * x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/retroarch/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/retroarch/) -## Limitations +### Limitations * 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 +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues - * 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/ +* Official app website: http://www.retroarch.com/ +* Official user documentation: https://docs.libretro.com/ +* Official admin documentation: https://docs.libretro.com/ +* Upstream app code repository: https://github.com/libretro/RetroArch +* YunoHost documentation for this app: https://yunohost.org/app_retroarch +* Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues +## Developer info ---- - -Developers info ----------------- - -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -75,5 +68,4 @@ or sudo yunohost app upgrade retroarch -u https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug ``` - - +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 0c04d55..beee75e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,70 +1,59 @@ -# RetroArch Web Player 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) +[![Niveau d'intégration](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) ![](https://ci-apps.yunohost.org/ci/badges/retroarch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/retroarch.maintain.svg) +[![Installer Retroarch Web Player avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=retroarch) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer retroarch rapidement et simplement sur un serveur Yunohost. +> *Ce package vous permet d'installer Retroarch Web Player rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -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/). +Emulez des consoles de jeux et jouer à ces jeux vidéos dans votre explorateur web... Et beaucoup plus! +**Version incluse :** 1.9.7 -**Version incluse:** 1.9.6 +**Démo :** https://web.libretro.com/ ## Captures d'écran -![](https://github.com/libretro/RetroArch/blob/master/docs/ozone-main-menu.jpg) +![](./doc/screenshots/XMB-main-menu.jpg) +![](./doc/screenshots/ozone-main-menu.jpg) +![](./doc/screenshots/rgui-main-menu.jpg) -## Démo +## Avertissements / informations importantes -* [Démo officielle](https://web.libretro.com/) - - -## Documentation - - * [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 - -#### Bibliothèque partagée +### Bibliothèque partagée 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 +### Architectures supportées * x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/retroarch/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/retroarch/) * Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/retroarch/) -## Limitations +### Limitations * 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 +## Documentations et ressources - * Signaler un bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues - * 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/ +* Site officiel de l'app : http://www.retroarch.com/ +* Documentation officielle utilisateur : https://docs.libretro.com/ +* Documentation officielle de l'admin : https://docs.libretro.com/ +* Dépôt de code officiel de l'app : https://github.com/libretro/RetroArch +* Documentation YunoHost pour cette app : https://yunohost.org/app_retroarch +* Signaler un bug : https://github.com/YunoHost-Apps/retroarch_ynh/issues ---- +## Informations pour les développeurs -Informations pour les développeurs ----------------- - -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. @@ -73,3 +62,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/retroarch_ynh/tree/te ou sudo yunohost app upgrade retroarch -u https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..00d44ac --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,18 @@ +### 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` + + +### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/retroarch/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/retroarch/) + +### Limitations + +* 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. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..831a682 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,17 @@ +### Bibliothèque partagée + +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 + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/retroarch/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/retroarch/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/retroarch%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/retroarch/) + +### Limitations + +* 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. diff --git a/doc/screenshots/XMB-main-menu.jpg b/doc/screenshots/XMB-main-menu.jpg new file mode 100644 index 0000000..0eec127 --- /dev/null +++ b/doc/screenshots/XMB-main-menu.jpg @@ -0,0 +1,1252 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RetroArch/XMB-main-menu.jpg at master · libretro/RetroArch · GitHub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Skip to content + + + + + + + + + +
+ +
+ + + + + +
+ + + +
+ + + + + + + + + +
+
+
+ + + + + + + + + + + + + +
+ +
+ +
+

+ + + / + + RetroArch + + +

+ + +
+ + + +
+ + + + +
+ + +
+
+ + + + +
+ + + + Permalink + + + +
+ +
+
+ + + master + + + + +
+
+
+ Switch branches/tags + +
+ + + +
+ +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + +
+ + + + +
+
+ +
+ +
+ +

+ RetroArch/docs/XMB-main-menu.jpg +

+ + Go to file + + +
+ + + + + + + + + +
    +
  • + + Go to file + +
    • +
  • + +
    • +
  • +
  • + + Copy path + +
    • +
  • + + + Copy permalink + + +
    • +
+
+
+ + + + +
+ +
+
+
 
+
+ +
+
 
+ Cannot retrieve contributors at this time +
+
+ + + + + + + + + +
+ +
+ + +
+ + 212 KB +
+ +
+ +
+ + + Download + + + +
+ +
+ + + + +
+ +
+
+ +
+
+ + + + + +
+
+
+ + + +
+ +
+ XMB-main-menu.jpg +
+
+ +
+ + + + +
+ + +
+ + +
 +
+ + +
+ + + +
+
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/screenshots/ozone-main-menu.jpg b/doc/screenshots/ozone-main-menu.jpg new file mode 100644 index 0000000..5abff74 Binary files /dev/null and b/doc/screenshots/ozone-main-menu.jpg differ diff --git a/doc/screenshots/rgui-main-menu.jpg b/doc/screenshots/rgui-main-menu.jpg new file mode 100644 index 0000000..f0d629f --- /dev/null +++ b/doc/screenshots/rgui-main-menu.jpg @@ -0,0 +1,1359 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RetroArch/rgui-main-menu.jpg at master · libretro/RetroArch · GitHub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Skip to content + + + + + + + + + +
+ +
+ + + + + +
+ + + +
+ + + + + + + + + +
+
+
+ + + + + + + + + + + + + +
+ +
+ +
+

+ + + / + + RetroArch + + +

+ + +
+ + + +
+ + + + +
+ + +
+
+ + + + +
+ + + + Permalink + + + +
+ +
+
+ + + master + + + + +
+
+
+ Switch branches/tags + +
+ + + +
+ +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + +
+ + + + +
+
+ +
+ +
+ +

+ RetroArch/docs/rgui-main-menu.jpg +

+ + Go to file + + +
+ + + + + + + + + +
    +
  • + + Go to file + +
    • +
  • + +
    • +
  • +
  • + + Copy path + +
    • +
  • + + + Copy permalink + + +
    • +
+
+
+ + + + +
+ +
+
+ + @fpscan + +
+
+ fpscan + + + (Docs) Update README.md latest RetroArch changes (#10092) + +
+ + + + + + + + +
+
+ + Latest commit + f9c81f3 + Mar 7, 2020 + + + + + + History + + +
+
+ 
* 1.8.4 images && official links
+* Update README.md
+* Update README.md
+* Update README.md
+* new location
+* images moved to docs folder
+* Update README.md
+* Update README.md
+* Links have changed to markdown format
+* Update README.md
+* docs: Use https on libretro.com link
+Co-Authored-By: Margen67 <Margen67@users.noreply.github.com>
+Co-authored-by: Rob Loach <robloach@gmail.com>
+ +
+ +
+
+ + + 1 + + contributor + + +
+ +

+ Users who have contributed to this file +

+
+ + + + + + + +
+
+
+ + + + + + + + + +
+ +
+ + +
+ + 148 KB +
+ +
+ +
+ + + Download + + + +
+ +
+ + + + +
+ +
+
+ +
+
+ + + + + +
+
+
+ + + +
+ +
+ rgui-main-menu.jpg +
+
+ +
+ + + + +
+ + +
+ + +
 +
+ + +
+ + + +
+
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +