aboutsummaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
authorrubenwardy <rw@rubenwardy.com>2019-01-06 09:23:35 +0000
committerLoïc Blot <nerzhul@users.noreply.github.com>2019-01-06 10:23:35 +0100
commit70bf3439ab9f3cb826d76111552dcc38678fcf3d (patch)
tree1c56f6667e84b3f979c0b1bfcbc18db7cfbf2cc7 /doc/lua_api.txt
parent3a9fe2bd5b0c112150eb20e375729aea7a4776f4 (diff)
downloadminetest-70bf3439ab9f3cb826d76111552dcc38678fcf3d.tar.gz
minetest-70bf3439ab9f3cb826d76111552dcc38678fcf3d.tar.bz2
minetest-70bf3439ab9f3cb826d76111552dcc38678fcf3d.zip
Deprecate modpack.txt and use modpack.conf instead (#7892)
* Deprecate modpack.txt and use modpack.conf instead
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 0b08282a0..a8380e1cc 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -119,8 +119,14 @@ Modpacks
--------
Mods can be put in a subdirectory, if the parent directory, which otherwise
-should be a mod, contains a file named `modpack.txt`. This file shall be
-empty, except for lines starting with `#`, which are comments.
+should be a mod, contains a file named `modpack.conf`.
+The file is a key-value store of modpack details.
+
+* `name`: The modpack name.
+* `description`: Description of mod to be shown in the Mods tab of the main
+ menu.
+
+Note: to support 0.4.x, please also create an empty modpack.txt file.
Mod directory structure
-----------------------