Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.77 KB

README.md

File metadata and controls

40 lines (32 loc) · 1.77 KB
Raw

BMSSV.IO

An IO library for interacting with the Mercury Steam BMSSV save format.

This library is still in active development. Currently, common.bmssv, pkprfl.bmssv, samus.bmssv, and userdata.bmssv have been parsed.

Contributing

This is an independently developed project. Currently, pull requests will not be accepted as the project will be constantly changing to support my other projects relating to the BMSSV format.

Install

This project is developed using .NET 5.0 and built as a NuGet package. To add this NuGet package to a project:

GitHub does not currently support access to package registries without authenticating. You will need to create a personal access token with the "read:packages" permission enabled. Add the following to the configuration section in your NuGet.Config:

<packageSources>
  <add key="KhaosVoidPackages" value="https://nuget.pkg.github.com/KhaosVoid/index.json" />
</packageSources>
<packageSourceCredentials>
  <KhaosVoidPackages>
    <add key="Username" value="<your username>" />
    <add key="ClearTextPassword" value="<your github personal access token>" />
  </KhaosVoidPackages>
</packageSourceCredentials>

To add the NuGet package to your project, you can either use the dotnet CLI or add a package reference line to your csproj.

dotnet CLI (replace 'packageVersion' with one of the available package versions):

$ dotnet add PROJECT package BMSSV.IO --version packageVersion

PackageReference (replace 'packageVersion' with one of the available package versions):

<ItemGroup>
  <PackageReference Include="BMSSV.IO" Version="packageVersion" />
</ItemGroup>