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 "util/cpp11_container.h"
34 #define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
41 UNORDERED_SET<std::string> depends;
42 UNORDERED_SET<std::string> optdepends;
43 UNORDERED_SET<std::string> unsatisfied_depends;
48 std::map<std::string,ModSpec> modpack_content;
49 ModSpec(const std::string &name_="", const std::string &path_=""):
54 unsatisfied_depends(),
55 part_of_modpack(false),
61 // Retrieves depends, optdepends, is_modpack and modpack_content
62 void parseModContents(ModSpec &mod);
64 std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
66 // replaces modpack Modspecs with their content
67 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
69 // a ModConfiguration is a subset of installed mods, expected to have
70 // all dependencies fullfilled, so it can be used as a list of mods to
71 // load when the game starts.
72 class ModConfiguration
75 // checks if all dependencies are fullfilled.
76 bool isConsistent() const
78 return m_unsatisfied_mods.empty();
81 std::vector<ModSpec> getMods()
86 const std::vector<ModSpec> &getUnsatisfiedMods() const
88 return m_unsatisfied_mods;
91 void printUnsatisfiedModsError() const;
94 ModConfiguration(const std::string &worldpath);
95 // adds all mods in the given path. used for games, modpacks
96 // and world-specific mods (worldmods-folders)
97 void addModsInPath(const std::string &path);
99 // adds all mods in the set.
100 void addMods(const std::vector<ModSpec> &new_mods);
102 void checkConflictsAndDeps();
104 // move mods from m_unsatisfied_mods to m_sorted_mods
105 // in an order that satisfies dependencies
106 void resolveDependencies();
108 // mods with unmet dependencies. Before dependencies are resolved,
109 // this is where all mods are stored. Afterwards this contains
110 // only the ones with really unsatisfied dependencies.
111 std::vector<ModSpec> m_unsatisfied_mods;
113 // list of mods sorted such that they can be loaded in the
114 // given order with all dependencies being fullfilled. I.e.,
115 // every mod in this list has only dependencies on mods which
116 // appear earlier in the vector.
117 std::vector<ModSpec> m_sorted_mods;
119 // set of mod names for which an unresolved name conflict
120 // exists. A name conflict happens when two or more mods
121 // at the same level have the same name but different paths.
122 // Levels (mods in higher levels override mods in lower levels):
123 // 1. game mod in modpack; 2. game mod;
124 // 3. world mod in modpack; 4. world mod;
125 // 5. addon mod in modpack; 6. addon mod.
126 UNORDERED_SET<std::string> m_name_conflicts;
128 // Deleted default constructor
129 ModConfiguration() {}
133 class ServerModConfiguration: public ModConfiguration
136 ServerModConfiguration(const std::string &worldpath);
141 class ClientModConfiguration: public ModConfiguration
144 ClientModConfiguration(const std::string &path);
149 Json::Value getModstoreUrl(const std::string &url);
151 inline Json::Value getModstoreUrl(const std::string &url)
153 return Json::Value();
157 struct ModLicenseInfo {
159 std::string shortinfo;
163 struct ModAuthorInfo {
165 std::string username;
171 std::string basename;
172 ModAuthorInfo author;
177 struct ModStoreCategoryInfo {
182 struct ModStoreVersionEntry {
187 //ugly version number
191 struct ModStoreTitlePic {
194 std::string description;
198 struct ModStoreModDetails {
200 std::vector<ModStoreCategoryInfo> categories;
201 ModAuthorInfo author;
202 ModLicenseInfo license;
203 ModStoreTitlePic titlepic;
206 std::string basename;
207 std::string description;
208 std::string repository;
210 std::vector<std::string> depends;
211 std::vector<std::string> softdeps;
213 std::string download_url;
214 std::string screenshot_url;
215 std::vector<ModStoreVersionEntry> versions;
219 class ModMetadata: public Metadata
222 ModMetadata(const std::string &mod_name);
225 virtual void clear();
227 bool save(const std::string &root_path);
228 bool load(const std::string &root_path);
230 bool isModified() const { return m_modified; }
231 const std::string &getModName() const { return m_mod_name; }
233 virtual bool setString(const std::string &name, const std::string &var);
235 std::string m_mod_name;