From 4e9e230e34912d08ec0f0fc01d14ef80654c7cac Mon Sep 17 00:00:00 2001
From: rubenwardy <rw@rubenwardy.com>
Date: Sat, 21 May 2022 16:23:30 +0100
Subject: Deprecate game.conf name, use title instead (#12030)

---
 doc/menu_lua_api.txt | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'doc/menu_lua_api.txt')

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",
-- 
cgit v1.2.3