Souls Lib (Soulib)

Currently a very WIP library being created slowly in my free time. Feel free to contribute but I don't have any clear direction on how I want this project to be structured so please be mindful of that. If you have any questions feel free to ask them.

Goals

• Zig Library
• C ABI Library from Zig
• All recent common fromsoft formats (excluding older titles. anything prior ds1-ptde)

Design of the library

Rough summary of using the library:

• Open file using it's path.
• Read all bytes from file.
• Pass file bytes to library and parse.

Example Usage

const std = @import("std");
// Import the library.
const soulib = @import("soulib");

pub fn main() !void {
    // Define the allocator to use.
    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
    defer arena.deinit();
    const allocator = arena.allocator();

    // Define the file to parse over.
    const path = "path/to/dcx/file.dcx";
    var file = std.fs.openFileAbsolute(
        path,
        .{ .mode = .read_only },
    ) catch unreachable;
    defer file.close();

    // Read the bytes from the file.
    const fileBytes = try file.readToEndAlloc(allocator, try file.getEndPos());

    // Parse the file.
    const dcx = try soulib.DCX.read(
        allocator,
        fileBytes,
    );
    
    // Use the parsed data.
    std.debug.print("HEADER:\n    Magic: {c}\n    Compression Type: {c}\n    Compressed size: {d}\n    Decompressed size: {d}\nBODY:\n    Length: {d}\n    Summary: {x}", .{
        dcx.header.dcx,
        dcx.header.format,
        dcx.header.compressedSize,
        dcx.header.uncompressedSize,
        dcx.data.len,
        dcx.data[0..32],
    });
}

Formats

Basic descriptions are provided below. Checkmarks show library progress on file type.

Examples Building

To run examples:
zig build read_dcx -Dtarget=x86_64-windows -- "E:/SteamLibrary/steamapps/common/DARK SOULS REMASTERED/msg/ENGLISH/item.msgbnd.dcx"

Notes on Testing

The tests in the source look to a Dark Souls Remastered Directory. It should be alongside the build.zig and called "dsr".

• build.zig
• src/
  • root.zig
  • dcx.zig
• dsr/
  • chr/
  • msg/