Skip to content
This repository was archived by the owner on Jul 3, 2024. It is now read-only.

OatmealDome/NintenTools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NintenTools

This is a collection of .NET libraries and tools to handle typical Nintendo file formats, wrapping them in object oriented libraries and add-ons for programs to handle them, closely trying to resemble what the original Nintendo tools might have provided to create the files.

Most specifically, the BFRES file format is focused, based on the documentation of the Custom Mario Kart 8 Wiki and own research.

The library is available as a NuGet package.

Usage

Right now, the following usage cases are possible:

  • YAZ0 compressed files can be decompressed.
  • BYAML files can be loaded and queried dynamically like byaml["Obj"][1]["UnitIdNum"].
  • BFRES files can be loaded and their structure inspected (deprecated classes, need update).

Contributing

Right now, the library is not under active development as I focus the Blender add-on first. I will probably rewrite big parts of the C# library in the future.

You're welcome to contribute. Let it be just raw BFRES file information which I implement then, or offer your own pull requests.

About code style: All Microsoft C# guidelines, max. line width of 120 characters. For C#, document everything except private stuff (it's nice to add research notes to some basic documentation later on).

License

WTFPL WTFPL

Copyright © 2016 syroot.com <admin@syroot.com>
This work is free. You can redistribute it and/or modify it under the
terms of the Do What The Fuck You Want To Public License, Version 2,
as published by Sam Hocevar. See the COPYING file for more details.

About

.NET tools and libraries to load and modify Nintendo file formats.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages