BfmeFoundationProject.WorkshopKit 3.0.0

dotnet add package BfmeFoundationProject.WorkshopKit --version 3.0.0
                    
NuGet\Install-Package BfmeFoundationProject.WorkshopKit -Version 3.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BfmeFoundationProject.WorkshopKit" Version="3.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BfmeFoundationProject.WorkshopKit" Version="3.0.0" />
                    
Directory.Packages.props
<PackageReference Include="BfmeFoundationProject.WorkshopKit" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add BfmeFoundationProject.WorkshopKit --version 3.0.0
                    
#r "nuget: BfmeFoundationProject.WorkshopKit, 3.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package BfmeFoundationProject.WorkshopKit@3.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=BfmeFoundationProject.WorkshopKit&version=3.0.0
                    
Install as a Cake Addin
#tool nuget:?package=BfmeFoundationProject.WorkshopKit&version=3.0.0
                    
Install as a Cake Tool

WorkshopKit by the Bfme Foundation Project

This project is part of the Bfme Foundation Project!

<a href="https://github.com/MarcellVokk/BfmeFoundationProject"> <img src="https://img.shields.io/badge/GitHub-Foundation Project-lime"/> </a>

Welcome

This package allows you to access the BFME Workshop, and also provides realy powerful tools for patch switching, modding and more!

Get on NuGet

<a href="https://www.nuget.org/packages/BfmeFoundationProject.WorkshopKit"> <img src="https://img.shields.io/nuget/v/BfmeFoundationProject.WorkshopKit"/> </a>

Usage

  • BfmeWorkshopManager exposes the curent state of the users workshop library, and for example provides functions to get the curently enabled mod for a specified game, or get a list of enabled enhancements for a specified game.
  • BfmeWorkshopQueryManager exposes several methods that can be used to query or search the workshop.
  • BfmeWorkshopDownloadManager exposes several methods that allow you to download packages from the workshop. Downloading a package is required when syncing, as a package preview (obtained by a query) is not enough.
  • BfmeWorkshopSyncManager is the workshops built in "patch switcher". It is highly recommended that you use this instead of trying to build your own!
  • BfmeWorkshopLibraryManager is used to access the users library, and query, add or remove workshop entries from it.
  • BfmeWorkshopAdminManager is for uploading or deleting your own entries to the workshop.
  • BfmeWorkshopAuthManager is used for authentication. This is the way you can get a BfmeWorkshopAuthInfo to use in the methods exposed by BfmeWorkshopAdminManager.

Examples

A very simple workshop browser example made in WinForms is available in the github repository, as well as the source code of the AIO Launcher, which also uses this package.

Developed by The Online Battle Arena Team, in collaboration with the Patch 2.22 Team
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.0.0 235 5/6/2025
2.5.0 279 3/7/2025
2.4.1 153 12/29/2024
2.4.0 135 12/22/2024
2.3.9 135 12/22/2024
2.3.8 161 12/10/2024
2.3.7 139 12/10/2024
2.3.6 143 12/10/2024
2.3.5 160 12/10/2024
2.3.4 143 12/10/2024
2.3.3 155 12/10/2024
2.3.2 137 12/10/2024
2.3.1 143 12/2/2024
2.3.0 151 11/22/2024
2.2.0 163 11/10/2024
2.1.0 148 11/6/2024
2.0.3 156 11/2/2024
2.0.2 143 11/2/2024
2.0.1 154 11/2/2024
2.0.0 166 11/2/2024
1.9.9 178 11/2/2024
1.9.8 157 11/1/2024
1.9.6 150 10/31/2024
1.9.5 154 10/23/2024
1.9.4 162 10/20/2024
1.9.2 159 10/3/2024
1.9.1 151 10/2/2024
1.9.0 162 10/1/2024
1.8.9 167 9/30/2024
1.8.8 155 9/29/2024
1.8.7 160 9/29/2024
1.8.6 158 9/29/2024
1.8.4 153 9/28/2024
1.8.3 124 9/17/2024
1.8.2 116 9/15/2024
1.8.1 171 8/30/2024
1.8.0 162 8/29/2024
1.7.9 159 8/29/2024
1.7.8 157 8/29/2024
1.7.7 236 8/25/2024
1.7.6 193 8/24/2024
1.7.5 183 8/24/2024
1.7.4 194 8/23/2024
1.7.3 200 8/22/2024
1.7.2 182 8/22/2024
1.7.1 185 8/21/2024
1.7.0 180 8/21/2024
1.6.9 190 8/21/2024
1.6.8 189 8/21/2024
1.6.7 189 8/21/2024
1.6.6 201 8/20/2024
1.6.5 193 8/20/2024
1.6.4 190 8/19/2024
1.6.3 175 8/19/2024
1.6.2 211 8/12/2024
1.6.1 173 8/12/2024
1.6.0 172 8/12/2024
1.5.0 191 8/11/2024
1.4.9 185 8/10/2024
1.4.8 182 8/10/2024
1.4.7 200 8/10/2024
1.4.6 181 8/10/2024
1.4.5 168 8/10/2024
1.4.4 171 8/10/2024
1.4.3 414 8/10/2024