Giter Club home page Giter Club logo

soulsformats's Introduction

SoulsFormats

A .NET library for reading and writing various FromSoftware file formats, targeting .NET 6 and 7.
Elden Ring, Dark Souls, Demon's Souls, Bloodborne, and Sekiro are the main focus, but other From games may be supported to varying degrees.
A brief description of each supported format can be found in FORMATS.md, with further documentation for some formats.

Forked from JKAnderson's repository, but also contains all the new changes from DS Map Studio (where it's currently maintained officially?). Sadly I have no option but to merge the changes manually โ€” all credits go to the contributors there.

Additionally, I implement my own changes as well, mainly to the Headerizer class, which is used for deswizzling console textures (the most popular being PS4).

Usage

Objects for most formats can be created with the static method Read, which accepts either a Memory<byte>, or a file path. A very new addition to the library was to use Memory Mapped files, which reduces memory consumption, and is much faster due to unnecessary allocations.

BND4 bnd = BND4.Read(@"C:\your\path\here.chrbnd");

// or

var file = MemoryMappedFile.CreateFromFile(@"C:\your\path\here.chrbnd", FileMode.Open, null, 0, MemoryMappedFileAccess.Read);
var accessor = file.CreateMemoryAccessor(0, 0, MemoryMappedFileAccess.Read);
BND4 bnd = BND4.Read(accessor.Memory);

The Write method can be used to create a new file from an object. If given a path it will be written to that location with a stream, otherwise a byte array will be returned.

bnd.Write(@"C:\your\path\here.chrbnd");

// or

byte[] bytes = bnd.Write();
using FileStream stream = File.Create(@"C:\your\path\here.chrbnd");
stream.Write(bytes, 0, bytes.Length);
stream.Flush();

DCX (compressed files) will be decompressed automatically and the compression type will be remembered and reapplied when writing the file.

BND4 bnd = BND4.Read(@"C:\your\path\here.chrbnd.dcx");
bnd.Write(@"C:\your\path\here.chrbnd.dcx");

The compression type can be changed by either setting the Compression field of the object, or specifying one when calling Write.

BND4 bnd = BND4.Read(@"C:\your\path\here.chrbnd.dcx");
bnd.Write(@"C:\your\path\here.chrbnd", DCX.Type.None);

// or

BND4 bnd = BND4.Read(@"C:\your\path\here.chrbnd.dcx");
bnd.Compression = DCX.Type.None;
bnd.Write(@"C:\your\path\here.chrbnd");

Finally, DCX files can be generically read and written with static methods if necessary. DCX holds no important metadata so they read/write directly to/from byte arrays instead of creating an object.

Memory<byte> bndBytes = DCX.Decompress(@"C:\your\path\here.chrbnd.dcx");
BND4 bnd = BND4.Read(bndBytes);

// or

var file = MemoryMappedFile.CreateFromFile(@"C:\your\path\here.chrbnd.dcx", FileMode.Open, null, 0, MemoryMappedFileAccess.Read);
var accessor = file.CreateMemoryAccessor(0, 0, MemoryMappedFileAccess.Read);
Memory<byte> bndBytes = DCX.Decompress(accessor.Memory);
BND4 bnd = BND4.Read(bndBytes);

Writing a new DCX requires a DCX.Type parameter indicating which game it is for. DCX.Decompress has an optional out parameter indicating the detected type which should usually be used instead of specifying your own.

Memory<byte> bndBytes = DCX.Decompress(@"C:\your\path\here.chrbnd.dcx", out DCX.Type type);
DCX.Compress(bndBytes, type, @"C:\your\path\here.chrbnd.dcx");

// or

Memory<byte> bndBytes = DCX.Decompress(@"C:\your\path\here.chrbnd.dcx", out DCX.Type type);
Memory<byte> dcxBytes = DCX.Compress(bndBytes.Span, type);
using FileStream stream = File.Create(@"C:\your\path\here.chrbnd.dcx");
stream.Write(dcxBytes.Span);
stream.Flush();

Special Thanks

  • albeartron
  • Atvaark
  • B3LYP
  • horkrux
  • HotPocketRemix
  • katalash
  • Lance
  • Meowmaritus
  • Nyxojaele
  • Pav
  • SeanP
  • thefifthmatt
  • Wulf2k
  • Yoshimitsu
  • DS Map Studio
  • DS Anim Studio

soulsformats's People

Contributors

jkanderson avatar kotn3l avatar gracenotes avatar meowmaritus avatar albeartron 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.