epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move file system mounting into mod code.

Browse Source
This commit is contained in:
Paul Chote
2024-09-28 17:52:04 +01:00
committed by Gustas
parent b60b1e369a
commit 720b925fd5
12 changed files with 178 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
OpenRA.Game/FileSystem/FileSystem.cs
View File

@@ -181,12 +181,8 @@ namespace OpenRA.FileSystem
fileIndex = new Cache<string, List<IReadOnlyPackage>>(_ => new List<IReadOnlyPackage>()); fileIndex = new Cache<string, List<IReadOnlyPackage>>(_ => new List<IReadOnlyPackage>());
} }
public void LoadFromManifest(Manifest manifest) public void TrimExcess()
{ {
UnmountAll();
foreach (var kv in manifest.Packages)
Mount(kv.Key, kv.Value);
mountedPackages.TrimExcess(); mountedPackages.TrimExcess();
explicitMounts.TrimExcess(); explicitMounts.TrimExcess();
modPackages.TrimExcess(); modPackages.TrimExcess();

8
OpenRA.Game/Manifest.cs
View File

@@ -65,8 +65,8 @@ namespace OpenRA
Weapons, Voices, Notifications, Music, Translations, TileSets, Weapons, Voices, Notifications, Music, Translations, TileSets,
ChromeMetrics, MapCompatibility, Missions, Hotkeys; ChromeMetrics, MapCompatibility, Missions, Hotkeys;
public readonly IReadOnlyDictionary<string, string> Packages;
public readonly IReadOnlyDictionary<string, string> MapFolders; public readonly IReadOnlyDictionary<string, string> MapFolders;
public readonly MiniYaml FileSystem;
public readonly MiniYaml LoadScreen; public readonly MiniYaml LoadScreen;
public readonly string DefaultOrderGenerator; public readonly string DefaultOrderGenerator;
@@ -81,7 +81,7 @@ namespace OpenRA
readonly string[] reservedModuleNames = readonly string[] reservedModuleNames =
{ {
"Include", "Metadata", "Folders", "MapFolders", "Packages", "Rules", "Include", "Metadata", "FileSystem", "MapFolders", "Rules",
"Sequences", "ModelSequences", "Cursors", "Chrome", "Assemblies", "ChromeLayout", "Weapons", "Sequences", "ModelSequences", "Cursors", "Chrome", "Assemblies", "ChromeLayout", "Weapons",
"Voices", "Notifications", "Music", "Translations", "TileSets", "ChromeMetrics", "Missions", "Hotkeys", "Voices", "Notifications", "Music", "Translations", "TileSets", "ChromeMetrics", "Missions", "Hotkeys",
"ServerTraits", "LoadScreen", "DefaultOrderGenerator", "SupportsMapsFrom", "SoundFormats", "SpriteFormats", "VideoFormats", "ServerTraits", "LoadScreen", "DefaultOrderGenerator", "SupportsMapsFrom", "SoundFormats", "SpriteFormats", "VideoFormats",
@@ -123,8 +123,8 @@ namespace OpenRA
// TODO: Use fieldloader // TODO: Use fieldloader
MapFolders = YamlDictionary(yaml, "MapFolders"); MapFolders = YamlDictionary(yaml, "MapFolders");
if (yaml.TryGetValue("Packages", out var packages)) if (!yaml.TryGetValue("FileSystem", out FileSystem))
Packages = packages.ToDictionary(x => x.Value); throw new InvalidDataException("`FileSystem` section is not defined.");
Rules = YamlList(yaml, "Rules"); Rules = YamlList(yaml, "Rules");
Sequences = YamlList(yaml, "Sequences"); Sequences = YamlList(yaml, "Sequences");

15
OpenRA.Game/ModData.cs
View File

@@ -35,6 +35,8 @@ namespace OpenRA
public readonly ISpriteSequenceLoader SpriteSequenceLoader; public readonly ISpriteSequenceLoader SpriteSequenceLoader;
public readonly IVideoLoader[] VideoLoaders; public readonly IVideoLoader[] VideoLoaders;
public readonly HotkeyManager Hotkeys; public readonly HotkeyManager Hotkeys;
public readonly IFileSystemLoader FileSystemLoader;
public ILoadScreen LoadScreen { get; } public ILoadScreen LoadScreen { get; }
public CursorProvider CursorProvider { get; private set; } public CursorProvider CursorProvider { get; private set; }
public FS ModFiles; public FS ModFiles;
@@ -54,9 +56,13 @@ namespace OpenRA
Manifest = new Manifest(mod.Id, mod.Package); Manifest = new Manifest(mod.Id, mod.Package);
ObjectCreator = new ObjectCreator(Manifest, mods); ObjectCreator = new ObjectCreator(Manifest, mods);
PackageLoaders = ObjectCreator.GetLoaders<IPackageLoader>(Manifest.PackageFormats, "package"); PackageLoaders = ObjectCreator.GetLoaders<IPackageLoader>(Manifest.PackageFormats, "package");
ModFiles = new FS(mod.Id, mods, PackageLoaders); ModFiles = new FS(mod.Id, mods, PackageLoaders);
ModFiles.LoadFromManifest(Manifest);
FileSystemLoader = ObjectCreator.GetLoader<IFileSystemLoader>(Manifest.FileSystem.Value, "filesystem");
FieldLoader.Load(FileSystemLoader, Manifest.FileSystem);
FileSystemLoader.Mount(ModFiles, ObjectCreator);
ModFiles.TrimExcess();
Manifest.LoadCustomData(ObjectCreator); Manifest.LoadCustomData(ObjectCreator);
if (useLoadScreen) if (useLoadScreen)
@@ -190,4 +196,9 @@ namespace OpenRA
/// <summary>Called when the engine expects to connect to a server/replay or load the shellmap.</summary> /// <summary>Called when the engine expects to connect to a server/replay or load the shellmap.</summary>
void StartGame(Arguments args); void StartGame(Arguments args);
} }
public interface IFileSystemLoader
{
void Mount(FS fileSystem, ObjectCreator objectCreator);
}
} }

27
OpenRA.Mods.Common/FileSystem/DefaultFileSystemLoader.cs Normal file
View File

@@ -0,0 +1,27 @@
#region Copyright & License Information
/*
* Copyright (c) The OpenRA Developers and Contributors
* This file is part of OpenRA, which is free software. It is made
* available to you under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version. For more
* information, see COPYING.
*/
#endregion
using System.Collections.Generic;
namespace OpenRA.Mods.Common.FileSystem
{
public class DefaultFileSystemLoader : IFileSystemLoader
{
public readonly Dictionary<string, string> Packages = null;
public void Mount(OpenRA.FileSystem.FileSystem fileSystem, ObjectCreator objectCreator)
{
if (Packages != null)
foreach (var kv in Packages)
fileSystem.Mount(kv.Key, kv.Value);
}
}
}

6
OpenRA.Mods.Common/Widgets/Logic/Installation/ModContentLogic.cs
View File

@@ -42,7 +42,11 @@ namespace OpenRA.Mods.Common.Widgets.Logic
var modObjectCreator = new ObjectCreator(mod, Game.Mods); var modObjectCreator = new ObjectCreator(mod, Game.Mods);
var modPackageLoaders = modObjectCreator.GetLoaders<IPackageLoader>(mod.PackageFormats, "package"); var modPackageLoaders = modObjectCreator.GetLoaders<IPackageLoader>(mod.PackageFormats, "package");
var modFileSystem = new FS(mod.Id, Game.Mods, modPackageLoaders); var modFileSystem = new FS(mod.Id, Game.Mods, modPackageLoaders);
modFileSystem.LoadFromManifest(mod);
var modFileSystemLoader = modObjectCreator.GetLoader<IFileSystemLoader>(mod.FileSystem.Value, "filesystem");
FieldLoader.Load(modFileSystemLoader, mod.FileSystem);
modFileSystemLoader.Mount(modFileSystem, modObjectCreator);
modFileSystem.TrimExcess();
var sourceYaml = MiniYaml.Load(modFileSystem, content.Sources, null); var sourceYaml = MiniYaml.Load(modFileSystem, content.Sources, null);
foreach (var s in sourceYaml) foreach (var s in sourceYaml)

6
OpenRA.Mods.Common/Widgets/Logic/Installation/ModContentPromptLogic.cs
View File

@@ -78,7 +78,11 @@ namespace OpenRA.Mods.Common.Widgets.Logic
var modObjectCreator = new ObjectCreator(mod, Game.Mods); var modObjectCreator = new ObjectCreator(mod, Game.Mods);
var modPackageLoaders = modObjectCreator.GetLoaders<IPackageLoader>(mod.PackageFormats, "package"); var modPackageLoaders = modObjectCreator.GetLoaders<IPackageLoader>(mod.PackageFormats, "package");
var modFileSystem = new FS(mod.Id, Game.Mods, modPackageLoaders); var modFileSystem = new FS(mod.Id, Game.Mods, modPackageLoaders);
modFileSystem.LoadFromManifest(mod);
var modFileSystemLoader = modObjectCreator.GetLoader<IFileSystemLoader>(mod.FileSystem.Value, "filesystem");
FieldLoader.Load(modFileSystemLoader, mod.FileSystem);
modFileSystemLoader.Mount(modFileSystem, modObjectCreator);
modFileSystem.TrimExcess();
var downloadYaml = MiniYaml.Load(modFileSystem, content.Downloads, null); var downloadYaml = MiniYaml.Load(modFileSystem, content.Downloads, null);
modFileSystem.UnmountAll(); modFileSystem.UnmountAll();

5
mods/all/mod.yaml
View File

@@ -3,8 +3,9 @@ Metadata:
Version: {DEV_VERSION} Version: {DEV_VERSION}
Hidden: true Hidden: true
Packages: FileSystem: DefaultFileSystem
^EngineDir Packages:
^EngineDir
Cursors: Cursors:

55
mods/cnc/mod.yaml
View File

@@ -7,33 +7,34 @@ Metadata:
PackageFormats: Mix PackageFormats: Mix
Packages: FileSystem: DefaultFileSystem
~^SupportDir|Content/cnc Packages:
~^SupportDir|Content/cnc/movies ~^SupportDir|Content/cnc
^EngineDir ~^SupportDir|Content/cnc/movies
$cnc: cnc ^EngineDir
^EngineDir|mods/common: common $cnc: cnc
~speech.mix ^EngineDir|mods/common: common
~conquer.mix ~speech.mix
~sounds.mix ~conquer.mix
~tempicnh.mix ~sounds.mix
~temperat.mix ~tempicnh.mix
~winter.mix ~temperat.mix
~desert.mix ~winter.mix
~movies.mix ~desert.mix
~scores.mix ~movies.mix
~scores2.mix ~scores.mix
~scores-covertops.mix ~scores2.mix
~transit.mix ~scores-covertops.mix
~general.mix ~transit.mix
cnc|bits/snow.mix ~general.mix
cnc|bits cnc|bits/snow.mix
cnc|bits/jungle cnc|bits
cnc|bits/desert cnc|bits/jungle
cnc|bits/ss cnc|bits/desert
cnc|scripts cnc|bits/ss
common|scripts cnc|scripts
cnc|uibits common|scripts
cnc|uibits
MapFolders: MapFolders:
cnc|maps: System cnc|maps: System

28
mods/d2k/mod.yaml
View File

@@ -7,20 +7,20 @@ Metadata:
PackageFormats: D2kSoundResources PackageFormats: D2kSoundResources
Packages: FileSystem: DefaultFileSystem
~^SupportDir|Content/d2k/v3/ Packages:
~^SupportDir|Content/d2k/v3/GAMESFX ~^SupportDir|Content/d2k/v3/
~^SupportDir|Content/d2k/v3/Movies ~^SupportDir|Content/d2k/v3/GAMESFX
~^SupportDir|Content/d2k/v3/Music ~^SupportDir|Content/d2k/v3/Movies
^EngineDir ~^SupportDir|Content/d2k/v3/Music
$d2k: d2k ^EngineDir
^EngineDir|mods/common: common $d2k: d2k
^EngineDir|mods/common: common
~SOUND.RS ~SOUND.RS
d2k|bits d2k|bits
d2k|scripts d2k|scripts
common|scripts common|scripts
d2k|uibits d2k|uibits
MapFolders: MapFolders:
d2k|maps: System d2k|maps: System

9
mods/modcontent/mod.yaml
View File

@@ -3,10 +3,11 @@ Metadata:
Version: {DEV_VERSION} Version: {DEV_VERSION}
Hidden: true Hidden: true
Packages: FileSystem: DefaultFileSystem
^EngineDir Packages:
^EngineDir|mods/modcontent: modcontent ^EngineDir
^EngineDir|mods/common: common ^EngineDir|mods/modcontent: modcontent
^EngineDir|mods/common: common
Rules: Rules:
modcontent|rules.yaml modcontent|rules.yaml

61
mods/ra/mod.yaml
View File

@@ -7,36 +7,37 @@ Metadata:
PackageFormats: Mix PackageFormats: Mix
Packages: FileSystem: DefaultFileSystem
~^SupportDir|Content/ra/v2/ Packages:
~^SupportDir|Content/ra/v2/expand ~^SupportDir|Content/ra/v2/
~^SupportDir|Content/ra/v2/cnc ~^SupportDir|Content/ra/v2/expand
~^SupportDir|Content/ra/v2/movies ~^SupportDir|Content/ra/v2/cnc
^EngineDir ~^SupportDir|Content/ra/v2/movies
$ra: ra ^EngineDir
^EngineDir|mods/common: common $ra: ra
~main.mix ^EngineDir|mods/common: common
~conquer.mix ~main.mix
~lores.mix: lores ~conquer.mix
~hires.mix ~lores.mix: lores
~local.mix ~hires.mix
~sounds.mix ~local.mix
~speech.mix ~sounds.mix
~allies.mix ~speech.mix
~russian.mix ~allies.mix
~temperat.mix ~russian.mix
~snow.mix ~temperat.mix
~interior.mix ~snow.mix
~scores.mix ~interior.mix
~expand2.mix ~scores.mix
~hires1.mix ~expand2.mix
~desert.mix ~hires1.mix
~general.mix ~desert.mix
ra|bits ~general.mix
ra|bits/desert ra|bits
ra|scripts ra|bits/desert
common|scripts ra|scripts
ra|uibits common|scripts
ra|uibits
MapFolders: MapFolders:
ra|maps: System ra|maps: System

83
mods/ts/mod.yaml
View File

@@ -7,48 +7,49 @@ Metadata:
PackageFormats: Mix PackageFormats: Mix
Packages: FileSystem: DefaultFileSystem
~^SupportDir|Content/ts Packages:
~^SupportDir|Content/ts/firestorm ~^SupportDir|Content/ts
^EngineDir ~^SupportDir|Content/ts/firestorm
$ts: ts ^EngineDir
^EngineDir|mods/common: common $ts: ts
^EngineDir|mods/common: common
# Tiberian Sun # Tiberian Sun
~scores.mix ~scores.mix
~sidenc01.mix ~sidenc01.mix
~sidenc02.mix ~sidenc02.mix
~e01scd01.mix ~e01scd01.mix
~e01scd02.mix ~e01scd02.mix
~movies01.mix ~movies01.mix
~movies02.mix ~movies02.mix
~sidecd01.mix ~sidecd01.mix
~sidecd02.mix ~sidecd02.mix
~cache.mix ~cache.mix
~conquer.mix ~conquer.mix
~isosnow.mix ~isosnow.mix
~isotemp.mix ~isotemp.mix
~local.mix ~local.mix
~sidec01.mix: sidebar-gdi ~sidec01.mix: sidebar-gdi
~sidec02.mix: sidebar-nod ~sidec02.mix: sidebar-nod
~sno.mix ~sno.mix
~snow.mix ~snow.mix
~sounds.mix ~sounds.mix
~speech01.mix: speech-gdi ~speech01.mix: speech-gdi
~speech02.mix: speech-nod ~speech02.mix: speech-nod
~tem.mix ~tem.mix
~temperat.mix ~temperat.mix
# Firestorm # Firestorm
~scores01.mix ~scores01.mix
~expand01.mix ~expand01.mix
~sounds01.mix ~sounds01.mix
~e01sc01.mix ~e01sc01.mix
~e01sc02.mix ~e01sc02.mix
~e01vox01.mix ~e01vox01.mix
~e01vox02.mix ~e01vox02.mix
~ecache01.mix ~ecache01.mix
ts|bits ts|bits
ts|uibits ts|uibits
MapFolders: MapFolders:
ts|maps: System ts|maps: System