2021-02-20 19:31:31 +01:00
# RetroArch Web Player for YunoHost
2020-05-08 20:42:27 +02:00
2021-04-25 16:55:10 +02:00
[](https://dash.yunohost.org/appci/app/retroarch)
2021-02-20 19:31:31 +01:00
[](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-02-20 19:31:31 +01:00
> *This package allow you to install RetroArch quickly and simply on a YunoHost server.
2020-05-08 20:42:27 +02:00
If you don't have YunoHost, please see [here ](https://yunohost.org/#/install ) to know how to install and enjoy it.*
## Overview
2021-05-09 18:14:08 +02:00
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.
2021-05-09 10:18:04 +02:00
2021-05-09 18:14:08 +02:00
The RetroArch Web Player is RetroArch compiled through [Emscripten ](http://kripken.github.io/emscripten-site/ ).
2020-05-08 20:42:27 +02:00
2021-04-25 16:55:10 +02:00
**Shipped version:** 1.9.1
2020-05-08 20:42:27 +02:00
## Screenshots
2021-05-09 10:18:04 +02:00
2020-05-08 20:42:27 +02:00
## Demo
2021-02-20 19:31:31 +01:00
* [Official demo ](https://web.libretro.com/ )
2020-05-08 20:42:27 +02:00
## Documentation
2021-05-09 18:14:08 +02:00
* [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/ )
2020-05-08 20:42:27 +02:00
## YunoHost specific features
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
#### Supported architectures
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
## Limitations
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
## Links
2021-04-25 16:55:10 +02:00
* Report a bug: https://github.com/YunoHost-Apps/retroarch_ynh/issues
2021-05-09 18:14:08 +02:00
* App website: [Official Website ](https://www.retroarch.com/ )
* Upstream app repository: https://github.com/libretro/RetroArch/tree/master/pkg/emscripten
2020-05-08 20:42:27 +02:00
* YunoHost website: https://yunohost.org/
---
Developers info
----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
2021-04-25 16:55:10 +02:00
Please do 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
```
