2021-07-25 20:21:55 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
# Retroarch Web Player for YunoHost
[](https://dash.yunohost.org/appci/app/retroarch)  
[](https://install-app.yunohost.org/?app=retroarch)
2020-05-08 20:42:27 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-07-25 20:21:55 +02:00
> *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.*
2020-05-08 20:42:27 +02:00
## Overview
2021-07-25 20:21:55 +02:00
Emulate videogames system and play videogames through your web browser... and more!
2020-05-08 20:42:27 +02:00
2021-08-23 21:12:18 +02:00
**Shipped version:** 1.9.8
2020-05-08 20:42:27 +02:00
2021-07-25 20:23:39 +02:00
**Demo:** https://web.libretro.com/
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
## Screenshots
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
2021-07-25 20:22:01 +02:00
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
## Disclaimers / important information
2020-05-08 20:42:27 +02:00
2021-05-09 18:14:08 +02:00
### 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`
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
### Supported architectures
2020-05-08 20:42:27 +02:00
2021-04-25 16:55:10 +02:00
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/retroarch/)
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/retroarch/)
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
### Limitations
2020-05-08 20:42:27 +02:00
2021-05-09 18:14:08 +02:00
* 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.
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
## Documentation and resources
2020-05-08 20:42:27 +02:00
2021-07-25 20:23:39 +02:00
* 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
2021-07-25 20:21:55 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_retroarch
* Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
## Developer info
2020-05-08 20:42:27 +02:00
2021-07-25 20:21:55 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing ).
2020-05-08 20:42:27 +02:00
To try the testing branch, please proceed like that.
```
2021-04-25 16:55:10 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug
2020-05-08 20:42:27 +02:00
or
2021-04-25 16:55:10 +02:00
sudo yunohost app upgrade retroarch -u https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug
2020-05-08 20:42:27 +02:00
```
2021-07-25 20:21:55 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
