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