Addons Manager

No description.

Building

• Open the project in your preferred .NET IDE (e.g., Visual Studio, Rider, VS Code).
• Build the project. The output DLL and resources will be placed in the build/ directory.
• The publish process will also create a zip file for easy distribution.

Publishing

• Use the dotnet publish -c Release command to build and package your plugin.
• Distribute the generated zip file or the contents of the build/publish directory.

Commands

sw_downloadaddon <workshop_id> # Download a workshop addon via command
sw_searchpath # View all the VPK Search Paths

Adding Addons

• To add an addon for players to download, modify addons/swiftlys2/configs/plugins/AddonsManager/config.jsonc at key Main.Addons with Workshop ID's:

{
  "Main": {
    "Addons": [
      "WORKSHOP_ID1",
      "WORKSHOP_ID2",
      // ...
    ],
    // ...
  }
}

Config Options

Option	Default	Description
Addons	[]	Workshop IDs mounted and sent to clients on connect.
BlockDisconnectMessages	true	Suppress the loopback disconnect message clients get when the server mounts addons (reconnect). Set false to let it through.
CacheClientsWithAddons	true	Remember which addons a client already downloaded across reconnects, skipping re-download. false clears the list on disconnect.
CacheClientsDurationInSeconds	0.0	How long a client's download cache stays valid after going inactive, in seconds. 0 disables expiry (cache never clears from inactivity). Only applies when CacheClientsWithAddons is true.
ExtraAddonsTimeoutInSeconds	10.0	Seconds to wait for a client to finish downloading a pending addon after reconnect before giving up on crediting it as downloaded.
RedownloadAddonOnMount	false	Force a re-download of an addon every time it's mounted, even if already installed.

API for other plugins

Reference AddonsManager.Contract.dll (build output of AddonsManager.Contract), then:

private IAddonsManagerApi? _addons;

public override void UseSharedInterface(IInterfaceManager interfaceManager)
{
    if (interfaceManager.TryGetSharedInterface<IAddonsManagerApi>(IAddonsManagerApi.Key, out var api))
        _addons = api;
}

public override void Load(bool hotReload) => _addons?.AddAddon("WORKSHOP_ID");

• AddAddon(id) / RemoveAddon(id): in memory only, call on every load. Config addons cannot be removed.
• GetAddons() / GetMountedAddons(): read-only lists.

Acknowledgements

This plugin is a port of Source2ZE's MultiAddonManager for SwiftlyS2. It is released under GPL with credits given to the original code writers.