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 #define WORLDNAME_BLACKLISTED_CHARS "/\\"
  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
  37         SubgameSpec(const std::string &id_="",
  38                         const std::string &path_="",
  39                         const std::string &gamemods_path_="",
  40                         const std::set<std::string> &addon_mods_paths_=std::set<std::string>(),
  41                         const std::string &name_=""):
  42                 id(id_),
  43                 path(path_),
  44                 gamemods_path(gamemods_path_),
  45                 addon_mods_paths(addon_mods_paths_),
  46                 name(name_)
  47         {}
  48
  49         bool isValid() const
  50         {
  51                 return (id != "" && path != "");
  52         }
  53 };
  54
  55 std::string getGameName(const std::string &game_path);
  56
  57 SubgameSpec findSubgame(const std::string &id);
  58 SubgameSpec findWorldSubgame(const std::string &world_path);
  59
  60 std::set<std::string> getAvailableGameIds();
  61 std::vector<SubgameSpec> getAvailableGames();
  62
  63 bool getWorldExists(const std::string &world_path);
  64 std::string getWorldGameId(const std::string &world_path,
  65                 bool can_be_legacy=false);
  66
  67 struct WorldSpec
  68 {
  69         std::string path;
  70         std::string name;
  71         std::string gameid;
  72
  73         WorldSpec(
  74                 const std::string &path_="",
  75                 const std::string &name_="",
  76                 const std::string &gameid_=""
  77         ):
  78                 path(path_),
  79                 name(name_),
  80                 gameid(gameid_)
  81         {}
  82
  83         bool isValid() const
  84         {
  85                 return (name != "" && path != "" && gameid != "");
  86         }
  87 };
  88
  89 std::vector<WorldSpec> getAvailableWorlds();
  90
  91 // Create world directory and world.mt if they don't exist
  92 bool initializeWorld(const std::string &path, const std::string &gameid);
  93
  94 #endif
  95