BfmeKit by Online Battle Arena Team

This project is part of the Bfme Foundation Project!

Welcome

Welcome to the official github repository of BfmeKit! 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

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)