fix: cleanup and suggested changes

Signed-off-by: Rachel Powers <508861+Ryex@users.noreply.github.com>

launcher/minecraft/mod/DataPack.cpp

@@ -30,9 +30,9 @@
 // Values taken from:
 // https://minecraft.fandom.com/wiki/Tutorials/Creating_a_data_pack#%22pack_format%22
 static const QMap<int, std::pair<Version, Version>> s_pack_format_versions = {
-    { 4, { Version("1.13"), Version("1.14.4") } }, { 5, { Version("1.15"), Version("1.16.1") } }, 
+    { 4, { Version("1.13"), Version("1.14.4") } },   { 5, { Version("1.15"), Version("1.16.1") } },
-    { 6, { Version("1.16.2"), Version("1.16.5") } }, { 7, { Version("1.17"), Version("1.17.1") } }, 
+    { 6, { Version("1.16.2"), Version("1.16.5") } }, { 7, { Version("1.17"), Version("1.17.1") } },
-    { 8, { Version("1.18"), Version("1.18.1") } }, { 9, { Version("1.18.2"), Version("1.18.2") } },
+    { 8, { Version("1.18"), Version("1.18.1") } },   { 9, { Version("1.18.2"), Version("1.18.2") } },
     { 10, { Version("1.19"), Version("1.19.3") } },
 };
 

launcher/minecraft/mod/DataPack.h

@@ -45,7 +45,7 @@ class DataPack : public Resource {
     /** Gets, respectively, the lower and upper versions supported by the set pack format. */
     [[nodiscard]] std::pair<Version, Version> compatibleVersions() const;
 
-    /** Gets the description of the resource pack. */
+    /** Gets the description of the data pack. */
     [[nodiscard]] QString description() const { return m_description; }
 
     /** Thread-safe. */
@@ -62,12 +62,12 @@ class DataPack : public Resource {
    protected:
     mutable QMutex m_data_lock;
 
-    /* The 'version' of a resource pack, as defined in the pack.mcmeta file.
+    /* The 'version' of a data pack, as defined in the pack.mcmeta file.
-     * See https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
+     * See https://minecraft.fandom.com/wiki/Data_pack#pack.mcmeta
      */
     int m_pack_format = 0;
 
-    /** The resource pack's description, as defined in the pack.mcmeta file.
+    /** The data pack's description, as defined in the pack.mcmeta file.
      */
     QString m_description;
 };

launcher/minecraft/mod/Mod.cpp

@@ -199,4 +199,4 @@ void Mod::finishResolvingWithDetails(ModDetails&& details)
 bool Mod::valid() const
 {
     return !m_local_details.mod_id.isEmpty();
-}
+}

launcher/minecraft/mod/ResourcePack.cpp

@@ -13,12 +13,11 @@
 // Values taken from:
 // https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
 static const QMap<int, std::pair<Version, Version>> s_pack_format_versions = {
-    { 1, { Version("1.6.1"), Version("1.8.9") } }, { 2, { Version("1.9"), Version("1.10.2") } },
+    { 1, { Version("1.6.1"), Version("1.8.9") } },    { 2, { Version("1.9"), Version("1.10.2") } },
-    { 3, { Version("1.11"), Version("1.12.2") } }, { 4, { Version("1.13"), Version("1.14.4") } },
+    { 3, { Version("1.11"), Version("1.12.2") } },    { 4, { Version("1.13"), Version("1.14.4") } },
-    { 5, { Version("1.15"), Version("1.16.1") } }, { 6, { Version("1.16.2"), Version("1.16.5") } },
+    { 5, { Version("1.15"), Version("1.16.1") } },    { 6, { Version("1.16.2"), Version("1.16.5") } },
-    { 7, { Version("1.17"), Version("1.17.1") } }, { 8, { Version("1.18"), Version("1.18.2") } },
+    { 7, { Version("1.17"), Version("1.17.1") } },    { 8, { Version("1.18"), Version("1.18.2") } },
-    { 9, { Version("1.19"), Version("1.19.2") } },
+    { 9, { Version("1.19"), Version("1.19.2") } },    { 11, { Version("22w42a"), Version("22w44a") } },
-    // { 11, { Version("22w42a"), Version("22w44a") } }
     { 12, { Version("1.19.3"), Version("1.19.3") } },
 };
 

launcher/minecraft/mod/ShaderPack.cpp

@@ -24,12 +24,10 @@
 
 #include "minecraft/mod/tasks/LocalShaderPackParseTask.h"
 
-
 void ShaderPack::setPackFormat(ShaderPackFormat new_format)
 {
     QMutexLocker locker(&m_data_lock);
 
-    
     m_pack_format = new_format;
 }
 

launcher/minecraft/mod/ShaderPack.h

@@ -24,31 +24,27 @@
 #include "Resource.h"
 
 /* Info:
- * Currently For Optifine / Iris shader packs, 
+ * Currently For Optifine / Iris shader packs,
- * could be expanded to support others should they exsist?
+ * could be expanded to support others should they exist?
  *
- * This class and enum are mostly here as placeholders for validating 
+ * This class and enum are mostly here as placeholders for validating
- * that a shaderpack exsists and is in the right format,
+ * that a shaderpack exists and is in the right format,
  * namely that they contain a folder named 'shaders'.
  *
- * In the technical sense it would be possible to parse files like `shaders/shaders.properties` 
+ * In the technical sense it would be possible to parse files like `shaders/shaders.properties`
- * to get information like the availble profiles but this is not all that usefull without more knoledge of the 
+ * to get information like the available profiles but this is not all that useful without more knowledge of the
- * shader mod used to be able to change settings
+ * shader mod used to be able to change settings.
- *
  */
 
 #include <QMutex>
 
-enum class ShaderPackFormat {
+enum class ShaderPackFormat { VALID, INVALID };
-	VALID,
-	INVALID
-};
 
 class ShaderPack : public Resource {
     Q_OBJECT
    public:
     using Ptr = shared_qobject_ptr<Resource>;
- 
+
     [[nodiscard]] ShaderPackFormat packFormat() const { return m_pack_format; }
 
     ShaderPack(QObject* parent = nullptr) : Resource(parent) {}
@@ -62,5 +58,5 @@ class ShaderPack : public Resource {
    protected:
     mutable QMutex m_data_lock;
 
-		ShaderPackFormat m_pack_format = ShaderPackFormat::INVALID;
+    ShaderPackFormat m_pack_format = ShaderPackFormat::INVALID;
 };

launcher/minecraft/mod/WorldSave.cpp

@@ -27,7 +27,6 @@ void WorldSave::setSaveFormat(WorldSaveFormat new_save_format)
 {
     QMutexLocker locker(&m_data_lock);
 
-    
     m_save_format = new_save_format;
 }
 
@@ -35,11 +34,10 @@ void WorldSave::setSaveDirName(QString dir_name)
 {
     QMutexLocker locker(&m_data_lock);
 
-    
     m_save_dir_name = dir_name;
 }
 
 bool WorldSave::valid() const
 {
-	return m_save_format != WorldSaveFormat::INVALID;
+    return m_save_format != WorldSaveFormat::INVALID;
-}
+}

launcher/minecraft/mod/WorldSave.h

@@ -27,11 +27,7 @@
 
 class Version;
 
-enum class WorldSaveFormat {
+enum class WorldSaveFormat { SINGLE, MULTI, INVALID };
-	SINGLE,
-	MULTI,
-	INVALID
-};
 
 class WorldSave : public Resource {
     Q_OBJECT
@@ -53,15 +49,13 @@ class WorldSave : public Resource {
 
     bool valid() const override;
 
-
    protected:
     mutable QMutex m_data_lock;
 
-    /* The 'version' of a resource pack, as defined in the pack.mcmeta file.
+    /** The format in which the save file is in.
-     * See https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
+     *  Since saves can be distributed in various slightly different ways, this allows us to treat them separately.
      */
     WorldSaveFormat m_save_format = WorldSaveFormat::INVALID;
 
-		QString m_save_dir_name;
+    QString m_save_dir_name;
-
 };

launcher/minecraft/mod/tasks/LocalDataPackParseTask.cpp

@@ -25,8 +25,8 @@
 #include "Json.h"
 
 #include <quazip/quazip.h>
-#include <quazip/quazipfile.h>
 #include <quazip/quazipdir.h>
+#include <quazip/quazipfile.h>
 
 #include <QCryptographicHash>
 
@@ -40,7 +40,7 @@ bool process(DataPack& pack, ProcessingLevel level)
         case ResourceType::ZIPFILE:
             return DataPackUtils::processZIP(pack, level);
         default:
-            qWarning() << "Invalid type for resource pack parse task!";
+            qWarning() << "Invalid type for data pack parse task!";
             return false;
     }
 }
@@ -49,11 +49,16 @@ bool processFolder(DataPack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::FOLDER);
 
+    auto mcmeta_invalid = [&pack]() {
+        qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
+        return false;  // the mcmeta is not optional
+    };
+
     QFileInfo mcmeta_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.mcmeta"));
     if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
         QFile mcmeta_file(mcmeta_file_info.filePath());
         if (!mcmeta_file.open(QIODevice::ReadOnly))
-            return false; // can't open mcmeta file
+            return mcmeta_invalid();  // can't open mcmeta file
 
         auto data = mcmeta_file.readAll();
 
@@ -61,22 +66,22 @@ bool processFolder(DataPack& pack, ProcessingLevel level)
 
         mcmeta_file.close();
         if (!mcmeta_result) {
-            return false; // mcmeta invalid
+            return mcmeta_invalid();  // mcmeta invalid
         }
     } else {
-        return false; // mcmeta file isn't a valid file
+        return mcmeta_invalid();  // mcmeta file isn't a valid file
     }
 
     QFileInfo data_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "data"));
     if (!data_dir_info.exists() || !data_dir_info.isDir()) {
-        return false; // data dir does not exists or isn't valid
+        return false;  // data dir does not exists or isn't valid
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
 
-    return true; // all tests passed
+    return true;  // all tests passed
 }
 
 bool processZIP(DataPack& pack, ProcessingLevel level)
@@ -85,15 +90,20 @@ bool processZIP(DataPack& pack, ProcessingLevel level)
 
     QuaZip zip(pack.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
-        return false; // can't open zip file
+        return false;  // can't open zip file
 
     QuaZipFile file(&zip);
 
+    auto mcmeta_invalid = [&pack]() {
+        qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
+        return false;  // the mcmeta is not optional
+    };
+
     if (zip.setCurrentFile("pack.mcmeta")) {
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return false;
+            return mcmeta_invalid();
         }
 
         auto data = file.readAll();
@@ -102,20 +112,20 @@ bool processZIP(DataPack& pack, ProcessingLevel level)
 
         file.close();
         if (!mcmeta_result) {
-            return false; // mcmeta invalid
+            return mcmeta_invalid();  // mcmeta invalid
         }
     } else {
-        return false; // could not set pack.mcmeta as current file.
+        return mcmeta_invalid();  // could not set pack.mcmeta as current file.
     }
 
     QuaZipDir zipDir(&zip);
     if (!zipDir.exists("/data")) {
-        return false; // data dir does not exists at zip root
+        return false;  // data dir does not exists at zip root
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
         zip.close();
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
 
     zip.close();
@@ -123,7 +133,7 @@ bool processZIP(DataPack& pack, ProcessingLevel level)
     return true;
 }
 
-// https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
+// https://minecraft.fandom.com/wiki/Data_pack#pack.mcmeta
 bool processMCMeta(DataPack& pack, QByteArray&& raw_data)
 {
     try {
@@ -147,9 +157,7 @@ bool validate(QFileInfo file)
 
 }  // namespace DataPackUtils
 
-LocalDataPackParseTask::LocalDataPackParseTask(int token, DataPack& dp)
+LocalDataPackParseTask::LocalDataPackParseTask(int token, DataPack& dp) : Task(nullptr, false), m_token(token), m_data_pack(dp) {}
-    : Task(nullptr, false), m_token(token), m_resource_pack(dp)
-{}
 
 bool LocalDataPackParseTask::abort()
 {
@@ -159,7 +167,7 @@ bool LocalDataPackParseTask::abort()
 
 void LocalDataPackParseTask::executeTask()
 {
-    if (!DataPackUtils::process(m_resource_pack))
+    if (!DataPackUtils::process(m_data_pack))
         return;
 
     if (m_aborted)

launcher/minecraft/mod/tasks/LocalDataPackParseTask.h

@@ -59,7 +59,7 @@ class LocalDataPackParseTask : public Task {
    private:
     int m_token;
 
-    DataPack& m_resource_pack;
+    DataPack& m_data_pack;
 
     bool m_aborted = false;
 };

launcher/minecraft/mod/tasks/LocalModParseTask.cpp

@@ -284,7 +284,8 @@ ModDetails ReadLiteModInfo(QByteArray contents)
     return details;
 }
 
-bool process(Mod& mod, ProcessingLevel level) {
+bool process(Mod& mod, ProcessingLevel level)
+{
     switch (mod.type()) {
         case ResourceType::FOLDER:
             return processFolder(mod, level);
@@ -293,13 +294,13 @@ bool process(Mod& mod, ProcessingLevel level) {
         case ResourceType::LITEMOD:
             return processLitemod(mod);
         default:
-            qWarning() << "Invalid type for resource pack parse task!";
+            qWarning() << "Invalid type for mod parse task!";
             return false;
     }
 }
 
-bool processZIP(Mod& mod, ProcessingLevel level) {
+bool processZIP(Mod& mod, ProcessingLevel level)
-
+{
     ModDetails details;
 
     QuaZip zip(mod.fileinfo().filePath());
@@ -316,7 +317,7 @@ bool processZIP(Mod& mod, ProcessingLevel level) {
 
         details = ReadMCModTOML(file.readAll());
         file.close();
-        
+
         // to replace ${file.jarVersion} with the actual version, as needed
         if (details.version == "${file.jarVersion}") {
             if (zip.setCurrentFile("META-INF/MANIFEST.MF")) {
@@ -347,7 +348,6 @@ bool processZIP(Mod& mod, ProcessingLevel level) {
             }
         }
 
-
         zip.close();
         mod.setDetails(details);
 
@@ -403,11 +403,11 @@ bool processZIP(Mod& mod, ProcessingLevel level) {
     }
 
     zip.close();
-    return false; // no valid mod found in archive
+    return false;  // no valid mod found in archive
 }
 
-bool processFolder(Mod& mod, ProcessingLevel level) {
+bool processFolder(Mod& mod, ProcessingLevel level)
-
+{
     ModDetails details;
 
     QFileInfo mcmod_info(FS::PathCombine(mod.fileinfo().filePath(), "mcmod.info"));
@@ -424,13 +424,13 @@ bool processFolder(Mod& mod, ProcessingLevel level) {
         return true;
     }
 
-    return false; // no valid mcmod.info file found
+    return false;  // no valid mcmod.info file found
 }
 
-bool processLitemod(Mod& mod, ProcessingLevel level) {
+bool processLitemod(Mod& mod, ProcessingLevel level)
-    
+{
     ModDetails details;
-    
+
     QuaZip zip(mod.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
         return false;
@@ -451,24 +451,22 @@ bool processLitemod(Mod& mod, ProcessingLevel level) {
     }
     zip.close();
 
-    return false; // no valid litemod.json found in archive
+    return false;  // no valid litemod.json found in archive
 }
 
 /** Checks whether a file is valid as a mod or not. */
-bool validate(QFileInfo file) {
+bool validate(QFileInfo file)
-    
+{
     Mod mod{ file };
     return ModUtils::process(mod, ProcessingLevel::BasicInfoOnly) && mod.valid();
 }
 
 }  // namespace ModUtils
 
-
 LocalModParseTask::LocalModParseTask(int token, ResourceType type, const QFileInfo& modFile)
     : Task(nullptr, false), m_token(token), m_type(type), m_modFile(modFile), m_result(new Result())
 {}
 
-
 bool LocalModParseTask::abort()
 {
     m_aborted.store(true);
@@ -476,7 +474,7 @@ bool LocalModParseTask::abort()
 }
 
 void LocalModParseTask::executeTask()
-{   
+{
     Mod mod{ m_modFile };
     ModUtils::process(mod, ModUtils::ProcessingLevel::Full);
 

launcher/minecraft/mod/tasks/LocalModParseTask.h

@@ -27,32 +27,29 @@ bool processLitemod(Mod& mod, ProcessingLevel level = ProcessingLevel::Full);
 bool validate(QFileInfo file);
 }  // namespace ModUtils
 
-class LocalModParseTask : public Task
+class LocalModParseTask : public Task {
-{
     Q_OBJECT
-public:
+   public:
     struct Result {
         ModDetails details;
     };
     using ResultPtr = std::shared_ptr<Result>;
-    ResultPtr result() const {
+    ResultPtr result() const { return m_result; }
-        return m_result;
-    }
 
     [[nodiscard]] bool canAbort() const override { return true; }
     bool abort() override;
 
-    LocalModParseTask(int token, ResourceType type, const QFileInfo & modFile);
+    LocalModParseTask(int token, ResourceType type, const QFileInfo& modFile);
     void executeTask() override;
 
     [[nodiscard]] int token() const { return m_token; }
 
-private:
+   private:
     void processAsZip();
     void processAsFolder();
     void processAsLitemod();
 
-private:
+   private:
     int m_token;
     ResourceType m_type;
     QFileInfo m_modFile;

launcher/minecraft/mod/tasks/LocalResourcePackParseTask.cpp

@@ -22,8 +22,8 @@
 #include "Json.h"
 
 #include <quazip/quazip.h>
-#include <quazip/quazipfile.h>
 #include <quazip/quazipdir.h>
+#include <quazip/quazipfile.h>
 
 #include <QCryptographicHash>
 
@@ -46,11 +46,16 @@ bool processFolder(ResourcePack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::FOLDER);
 
+    auto mcmeta_invalid = [&pack]() {
+        qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
+        return false;  // the mcmeta is not optional
+    };
+
     QFileInfo mcmeta_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.mcmeta"));
     if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
         QFile mcmeta_file(mcmeta_file_info.filePath());
         if (!mcmeta_file.open(QIODevice::ReadOnly))
-            return false; // can't open mcmeta file
+            return mcmeta_invalid();  // can't open mcmeta file
 
         auto data = mcmeta_file.readAll();
 
@@ -58,26 +63,31 @@ bool processFolder(ResourcePack& pack, ProcessingLevel level)
 
         mcmeta_file.close();
         if (!mcmeta_result) {
-            return false; // mcmeta invalid
+            return mcmeta_invalid();  // mcmeta invalid
         }
     } else {
-        return false; // mcmeta file isn't a valid file
+        return mcmeta_invalid();  // mcmeta file isn't a valid file
     }
 
     QFileInfo assets_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "assets"));
     if (!assets_dir_info.exists() || !assets_dir_info.isDir()) {
-        return false; // assets dir does not exists or isn't valid
+        return false;  // assets dir does not exists or isn't valid
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
-        
+
+    auto png_invalid = [&pack]() {
+        qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.png";
+        return true;  // the png is optional
+    };
+
     QFileInfo image_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.png"));
     if (image_file_info.exists() && image_file_info.isFile()) {
         QFile pack_png_file(image_file_info.filePath());
         if (!pack_png_file.open(QIODevice::ReadOnly))
-            return false; // can't open pack.png file
+            return png_invalid();  // can't open pack.png file
 
         auto data = pack_png_file.readAll();
 
@@ -85,13 +95,13 @@ bool processFolder(ResourcePack& pack, ProcessingLevel level)
 
         pack_png_file.close();
         if (!pack_png_result) {
-            return false; // pack.png invalid
+            return png_invalid();  // pack.png invalid
         }
     } else {
-        return false; // pack.png does not exists or is not a valid file.
+        return png_invalid();  // pack.png does not exists or is not a valid file.
     }
 
-    return true; // all tests passed
+    return true;  // all tests passed
 }
 
 bool processZIP(ResourcePack& pack, ProcessingLevel level)
@@ -100,15 +110,20 @@ bool processZIP(ResourcePack& pack, ProcessingLevel level)
 
     QuaZip zip(pack.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
-        return false; // can't open zip file
+        return false;  // can't open zip file
 
     QuaZipFile file(&zip);
 
+    auto mcmeta_invalid = [&pack]() {
+        qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
+        return false;  // the mcmeta is not optional
+    };
+
     if (zip.setCurrentFile("pack.mcmeta")) {
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return false;
+            return mcmeta_invalid();
         }
 
         auto data = file.readAll();
@@ -117,27 +132,32 @@ bool processZIP(ResourcePack& pack, ProcessingLevel level)
 
         file.close();
         if (!mcmeta_result) {
-            return false; // mcmeta invalid
+            return mcmeta_invalid();  // mcmeta invalid
         }
     } else {
-        return false; // could not set pack.mcmeta as current file.
+        return mcmeta_invalid();  // could not set pack.mcmeta as current file.
     }
 
     QuaZipDir zipDir(&zip);
     if (!zipDir.exists("/assets")) {
-        return false; // assets dir does not exists at zip root
+        return false;  // assets dir does not exists at zip root
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
         zip.close();
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
 
+    auto png_invalid = [&pack]() {
+        qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.png";
+        return true;  // the png is optional
+    };
+
     if (zip.setCurrentFile("pack.png")) {
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return false;
+            return png_invalid();
         }
 
         auto data = file.readAll();
@@ -146,10 +166,10 @@ bool processZIP(ResourcePack& pack, ProcessingLevel level)
 
         file.close();
         if (!pack_png_result) {
-            return false; // pack.png invalid
+            return png_invalid();  // pack.png invalid
         }
     } else {
-        return false; // could not set pack.mcmeta as current file.
+        return png_invalid();  // could not set pack.mcmeta as current file.
     }
 
     zip.close();

launcher/minecraft/mod/tasks/LocalShaderPackParseTask.cpp

@@ -24,8 +24,8 @@
 #include "FileSystem.h"
 
 #include <quazip/quazip.h>
-#include <quazip/quazipfile.h>
 #include <quazip/quazipdir.h>
+#include <quazip/quazipfile.h>
 
 namespace ShaderPackUtils {
 
@@ -45,18 +45,18 @@ bool process(ShaderPack& pack, ProcessingLevel level)
 bool processFolder(ShaderPack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::FOLDER);
- 
+
     QFileInfo shaders_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "shaders"));
     if (!shaders_dir_info.exists() || !shaders_dir_info.isDir()) {
-        return false; // assets dir does not exists or isn't valid
+        return false;  // assets dir does not exists or isn't valid
     }
     pack.setPackFormat(ShaderPackFormat::VALID);
 
     if (level == ProcessingLevel::BasicInfoOnly) {
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
-      
+
-    return true; // all tests passed
+    return true;  // all tests passed
 }
 
 bool processZIP(ShaderPack& pack, ProcessingLevel level)
@@ -65,19 +65,19 @@ bool processZIP(ShaderPack& pack, ProcessingLevel level)
 
     QuaZip zip(pack.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
-        return false; // can't open zip file
+        return false;  // can't open zip file
 
     QuaZipFile file(&zip);
 
     QuaZipDir zipDir(&zip);
     if (!zipDir.exists("/shaders")) {
-        return false; // assets dir does not exists at zip root
+        return false;  // assets dir does not exists at zip root
     }
     pack.setPackFormat(ShaderPackFormat::VALID);
 
     if (level == ProcessingLevel::BasicInfoOnly) {
         zip.close();
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
 
     zip.close();
@@ -85,7 +85,6 @@ bool processZIP(ShaderPack& pack, ProcessingLevel level)
     return true;
 }
 
-
 bool validate(QFileInfo file)
 {
     ShaderPack sp{ file };
@@ -94,9 +93,7 @@ bool validate(QFileInfo file)
 
 }  // namespace ShaderPackUtils
 
-LocalShaderPackParseTask::LocalShaderPackParseTask(int token, ShaderPack& sp)
+LocalShaderPackParseTask::LocalShaderPackParseTask(int token, ShaderPack& sp) : Task(nullptr, false), m_token(token), m_shader_pack(sp) {}
-    : Task(nullptr, false), m_token(token), m_shader_pack(sp)
-{}
 
 bool LocalShaderPackParseTask::abort()
 {

launcher/minecraft/mod/tasks/LocalShaderPackParseTask.h

@@ -19,7 +19,6 @@
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-
 #pragma once
 
 #include <QDebug>
@@ -38,7 +37,7 @@ bool process(ShaderPack& pack, ProcessingLevel level = ProcessingLevel::Full);
 bool processZIP(ShaderPack& pack, ProcessingLevel level = ProcessingLevel::Full);
 bool processFolder(ShaderPack& pack, ProcessingLevel level = ProcessingLevel::Full);
 
-/** Checks whether a file is valid as a resource pack or not. */
+/** Checks whether a file is valid as a shader pack or not. */
 bool validate(QFileInfo file);
 }  // namespace ShaderPackUtils
 

launcher/minecraft/mod/tasks/LocalWorldSaveParseTask.cpp

@@ -24,12 +24,12 @@
 
 #include "FileSystem.h"
 
-#include <qdir.h>
-#include <qfileinfo.h>
 #include <quazip/quazip.h>
-#include <quazip/quazipfile.h>
 #include <quazip/quazipdir.h>
-#include <utility>
+#include <quazip/quazipfile.h>
+
+#include <QDir>
+#include <QFileInfo>
 
 namespace WorldSaveUtils {
 
@@ -41,15 +41,22 @@ bool process(WorldSave& pack, ProcessingLevel level)
         case ResourceType::ZIPFILE:
             return WorldSaveUtils::processZIP(pack, level);
         default:
-            qWarning() << "Invalid type for shader pack parse task!";
+            qWarning() << "Invalid type for world save parse task!";
             return false;
     }
 }
 
-
+/// @brief checks a folder structure to see if it contains a level.dat
+/// @param dir the path to check
+/// @param saves used in recursive call if a "saves" dir was found
+/// @return std::tuple of (
+///             bool <found level.dat>, 
+///             QString <name of folder containing level.dat>, 
+///             bool <saves folder found>
+///         )
 static std::tuple<bool, QString, bool> contains_level_dat(QDir dir, bool saves = false)
 {
-    for(auto const& entry : dir.entryInfoList()) {
+    for (auto const& entry : dir.entryInfoList()) {
         if (!entry.isDir()) {
             continue;
         }
@@ -64,12 +71,11 @@ static std::tuple<bool, QString, bool> contains_level_dat(QDir dir, bool saves =
     return std::make_tuple(false, "", saves);
 }
 
-
 bool processFolder(WorldSave& save, ProcessingLevel level)
 {
     Q_ASSERT(save.type() == ResourceType::FOLDER);
 
-		auto [ found, save_dir_name, found_saves_dir ] = contains_level_dat(QDir(save.fileinfo().filePath()));
+    auto [found, save_dir_name, found_saves_dir] = contains_level_dat(QDir(save.fileinfo().filePath()));
 
     if (!found) {
         return false;
@@ -84,14 +90,21 @@ bool processFolder(WorldSave& save, ProcessingLevel level)
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
 
-    // resurved for more intensive processing
+    // reserved for more intensive processing
-      
+
-    return true; // all tests passed
+    return true;  // all tests passed
 }
 
+/// @brief checks a folder structure to see if it contains a level.dat
+/// @param zip the zip file to check
+/// @return std::tuple of (
+///             bool <found level.dat>, 
+///             QString <name of folder containing level.dat>, 
+///             bool <saves folder found>
+///         )
 static std::tuple<bool, QString, bool> contains_level_dat(QuaZip& zip)
 {
     bool saves = false;
@@ -100,7 +113,7 @@ static std::tuple<bool, QString, bool> contains_level_dat(QuaZip& zip)
         saves = true;
         zipDir.cd("/saves");
     }
-    
+
     for (auto const& entry : zipDir.entryList()) {
         zipDir.cd(entry);
         if (zipDir.exists("level.dat")) {
@@ -117,14 +130,14 @@ bool processZIP(WorldSave& save, ProcessingLevel level)
 
     QuaZip zip(save.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
-        return false; // can't open zip file
+        return false;  // can't open zip file
 
-    auto [ found, save_dir_name, found_saves_dir ] = contains_level_dat(zip);
+    auto [found, save_dir_name, found_saves_dir] = contains_level_dat(zip);
 
     if (save_dir_name.endsWith("/")) {
         save_dir_name.chop(1);
     }
-    
+
     if (!found) {
         return false;
     }
@@ -139,17 +152,16 @@ bool processZIP(WorldSave& save, ProcessingLevel level)
 
     if (level == ProcessingLevel::BasicInfoOnly) {
         zip.close();
-        return true; // only need basic info already checked
+        return true;  // only need basic info already checked
     }
 
-    // resurved for more intensive processing
+    // reserved for more intensive processing
 
     zip.close();
 
     return true;
 }
 
-
 bool validate(QFileInfo file)
 {
     WorldSave sp{ file };
@@ -158,9 +170,7 @@ bool validate(QFileInfo file)
 
 }  // namespace WorldSaveUtils
 
-LocalWorldSaveParseTask::LocalWorldSaveParseTask(int token, WorldSave& save)
+LocalWorldSaveParseTask::LocalWorldSaveParseTask(int token, WorldSave& save) : Task(nullptr, false), m_token(token), m_save(save) {}
-    : Task(nullptr, false), m_token(token), m_save(save)
-{}
 
 bool LocalWorldSaveParseTask::abort()
 {

launcher/minecraft/mod/tasks/LocalWorldSaveParseTask.h

@@ -59,4 +59,4 @@ class LocalWorldSaveParseTask : public Task {
     WorldSave& m_save;
 
     bool m_aborted = false;
-};
+};

launcher/modplatform/flame/FlameInstanceCreationTask.cpp

@@ -53,15 +53,16 @@
 #include "ui/dialogs/BlockedModsDialog.h"
 #include "ui/dialogs/CustomMessageBox.h"
 
-#include <minecraft/mod/tasks/LocalResourcePackParseTask.h>
+#include <QDebug>
-#include <minecraft/mod/tasks/LocalTexturePackParseTask.h>
+#include <QFileInfo>
-#include <minecraft/mod/tasks/LocalDataPackParseTask.h>
+
-#include <minecraft/mod/tasks/LocalModParseTask.h>
+#include "minecraft/World.h"
-#include <minecraft/mod/tasks/LocalWorldSaveParseTask.h>
+#include "minecraft/mod/tasks/LocalDataPackParseTask.h"
-#include <minecraft/mod/tasks/LocalShaderPackParseTask.h>
+#include "minecraft/mod/tasks/LocalModParseTask.h"
-#include <minecraft/World.h>
+#include "minecraft/mod/tasks/LocalResourcePackParseTask.h"
-#include <qdebug.h>
+#include "minecraft/mod/tasks/LocalShaderPackParseTask.h"
-#include <qfileinfo.h>
+#include "minecraft/mod/tasks/LocalTexturePackParseTask.h"
+#include "minecraft/mod/tasks/LocalWorldSaveParseTask.h"
 
 const static QMap<QString, QString> forgemap = { { "1.2.5", "3.4.9.171" },
                                                  { "1.4.2", "6.0.1.355" },
@@ -411,8 +412,7 @@ void FlameCreationTask::idResolverSucceeded(QEventLoop& loop)
     QList<BlockedMod> blocked_mods;
     auto anyBlocked = false;
     for (const auto& result : results.files.values()) {
-
+        if (result.fileName.endsWith(".zip")) {
-        if(result.fileName.endsWith(".zip")) {
             m_ZIP_resources.append(std::make_pair(result.fileName, result.targetFolder));
         }
 
@@ -454,7 +454,6 @@ void FlameCreationTask::idResolverSucceeded(QEventLoop& loop)
     }
 }
 
-
 void FlameCreationTask::setupDownloadJob(QEventLoop& loop)
 {
     m_files_job = new NetJob(tr("Mod download"), APPLICATION->network());
@@ -493,8 +492,8 @@ void FlameCreationTask::setupDownloadJob(QEventLoop& loop)
     }
 
     m_mod_id_resolver.reset();
-    connect(m_files_job.get(), &NetJob::succeeded, this, [&]() { 
+    connect(m_files_job.get(), &NetJob::succeeded, this, [&]() {
-        m_files_job.reset(); 
+        m_files_job.reset();
         validateZIPResouces();
     });
     connect(m_files_job.get(), &NetJob::failed, [&](QString reason) {
@@ -543,26 +542,26 @@ void FlameCreationTask::copyBlockedMods(QList<BlockedMod> const& blocked_mods)
 bool moveFile(QString src, QString dst)
 {
     if (!FS::copy(src, dst)()) {  // copy
-        qDebug() << "Copy of" << src << "to" << dst << "Failed!";
+        qDebug() << "Copy of" << src << "to" << dst << "failed!";
         return false;
     } else {
         if (!FS::deletePath(src)) {  // remove original
-            qDebug() << "Deleation of" << src << "Failed!";
+            qDebug() << "Deletion of" << src << "failed!";
             return false;
         };
     }
     return true;
 }
 
-
 void FlameCreationTask::validateZIPResouces()
 {
-    qDebug() << "Validating resoucres stored as .zip are in the right place";
+    qDebug() << "Validating whether resources stored as .zip are in the right place";
     for (auto [fileName, targetFolder] : m_ZIP_resources) {
-
         qDebug() << "Checking" << fileName << "...";
         auto localPath = FS::PathCombine(m_stagingPath, "minecraft", targetFolder, fileName);
 
+        /// @brief check the target and move the the file
+        /// @return path where file can now be found
         auto validatePath = [&localPath, this](QString fileName, QString targetFolder, QString realTarget) {
             if (targetFolder != realTarget) {
                 qDebug() << "Target folder of" << fileName << "is incorrect, it belongs in" << realTarget;
@@ -589,7 +588,7 @@ void FlameCreationTask::validateZIPResouces()
             } else if (ModUtils::validate(localFileInfo)) {
                 qDebug() << fileName << "is a mod";
                 validatePath(fileName, targetFolder, "mods");
-            } else  if (WorldSaveUtils::validate(localFileInfo)) {
+            } else if (WorldSaveUtils::validate(localFileInfo)) {
                 qDebug() << fileName << "is a world save";
                 QString worldPath = validatePath(fileName, targetFolder, "saves");
 
@@ -600,7 +599,7 @@ void FlameCreationTask::validateZIPResouces()
                     qDebug() << "World at" << worldPath << "is not valid, skipping install.";
                 } else {
                     w.install(FS::PathCombine(m_stagingPath, "minecraft", "saves"));
-                } 
+                }
             } else if (ShaderPackUtils::validate(localFileInfo)) {
                 // in theroy flame API can't do this but who knows, that *may* change ?
                 // better to handle it if it *does* occure in the future
@@ -610,7 +609,7 @@ void FlameCreationTask::validateZIPResouces()
                 qDebug() << "Can't Identify" << fileName << "at" << localPath << ", leaving it where it is.";
             }
         } else {
-            qDebug() << "Can't find" << localPath << "to validate it, ignoreing";
+            qDebug() << "Can't find" << localPath << "to validate it, ignoring";
         }
     }
 }

tests/ResourcePackParse_test.cpp

@@ -67,7 +67,7 @@ class ResourcePackParseTest : public QObject {
 
         QVERIFY(pack.packFormat() == 6);
         QVERIFY(pack.description() == "o quartel pegou fogo, policia deu sinal, acode acode acode a bandeira nacional");
-        QVERIFY(valid == false);
+        QVERIFY(valid == false); // no assets dir
     }
 };