diff --git a/README.md b/README.md index eea4a25..f14a5ad 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ 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) ![](https://ci-apps.yunohost.org/ci/badges/veloren.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/veloren.maintain.svg) +[![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)* @@ -15,43 +16,44 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Multiplayer voxel RPG inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft +Multiplayer voxel RPG -**Shipped version:** 0.10.0~ynh1 +**Shipped version:** 0.11.0~ynh1 **Demo:** server.veloren.net:14004 ## Screenshots -![](./doc/screenshots/veloren.png) +![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) + * [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 +* Official app website: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## 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 \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index b44da1f..a9c7195 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,53 +1,59 @@ + + # Veloren server pour YunoHost -[![Niveau d'intégration](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) +[![Niveau d’intégration](https://dash.yunohost.org/integration/veloren.svg)](https://dash.yunohost.org/appci/app/veloren) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/veloren.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/veloren.maintain.svg) + [![Installer Veloren server avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=veloren) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Veloren server rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* +> *Ce package vous permet d’installer Veloren server rapidement et simplement sur un serveur YunoHost. +Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* -## Vue d'ensemble +## Vue d’ensemble -RPG voxel multijoueur inspiré de jeux tels que Cube World, Legend of Zelda : Breath of the Wild, Dwarf Fortress et Minecraft +RPG voxel multijoueur -**Version incluse :** 0.10.0~ynh1 +**Version incluse :** 0.11.0~ynh1 **Démo :** server.veloren.net:14004 -## Captures d'écran +## Captures d’écran -![](./doc/screenshots/veloren.png) +![Capture d’écran de Veloren server](./doc/screenshots/veloren.png) ## Avertissements / informations importantes Veloren est en pre-alpha, il y aura des bugs. Ce paquet fournit la dernière version "release" de Veloren, qui est plus ancienne que celle du serveur officiel. Il vous faudra télécharger la version correspondante du 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) + * [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) ## Documentations et ressources -* Site officiel de l'app : https://veloren.net/ -* Documentation officielle utilisateur : https://book.veloren.net/players/ -* Documentation officielle de l'admin : https://book.veloren.net/players/hosting-a-server.html -* Dépôt de code officiel de l'app : https://gitlab.com/veloren/veloren -* Documentation YunoHost pour cette app : https://yunohost.org/app_veloren -* Signaler un bug : https://github.com/YunoHost-Apps/veloren_ynh/issues +* Site officiel de l’app : +* Documentation officielle utilisateur : +* Documentation officielle de l’admin : +* Dépôt de code officiel de l’app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/veloren_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug ou sudo yunohost app upgrade veloren -u https://github.com/YunoHost-Apps/veloren_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file diff --git a/conf/app.src b/conf/app.src index 3efc1cb..bf6501d 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,7 +1,7 @@ -SOURCE_URL=https://gitlab.com/veloren/veloren/-/archive/v0.10.0/veloren-v0.10.0.tar.gz -SOURCE_SUM=8bda76af18db8553556cb09a4126bb9c4e0956bcf021fbb93c019de450c38016 +SOURCE_URL=https://gitlab.com/veloren/veloren/-/archive/v0.11.0/veloren-v0.11.0.tar.gz +SOURCE_SUM=a2a840fcbbafaaa429c8c2ffce56488de099ed71e310fcae6d56b927409d1f8f SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true -SOURCE_FILENAME=veloren-v0.10.0.tar.gz +SOURCE_FILENAME=veloren-v0.11.0.tar.gz SOURCE_EXTRACT=true diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 4a1fea2..704ad17 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,6 +1,6 @@ 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) + * [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) diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 7c183b4..2338649 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -1,6 +1,6 @@ Veloren est en pre-alpha, il y aura des bugs. Ce paquet fournit la dernière version "release" de Veloren, qui est plus ancienne que celle du serveur officiel. Il vous faudra télécharger la version correspondante du 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) + * [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) diff --git a/manifest.json b/manifest.json index c976b96..67860a5 100644 --- a/manifest.json +++ b/manifest.json @@ -3,10 +3,10 @@ "id": "veloren", "packaging_format": 1, "description": { - "en": "Multiplayer voxel RPG inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft", - "fr": "RPG voxel multijoueur inspiré de jeux tels que Cube World, Legend of Zelda : Breath of the Wild, Dwarf Fortress et Minecraft" + "en": "Multiplayer voxel RPG", + "fr": "RPG voxel multijoueur" }, - "version": "0.10.0~ynh1", + "version": "0.11.0~ynh1", "url": "https://veloren.net", "upstream": { "license": "GPL-3.0-only", @@ -22,7 +22,7 @@ "email": "jules.bertholet@gmail.com" }, "requirements": { - "yunohost": ">= 4.1.3" + "yunohost": ">= 11.1.15" }, "multi_instance": true, "services": [], diff --git a/scripts/install b/scripts/install index fe5fe43..7a9a2d0 100755 --- a/scripts/install +++ b/scripts/install @@ -50,6 +50,7 @@ ynh_script_progression --message="Validating installation parameters..." --weigh final_path=/opt/yunohost/$app test ! -e "$final_path" || ynh_die --message="This path already contains a folder" + data_path=/home/yunohost.app/$app test ! -e "$data_path" || ynh_die --message="This path already contains a folder" @@ -101,7 +102,7 @@ ynh_exec_warn_less yunohost firewall allow --no-upnp Both $port #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." --weight=20 +ynh_script_progression --message="Installing dependencies..." --weight=2 ynh_install_app_dependencies $pkg_dependencies @@ -116,7 +117,7 @@ ynh_system_user_create --username=$app --home_dir="$data_path" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." --weight=155 +ynh_script_progression --message="Setting up source files..." --weight=10 ynh_app_setting_set --app=$app --key=final_path --value=$final_path ynh_app_setting_set --app=$app --key=data_path --value=$data_path @@ -128,7 +129,7 @@ setup_source #================================================= # COMPILE SERVER #================================================= -ynh_script_progression --message="Compiling server..." --weight=135 +ynh_script_progression --message="Compiling server..." --weight=10 compile_server @@ -139,7 +140,7 @@ compile_server map_generated=0 if [ $generate_custom_world -eq 1 ]; then - ynh_script_progression --message="Generating custom world..." --weight=730 + ynh_script_progression --message="Generating custom world..." --weight=10 generate_custom_world fi @@ -156,7 +157,7 @@ add_configuration_files ynh_script_progression --message="Configuring a systemd service..." --weight=1 # Create a dedicated systemd config -ynh_add_systemd_config --others_var="data_path" +ynh_add_systemd_config #================================================= # GENERIC FINALIZATION @@ -178,7 +179,7 @@ yunohost service add $app --description="Veloren game server" --needs_exposed_po #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=35 +ynh_script_progression --message="Starting a systemd service..." --weight=10 # Start a systemd service ynh_systemd_action --service_name=$app --action="start" --line_match="Server is ready to accept connections." --log_path="/var/log/$app/$app.log" diff --git a/scripts/remove b/scripts/remove index 1bfe044..45f623d 100755 --- a/scripts/remove +++ b/scripts/remove @@ -34,7 +34,7 @@ fi #================================================= # STOP AND REMOVE SERVICE #================================================= -ynh_script_progression --message="Stopping and removing the systemd service..." --weight=120 +ynh_script_progression --message="Stopping and removing the systemd service..." --weight=5 # Remove the dedicated systemd config ynh_remove_systemd_config @@ -42,7 +42,7 @@ ynh_remove_systemd_config #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." --weight=10 +ynh_script_progression --message="Removing dependencies..." --weight=5 # Remove metapackage and its dependencies ynh_remove_app_dependencies @@ -50,7 +50,7 @@ ynh_remove_app_dependencies #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 +ynh_script_progression --message="Removing app main directory..." --weight=3 # Remove the app directory securely ynh_secure_remove --file="$final_path" @@ -58,15 +58,18 @@ ynh_secure_remove --file="$final_path" #================================================= # REMOVE APP DATA DIR #================================================= -ynh_script_progression --message="Removing app data directory..." --weight=1 -# Remove the data directory securely -ynh_secure_remove --file="$data_path" +# Remove the data directory if --purge option is used +if [ "${YNH_APP_PURGE:-0}" -eq 1 ] +then + ynh_script_progression --message="Removing app data directory..." --weight=1 + ynh_secure_remove --file="$datadir" +fi #================================================= # REMOVE LOGROTATE CONFIGURATION #================================================= -ynh_script_progression --message="Removing logrotate configuration..." --weight=1 +ynh_script_progression --message="Removing logrotate configuration..." --weight=5 # Remove the app-specific logrotate config ynh_remove_logrotate @@ -95,7 +98,7 @@ ynh_secure_remove --file="/var/log/$app" #================================================= # REMOVE DEDICATED USER #================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 +ynh_script_progression --message="Removing the dedicated system user..." --weight=10 # Delete a system user ynh_system_user_delete --username=$app diff --git a/scripts/restore b/scripts/restore index 51ae125..73f9ebf 100755 --- a/scripts/restore +++ b/scripts/restore @@ -52,7 +52,7 @@ ynh_system_user_create --username=$app --home_dir="$data_path" #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=15 +ynh_script_progression --message="Reinstalling dependencies..." --weight=6 # Define and install dependencies ynh_install_app_dependencies $pkg_dependencies @@ -60,7 +60,7 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring the app main directory..." --weight=1 +ynh_script_progression --message="Restoring the app main directory..." --weight=4 ynh_restore_file --origin_path="$final_path" @@ -94,7 +94,7 @@ yunohost service add $app --description="Veloren game server" --needs_exposed_po #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=1 +ynh_script_progression --message="Starting a systemd service..." --weight=10 ynh_systemd_action --service_name=$app --action="start" --line_match="Server is ready to accept connections." --log_path="/var/log/$app/$app.log" diff --git a/scripts/upgrade b/scripts/upgrade index 90dfcc1..9d4bd5d 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -60,7 +60,7 @@ ynh_system_user_create --username=$app --home_dir="$data_path" #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=10 +ynh_script_progression --message="Upgrading dependencies..." --weight=1 ynh_install_app_dependencies $pkg_dependencies @@ -70,7 +70,7 @@ ynh_install_app_dependencies $pkg_dependencies if [ "$upgrade_type" == "UPGRADE_APP" ] then - ynh_script_progression --message="Upgrading source files..." --weight=155 + ynh_script_progression --message="Upgrading source files..." --weight=10 # Download, check integrity, uncompress and patch the source from app.src setup_source @@ -81,7 +81,7 @@ fi #================================================= # COMPILE SERVER #================================================= -ynh_script_progression --message="Compiling server..." --weight=135 +ynh_script_progression --message="Compiling server..." --weight=10 compile_server @@ -92,7 +92,7 @@ compile_server map_generated=0 if [ $generate_custom_world -eq 1 ]; then - ynh_script_progression --message="Generating custom world..." --weight=730 + ynh_script_progression --message="Generating custom world..." --weight=10 generate_custom_world fi @@ -109,7 +109,7 @@ add_configuration_files ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 # Create a dedicated systemd config -ynh_add_systemd_config --others_var="data_path" +ynh_add_systemd_config #================================================= # GENERIC FINALIZATION @@ -124,14 +124,14 @@ ynh_use_logrotate --non-append #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 +ynh_script_progression --message="Integrating service in YunoHost..." --weight=10 yunohost service add $app --description="Veloren game server" --needs_exposed_ports "$port" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=35 +ynh_script_progression --message="Starting a systemd service..." --weight=3 ynh_systemd_action --service_name=$app --action="start" --line_match="Server is ready to accept connections." --log_path="/var/log/$app/$app.log"