Code Monkey home page Code Monkey logo

toofz-necrodancer-core's Introduction

toofz NecroDancer Core

Build status codecov MyGet

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

Dependencies

Requirements

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);
    // ...
}

Reading a replay:

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

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.

toofz-necrodancer-core's People

Contributors

leonard-thieu avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.