minetest_ynh/README.md

# Minetest for YunoHost

[![Integration level](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest) ![](https://ci-apps.yunohost.org/ci/badges/minetest.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/minetest.maintain.svg)  
[![Install Minetest with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest)

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

> *This package allow you to install Minetest quickly and simply on a YunoHost server.
If you don’t have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*

## Overview
Minetest is a free open-source voxel game engine with easy modding and game creation.

**Shipped version:** 5.2.0

## Screenshots

![](https://www.minetest.net/media/gallery/1.jpg)

## Demo

No demo but you can test with servers in https://servers.minetest.net/

## Configuration

How to configure this app: by SSH

## Documentation

 * Official documentation: https://wiki.minetest.net/
 * YunoHost documentation: https://yunohost.org/#/app_minetest

## YunoHost specific features

#### Multi-users support

* Are LDAP and HTTP auth supported? **No**
* Can the app be used by multiple users? **Yes**

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minetest%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/minetest/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minetest%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/)

## Limitations

* This app is not compatible with LDAP.

## Additional information

* Migration from old package

* You can’t migrate directly with an update.
	* Before installing the new package you need to download this folder from your server `/var/games/minetest-server/.minetest/worlds/world` (this folder contains all world data)
	* Uninstall the old package `sudo yunohost app remove minetest`
	* Install the new one `sudo yunohost app install https://github.com/YunoHost-Apps/minetest_ynh`
	* Stop Minetest service `sudo systemctl stop minetest`
	* Copy the folder you have copied before in `/home/yunohost.app/minetest/.minetest/worlds`
	* Start the Minetest service `sudo systemctl start minetest`

* Installing mods
	* For installing mods you need to create a `worldmods` folder in `/home/yunohost.app/minetest/.minetest/worlds/world/`
	* Clone the repo of the mod in this folder (ex: `git clone https://github.com/minetest-mods/mesecons`)
	* Edit `/home/yunohost.app/minetest/.minetest/worlds/world/world.mt` and add at the end `load_mod_mesecons = true`
	* Restart Minetest with `sudo systemctl restart minetest`
	* The mod is now installed :)


## Links

 * Report a bug: https://github.com/YunoHost-Apps/minetest_ynh/issues
 * App website: https://www.minetest.net/
 * Upstream app repository: https://github.com/minetest/minetest
 * YunoHost website: https://yunohost.org/

---

Developers info
----------------

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

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug
or
sudo yunohost app upgrade minetest -u https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug
```
-												Fix readme

											
										
										
											2019-10-22 18:27:38 +02:00
+								# Minetest for YunoHost
-												First commit

											
										
										
											2017-06-09 14:03:32 +02:00
-												Add status badges

											
										
										
											2020-06-30 22:24:27 +02:00
+								[![Integration level](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest) ![](https://ci-apps.yunohost.org/ci/badges/minetest.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/minetest.maintain.svg)
-												Fix readme

											
										
										
											2019-10-22 18:27:38 +02:00
+								[![Install Minetest with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest)
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
 								*[Lire ce readme en français.](./README_fr.md)*
 								> *This package allow you to install Minetest quickly and simply on a YunoHost server.
-												typo

											
										
										
											2020-05-13 16:32:46 +02:00
+								If you don’t have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
 								## Overview
-												small fixes

											
										
										
											2019-08-15 14:21:00 +02:00
+								Minetest is a free open-source voxel game engine with easy modding and game creation.
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
-												update to V.5.2.0

											
										
										
											2020-05-12 23:18:55 +02:00
+								**Shipped version:** 5.2.0
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
 								## Screenshots
 								![](https://www.minetest.net/media/gallery/1.jpg)
 								## Demo
 								No demo but you can test with servers in https://servers.minetest.net/
 								## Configuration
 								How to configure this app: by SSH
 								## Documentation
 								 * Official documentation: https://wiki.minetest.net/
-												Fix typos

											
										
										
											2020-05-13 16:28:19 +02:00
+								 * YunoHost documentation: https://yunohost.org/#/app_minetest
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
 								## YunoHost specific features
 								#### Multi-users support
-												cleaning up

											
										
										
											2020-06-07 10:47:21 +02:00
+								* Are LDAP and HTTP auth supported? **No**
 								* Can the app be used by multiple users? **Yes**
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
 								#### Supported architectures
-												cleaning up

											
										
										
											2020-06-07 10:47:21 +02:00
+								* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minetest%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/minetest/)
-												Fix ci badge
											
										
										
											2019-10-27 16:20:54 +01:00
+								* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minetest%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/)
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
 								## Limitations
 								* This app is not compatible with LDAP.
 								## Additional information
 								* Migration from old package
-												Fix typos

											
										
										
											2020-05-13 16:28:19 +02:00
-												fix list

											
										
										
											2020-05-13 16:40:18 +02:00
+								* You can’t migrate directly with an update.
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
+									* Before installing the new package you need to download this folder from your server `/var/games/minetest-server/.minetest/worlds/world` (this folder contains all world data)
 									* Uninstall the old package `sudo yunohost app remove minetest`
 									* Install the new one `sudo yunohost app install https://github.com/YunoHost-Apps/minetest_ynh`
 									* Stop Minetest service `sudo systemctl stop minetest`
 									* Copy the folder you have copied before in `/home/yunohost.app/minetest/.minetest/worlds`
 									* Start the Minetest service `sudo systemctl start minetest`
-												Fix readme

											
										
										
											2019-10-22 18:27:38 +02:00
+								* Installing mods
-												Fix typos

											
										
										
											2020-05-13 16:28:19 +02:00
+									* For installing mods you need to create a `worldmods` folder in `/home/yunohost.app/minetest/.minetest/worlds/world/`
 									* Clone the repo of the mod in this folder (ex: `git clone https://github.com/minetest-mods/mesecons`)
 									* Edit `/home/yunohost.app/minetest/.minetest/worlds/world/world.mt` and add at the end `load_mod_mesecons = true`
 									* Restart Minetest with `sudo systemctl restart minetest`
-												Fix readme

											
										
										
											2019-10-22 18:27:38 +02:00
+									* The mod is now installed :)
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
+								## Links
 								 * Report a bug: https://github.com/YunoHost-Apps/minetest_ynh/issues
-												Fix typos

											
										
										
											2020-05-13 16:28:19 +02:00
+								 * App website: https://www.minetest.net/
 								 * Upstream app repository: https://github.com/minetest/minetest
-												Complete rework

											
										
										
											2019-04-21 15:32:30 +02:00
+								 * YunoHost website: https://yunohost.org/
 								---
 								Developers info
 								----------------
 								Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/minetest_ynh/tree/testing).
 								To try the testing branch, please proceed like that.
 								```
 								sudo yunohost app install https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug
 								or
 								sudo yunohost app upgrade minetest -u https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug
 								```