diff options
| author | rubenwardy <rw@rubenwardy.com> | 2019-01-06 09:23:35 +0000 |
|---|---|---|
| committer | Loïc Blot <nerzhul@users.noreply.github.com> | 2019-01-06 10:23:35 +0100 |
| commit | 70bf3439ab9f3cb826d76111552dcc38678fcf3d (patch) | |
| tree | 1c56f6667e84b3f979c0b1bfcbc18db7cfbf2cc7 /doc | |
| parent | 3a9fe2bd5b0c112150eb20e375729aea7a4776f4 (diff) | |
| download | minetest-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')
| -rw-r--r-- | doc/client_lua_api.txt | 8 | ||||
| -rw-r--r-- | doc/lua_api.txt | 10 |
2 files changed, 14 insertions, 4 deletions
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt index 41560b983..f0e585355 100644 --- a/doc/client_lua_api.txt +++ b/doc/client_lua_api.txt @@ -68,8 +68,12 @@ Modpack support **NOTE: Not implemented yet.** 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. Mod directory structure ------------------------ 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 ----------------------- |