Files
SPT-Server-Build/Libraries/SPTarkov.Server.Core/Loaders/BundleLoader.cs
T
Jesse c852debf2b Bundle loader refactor (#502)
* Bundle loader refactor

- Made async
- Validate if bundle actually exists, if not throw warning into the console
- Updated mod example

* Cleanup unused var
2025-07-22 12:54:06 +01:00

128 lines
3.6 KiB
C#

using System.Text.Json.Serialization;
using SPTarkov.DI.Annotations;
using SPTarkov.Server.Core.Extensions;
using SPTarkov.Server.Core.Models.Spt.Mod;
using SPTarkov.Server.Core.Models.Utils;
using SPTarkov.Server.Core.Services;
using SPTarkov.Server.Core.Utils;
namespace SPTarkov.Server.Core.Loaders;
/*
{
"ModPath" : "/user/mods/Mod3",
"FileName" : "assets/content/weapons/usable_items/item_bottle/textures/client_assets.bundle",
"Bundle" : {
"key" : "assets/content/weapons/usable_items/item_bottle/textures/client_assets.bundle",
"dependencyKeys" : [ ]
},
"Crc" : 1030040371,
"Dependencies" : [ ]
} */
public class BundleInfo(string modPath, BundleManifestEntry bundle, uint bundleHash)
{
public string ModPath { get; private set; } = modPath;
public string FileName { get; private set; } = bundle.Key;
public BundleManifestEntry Bundle { get; private set; } = bundle;
public uint Crc { get; private set; } = bundleHash;
public List<string> Dependencies { get; private set; } = bundle?.DependencyKeys ?? [];
}
[Injectable(InjectionType.Singleton)]
public class BundleLoader(
ISptLogger<BundleLoader> logger,
JsonUtil jsonUtil,
BundleHashCacheService bundleHashCacheService
)
{
private readonly Dictionary<string, BundleInfo> _bundles = [];
public async Task LoadBundlesAsync(SptMod mod)
{
var modPath = mod.GetModPath();
var modBundles = await jsonUtil.DeserializeFromFileAsync<BundleManifest>(
Path.Join(Directory.GetCurrentDirectory(), modPath, "bundles.json")
);
var bundleManifests = modBundles?.Manifest ?? [];
foreach (var bundleManifest in bundleManifests)
{
var relativeModPath = modPath.Replace('\\', '/');
var bundleLocalPath = Path.Join(relativeModPath, "bundles", bundleManifest.Key)
.Replace('\\', '/');
if (!File.Exists(bundleLocalPath))
{
logger.Warning(
$"Could not find bundle {bundleManifest.Key} for mod {mod.ModMetadata.Name}"
);
continue;
}
if (!bundleHashCacheService.CalculateAndMatchHash(bundleLocalPath))
{
await bundleHashCacheService.CalculateAndStoreHash(bundleLocalPath);
}
var bundleHash = bundleHashCacheService.GetStoredValue(bundleLocalPath);
AddBundle(
bundleManifest.Key,
new BundleInfo(relativeModPath, bundleManifest, bundleHash)
);
}
}
/// <summary>
/// Handle singleplayer/bundles
/// </summary>
/// <returns> List of loaded bundles.</returns>
public List<BundleInfo> GetBundles()
{
var result = new List<BundleInfo>();
foreach (var bundle in _bundles)
{
result.Add(bundle.Value);
}
return result;
}
public BundleInfo? GetBundle(string bundleKey)
{
return _bundles.GetValueOrDefault(bundleKey);
}
public void AddBundle(string key, BundleInfo bundle)
{
var success = _bundles.TryAdd(key, bundle);
if (!success)
{
logger.Error($"Unable to add bundle: {key}");
}
}
}
public record BundleManifest
{
[JsonPropertyName("manifest")]
public List<BundleManifestEntry>? Manifest { get; set; }
}
public record BundleManifestEntry
{
[JsonPropertyName("key")]
public required string Key { get; set; }
[JsonPropertyName("dependencyKeys")]
public List<string>? DependencyKeys { get; set; }
}