# Latest official docs
- [English](https://docs.unity3d.com/Packages/com.unity.sharp-zip-lib@latest)

[![](https://badge-proxy.cds.internal.unity3d.com/78081939-b2a0-4fc9-bebf-901b49fd954c)](https://badges.cds.internal.unity3d.com/packages/com.unity.sharp-zip-lib/build-info?branch=master&testWorkflow=package-isolation)
[![](https://badge-proxy.cds.internal.unity3d.com/faf61743-4d21-479c-b01c-ab63561e27d9)](https://badges.cds.internal.unity3d.com/packages/com.unity.sharp-zip-lib/dependencies-info?branch=master&testWorkflow=updated-dependencies)
[![](https://badge-proxy.cds.internal.unity3d.com/e5917bce-0357-4f49-a9c3-c356b9de832c)](https://badges.cds.internal.unity3d.com/packages/com.unity.sharp-zip-lib/dependants-info)
[![](https://badge-proxy.cds.internal.unity3d.com/f2066c51-3423-424d-a58f-24a64683cf57)](https://badges.cds.internal.unity3d.com/packages/com.unity.sharp-zip-lib/warnings-info?branch=master)
# com.unity.sharp-zip-lib

`com.unity.sharp-zip-lib` is a package that wraps [SharpZipLib](https://github.com/icsharpcode/SharpZipLib) to be used inside Unity,
and provides various compression/uncompression utility functions.

Currently, this package uses [SharpZipLib v1.3.3](https://github.com/icsharpcode/SharpZipLib/releases/tag/v1.3.3).
Please refer to the [installation](Documentation~/Installation.md) page to install this package.

> The version numbering of this package itself and the version of SharpZipLib used in the package may look similar,
but they are not related.


## How to Use

* All [SharpZipLib](https://github.com/icsharpcode/SharpZipLib) APIs are available under `Unity.SharpZipLib` namespace. For example:
  ```csharp
    using System.IO;
    using Unity.SharpZipLib.GZip;

    ...

    public void UseSharpZipLibAPIs() {
        MemoryStream ms = new MemoryStream();
        GZipOutputStream outStream = new GZipOutputStream(ms);
        ...
    }
  ```

  Please refer to the API documentation of the [SharpZipLib](https://github.com/icsharpcode/SharpZipLib) version used
  in this package for more details.

* In addition, `com.unity.sharp-zip-lib` also provides additional utility APIs:
  * `ZipUtility.CompressFolderToZip()`: Creates a zip file on disk containing the contents of the nominated folder.
  * `ZipUtility.UncompressFromZip()`: Uncompress the contents of a zip file into the specified folder.

  As an example:
  ```csharp
  static void CompressAndUncompress() {
      //Compress
      string folderToCompress = "Assets";
      string zipPath = Path.Combine(Application.temporaryCachePath, "UnityAssets.zip");
      ZipUtility.CompressFolderToZip(zipPath,null, folderToCompress);
      Debug.Log($"{folderToCompress} folder compressed to: " + zipPath);

      //Uncompress
      string extractPath = Path.Combine(Application.temporaryCachePath, "UnityAssetsExtracted");
      ZipUtility.UncompressFromZip(zipPath, null, extractPath);
      Debug.Log($"Uncompressed to: " + extractPath);
  }
  ```


## Supported Unity Versions

* Unity `2021.3.45` or higher.
## Steps to update SharpZipLib

### Windows

#### Environment Prerequisites
1. Visual Studio 2022 (17.19.1) or later
   * Check ".Net desktop development" during the installation of Visual Studio
2. Make sure that .Net SDK 8.0 is installed as follows:
   * Open "Developer Command Prompt for VS 2022"
   * Type: `dotnet --list-sdks`

#### Steps

1. Download the source from https://github.com/icsharpcode/SharpZipLib/releases
1. Extract the source into a folder, e.g:  `Src/SharpZipLib-1.3.3`
1. Open "Developer Command Prompt for VS 2022"
   1. Execute `update_sharp-zip-lib.cmd [src_folder]`
      * E.g: `update_sharp-zip-lib.cmd Src/SharpZipLib-1.3.3`
      * Executing `update_sharp-zip-lib.cmd` without arguments will print the list of acceptable arguments
1. Open SharpZipLib~ test project, ensure everything compiles and the tests are successful.
   * We may need to fix/remove some tests that were copied from the source.
     For example: [async tests](https://docs.unity3d.com/Packages/com.unity.test-framework@1.4/manual/reference-async-tests.html)
     which are not supported in Unity 2018 and earlier.
1. Open a shell / Git Bash / terminal
   1. Execute `sh Scripts~/clean_up_cs.sh` to clean up cs source code.



*Auto-generated on Thu Dec 19 08:01:25 UTC 2024*