mirror of
https://github.com/YunoHost-Apps/retroarch_ynh.git
synced 2024-09-03 20:16:12 +02:00
Update doc
This commit is contained in:
Krakinou
parent
d80e0ac169
commit
72f2012c7e
2 changed files with 34 additions and 60 deletions
49
README.md
49
README.md
|
|
@ -1,5 +1,3 @@
|
||||||
##ON GOING DEVELOPMENT - DO NOT USE
|
|
||||||
|
|
||||||
# RetroArch Web Player for YunoHost
|
# RetroArch Web Player for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/retroarch)
|
[](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.*
|
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||||
|
|
||||||
## Overview
|
## 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.
|
RetroArch is a frontend for emulators, game engines and media players.
|
||||||
Popular examples of implementations for this API includes video game system emulators and game engines as well as more generalized 3D programs.
|
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.
|
||||||
These programs are instantiated as dynamic libraries. We refer to these as "libretro cores". In our case, these cores are emulators
|
|
||||||
|
|
||||||
* cannot save game, in fact, cannot write at all... so configuration is lost each time you start again
|
The RetroArch Web Player is RetroArch compiled through [Emscripten](http://kripken.github.io/emscripten-site/).
|
||||||
* 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`
|
|
||||||
|
|
||||||
**Shipped version:** 1.9.1
|
**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/)
|
* [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
|
## Documentation
|
||||||
|
|
||||||
* Official documentation: Link to the official documentation of this app
|
* [Official Website](https://www.retroarch.com/)
|
||||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
* [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
|
## 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
|
#### Supported architectures
|
||||||
|
|
||||||
|
|
@ -54,22 +48,15 @@ Can the app be used by multiple users?
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
* Any known 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.
|
||||||
|
|
||||||
## Additional information
|
|
||||||
|
|
||||||
* Other information you would add about this application
|
|
||||||
|
|
||||||
**More information on the documentation page:**
|
|
||||||
https://yunohost.org/packaging_apps
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues
|
||||||
* App website: Link to the official website of this app
|
* App website: [Official Website](https://www.retroarch.com/)
|
||||||
* Upstream app repository: Link to the official repository of the upstream app
|
* Upstream app repository: https://github.com/libretro/RetroArch/tree/master/pkg/emscripten
|
||||||
* YunoHost website: https://yunohost.org/
|
* YunoHost website: https://yunohost.org/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
45
README_fr.md
45
README_fr.md
|
|
@ -1,5 +1,4 @@
|
||||||
##DEVELOPPEMENT EN COURS - NE PAS UTILISER!
|
# RetroArch Web Player pour YunoHost
|
||||||
# App exemple pour YunoHost
|
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/retroarch)
|
[](https://dash.yunohost.org/appci/app/retroarch)
|
||||||
[](https://install-app.yunohost.org/?app=retroarch)
|
[](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.*
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d'ensemble
|
## 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.
|
RetroArch est un frontend pour des émulateurs, des moteurs de jeux et des lecteurs média.
|
||||||
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.
|
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.
|
||||||
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`
|
|
||||||
|
|
||||||
|
Le Web Player Retroarch utilise RetroArch compilé grace à [Emscripten](http://kripken.github.io/emscripten-site/).
|
||||||
|
|
||||||
|
|
||||||
**Version incluse:** 1.9.1
|
**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/)
|
* [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
|
||||||
|
|
||||||
* Documentation officielle: Lien vers la documentation officielle de cette application
|
* [Website officiel](https://www.retroarch.com/)
|
||||||
* Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
* [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
|
## Caractéristiques spécifiques YunoHost
|
||||||
|
|
||||||
#### Support multi-utilisateurs
|
#### Bibliothèque partagée
|
||||||
|
|
||||||
L'authentification LDAP et HTTP est-elle prise en charge?
|
Même si vous pouvez uploader une ROM depuis l'application, RetroArch peut accéder à celle déjà sur votre serveur:
|
||||||
L'application peut-elle être utilisée par plusieurs utilisateurs?
|
* 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
|
||||||
|
|
||||||
|
|
@ -56,20 +48,15 @@ L'application peut-elle être utilisée par plusieurs utilisateurs?
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
* Limitations connues.
|
* 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
|
||||||
## Informations additionnelles
|
* 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.
|
||||||
|
|
||||||
* Autres informations à ajouter sur cette application
|
|
||||||
|
|
||||||
**Plus d'informations sur la page de documentation:**
|
|
||||||
https://yunohost.org/packaging_apps
|
|
||||||
|
|
||||||
## Liens
|
## Liens
|
||||||
|
|
||||||
* Signaler un bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues
|
* Signaler un bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues
|
||||||
* Site de l'application: Lien vers le site officiel de cette application
|
* Site de l'application: [Official Website](https://www.retroarch.com/)
|
||||||
* Dépôt de l'application principale: Lien vers le dépôt officiel de l'application principale
|
* Dépôt de l'application principale: https://github.com/libretro/RetroArch/tree/master/pkg/emscripten
|
||||||
* Site web YunoHost: https://yunohost.org/
|
* Site web YunoHost: https://yunohost.org/
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue