aboutsummaryrefslogtreecommitdiff
path: root/doc/world_format.txt
diff options
context:
space:
mode:
authorrubenwardy <rw@rubenwardy.com>2022-01-30 22:40:53 +0000
committerGitHub <noreply@github.com>2022-01-30 22:40:53 +0000
commit128f6359e936bcdc5e26409ddd73438bce9c6dd6 (patch)
treef4d396d479ae17f57f25ab78df300256e28d5945 /doc/world_format.txt
parent8c0331d2449cf71049c7ce9c06d141e2846ebcb0 (diff)
downloadhax-minetest-server-128f6359e936bcdc5e26409ddd73438bce9c6dd6.tar.gz
hax-minetest-server-128f6359e936bcdc5e26409ddd73438bce9c6dd6.zip
Use virtual paths to specify exact mod to enable (#11784)
Diffstat (limited to 'doc/world_format.txt')
-rw-r--r--doc/world_format.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/world_format.txt b/doc/world_format.txt
index eb1d7f728..98c9d2009 100644
--- a/doc/world_format.txt
+++ b/doc/world_format.txt
@@ -133,6 +133,19 @@ Example content (added indentation and - explanations):
load_mod_<mod> = false - whether <mod> is to be loaded in this world
auth_backend = files - which DB backend to use for authentication data
+For load_mod_<mod>, the possible values are:
+
+* `false` - Do not load the mod.
+* `true` - Load the mod from wherever it is found (may cause conflicts if the same mod appears also in some other place).
+* `mods/modpack/moddir` - Relative path to the mod
+ * Must be one of the following:
+ * `mods/`: mods in the user path's mods folder (ex `/home/user/.minetest/mods`)
+ * `share/`: mods in the share's mods folder (ex: `/usr/share/minetest/mods`)
+ * `/path/to/env`: you can use absolute paths to mods inside folders specified with the `MINETEST_MOD_PATH` env variable.
+ * Other locations and absolute paths are not supported
+ * Note that `moddir` is the directory name, not the mod name specified in mod.conf.
+
+
Player File Format
===================