tutorials - server - game.conf features and description usage

tutorials/servers-howto-en.md

@@ -1,7 +1,8 @@
 # Minetest Server
 
 **Minetest is a game** that although it is played on your computer or phone, it can also be played online, 
-that means it is a client - server game, **where the client is the guest and the server is the host.**
+
+Means it is a client - server game, **where the client is your phone/pc** and the server can be your phone/pc or a remote internet computer.
 
 ## Knowning server and client
 
@@ -66,7 +67,7 @@ A minetest server need as minimun of 3 parameters to indicate: game id, config f
 
 * **gameid** : a game itself is a directory with collection of mods that defines behaviour of the game, those 
 will load the files inside mods directories, **Due we are assuming** `RUN_IN_PLACE` **they are located at** 
-`/usr/local/minetest/games`, **and you must download under that path (generally as a unique directory)**, 
+`/usr/local/minetest/games`, but if you are running as system wide, are located at `$HOME/.minetest/games`; **you must download under the games path (generally as a unique directory)**, 
 there are some famous:
     * `minetest_game` is the default one.. download from https://github.com/minetest/minetest_game/tags 
     and must match the minetest version runing, is the most stable and basic to run.
@@ -78,6 +79,23 @@ there are some famous:
     for 0.4.X at https://github.com/davedevils/MineClone, since v0.51 are only for 5.X releases.
     * `clonecrat` like the previous one but lighter, download at https://github.com/notanewbie/clonecraft_ZIP 
     but is a older development so use only for 0.4 releases
+* **game.conf** : the config file that the server try to load over minetest.conf when the `game_id` loads.
+    * Loading path: it loads from the directory of the game that are currently loading.
+    * Contains paramteters to run the host:
+         * `title`: (Required), the name of the directory where game parts will be loaded
+         * `name`: (Deprecated) same as title, used for minetst from 0.X to 5.4 releases.
+         * `description`: Short description to be shown in the content tab, no more than 128 chars
+         * `allowed_mapgens = <comma-separated mapgens>` e.g `v5,v6,flat`, Mapgens not in this 
+         list are removed from the list of mapgens for the game. If not specified, all mapgens are allowed.
+         * `disallowed_mapgens = <comma-separated mapgens>` e.g. `v6,flat` These mapgens are removed from the 
+         list of mapgens for the game, allowed_mapgens is applied before disallowed_mapgens.
+         * `disabled_settings = <comma-separated settings>` e.g. `disabled_settings = enable_damage, creative_mode` 
+         these settings are hidden for this game in the "Start game" tab and will be initialized as false when 
+         the game is started. Prepend a setting name with an exclamation mark to initialize it to true (this does 
+         not work for enable_server). Only these settings are supported: `enable_damage, creative_mode, enable_server`.
+         * `map_persistent`: Specifies whether newly created worlds should use a persistent map backend. 
+         Defaults to true (= "sqlite3")
+         * `author`: The author of the game. It only appears when downloaded from ContentDB.
 * **world** : a world itself, is a directory with collection of files for environment and/or building(s) and 
 all saved data associated with a world, **Due we are assuming** `RUN_IN_PLACE` **they are located at** 
 `/usr/local/minetest/worlds`, **and if not pointed in config will be loaded one named `world`** 
@@ -93,9 +111,24 @@ by default, it (will) contains:
     * `world.mt` is the definition of the world, is the only file that must be present before anything, 
     if the world is new or if the other files are already present, this must be in sync with.
 * **minetest.conf** : the config file that the server must use to start, it defines the path to the world place 
-and the usage of the gameid of the world, also paramteters to run the host of the game, the minimal ones 
-to be configure are:
-    * `default_game` it defines the `gameid` to be used inside the running minetest server adn for the world.
+and the usage of the gameid of the world, you will now rarely need to edit minetest.conf manually cos the GUI 
+screen provide you a interface to confgure it all. This file is read every time the game starts and is always 
+created/modified when the menu quits.
+    * Loading path: it loads from:
+         * `/usr/local/minetest/games/<gameid>/minetest.conf` if you have system wide with `/usr/local` as prefix
+         and build the game with `RUN_IN_PLACE=0` (means it loads from the gameid directory of the game first)
+         * `$HOME/.minetest/games/<gameid>/minetest.conf` as second try if the game is running from user wide
+         and build the game with `RUN_IN_PLACE=0` (means it loads from the gameid user directory then)
+         * `../minetest.conf` if you are configuring build for `RUN_IN_PLACE=1` that means all the minetest 
+         files are running from one place.
+         * `../../minetest.conf` also, but will not write to it, if you are configuring build for `RUN_IN_PLACE=1` 
+         that means all the minetest files are running from one place.
+         * `~/.minetest/minetest.conf` if you are running a system wide installation, like a package 
+         from distribution or if configuring build for `RUN_IN_PLACE=0`
+         * Custom path in command line using the option `--config /path/to/minetest.conf` of the server 
+         binary program.
+    * Contains paramteters to run the host:
+         * `default_game` it defines the `gameid` to be used inside the running minetest server adn for the world.
 
 Rest of files and setting are enough as default and must be tuned depending of the target of the dessired game.