1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/veloren_ynh.git synced 2024-09-03 17:46:10 +02:00
veloren_ynh/README.md

57 lines
2.5 KiB
Markdown
Raw Normal View History

2021-05-26 23:34:41 +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.
-->
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
# Veloren server for YunoHost
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
[![Integration level](https://dash.yunohost.org/integration/veloren.svg)](https://dash.yunohost.org/appci/app/veloren) ![](https://ci-apps.yunohost.org/ci/badges/veloren.status.svg) ![](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)
2021-04-26 04:14:15 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-05-26 23:34:41 +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.*
2021-04-26 04:14:15 +02:00
## Overview
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
2021-04-26 04:14:15 +02:00
2021-06-13 20:21:20 +02:00
**Shipped version:** 0.10.0~ynh1
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
**Demo:** server.veloren.net:14004
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
## Screenshots
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
![](./doc/screenshots/veloren.png)
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
## Disclaimers / important information
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
Veloren is in pre-alpha, il y aura des bugs.
2021-04-26 04:14:15 +02:00
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:
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)
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +02:00
## Documentation and resources
2021-04-26 04:14:15 +02:00
2021-05-26 23:34:41 +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
2021-06-13 20:21:20 +02:00
* Upstream app code repository: https://gitlab.com/veloren/veloren
2021-05-26 23:34:41 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_veloren
* Report a bug: https://github.com/YunoHost-Apps/veloren_ynh/issues
2021-04-26 04:14:15 +02:00
## Developer info
2021-05-26 23:34:41 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/veloren_ynh/tree/testing).
2021-04-26 04:14:15 +02:00
To try the testing branch, please proceed like that.
```
2021-05-26 23:34:41 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug
2021-04-26 04:14:15 +02:00
or
2021-05-26 23:34:41 +02:00
sudo yunohost app upgrade veloren -u https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug
2021-04-26 04:14:15 +02:00
```
2021-05-26 23:34:41 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps