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 #define WORLDNAME_BLACKLISTED_CHARS "/\\"
  30
  31 struct SubgameSpec
  32 {
  33         std::string id; // "" = game does not exist
  34         std::string path; // path to game
  35         std::string gamemods_path; //path to mods of the game
  36         std::set<std::string> addon_mods_paths; //paths to addon mods for this game
  37         std::string name;
  38         std::string menubackground_path;
  39         std::string menuoverlay_path;
  40         std::string menuicon_path;
  41
  42         SubgameSpec(const std::string &id_="",
  43                         const std::string &path_="",
  44                         const std::string &gamemods_path_="",
  45                         const std::set<std::string> &addon_mods_paths_=std::set<std::string>(),
  46                         const std::string &name_="",
  47                         const std::string &menubackground_path_="",
  48                         const std::string &menuoverlay_path_="",
  49                         const std::string &menuicon_path_=""):
  50                 id(id_),
  51                 path(path_),
  52                 gamemods_path(gamemods_path_),
  53                 addon_mods_paths(addon_mods_paths_),
  54                 name(name_),
  55                 menubackground_path(menubackground_path_),
  56                 menuoverlay_path(menuoverlay_path_),
  57                 menuicon_path(menuicon_path_)
  58         {}
  59
  60         bool isValid() const
  61         {
  62                 return (id != "" && path != "");
  63         }
  64 };
  65
  66 // minetest.conf
  67 bool getGameMinetestConfig(const std::string &game_path, Settings &conf);
  68 // game.conf
  69 bool getGameConfig(const std::string &game_path, Settings &conf);
  70
  71 std::string getGameName(const std::string &game_path);
  72
  73 SubgameSpec findSubgame(const std::string &id);
  74 SubgameSpec findWorldSubgame(const std::string &world_path);
  75
  76 std::set<std::string> getAvailableGameIds();
  77 std::vector<SubgameSpec> getAvailableGames();
  78
  79 bool getWorldExists(const std::string &world_path);
  80 std::string getWorldGameId(const std::string &world_path,
  81                 bool can_be_legacy=false);
  82
  83 struct WorldSpec
  84 {
  85         std::string path;
  86         std::string name;
  87         std::string gameid;
  88
  89         WorldSpec(
  90                 const std::string &path_="",
  91                 const std::string &name_="",
  92                 const std::string &gameid_=""
  93         ):
  94                 path(path_),
  95                 name(name_),
  96                 gameid(gameid_)
  97         {}
  98
  99         bool isValid() const
 100         {
 101                 return (name != "" && path != "" && gameid != "");
 102         }
 103 };
 104
 105 std::vector<WorldSpec> getAvailableWorlds();
 106
 107 // Create world directory and world.mt if they don't exist
 108 bool initializeWorld(const std::string &path, const std::string &gameid);
 109
 110 #endif
 111