toofz NecroDancer Core

Overview

toofz NecroDancer Core is a .NET library designed for parsing and editing Crypt of the NecroDancer files. The library supports necrodancer.xml, replays, and saves.

---

toofz NecroDancer Core is a component of toofz. Information about other projects that support toofz can be found in the meta-repository.

Description

toofz NecroDancer Core supports reading and modifying necrodancer.xml, replays, and saves. It powers the Items and Enemies sections of toofz through data mining. It also provides richer leaderboard entry data by parsing replays associated with entries.

Installing via NuGet

Add a NuGet.Config to your solution directory with the following content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="toofz" value="https://www.myget.org/F/toofz/api/v3/index.json" />
  </packageSources>
</configuration>

Install-Package 'toofz.NecroDancer'

Dependents

• toofz API
• toofz Replays Service
• toofz Data

Dependencies

• toofz Build

Requirements

• .NET Standard 1.3-compatible platform
  • .NET Core 1.0
  • .NET Framework 4.6
  • Mono 4.6

Usage

Data API (necrodancer.xml)

Reading necrodancer.xml:

var necrodancerXmlPath = @"C:\Program Files\Steam\steamapps\common\Crypt of the NecroDancer\data\necrodancer.xml";
using (var fs = File.OpenRead(necrodancerXmlPath))
{
    var serializer = new NecroDancerDataSerializer();
    NecroDancerData data = serializer.Deserialize(fs);
    // ...
}

Replays API

Reading a replay:

using (var fs = File.OpenRead(replayPath))
{
    var serializer = new ReplayDataSerializer();
    ReplayData replayData = serializer.Deserialize(fs);
    // ...
}

Saves API

Reading a save:

using (var fs = File.OpenRead(saveDataPath))
{
    var serializer = new SaveDataSerializer();
    SaveData saveData = serializer.Deserialize(fs);
    // ...
}

Contributing

Contributions are welcome for toofz NecroDancer Core.

• Want to report a bug or request a feature? File a new issue.
• Join in design conversations.
• Fix an issue or add a new feature.
  • Aside from trivial issues, please raise a discussion before submitting a pull request.

Development

Requirements

• Visual Studio 2017

Getting started

Open the solution file and build. Use Test Explorer to run tests.

Repository layout

• Data - read and modify necrodancer.xml
• Replays - read and modify replays
• Saves - read and modify save data

License

toofz NecroDancer Core is released under the MIT License.