[Open-Source] SlimPK2 - A Pk2 framework written in c#

[torstmn]

Hey guys,
has been long since a new release but here we go:

A complete (read/write elements) PK2 integration for the .NET framework.

First of all, please do not ask stupid questions!
This project is open source and if you have any questions please check the source-code on github (link below).

The whole code is documented and should be easy to understand.

Quick guide


General information

SlimPK2 supports 3 modes to work with a .pk2 file archive:

Index - Will create a special index of files, to get access to path variables (Less efficient but easy to use)
BlockIndex - Will create an index "as-is" without special classes for files/directories.
FreeBrowse - Will not create any index at all. You can now use PK2Archive.GetNavigator() to navigate through the archive. (fastest)

How to
You can initialize a new PK2 archive using the following code:

var PK2 = new PK2Archive("myPath", PK2Config.GetDefault());

Feel free to check out the PK2Config.cs class. This class alows you to provide more parameters such as "key", "mode" and "base key".

Using the navigator

As explained above, the PK2Navigator class (PK2Archive.GetNavigator()) allows you to freely browse the PK2 archive. That means, that only the root block is being loaded at the beginning to grant a default location. You can not access any PK2 index at all! The Navigator class has many functions that allow you to browse through the PK2.

Create new files

Use PK2Entry.Create() to create new items within the PK2.

Delete/rename files

The following example can also be used to delete/rename directories! PK2Archive.GetFile("path").Delete(); PK2Archive.GetDirectory("path").Rename("new name");

Known bugs

I did not test everything. It could be that it's not possible to create items in the root directory at the moment. If you find any other bugs feel free to create a pull request. I don't give you ANY support!

Link to the project:


Anyone who found a bug? Pull-request or did not happen.

[Stratti]

Hey,

I just checked your code and I think it's a really cool project, great implementation and well-documented.

I am just curious about one thing, is there any reason why you used the singleton-pattern? I personally don't like it. This way it's not possible to open
multiple archives at the "same time" (well actually you can but it will lead to unexpected results). You have to dispose an instance before you create another.
Imagine two different classes which both have an instance to the PK2Archive class (probably even in a multi-threaded Enviromnment), now things get really tricky.

Anyways, thank your for this release

Stratti

[KingDollar]

nice release