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)

*[Read this README in other languages.](./ALL_README.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 inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft

**Shipped version:** 0.10.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.10.0/download?job=windows)
 * [Linux x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.10.0/download?job=linux)
 * [MacOS x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.10.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 Store: <https://apps.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>
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`<!--`
Update READMEs 2024-06-23 14:41:53 +02:00			`N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>`
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`It shall NOT be edited by hand.`
			`-->`
Initial commit 2021-04-26 04:14:15 +02:00
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`# Veloren server for YunoHost`
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`[![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)`

Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`[![Install Veloren server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=veloren)`
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`[Read this README in other languages.](./ALL_README.md)`
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`> 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.`
Initial commit 2021-04-26 04:14:15 +02:00
			`## Overview`

Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`Multiplayer voxel RPG inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft`
Initial commit 2021-04-26 04:14:15 +02:00
Update to v0.10.0 2021-06-13 20:21:20 +02:00			`Shipped version: 0.10.0~ynh1`
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`Demo: <server.veloren.net:14004>`
Initial commit 2021-04-26 04:14:15 +02:00
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`## Screenshots`
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`![Screenshot of Veloren server](./doc/screenshots/veloren.png)`
Initial commit 2021-04-26 04:14:15 +02:00
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`## Disclaimers / important information`
Initial commit 2021-04-26 04:14:15 +02:00
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`Veloren is in pre-alpha, il y aura des bugs.`
Initial commit 2021-04-26 04:14:15 +02:00
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`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:`
Update to v0.10.0 2021-06-13 20:21:20 +02:00			`* [Windows x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.10.0/download?job=windows)`
			`* [Linux x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.10.0/download?job=linux)`
			`* [MacOS x64](https://gitlab.com/veloren/veloren/-/jobs/artifacts/v0.10.0/download?job=macos)`
Initial commit 2021-04-26 04:14:15 +02:00
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`## Documentation and resources`
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`- 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 Store: <https://apps.yunohost.org/app/veloren>`
			`- Report a bug: <https://github.com/YunoHost-Apps/veloren_ynh/issues>`
Initial commit 2021-04-26 04:14:15 +02:00
			`## Developer info`

Update READMEs 2024-06-23 14:41:53 +02:00			Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/veloren_ynh/tree/testing).
Initial commit 2021-04-26 04:14:15 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			To try the `testing` branch, please proceed like that:

			```bash
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug`
Initial commit 2021-04-26 04:14:15 +02:00			`or`
Initial commit for Veloren 2021-05-26 23:34:41 +02:00			`sudo yunohost app upgrade veloren -u https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug`
Initial commit 2021-04-26 04:14:15 +02:00			```
Initial commit for Veloren 2021-05-26 23:34:41 +02:00
Update READMEs 2024-06-23 14:41:53 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`