ZipIt Documentation

1. Getting started

ZipIt is separated into 3 parts:

For C++, don't forget to include ZipIt to your project's module include list in <Project>.Build.cs:

PrivateDependencyModuleNames.AddRange(new string[] { "ZipIt" });

2. Blueprints

2.1. Zipping

2.1.1. Zipping a directory

To zip a directory, we can use the helper node to do it in a single node:

2.1.2. Zipping files from different locations

A node to zip several files from different locations into a single zip archive exists:

2.2. Unzipping

To unzip a file, use the Unzip Zip Archive node:

3. C++

3.1. Zipping

3.1.1. Zipping a directory

Using ZipLibrary, we can easily zip a whole directory into a single archive:

// Don't forget to #include "ZipLibrary.h"

// The delegate to react to events.
FOnFilesZipped OnFilesZipped;
FOnFileZipped  OnFileZipped;

// Lambda as an example, you can bind a UObject's method with
// OnFilesZipped.AddUObject(Obj, &UMyClass:Func);
OnFilesZipped.AddLambda([](const bool bSuccess, const int64 NumberOfFilesZipped) -> void
{
    if (bSuccess)
    {
        // "NumberOfFilesZipped" files have been zipped.
    }
    else
    {
        // An error occurred.
    }
});

// Lambda as an example, you can bind a UObject's method with
// OnFileZipped.AddUObject(Obj, &UMyClass:Func);
OnFileZipped.AddLambda([](const FString& ArchivePath, const FString& FilePath, const int64 FilesZippedCount, const int64 TotalFilesCount) -> void
{
    // We just zipped the file "FilePath" to "ArchivePath" in the archive.
    // And "FilesZippedCount" / "TotalFilesCount" have been zipped.
});

// Launch the zip task.
UZipLibrary::ZipDirectory
(
    TEXT("./MyDir/"),            // Directory to zip.
    TEXT("./Result/Zipped.zip"), // Resulting .zip archive.
    TEXT("ZipPassword"),         // Archive password
    EZipCompressLevel::Level9,   // Compression level, 9 is max.
    EZipCreationFlag::Overwrite, // Overwrite existing files.
    OnFilesZipped,               // Delegate binded before.
    OnFileZipped                 // Delegate binded before.
);

3.1.2. Zipping files and folder from different locations

To do it, we use directly the UZipper class:

// Don't forget to #include "Zipper.h".

// Create a new zipper.
UZipper* const Zipper = UZipper::CreateZipper();

// We add the files we want here, it just registers the file
// for when we will zip the archive. No check is done.
Zipper->AddFile(TEXT("C:/Dir/apache_start.bat"), TEXT("start.bat"));
Zipper->AddFile(TEXT("./SomeDir/uninstall.dat"), TEXT("Folder/uninstall.dat"));

// We add the directories to include in the zip archive.
// The directory is just registered, this method is cheap.
Zipper->AddDirectory(TEXT("C:/Test/"));
Zipper->AddDirectory(TEXT("./OtherDir/Dir/"));

// Delegate called when all files have been zipped or when an error occured.
Zipper->OnFilesZipped().AddLambda([](const bool bSuccess, const int64 NumberOfFilesZipped) -> void
{
    if (bSuccess)
    {
        // Files zipped
    }
    else
    {
        // Error, see output log.
    }
});

// Called just after a file has been zipped.
Zipper->OnFileZipped().AddLambda([](const FString& ArchivePath, const FString& DiskPath, const int64 FilesZipped, const int64 TotalFilesToZip) -> void
{
    // File "DiskPath" has been zipped.
    // Remaining "FilesZipped" / "TotalFilesToZip" files to zip.
});

// Launch the zip task.
Zipper->ZipAsync(TEXT("./SomeDir/Zipped.zip"), TEXT("Password"));

3.2. Unzipping

// Don't forget to #include "ZipLibrary.h".

// The delegates to handle events.
FOnFilesUnzipped OnFilesUnzipped;
FOnFileUnzipped  OnFileUnzipped;

// Lambda as an example, you can bind a UObject's method with
// OnFilesUnzipped.AddUObject(Obj, &UMyClass:Func);
OnFilesUnzipped.AddLambda([](const bool bSuccess, const int64 NumberOfFilesUnzipped) -> void
{
    if (bSuccess)
    {
        // "NumberOfFilesUnzipped" files have been unzipped.
    }
    else
    {
        // An error occurred.
    }
});

// Lambda as an example, you can bind a UObject's method with
// OnFileUnzipped.AddUObject(Obj, &UMyClass:Func);
OnFileUnzipped.AddLambda([](const FString& ArchivePath, const FString& FilePath, const int64 FilesUnzippedCount, const int64 TotalFilesCount) -> void
{
    // We just unzipped the file "FilePath" to "ArchivePath" in the archive.
    // And "FilesUnzippedCount" / "TotalFilesCount" have been unzipped.
});

// Launch the unzipping task.
UZipLibrary::UnzipArchive
(
    TEXT("./Archive.zip"), // The archive we want to unzip.
    TEXT("./ZipResult/"),  // Where we want to unzip it.
    TEXT("MyPassword"),    // The archive's password.
    true /* bOverwrite */, // If we want to overwrite conflicting files.
    OnFilesUnzipped,       // Delegate binded before.
    OnFileUnzipped         // Delegate binded before.
);

4. Support