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

# Veloren server for YunoHost

[![Integration level](https://dash.yunohost.org/integration/veloren.svg)](https://dash.yunohost.org/appci/app/veloren) ![Working status](https://ci-apps.yunohost.org/ci/badges/veloren.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/veloren.maintain.svg)

[![Install Veloren server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=veloren)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Veloren server 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

Multiplayer voxel RPG

**Shipped version:** 0.11.0~ynh1

**Demo:** server.veloren.net:14004

## Screenshots

![Screenshot of Veloren server](./doc/screenshots/veloren.png)

## Disclaimers / important information

Veloren is in pre-alpha, il y aura des bugs.

This package provides the last "release" version of Veloren, which is older than that of the official server. You will need to download the corresponding version of the client:
 * [Windows x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.11.0/download?job=windows)
 * [Linux x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.11.0/download?job=linux)
 * [MacOS x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.11.0/download?job=macos)

## Documentation and resources

* Official app website: <https://veloren.net/>
* Official user documentation: <https://book.veloren.net/players/>
* Official admin documentation: <https://book.veloren.net/players/hosting-a-server.html>
* Upstream app code repository: <https://gitlab.com/veloren/veloren>
* YunoHost documentation for this app: <https://yunohost.org/app_veloren>
* Report a bug: <https://github.com/YunoHost-Apps/veloren_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/veloren_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug
or
sudo yunohost app upgrade veloren -u https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>