BfmeFoundationProject.BfmeKit 1.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package BfmeFoundationProject.BfmeKit --version 1.1.0                
NuGet\Install-Package BfmeFoundationProject.BfmeKit -Version 1.1.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.BfmeKit" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BfmeFoundationProject.BfmeKit --version 1.1.0                
#r "nuget: BfmeFoundationProject.BfmeKit, 1.1.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.
// Install BfmeFoundationProject.BfmeKit as a Cake Addin
#addin nuget:?package=BfmeFoundationProject.BfmeKit&version=1.1.0

// Install BfmeFoundationProject.BfmeKit as a Cake Tool
#tool nuget:?package=BfmeFoundationProject.BfmeKit&version=1.1.0                

BfmeKit by Online Battle Arena Team

This project is part of the Bfme Foundation Project!

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

Welcome

Welcome to the official github repository of RegistryKit! This library allows you to easily modify the registry entries used by the BFME games. Additionaly, it provides a way to list and generate previews of BFME maps, as well as list available color options. It can also create installation registries from scratch.

Get on NuGet

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

BfmeRegistryManager

  • BfmeRegistryManager.CreateNewInstallRegistry() - Create new installation registry (install the game)
  • BfmeRegistryManager.GetKeyValue() - Get a value from the game registry (get game language, installation directory, user data folder, etc...)
  • BfmeRegistryManager.SetKeyValue() - Set a value in the games registry
  • BfmeRegistryManager.EnsureDefaults() - Ensures that all necesary default values exist for the game to start without errors
  • BfmeRegistryManager.IsInstalled() - Returns a bool indicating wether the game is installed or not.
  • BfmeRegistryManager.EnsureFixedRegistry() - Manualy fixes the registry if it has been corrupted. Called every time when calling BfmeRegistryManager.GetKeyValue().

BfmeColorImporter

  • BfmeColorImporter.ImportColors() - Returns a list of color options available in the curently installed version of the game specified.

BfmeMapImporter

  • BfmeMapImporter.ImportMaps() - Returns a list of maps available in the curently installed version of the game specified.
  • BfmeMapImporter.GenerateMapPreview() - Generates and returns a bitmap image preview of the map specified.
Developed by The Online Battle Arena Team (Beterwel, MarcellVokk)
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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on BfmeFoundationProject.BfmeKit:

Package Downloads
BfmeFoundationProject.WorkshopKit

Easily access, upload and download from the BFME Workshop, as well as sync to packages and more.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0 42 11/22/2024
1.1.0 100 11/10/2024
1.0.0 85 11/6/2024