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"
29 #include <json/json.h>
30 #include <unordered_set>
34 #define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
41 std::unordered_set<std::string> depends;
42 std::unordered_set<std::string> optdepends;
43 std::unordered_set<std::string> unsatisfied_depends;
45 bool part_of_modpack = false;
46 bool is_modpack = false;
48 std::map<std::string,ModSpec> modpack_content;
49 ModSpec(const std::string &name_="", const std::string &path_=""):
55 // Retrieves depends, optdepends, is_modpack and modpack_content
56 void parseModContents(ModSpec &mod);
58 std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
60 // replaces modpack Modspecs with their content
61 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
63 // a ModConfiguration is a subset of installed mods, expected to have
64 // all dependencies fullfilled, so it can be used as a list of mods to
65 // load when the game starts.
66 class ModConfiguration
69 // checks if all dependencies are fullfilled.
70 bool isConsistent() const
72 return m_unsatisfied_mods.empty();
75 std::vector<ModSpec> getMods()
80 const std::vector<ModSpec> &getUnsatisfiedMods() const
82 return m_unsatisfied_mods;
85 void printUnsatisfiedModsError() const;
88 ModConfiguration(const std::string &worldpath);
89 // adds all mods in the given path. used for games, modpacks
90 // and world-specific mods (worldmods-folders)
91 void addModsInPath(const std::string &path);
93 // adds all mods in the set.
94 void addMods(const std::vector<ModSpec> &new_mods);
96 void addModsFormConfig(const std::string &settings_path, const std::set<std::string> &mods);
98 void checkConflictsAndDeps();
100 // move mods from m_unsatisfied_mods to m_sorted_mods
101 // in an order that satisfies dependencies
102 void resolveDependencies();
104 // mods with unmet dependencies. Before dependencies are resolved,
105 // this is where all mods are stored. Afterwards this contains
106 // only the ones with really unsatisfied dependencies.
107 std::vector<ModSpec> m_unsatisfied_mods;
109 // list of mods sorted such that they can be loaded in the
110 // given order with all dependencies being fullfilled. I.e.,
111 // every mod in this list has only dependencies on mods which
112 // appear earlier in the vector.
113 std::vector<ModSpec> m_sorted_mods;
115 // set of mod names for which an unresolved name conflict
116 // exists. A name conflict happens when two or more mods
117 // at the same level have the same name but different paths.
118 // Levels (mods in higher levels override mods in lower levels):
119 // 1. game mod in modpack; 2. game mod;
120 // 3. world mod in modpack; 4. world mod;
121 // 5. addon mod in modpack; 6. addon mod.
122 std::unordered_set<std::string> m_name_conflicts;
124 // Deleted default constructor
125 ModConfiguration() {}
129 class ServerModConfiguration: public ModConfiguration
132 ServerModConfiguration(const std::string &worldpath);
137 class ClientModConfiguration: public ModConfiguration
140 ClientModConfiguration(const std::string &path);
145 Json::Value getModstoreUrl(const std::string &url);
147 inline Json::Value getModstoreUrl(const std::string &url)
149 return Json::Value();
153 struct ModLicenseInfo {
155 std::string shortinfo;
159 struct ModAuthorInfo {
161 std::string username;
167 std::string basename;
168 ModAuthorInfo author;
173 struct ModStoreCategoryInfo {
178 struct ModStoreVersionEntry {
183 //ugly version number
187 struct ModStoreTitlePic {
190 std::string description;
194 struct ModStoreModDetails {
196 std::vector<ModStoreCategoryInfo> categories;
197 ModAuthorInfo author;
198 ModLicenseInfo license;
199 ModStoreTitlePic titlepic;
202 std::string basename;
203 std::string description;
204 std::string repository;
206 std::vector<std::string> depends;
207 std::vector<std::string> softdeps;
209 std::string download_url;
210 std::string screenshot_url;
211 std::vector<ModStoreVersionEntry> versions;
215 class ModMetadata: public Metadata
218 ModMetadata(const std::string &mod_name);
221 virtual void clear();
223 bool save(const std::string &root_path);
224 bool load(const std::string &root_path);
226 bool isModified() const { return m_modified; }
227 const std::string &getModName() const { return m_mod_name; }
229 virtual bool setString(const std::string &name, const std::string &var);
231 std::string m_mod_name;
232 bool m_modified = false;