{"id":26404679,"url":"https://github.com/blitz-krieg-cmd/soulib","last_synced_at":"2025-09-06T02:35:49.106Z","repository":{"id":282815159,"uuid":"949646455","full_name":"blitz-krieg-cmd/soulib","owner":"blitz-krieg-cmd","description":"Souls Lib - Zig library for Reading and Writing Dark Souls Remastered files.","archived":false,"fork":false,"pushed_at":"2025-03-25T19:17:16.000Z","size":72,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-21T12:35:35.961Z","etag":null,"topics":["fromsoftware","parser","zig","zig-package","ziglang"],"latest_commit_sha":null,"homepage":"","language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blitz-krieg-cmd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-16T22:35:29.000Z","updated_at":"2025-03-25T19:17:19.000Z","dependencies_parsed_at":"2025-03-17T05:23:40.715Z","dependency_job_id":"d044f01a-b3af-4b6e-a329-487421bf176a","html_url":"https://github.com/blitz-krieg-cmd/soulib","commit_stats":null,"previous_names":["blitz-krieg-cmd/soulib"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/blitz-krieg-cmd/soulib","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blitz-krieg-cmd%2Fsoulib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blitz-krieg-cmd%2Fsoulib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blitz-krieg-cmd%2Fsoulib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blitz-krieg-cmd%2Fsoulib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blitz-krieg-cmd","download_url":"https://codeload.github.com/blitz-krieg-cmd/soulib/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blitz-krieg-cmd%2Fsoulib/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270295838,"owners_count":24560351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fromsoftware","parser","zig","zig-package","ziglang"],"created_at":"2025-03-17T16:38:36.879Z","updated_at":"2025-08-13T19:07:13.161Z","avatar_url":"https://github.com/blitz-krieg-cmd.png","language":"Zig","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Souls Lib (Soulib)\n\n\u003e 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.\n\n## Goals\n\n- Zig Library\n- C ABI Library from Zig\n- All recent common fromsoft formats (excluding older titles. anything prior ds1-ptde)\n\n## Design of the library\n\nRough summary of using the library:\n\n- Open file using it's path.\n- Read all bytes from file.\n- Pass file bytes to library and parse.\n\n## Example Usage\n\n```zig\nconst std = @import(\"std\");\n// Import the library.\nconst soulib = @import(\"soulib\");\n\npub fn main() !void {\n    // Define the allocator to use.\n    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);\n    defer arena.deinit();\n    const allocator = arena.allocator();\n\n    // Define the file to parse over.\n    const path = \"path/to/dcx/file.dcx\";\n    var file = std.fs.openFileAbsolute(\n        path,\n        .{ .mode = .read_only },\n    ) catch unreachable;\n    defer file.close();\n\n    // Read the bytes from the file.\n    const fileBytes = try file.readToEndAlloc(allocator, try file.getEndPos());\n\n    // Parse the file.\n    const dcx = try soulib.DCX.read(\n        allocator,\n        fileBytes,\n    );\n    \n    // Use the parsed data.\n    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}\", .{\n        dcx.header.dcx,\n        dcx.header.format,\n        dcx.header.compressedSize,\n        dcx.header.uncompressedSize,\n        dcx.data.len,\n        dcx.data[0..32],\n    });\n}\n```\n\n## Formats\n\nBasic descriptions are provided below. Checkmarks show library progress on file type.\n\nState | Format | Extension | Description\n------ | ------ | --------- | -----------\n✏️ |  DCX | .dcx | A simple wrapper for a single compressed file\n✏️ |  TPF | .tpf | A container for platform-specific texture data\n❌ |  BND3 | .\\*bnd | A general-purpose file container used before DS2\n❌ |  BHD5 | .bhd, .bhd5 | The header file for the large primary file archives used by most games\n❌ |  BTAB | .btab | Controls lightmap atlasing\n❌ |  BTL | .btl | Configures point light sources\n❌ |  BTPB | .btpb | Contains baked light probes for a map\n❌ |  BXF3 | .\\*bhd + .\\*bdt | Equivalent to BND3 but with a separate header and data file\n❌ |  CCM | .ccm | Determines font layout and texture mapping\n❌ |  CLM2 | .clm | A FLVER companion format that has something to do with cloth\n❌ |  DRB | .drb | Controls GUI layout and styling\n❌ |  EDD | .edd | An ESD companion format that gives friendly names for various elements\n❌ |  EMELD | .eld, .emeld | Stores friendly names for EMEVD events\n❌ |  EMEVD | .evd, .emevd | Event scripts\n❌ |  ENFL | .entryfilelist | Specifies assets to preload when going through a load screen\n❌ |  ESD | .esd | Defines a set of state machines used to control characters, menus, dialog, and/or map events\n❌ |  F2TR | .flver2tri | A FLVER companion format that links the vertices to the FaceGen system\n❌ |  FLVER | .flv, .flver | FromSoftware's standard 3D model format\n❌ |  FMG | .fmg | A collection of strings with corresponding IDs used for most game text\n❌ |  GPARAM | .fltparam, .gparam | A generic graphics configuration format\n❌ |  GRASS | .grass | Specifies meshes for grass to be dynamically placed on\n❌ |  LUAGNL | .luagnl | A list of global variable names for Lua scripts\n❌ |  LUAINFO | .luainfo | Information about AI goals for Lua scripts\n❌ |  MCG | .mcg | A high-level navigation format used in DeS and DS1\n❌ |  MCP | .mcp | Another high-level navigation format used in DeS and DS1\n❌ |  MSB | .msb | The main map format, listing all enemies, collisions, trigger volumes, etc\n❌ |  MTD | .mtd | Defines some material and shader properties; referenced by FLVER materials\n❌ |  NVM | .nvm | The navmesh format used in DeS and DS1\n❌ |  PARAM | .param | A generic configuration format\n❌ |  PARAMDEF | .def, .paramdef | A companion format that specifies the format of data in a param\n❌ |  PARAMTDF | .tdf | A companion format that provides friendly names for enumerated types in params\n❌ |  RMB | .rmb | Controller rumble effects for all games\n\n## Examples Building\n\n\u003e To run examples:  \n`zig build read_dcx -Dtarget=x86_64-windows -- \"E:/SteamLibrary/steamapps/common/DARK SOULS REMASTERED/msg/ENGLISH/item.msgbnd.dcx\"`\n\n## Notes on Testing\n\nThe tests in the source look to a Dark Souls Remastered Directory. It should be alongside the build.zig and called \"dsr\".\n\n- build.zig\n- src/\n  - root.zig\n  - dcx.zig\n- dsr/\n  - chr/\n  - msg/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblitz-krieg-cmd%2Fsoulib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblitz-krieg-cmd%2Fsoulib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblitz-krieg-cmd%2Fsoulib/lists"}