ReScrap
/
ScrapModLoader
mirror of https://github.com/Strongleong/ScrapModLoader.git
2
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from Grumgog/refactor-Scrap-mod 

(refactor): ScrapMod class code refactoring
This commit is contained in:
Strongleong 2022-02-15 21:43:52 +11:00 committed by GitHub
parent 9deb717eea 90764c8636
commit 75333e8f68
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 115 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ScrapModLoader/ModsLauncher.cs
View File

@ -32,7 +32,7 @@ namespace ScrapModLoader
{ {
String[] files = Directory.GetFiles(folder, "*.sm", SearchOption.AllDirectories); String[] files = Directory.GetFiles(folder, "*.sm", SearchOption.AllDirectories);
foreach (String file in files) foreach (String file in files)
Mods.Add(new ScrapMod(file)); Mods.Add(ScrapMod.LoadFromFile(file));
} }
} }
} }
@ -96,9 +96,9 @@ namespace ScrapModLoader
if (mod.Checked) if (mod.Checked)
if (!mod.IsEnabled(gamePath)) if (!mod.IsEnabled(gamePath))
mod.Enable(gamePath, SelectedGameVersion); mod.Enable(gamePath, SelectedGameVersion);
else else
if (mod.IsEnabled(gamePath)) if (mod.IsEnabled(gamePath))
mod.Disable(gamePath); mod.Disable(gamePath);
} }
} }
} }

151
ScrapModLoader/ScrapMod.cs
View File

@ -2,7 +2,6 @@
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using System.Windows.Media.Imaging; using System.Windows.Media.Imaging;
using System.Xml;
using Ionic.Zip; using Ionic.Zip;
@ -12,41 +11,33 @@ namespace ScrapModLoader
{ {
public class ScrapMod public class ScrapMod
{ {
public String Name { get; private set; } public String Name { get; private set; } = String.Empty;
public String Description { get; private set; }
public String ModPath { get; private set; }
public BitmapImage Icon { get; private set; }
public Boolean Checked { get; set; }
public String Category { get; private set; }
public String Version { get; private set; }
public String RequiredLauncher { get; private set; }
public List<String> SupportedGameVersions { get; private set; }
public String SupportedGameVersionsDisplay {
get
{
String result = String.Empty;
foreach (String version in SupportedGameVersions)
result += version + ", ";
return result.TrimEnd(',', ' ');
}
}
public List<String> Authors { get; private set; }
public Dictionary<String, List<String>> Credits { get; private set; }
public ScrapMod(String path) public String Description { get; private set; } = String.Empty;
public String ModPath { get; private set; } = String.Empty;
public BitmapImage Icon { get; private set; } = new BitmapImage();
public Boolean Checked { get; set; } = false;
public String Category { get; private set; } = String.Empty;
public String Version { get; private set; } = String.Empty;
public String RequiredLauncher { get; private set; } = String.Empty;
public List<String> SupportedGameVersions { get; private set; } = new List<String>();
public String SupportedGameVersionsDisplay => String.Join(", ", SupportedGameVersions);
public List<String> Authors { get; private set; } = new List<String>();
public Dictionary<String, List<String>> Credits { get; private set; } = new Dictionary<String, List<String>>();
private ScrapMod()
{ {
ModPath = path;
Name = String.Empty;
Description = String.Empty;
Icon = new BitmapImage();
Checked = false;
Category = String.Empty;
Version = String.Empty;
RequiredLauncher = String.Empty;
SupportedGameVersions = new List<String>();
Authors = new List<String>();
Credits = new Dictionary<String, List<String>>();
LoadFromFile(path);
} }
@ -108,71 +99,55 @@ namespace ScrapModLoader
} }
} }
private void LoadFromFile(String path) public static ScrapMod LoadFromFile(String path)
{ {
using (ZipFile zipFile = ZipFile.Read(path)) using ZipFile zipFile = ZipFile.Read(path);
Byte[] iconBuffer = Utils.ExtractFromZip(zipFile, "icon.png");
Byte[] confBuffer = Utils.ExtractFromZip(zipFile, "config.toml");
ScrapMod mod = new ScrapMod()
{ {
Byte[] iconBuffer = ExtractFromZip(zipFile, "icon.png"); ModPath = path,
Byte[] confBuffer = ExtractFromZip(zipFile, "config.toml"); Icon = Utils.LoadImage(iconBuffer)
LoadIcon(iconBuffer); };
LoadConfig(confBuffer);
} LoadConfig(mod, confBuffer);
return mod;
} }
private Byte[] ExtractFromZip(ZipFile zip, String entry_path)
private static void LoadConfig(ScrapMod mod, Byte[] buffer)
{ {
ZipEntry? entry = zip[entry_path]; using MemoryStream sourceStream = new MemoryStream(buffer);
if (entry == null) using StreamReader reader = new StreamReader(sourceStream);
throw new FileFormatException($"No '{entry_path}' in {Name} found");
Byte[] buffer = new Byte[entry.UncompressedSize]; TomlTable config = TOML.Parse(reader);
using (MemoryStream zipStream = new MemoryStream(buffer))
entry.Extract(zipStream);
return buffer; CheckConfig(config);
}
private void LoadIcon(Byte[] buffer) mod.Name = config["title"];
{ mod.Description = config["description"];
using (MemoryStream sourceStream = new MemoryStream(buffer)) mod.Category = config["category"];
mod.Version = config["version"];
mod.RequiredLauncher = config["requiredLauncher"];
foreach (TomlNode version in config["supportedGameVersions"])
mod.SupportedGameVersions.Add(version);
foreach (TomlNode author in config["authors"])
mod.Authors.Add(author["name"]);
foreach (TomlNode credit in config["credits"])
{ {
Icon.BeginInit(); List<String> entries = new List<String>();
Icon.CacheOption = BitmapCacheOption.OnLoad;
Icon.StreamSource = sourceStream;
Icon.EndInit();
}
}
private void LoadConfig(Byte[] buffer) foreach (TomlNode entry in credit["credits"])
{ entries.Add(entry["name"]);
using (MemoryStream sourceStream = new MemoryStream(buffer))
using (StreamReader reader = new StreamReader(sourceStream))
{
TomlTable config = TOML.Parse(reader);
CheckConfig(config); mod.Credits.Add(credit["group"], entries);
Name = config["title"];
Description = config["description"];
Category = config["category"];
Version = config["version"];
RequiredLauncher = config["requiredLauncher"];
foreach (TomlNode version in config["supportedGameVersions"])
SupportedGameVersions.Add(version);
foreach (TomlNode author in config["authors"])
Authors.Add(author["name"]);
foreach (TomlNode credit in config["credits"])
{
List<String> entries = new List<String>();
foreach (TomlNode entry in credit["credits"])
entries.Add(entry["name"]);
Credits.Add(credit["group"], entries);
}
} }
} }

64
ScrapModLoader/Utils.cs
View File

@ -1,27 +1,59 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Collections.Specialized; using System.Collections.Specialized;
using System.IO;
using System.Windows.Media.Imaging;
namespace ScrapModLoader using Ionic.Zip;
namespace ScrapModLoader;
internal static class Utils
{ {
internal static class Utils public static String GetFolderDialog()
{ {
public static String GetFolderDialog() using System.Windows.Forms.FolderBrowserDialog? dialog = new System.Windows.Forms.FolderBrowserDialog();
{ System.Windows.Forms.DialogResult result = dialog.ShowDialog();
using System.Windows.Forms.FolderBrowserDialog? dialog = new System.Windows.Forms.FolderBrowserDialog(); return dialog.SelectedPath;
System.Windows.Forms.DialogResult result = dialog.ShowDialog(); }
return dialog.SelectedPath;
}
public static List<String> StringCollectionToList(StringCollection collection) public static List<String> StringCollectionToList(StringCollection collection)
{
List<String> list = new List<String>();
foreach (String? item in collection)
{ {
List<String> list = new List<String>(); if (item != null)
foreach (String? item in collection) list.Add(item);
{
if (item != null)
list.Add(item);
}
return list;
} }
return list;
}
public static Byte[] ExtractFromZip(ZipFile zip, String entry_path)
{
ZipEntry? entry = zip[entry_path];
if (entry == null)
throw new FileFormatException($"No '{entry_path}' in {zip.Name} found");
Byte[] buffer = new Byte[entry.UncompressedSize];
using (MemoryStream zipStream = new MemoryStream(buffer))
entry.Extract(zipStream);
return buffer;
}
public static BitmapImage LoadImage(Byte[] buffer)
{
using MemoryStream sourceStream = new MemoryStream(buffer);
BitmapImage? image = new BitmapImage();
image.BeginInit();
image.CacheOption = BitmapCacheOption.OnLoad;
image.StreamSource = sourceStream;
image.EndInit();
return image;
} }
} }