src/subgame.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef SUBGAME_HEADER
  21 #define SUBGAME_HEADER
  22
  23 #include <string>
  24 #include <set>
  25 #include <vector>
  26
  27 class Settings;
  28
  29 struct SubgameSpec
  30 {
  31         std::string id; // "" = game does not exist
  32         std::string path; // path to game
  33         std::string gamemods_path; //path to mods of the game
  34         std::set<std::string> addon_mods_paths; //paths to addon mods for this game
  35         std::string name;
  36         std::string menuicon_path;
  37
  38         SubgameSpec(const std::string &id_ = "",
  39                         const std::string &path_ = "",
  40                         const std::string &gamemods_path_ = "",
  41                         const std::set<std::string> &addon_mods_paths_ = std::set<std::string>(),
  42                         const std::string &name_ = "",
  43                         const std::string &menuicon_path_ = ""):
  44                 id(id_),
  45                 path(path_),
  46                 gamemods_path(gamemods_path_),
  47                 addon_mods_paths(addon_mods_paths_),
  48                 name(name_),
  49                 menuicon_path(menuicon_path_)
  50         {}
  51
  52         bool isValid() const
  53         {
  54                 return (id != "" && path != "");
  55         }
  56 };
  57
  58 // minetest.conf
  59 bool getGameMinetestConfig(const std::string &game_path, Settings &conf);
  60 // game.conf
  61 bool getGameConfig(const std::string &game_path, Settings &conf);
  62
  63 std::string getGameName(const std::string &game_path);
  64
  65 SubgameSpec findSubgame(const std::string &id);
  66 SubgameSpec findWorldSubgame(const std::string &world_path);
  67
  68 std::set<std::string> getAvailableGameIds();
  69 std::vector<SubgameSpec> getAvailableGames();
  70
  71 bool getWorldExists(const std::string &world_path);
  72 std::string getWorldGameId(const std::string &world_path,
  73                 bool can_be_legacy=false);
  74
  75 struct WorldSpec
  76 {
  77         std::string path;
  78         std::string name;
  79         std::string gameid;
  80
  81         WorldSpec(
  82                 const std::string &path_="",
  83                 const std::string &name_="",
  84                 const std::string &gameid_=""
  85         ):
  86                 path(path_),
  87                 name(name_),
  88                 gameid(gameid_)
  89         {}
  90
  91         bool isValid() const
  92         {
  93                 return (name != "" && path != "" && gameid != "");
  94         }
  95 };
  96
  97 std::vector<WorldSpec> getAvailableWorlds();
  98
  99 // loads the subgame's config and creates world directory
 100 // and world.mt if they don't exist
 101 bool loadGameConfAndInitWorld(const std::string &path, const SubgameSpec &gamespec);
 102
 103 #endif
 104