diff options
| author | rubenwardy <rw@rubenwardy.com> | 2022-05-21 16:23:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-21 16:23:30 +0100 |
| commit | 4e9e230e34912d08ec0f0fc01d14ef80654c7cac (patch) | |
| tree | ae06c4fc9971808dd0a87d07aba702d8561b05ef /doc | |
| parent | dc45b85a543b4c8ad72f69a554ecfe7f0a60c533 (diff) | |
| download | minetest-4e9e230e34912d08ec0f0fc01d14ef80654c7cac.tar.gz minetest-4e9e230e34912d08ec0f0fc01d14ef80654c7cac.tar.bz2 minetest-4e9e230e34912d08ec0f0fc01d14ef80654c7cac.zip | |
Deprecate game.conf name, use title instead (#12030)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 3 | ||||
| -rw-r--r-- | doc/menu_lua_api.txt | 6 |
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index abfaf08aa..6046a5902 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -62,7 +62,8 @@ Where `<gameid>` is unique to each game. The game directory can contain the following files: * `game.conf`, with the following keys: - * `name`: Required, a human readable title to address the game, e.g. `name = Minetest`. + * `title`: Required, a human-readable title to address the game, e.g. `title = Minetest Game`. + * `name`: (Deprecated) same as title. * `description`: Short description to be shown in the content tab * `allowed_mapgens = <comma-separated mapgens>` e.g. `allowed_mapgens = v5,v6,flat` diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt index c2931af31..68e7b4b9d 100644 --- a/doc/menu_lua_api.txt +++ b/doc/menu_lua_api.txt @@ -246,13 +246,14 @@ Package - content which is downloadable from the content db, may or may not be i * core.get_texturepath() (possible in async calls) * returns path to default textures * core.get_game(index) + * `name` in return value is deprecated, use `title` instead. * returns: { id = <id>, path = <full path to game>, gamemods_path = <path>, - name = <name of game>, + title = <title of game>, menuicon_path = <full path to menuicon>, author = "author", DEPRECATED: @@ -264,8 +265,9 @@ Package - content which is downloadable from the content db, may or may not be i * returns { - name = "name of content", + name = "technical_id", type = "mod" or "modpack" or "game" or "txp", + title = "Human readable title", description = "description", author = "author", path = "path/to/content", |