docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    com.unity.sharp-zip-lib

    com.unity.sharp-zip-lib is a package that wraps SharpZipLib to be used inside Unity, and provides various compression/uncompression utility functions.

    Currently, this package uses SharpZipLib v1.4.2. Please refer to the installation 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 APIs are available under Unity.SharpZipLib namespace. For example:

        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 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:

      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 2022.3.62 or higher.
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)