Use virtual paths to specify exact mod to enable (#11784)

[dragonfireclient.git] / doc / menu_lua_api.txt

diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt
index a8928441edef28e676e008424a7f995f68aaf73c..c2931af310f6a45aec6d43de75577aaf7a214432 100644 (file)
--- a/doc/menu_lua_api.txt
+++ b/doc/menu_lua_api.txt
@@ -221,13 +221,24 @@ Package - content which is downloadable from the content db, may or may not be i
     * returns path to global user data,
       the directory that contains user-provided mods, worlds, games, and texture packs.
 * core.get_modpath() (possible in async calls)
-    * returns path to global modpath, where mods can be installed
+    * returns path to global modpath in the user path, where mods can be installed
 * core.get_modpaths() (possible in async calls)
-    * returns list of paths to global modpaths, where mods have been installed
-
+    * returns table of virtual path to global modpaths, where mods have been installed
       The difference with "core.get_modpath" is that no mods should be installed in these
       directories by Minetest -- they might be read-only.
 
+      Ex:
+
+      ```
+      {
+          mods = "/home/user/.minetest/mods",
+          share = "/usr/share/minetest/mods",
+
+          -- Custom dirs can be specified by the MINETEST_MOD_DIR env variable
+          ["/path/to/custom/dir"] = "/path/to/custom/dir",
+      }
+      ```
+
 * core.get_clientmodpath() (possible in async calls)
     * returns path to global client-side modpath
 * core.get_gamepath() (possible in async calls)