ThemModdingHerds.GFS 2.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ThemModdingHerds.GFS --version 2.1.0                
NuGet\Install-Package ThemModdingHerds.GFS -Version 2.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ThemModdingHerds.GFS" Version="2.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ThemModdingHerds.GFS --version 2.1.0                
#r "nuget: ThemModdingHerds.GFS, 2.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ThemModdingHerds.GFS as a Cake Addin
#addin nuget:?package=ThemModdingHerds.GFS&version=2.1.0

// Install ThemModdingHerds.GFS as a Cake Tool
#tool nuget:?package=ThemModdingHerds.GFS&version=2.1.0                

Reverge Package File

Reverge Package File (.gfs) parser library for C#

Structure

Everything is Big Endian

struct Pascal64String
{
    size_t length;
    char chars[length];
};

struct Header
{
    uint dataOffset;
    Pascal64String identifier;
    Pascal64String version;
    size_t entryCount;
};

struct Entry
{
    Pascal64String path;
    size_t size;
    int alignment;
};

Header header;
Entry entries[header.entryCount];

Calculate Data Offset

size_t runningOffset = header.dataOffset;

for(size_t i = 0;i < header.entryCount;i++)
{
    Entry entry = entries[i];
    runningOffset += (entry.alignment - (runningOffset % entry.size)) % entry.alignment
    // runningOffset is the position of the data from entries[i]
    runningOffset += entry.size;
}

Usage

For reading:

using ThemModdingHerds.GFS;
using ThemModdingHerds.IO;

BinaryReader reader = new BinaryReader(someStreamOrFilePath);
RevergePackage file = reader.ReadRevergePackage(); // extends List<RevergePackageEntry>
RevergePackageHeader header = file.Header; // contains file count, offset, version and file identifier
RevergePackageEntry entry = file[index]; // contains all the files and their data

or parsing a folder into one:

using ThemModdingHerds.GFS;

GFSFile file = GFSFile.Read(pathToFolder); // now the folder became a .gfs file

Credits

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.1 256 11/10/2024
2.1.0 81 11/10/2024
2.0.0 77 11/9/2024
1.2.0 129 2/19/2024
1.1.1 126 2/12/2024
1.1.0 156 12/25/2023
1.0.3 147 12/20/2023
1.0.2 150 12/20/2023 1.0.2 is deprecated because it has critical bugs.
1.0.1 136 12/19/2023
1.0.0 126 12/18/2023