retroarch_ynh/README.md

<!--
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.
-->

# Retroarch Web Player for YunoHost

[![Integration level](https://dash.yunohost.org/integration/retroarch.svg)](https://dash.yunohost.org/appci/app/retroarch) ![Working status](https://ci-apps.yunohost.org/ci/badges/retroarch.status.svg) ![Maintenance status](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 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.
In addition to this, you are able to run original game discs (CDs) from RetroArch.
RetroArch has advanced features like shaders, netplay, rewinding, next-frame response times, runahead, machine translation, blind accessibility features, and more!


**Shipped version:** 1.15.0~ynh2

**Demo:** https://web.libretro.com/

## Screenshots

![Screenshot of Retroarch Web Player](./doc/screenshots/XMB-main-menu.jpg)
![Screenshot of Retroarch Web Player](./doc/screenshots/rgui-main-menu.jpg)
![Screenshot of Retroarch Web Player](./doc/screenshots/ozone-main-menu.jpg)

## Disclaimers / important information

### 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`

### 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.

## Documentation and resources

* 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

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.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/retroarch_ynh/tree/testing --debug
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>