Deprecate game.conf name, use title instead (#12030)

This commit is contained in:
rubenwardy 2022-05-21 16:23:30 +01:00 committed by GitHub
parent dc45b85a54
commit 4e9e230e34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 90 additions and 31 deletions

@ -151,11 +151,9 @@ local function start_install(package, reason)
if conf_path then if conf_path then
local conf = Settings(conf_path) local conf = Settings(conf_path)
if name_is_title then conf:set("title", package.title)
conf:set("name", package.title) if not name_is_title then
else conf:set("name", package.name)
conf:set("title", package.title)
conf:set("name", package.name)
end end
if not conf:get("description") then if not conf:get("description") then
conf:set("description", package.short_description) conf:set("description", package.short_description)
@ -360,7 +358,7 @@ function install_dialog.get_formspec()
selected_game_idx = i selected_game_idx = i
end end
games[i] = core.formspec_escape(games[i].name) games[i] = core.formspec_escape(games[i].title)
end end
local selected_game = pkgmgr.games[selected_game_idx] local selected_game = pkgmgr.games[selected_game_idx]
@ -410,7 +408,7 @@ function install_dialog.get_formspec()
"container[0.375,0.70]", "container[0.375,0.70]",
"label[0,0.25;", fgettext("Base Game:"), "]", "label[0,0.25;", fgettext("Base Game:"), "]",
"dropdown[2,0;4.25,0.5;gameid;", table.concat(games, ","), ";", selected_game_idx, "]", "dropdown[2,0;4.25,0.5;selected_game;", table.concat(games, ","), ";", selected_game_idx, "]",
"label[0,0.8;", fgettext("Dependencies:"), "]", "label[0,0.8;", fgettext("Dependencies:"), "]",
@ -461,9 +459,9 @@ function install_dialog.handle_submit(this, fields)
return true return true
end end
if fields.gameid then if fields.selected_game then
for _, game in pairs(pkgmgr.games) do for _, game in pairs(pkgmgr.games) do
if game.name == fields.gameid then if game.title == fields.selected_game then
core.settings:set("menu_last_game", game.id) core.settings:set("menu_last_game", game.id)
break break
end end

@ -646,6 +646,8 @@ function pkgmgr.install_dir(type, path, basename, targetpath)
else else
targetpath = core.get_gamepath() .. DIR_DELIM .. basename targetpath = core.get_gamepath() .. DIR_DELIM .. basename
end end
else
error("basefolder didn't return a recognised type, this shouldn't happen")
end end
-- Copy it -- Copy it
@ -692,7 +694,7 @@ function pkgmgr.preparemodlist(data)
retval[#retval + 1] = { retval[#retval + 1] = {
type = "game", type = "game",
is_game_content = true, is_game_content = true,
name = fgettext("$1 mods", gamespec.name), name = fgettext("$1 mods", gamespec.title),
path = gamespec.path path = gamespec.path
} }
end end
@ -873,10 +875,10 @@ end
function pkgmgr.gamelist() function pkgmgr.gamelist()
local retval = "" local retval = ""
if #pkgmgr.games > 0 then if #pkgmgr.games > 0 then
retval = retval .. core.formspec_escape(pkgmgr.games[1].name) retval = retval .. core.formspec_escape(pkgmgr.games[1].title)
for i=2,#pkgmgr.games,1 do for i=2,#pkgmgr.games,1 do
retval = retval .. "," .. core.formspec_escape(pkgmgr.games[i].name) retval = retval .. "," .. core.formspec_escape(pkgmgr.games[i].title)
end end
end end
return retval return retval

@ -88,7 +88,7 @@ if enable_gamebar then
local image = nil local image = nil
local text = nil local text = nil
local tooltip = core.formspec_escape(game.name) local tooltip = core.formspec_escape(game.title)
if (game.menuicon_path or "") ~= "" then if (game.menuicon_path or "") ~= "" then
image = core.formspec_escape(game.menuicon_path) image = core.formspec_escape(game.menuicon_path)

@ -62,7 +62,8 @@ Where `<gameid>` is unique to each game.
The game directory can contain the following files: The game directory can contain the following files:
* `game.conf`, with the following keys: * `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 * `description`: Short description to be shown in the content tab
* `allowed_mapgens = <comma-separated mapgens>` * `allowed_mapgens = <comma-separated mapgens>`
e.g. `allowed_mapgens = v5,v6,flat` e.g. `allowed_mapgens = v5,v6,flat`

@ -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) * core.get_texturepath() (possible in async calls)
* returns path to default textures * returns path to default textures
* core.get_game(index) * core.get_game(index)
* `name` in return value is deprecated, use `title` instead.
* returns: * returns:
{ {
id = <id>, id = <id>,
path = <full path to game>, path = <full path to game>,
gamemods_path = <path>, gamemods_path = <path>,
name = <name of game>, title = <title of game>,
menuicon_path = <full path to menuicon>, menuicon_path = <full path to menuicon>,
author = "author", author = "author",
DEPRECATED: DEPRECATED:
@ -264,8 +265,9 @@ Package - content which is downloadable from the content db, may or may not be i
* returns * returns
{ {
name = "name of content", name = "technical_id",
type = "mod" or "modpack" or "game" or "txp", type = "mod" or "modpack" or "game" or "txp",
title = "Human readable title",
description = "description", description = "description",
author = "author", author = "author",
path = "path/to/content", path = "path/to/content",

@ -1,2 +1,2 @@
name = Development Test title = Development Test
description = Testing environment to help with testing the engine features of Minetest. It can also be helpful in mod development. description = Testing environment to help with testing the engine features of Minetest. It can also be helpful in mod development.

@ -96,7 +96,12 @@ void parseContentInfo(ContentSpec &spec)
Settings conf; Settings conf;
if (!conf_path.empty() && conf.readConfigFile(conf_path.c_str())) { if (!conf_path.empty() && conf.readConfigFile(conf_path.c_str())) {
if (conf.exists("name")) if (conf.exists("title"))
spec.title = conf.get("title");
else if (spec.type == "game" && conf.exists("name"))
spec.title = conf.get("name");
if (spec.type != "game" && conf.exists("name"))
spec.name = conf.get("name"); spec.name = conf.get("name");
if (conf.exists("description")) if (conf.exists("description"))

@ -27,7 +27,14 @@ struct ContentSpec
std::string type; std::string type;
std::string author; std::string author;
u32 release = 0; u32 release = 0;
/// Technical name / Id
std::string name; std::string name;
/// Human-readable title
std::string title;
/// Short description
std::string desc; std::string desc;
std::string path; std::string path;
}; };

@ -17,6 +17,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/ */
#include <common/c_internal.h>
#include "content/subgames.h" #include "content/subgames.h"
#include "porting.h" #include "porting.h"
#include "filesys.h" #include "filesys.h"
@ -45,6 +46,25 @@ bool getGameMinetestConfig(const std::string &game_path, Settings &conf)
} }
void SubgameSpec::checkAndLog() const
{
// Log deprecation messages
auto handling_mode = get_deprecated_handling_mode();
if (!deprecation_msgs.empty() && handling_mode != DeprecatedHandlingMode::Ignore) {
std::ostringstream os;
os << "Game " << title << " at " << path << ":" << std::endl;
for (auto msg : deprecation_msgs)
os << "\t" << msg << std::endl;
if (handling_mode == DeprecatedHandlingMode::Error)
throw ModError(os.str());
else
warningstream << os.str();
}
}
struct GameFindPath struct GameFindPath
{ {
std::string path; std::string path;
@ -121,11 +141,13 @@ SubgameSpec findSubgame(const std::string &id)
Settings conf; Settings conf;
conf.readConfigFile(conf_path.c_str()); conf.readConfigFile(conf_path.c_str());
std::string game_name; std::string game_title;
if (conf.exists("name")) if (conf.exists("title"))
game_name = conf.get("name"); game_title = conf.get("title");
else if (conf.exists("name"))
game_title = conf.get("name");
else else
game_name = id; game_title = id;
std::string game_author; std::string game_author;
if (conf.exists("author")) if (conf.exists("author"))
@ -140,8 +162,14 @@ SubgameSpec findSubgame(const std::string &id)
menuicon_path = getImagePath( menuicon_path = getImagePath(
game_path + DIR_DELIM + "menu" + DIR_DELIM + "icon.png"); game_path + DIR_DELIM + "menu" + DIR_DELIM + "icon.png");
#endif #endif
return SubgameSpec(id, game_path, gamemod_path, mods_paths, game_name,
SubgameSpec spec(id, game_path, gamemod_path, mods_paths, game_title,
menuicon_path, game_author, game_release); menuicon_path, game_author, game_release);
if (conf.exists("name") && !conf.exists("title"))
spec.deprecation_msgs.push_back("\"name\" setting in game.conf is deprecated, please use \"title\" instead");
return spec;
} }
SubgameSpec findWorldSubgame(const std::string &world_path) SubgameSpec findWorldSubgame(const std::string &world_path)
@ -159,10 +187,12 @@ SubgameSpec findWorldSubgame(const std::string &world_path)
std::string conf_path = world_gamepath + DIR_DELIM + "game.conf"; std::string conf_path = world_gamepath + DIR_DELIM + "game.conf";
conf.readConfigFile(conf_path.c_str()); conf.readConfigFile(conf_path.c_str());
if (conf.exists("name")) if (conf.exists("title"))
gamespec.name = conf.get("name"); gamespec.title = conf.get("title");
else if (conf.exists("name"))
gamespec.title = conf.get("name");
else else
gamespec.name = world_gameid; gamespec.title = world_gameid;
return gamespec; return gamespec;
} }

@ -29,7 +29,7 @@ class Settings;
struct SubgameSpec struct SubgameSpec
{ {
std::string id; std::string id;
std::string name; std::string title;
std::string author; std::string author;
int release; int release;
std::string path; std::string path;
@ -41,20 +41,24 @@ struct SubgameSpec
std::unordered_map<std::string, std::string> addon_mods_paths; std::unordered_map<std::string, std::string> addon_mods_paths;
std::string menuicon_path; std::string menuicon_path;
// For logging purposes
std::vector<const char *> deprecation_msgs;
SubgameSpec(const std::string &id = "", const std::string &path = "", SubgameSpec(const std::string &id = "", const std::string &path = "",
const std::string &gamemods_path = "", const std::string &gamemods_path = "",
const std::unordered_map<std::string, std::string> &addon_mods_paths = {}, const std::unordered_map<std::string, std::string> &addon_mods_paths = {},
const std::string &name = "", const std::string &title = "",
const std::string &menuicon_path = "", const std::string &menuicon_path = "",
const std::string &author = "", int release = 0) : const std::string &author = "", int release = 0) :
id(id), id(id),
name(name), author(author), release(release), path(path), title(title), author(author), release(release), path(path),
gamemods_path(gamemods_path), addon_mods_paths(addon_mods_paths), gamemods_path(gamemods_path), addon_mods_paths(addon_mods_paths),
menuicon_path(menuicon_path) menuicon_path(menuicon_path)
{ {
} }
bool isValid() const { return (!id.empty() && !path.empty()); } bool isValid() const { return (!id.empty() && !path.empty()); }
void checkAndLog() const;
}; };
SubgameSpec findSubgame(const std::string &id); SubgameSpec findSubgame(const std::string &id);

@ -304,7 +304,11 @@ int ModApiMainMenu::l_get_games(lua_State *L)
lua_settable(L, top_lvl2); lua_settable(L, top_lvl2);
lua_pushstring(L, "name"); lua_pushstring(L, "name");
lua_pushstring(L, game.name.c_str()); lua_pushstring(L, game.title.c_str());
lua_settable(L, top_lvl2);
lua_pushstring(L, "title");
lua_pushstring(L, game.title.c_str());
lua_settable(L, top_lvl2); lua_settable(L, top_lvl2);
lua_pushstring(L, "author"); lua_pushstring(L, "author");
@ -356,6 +360,11 @@ int ModApiMainMenu::l_get_content_info(lua_State *L)
lua_pushstring(L, spec.author.c_str()); lua_pushstring(L, spec.author.c_str());
lua_setfield(L, -2, "author"); lua_setfield(L, -2, "author");
if (!spec.title.empty()) {
lua_pushstring(L, spec.title.c_str());
lua_setfield(L, -2, "title");
}
lua_pushinteger(L, spec.release); lua_pushinteger(L, spec.release);
lua_setfield(L, -2, "release"); lua_setfield(L, -2, "release");

@ -440,6 +440,7 @@ void Server::init()
m_script->loadMod(getBuiltinLuaPath() + DIR_DELIM "init.lua", BUILTIN_MOD_NAME); m_script->loadMod(getBuiltinLuaPath() + DIR_DELIM "init.lua", BUILTIN_MOD_NAME);
m_gamespec.checkAndLog();
m_modmgr->loadMods(m_script); m_modmgr->loadMods(m_script);
// Read Textures and calculate sha1 sums // Read Textures and calculate sha1 sums
@ -3109,7 +3110,7 @@ std::string Server::getStatusString()
// Version // Version
os << "version: " << g_version_string; os << "version: " << g_version_string;
// Game // Game
os << " | game: " << (m_gamespec.name.empty() ? m_gamespec.id : m_gamespec.name); os << " | game: " << (m_gamespec.title.empty() ? m_gamespec.id : m_gamespec.title);
// Uptime // Uptime
os << " | uptime: " << duration_to_string((int) m_uptime_counter->get()); os << " | uptime: " << duration_to_string((int) m_uptime_counter->get());
// Max lag estimate // Max lag estimate