3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
23 #include "irrlichttypes.h"
30 #include "json/json.h"
33 #define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
35 class ModError : public std::exception
38 ModError(const std::string &s)
43 virtual ~ModError() throw()
45 virtual const char * what() const throw()
57 std::set<std::string> depends;
58 std::set<std::string> optdepends;
59 std::set<std::string> unsatisfied_depends;
64 std::map<std::string,ModSpec> modpack_content;
65 ModSpec(const std::string &name_="", const std::string &path_=""):
70 unsatisfied_depends(),
71 part_of_modpack(false),
77 // Retrieves depends, optdepends, is_modpack and modpack_content
78 void parseModContents(ModSpec &mod);
80 std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
82 // If failed, returned modspec has name==""
83 ModSpec findCommonMod(const std::string &modname);
85 // expands modpack contents, but does not replace them.
86 std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods);
88 // replaces modpack Modspecs with their content
89 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
91 // a ModConfiguration is a subset of installed mods, expected to have
92 // all dependencies fullfilled, so it can be used as a list of mods to
93 // load when the game starts.
94 class ModConfiguration
104 ModConfiguration(std::string worldpath);
106 // checks if all dependencies are fullfilled.
109 return m_unsatisfied_mods.empty();
112 std::vector<ModSpec> getMods()
114 return m_sorted_mods;
117 std::vector<ModSpec> getUnsatisfiedMods()
119 return m_unsatisfied_mods;
123 // adds all mods in the given path. used for games, modpacks
124 // and world-specific mods (worldmods-folders)
125 void addModsInPath(std::string path);
127 // adds all mods in the set.
128 void addMods(std::vector<ModSpec> new_mods);
130 // move mods from m_unsatisfied_mods to m_sorted_mods
131 // in an order that satisfies dependencies
132 void resolveDependencies();
134 // mods with unmet dependencies. Before dependencies are resolved,
135 // this is where all mods are stored. Afterwards this contains
136 // only the ones with really unsatisfied dependencies.
137 std::vector<ModSpec> m_unsatisfied_mods;
139 // list of mods sorted such that they can be loaded in the
140 // given order with all dependencies being fullfilled. I.e.,
141 // every mod in this list has only dependencies on mods which
142 // appear earlier in the vector.
143 std::vector<ModSpec> m_sorted_mods;
145 // set of mod names for which an unresolved name conflict
146 // exists. A name conflict happens when two or more mods
147 // at the same level have the same name but different paths.
148 // Levels (mods in higher levels override mods in lower levels):
149 // 1. game mod in modpack; 2. game mod;
150 // 3. world mod in modpack; 4. world mod;
151 // 5. addon mod in modpack; 6. addon mod.
152 std::set<std::string> m_name_conflicts;
157 Json::Value getModstoreUrl(std::string url);
159 inline Json::Value getModstoreUrl(std::string url) {
160 return Json::Value();
164 struct ModLicenseInfo {
166 std::string shortinfo;
170 struct ModAuthorInfo {
172 std::string username;
178 std::string basename;
179 ModAuthorInfo author;
184 struct ModStoreCategoryInfo {
189 struct ModStoreVersionEntry {
194 //ugly version number
198 struct ModStoreTitlePic {
201 std::string description;
205 struct ModStoreModDetails {
207 std::vector<ModStoreCategoryInfo> categories;
208 ModAuthorInfo author;
209 ModLicenseInfo license;
210 ModStoreTitlePic titlepic;
213 std::string basename;
214 std::string description;
215 std::string repository;
217 std::vector<std::string> depends;
218 std::vector<std::string> softdeps;
220 std::string download_url;
221 std::string screenshot_url;
222 std::vector<ModStoreVersionEntry> versions;