Skip to content

Depends/DependsVersions attributes #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rosalie241 wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Depends/DependsVersions attributes #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fc3feb9
ModAPI.Common: add Version to ModConfiguration
Rosalie241 Jan 31, 2026
c6b4d93
Spore ModAPI Easy Installer: parse version attribute
Rosalie241 Jan 31, 2026
a3eb4f9
Spore ModAPI Easy Uninstaller: add mod version to UninstallerForm
Rosalie241 Jan 31, 2026
42197f8
ModAPI.Common: add Dependencies and DependenciesVersions to ModConfig…
Rosalie241 Jan 31, 2026
4c07ded
Spore ModAPI Easy Installer: add support for depends/dependsVersions …
Rosalie241 Jan 31, 2026
2e17074
Spore ModAPI Easy Uninstaller: add support for depends/dependsVersion…
Rosalie241 Jan 31, 2026
7295fea
Spore ModAPI Easy Installer: lock version/depends/dependsVersions beh…
Rosalie241 Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions ModAPI.Common/InstalledMods.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
using System.Collections.Generic;

using System.IO;
using System.Linq;
using System.Xml;

namespace ModAPI.Common
Expand Down Expand Up @@ -52,8 +53,11 @@ public class ModConfiguration : IEquatable<ModConfiguration>

public string Name;
public string Unique;
public Version Version;
public string DisplayName;
public string ConfiguratorPath;
public string[] Dependencies;
public Version[] DependenciesVersions;
public List<InstalledFile> InstalledFiles = new List<InstalledFile>();

public ModConfiguration(string name, string unique)
Expand Down Expand Up @@ -98,6 +102,27 @@ public void Save(XmlDocument document, XmlElement parent)
element.Attributes.Append(uniqueAttribute);
//}

if (Version != null)
{
var versionAttribute = document.CreateAttribute("version");
versionAttribute.Value = Version.ToString();
element.Attributes.Append(versionAttribute);
}

if (Dependencies != null && Dependencies.Length > 0)
{
var dependenciesAttribute = document.CreateAttribute("dependencies");
dependenciesAttribute.Value = String.Join("?", Dependencies);
element.Attributes.Append(dependenciesAttribute);
}

if (DependenciesVersions != null && DependenciesVersions.Length > 0)
{
var dependenciesVersionsAttribute = document.CreateAttribute("dependenciesVersions");
dependenciesVersionsAttribute.Value = String.Join("?", DependenciesVersions.Select(x => x.ToString()));
element.Attributes.Append(dependenciesVersionsAttribute);
}

if (this.ConfiguratorPath != null)
{
attribute = document.CreateAttribute("configurator");
Expand Down Expand Up @@ -132,6 +157,46 @@ public void Load(XmlNode node)
else
Unique = nameAttribute.Value;

var versionAttribute = node.Attributes.GetNamedItem("version");
if (versionAttribute != null &&
Version.TryParse(versionAttribute.Value, out Version parsedVersion))
{
Version = parsedVersion;
}
else
{
Version = null;
}

var dependenciesAttribute = node.Attributes.GetNamedItem("dependencies");
if (dependenciesAttribute != null)
{
Dependencies = dependenciesAttribute.Value.Split('?');
}

var dependenciesVersionsAttribute = node.Attributes.GetNamedItem("dependenciesVersions");
if (dependenciesVersionsAttribute != null)
{
List<Version> versions = new List<Version>();
foreach (string version in dependenciesVersionsAttribute.Value.Split('?'))
{
if (Version.TryParse(version, out Version parsedDependencyVersion))
{
versions.Add(parsedDependencyVersion);
}
else
{
versions.Clear();
break;
}
}

if (versions.Count() != 0)
{
DependenciesVersions = versions.ToArray();
}
}

var displayNameAttribute = node.Attributes.GetNamedItem("displayName");
if (displayNameAttribute != null)
this.DisplayName = displayNameAttribute.Value;
Expand Down
112 changes: 109 additions & 3 deletions Spore ModAPI Easy Installer/XmlInstallerWindow.xaml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ public partial class XmlInstallerWindow : DecoratableWindow
string ModSettingsStoragePath = string.Empty;
string ModConfigPath = string.Empty;
string ModUnique = string.Empty;
Version ModVersion = null;
List<string> ModDependencies = new List<string>();
List<Version> ModDependenciesVersions = new List<Version>();
XmlDocument Document = new XmlDocument();
List<ComponentInfo> Prerequisites = new List<ComponentInfo>();
List<ComponentInfo> CompatFiles = new List<ComponentInfo>();
Expand Down Expand Up @@ -154,7 +157,8 @@ private void PrepareInstaller()
if ((ModInfoVersion == new Version(1, 0, 0, 0)) ||
(ModInfoVersion == new Version(1, 0, 1, 0)) ||
(ModInfoVersion == new Version(1, 0, 1, 1)) ||
(ModInfoVersion == new Version(1, 0, 1, 2)))
(ModInfoVersion == new Version(1, 0, 1, 2)) ||
(ModInfoVersion == new Version(1, 0, 1, 3)))
{
if (File.Exists(Path.Combine(ModConfigPath, "Branding.png")))
{
Expand Down Expand Up @@ -182,7 +186,8 @@ private void PrepareInstaller()
}
else if ((ModInfoVersion == new Version(1, 0, 1, 0)) ||
(ModInfoVersion == new Version(1, 0, 1, 1)) ||
(ModInfoVersion == new Version(1, 0, 1, 2)))
(ModInfoVersion == new Version(1, 0, 1, 2)) ||
(ModInfoVersion == new Version(1, 0, 1, 3)))
{
_dontUseLegacyPackagePlacement = true;
_installerMode = 1;
Expand Down Expand Up @@ -243,6 +248,101 @@ private void PrepareInstaller()
else
ModDescription = string.Empty;

// installerSystemVersion 1.0.1.3 introduced the version, depends and dependsVersion attributes
if (ModInfoVersion == new Version(1, 0, 1, 3))
{
if (Document.SelectSingleNode("/mod").Attributes["version"] != null)
{
if (Version.TryParse(Document.SelectSingleNode("/mod").Attributes["version"].Value, out Version parsedVersion))
ModVersion = parsedVersion;
else
throw new Exception("This mod has an invalid version. Please inform the mod's developer of this.");
}
else
ModVersion = null;

if (Document.SelectSingleNode("/mod").Attributes["depends"] != null)
{
string dependsString = Document.SelectSingleNode("/mod").Attributes["depends"].Value;
string dependsVersionString = null;
if (Document.SelectSingleNode("/mod").Attributes["dependsVersions"] != null)
dependsVersionString = Document.SelectSingleNode("/mod").Attributes["dependsVersions"].Value;
string[] dependsUniqueNames = dependsString.Split('?');
string[] dependsVersions = dependsVersionString?.Split('?');
bool[] foundDepends = new bool[dependsUniqueNames.Length];

ModDependencies = dependsUniqueNames.ToList();
if (dependsVersions != null)
{
foreach (string dependsVersion in dependsVersions)
{
if (String.IsNullOrEmpty(dependsVersion))
{ // 0.0.0.0 is interpreted as having no version attribute
// but we need to pad the list to match the amount of items
// that ModDependencies has
ModDependenciesVersions.Add(new Version(0, 0, 0, 0));
}
else
{
if (Version.TryParse(dependsVersion, out Version parsedDependsVersion))
{
ModDependenciesVersions.Add(parsedDependsVersion);
}
else
{
throw new Exception($"This mod has an invalid dependsVersions entry: \"{dependsVersion}\". Please inform the mod's developer of this.");
}
}
}
}

foreach (ModConfiguration mod in configs)
{
for (int i = 0; i < dependsUniqueNames.Length; i++)
{
if (mod.Unique == dependsUniqueNames[i])
{
if (mod.Version != null &&
(ModDependenciesVersions.Count() > i) &&
(mod.Version >= ModDependenciesVersions[i]))
{ // name + version match
foundDepends[i] = true;
break;
}
else if (ModDependenciesVersions.Count() <= i ||
ModDependenciesVersions[i] == new Version(0, 0, 0, 0))
{ // name only match
foundDepends[i] = true;
break;
}
}
}
}

bool satisfiedDepends = true;
List<string> missingDepends = new List<string>();
for (int i = 0; i < foundDepends.Length; i++)
{
if (!foundDepends[i])
{
satisfiedDepends = false;
string missingDependsText = dependsUniqueNames[i];
if (dependsVersions != null &&
dependsVersions.Length > i)
{
missingDependsText += " " + dependsVersions[i];
}
missingDepends.Add(missingDependsText);
}
}

if (!satisfiedDepends)
{
throw new Exception($"This mod has dependencies that you don't have installed: {String.Join(", ", missingDepends)}");
}
}
}

NameTextBlock.Text = displayName;
DescriptionTextBlock.Text = ModDescription;

Expand Down Expand Up @@ -757,6 +857,9 @@ await Dispatcher.BeginInvoke(new Action(() =>
ModConfiguration mod = new ModConfiguration(ModName, ModUnique)
{
DisplayName = ModDisplayName,
Version = ModVersion,
Dependencies = ModDependencies.ToArray(),
DependenciesVersions = ModDependenciesVersions.ToArray(),
ConfiguratorPath = Path.Combine(ModConfigPath, "ModInfo.xml")
};

Expand All @@ -780,7 +883,10 @@ await Dispatcher.BeginInvoke(new Action(() =>
{
ModConfiguration mod = new ModConfiguration(ModName, ModUnique)
{
DisplayName = ModDisplayName
DisplayName = ModDisplayName,
Version = ModVersion,
Dependencies = ModDependencies.ToArray(),
DependenciesVersions = ModDependenciesVersions.ToArray(),
};

foreach (ComponentInfo c in Prerequisites)
Expand Down
25 changes: 25 additions & 0 deletions Spore ModAPI Easy Uninstaller/EasyUninstaller.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,31 @@ public static void UninstallMods(Dictionary<ModConfiguration, bool> mods)

try
{
// ensure we don't remove a mod which
// is a dependency of another mod
List<string> modDependencies = new List<string>();
List<string> reliantMods = new List<string>();
foreach (var mod in Mods.ModConfigurations)
{
foreach (var uninstallMod in mods)
{
if (mod.Dependencies != null &&
mod.Dependencies.Contains(uninstallMod.Key.Unique) &&
!mods.Select(x => x.Key.Unique).Contains(mod.Unique))
{
modDependencies.Add(uninstallMod.Key.DisplayName);
if (!reliantMods.Contains(mod.DisplayName))
reliantMods.Add(mod.DisplayName);
}
}
}

if (modDependencies.Count() > 0)
{
MessageBox.Show($"Cannot uninstall {String.Join(", ", modDependencies.ToArray())} because {String.Join(", ", reliantMods.ToArray())} relies on them being installed!", CommonStrings.Error, MessageBoxButtons.OK, MessageBoxIcon.Error);
return;
}

foreach (var mod in mods)
{
ResultType result = ResultType.Success;
Expand Down
9 changes: 9 additions & 0 deletions Spore ModAPI Easy Uninstaller/UninstallerForm.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 10 additions & 5 deletions Spore ModAPI Easy Uninstaller/UninstallerForm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,16 @@ public void AddMods(HashSet<ModConfiguration> mods)
// add mods
foreach (var mod in mods)
{
string versionString = "";
if (mod.Version != null)
{
versionString = mod.Version.ToString();
}

int index = this.dataGridView1.Rows.Add(new object[] { false, mod, mod.DisplayName });
int index = this.dataGridView1.Rows.Add(new object[] { false, mod, mod.DisplayName, versionString });

if (GetConfiguratorPath(index) != null)
this.dataGridView1.Rows[index].Cells[3].ReadOnly = true;
this.dataGridView1.Rows[index].Cells[4].ReadOnly = true;
}

// sort mods
Expand All @@ -67,7 +72,7 @@ private void btnCancel_Click(object sender, EventArgs e)

private void dataGridView_CellDoubleClick(Object sender, DataGridViewCellEventArgs e)
{
if (e.RowIndex != 0 && e.ColumnIndex == 3 && GetConfiguratorPath(e.RowIndex) != null)
if (e.RowIndex != 0 && e.ColumnIndex == 4 && GetConfiguratorPath(e.RowIndex) != null)
{
// execute configurator and close uninstaller
ExecuteConfigurator(GetModConfiguration(e.RowIndex));
Expand All @@ -80,7 +85,7 @@ private void dataGridView_CellDoubleClick(Object sender, DataGridViewCellEventAr

private void dataGridView_CellContentClick(object sender, DataGridViewCellEventArgs e)
{
if (e.RowIndex != 0 && e.ColumnIndex == 3 && GetConfiguratorPath(e.RowIndex) != null)
if (e.RowIndex != 0 && e.ColumnIndex == 4 && GetConfiguratorPath(e.RowIndex) != null)
{
// execute configurator and close uninstaller
ExecuteConfigurator(GetModConfiguration(e.RowIndex));
Expand Down Expand Up @@ -153,7 +158,7 @@ private void btnUninstall_Click(object sender, EventArgs e)

private void dataGridView_CellPainting(object sender, DataGridViewCellPaintingEventArgs e)
{
if (e.ColumnIndex == 3 && this.dataGridView1.SelectedRows.Count > 0)
if (e.ColumnIndex == 4 && this.dataGridView1.SelectedRows.Count > 0)
{
if (e.RowIndex > 0)
{
Expand Down
3 changes: 3 additions & 0 deletions Spore ModAPI Easy Uninstaller/UninstallerForm.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@
<metadata name="ModDisplayNames.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
<value>True</value>
</metadata>
<metadata name="ModVersions.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
<value>True</value>
</metadata>
<metadata name="ModConfiguration.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
<value>True</value>
</metadata>
Expand Down