unzip

The unzip namespace extracts compressed archives using Windows’ built-in tar.exe utility.

Blocks Game Frame

Archive extraction is a synchronous operation that blocks the calling frame until decompression finishes or a 10-second timeout expires. Run extraction from a button click or initialization sequence, never inside render or createmove.

---

Functions

Function	Parameters	Returns	Description
unzip.extract	archive_path: string, destination: string	boolean	Extracts full archive into destination directory.
unzip.unzip_file	directory: string, destination: string, filename: string	boolean	Extracts a single named file from an archive.

---

Example

local archive = "aimsense/scripts/data/assets.zip"
local output_dir = "aimsense/scripts/data/assets"

if files.exists(archive) then
    local ok = unzip.extract(archive, output_dir)
    if ok then
        print("Assets extracted successfully!")
    else
        print("Failed to extract assets archive.")
    end
end