Class ZipDistro

Distro that creates ZIP files for each build.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
DistroBase
ZipDistro
UploadDistro
Inherited Members
Namespace: sttz.Trimmer.Editor
Assembly: Trimmer-Editor.dll
Syntax
[CreateAssetMenu(fileName = "Zip Distro.asset", menuName = "Trimmer/Zip", order = 100)]
public class ZipDistro : DistroBase
Remarks

Zip distro uses 7zip, which is bundled with the Unity editor. Supported formats are 7z, Bzip2 (Tar), Gzip (Tar), Uncompressed Tar, Wim, Xz (Tar) and Zip.

If the build directory contains multiple files, the archive will contain the build folder. However, if the build directory only contains a single file or directory, that file or directory will be put at the root of the archive (e.g. macOS app bundles).

.DS_Store, Thumbs.db, desktop.ini and build.json files are ignored.

The prettyNames field allows to configure different archive file names per platform. If the archive includes the build directory, the name will also be applied to the archive's root directory.

Fields

| Improve this Doc View Source

appendVersion

Append the version number to the ZIP file name.

Declaration
public bool appendVersion
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

compression

The compression level used when creating the archives.

Declaration
public ZipDistro.CompressionLevel compression
Field Value
Type Description
ZipDistro.CompressionLevel
| Improve this Doc View Source

format

The compression format of the resulting archives.

Declaration
public ZipDistro.CompressionFormat format
Field Value
Type Description
ZipDistro.CompressionFormat
| Improve this Doc View Source

prettyNames

Define nicer names to use per-platform. The name will be used for the archive file as well as the root folder in the zip (if any).

Declaration
public ZipDistro.PrettyName[] prettyNames
Field Value
Type Description
ZipDistro.PrettyName[]

Methods

| Improve this Doc View Source

DistributeCoroutine(IEnumerable<DistroBase.BuildPath>, Boolean)

Declaration
protected override IEnumerator DistributeCoroutine(IEnumerable<DistroBase.BuildPath> buildPaths, bool forceBuild)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<DistroBase.BuildPath> buildPaths
System.Boolean forceBuild
Returns
Type Description
System.Collections.IEnumerator
Overrides
| Improve this Doc View Source

Get7ZipPath()

Declaration
protected string Get7ZipPath()
Returns
Type Description
System.String
| Improve this Doc View Source

GetPrettyName(BuildTarget)

Declaration
protected string GetPrettyName(BuildTarget target)
Parameters
Type Name Description
UnityEditor.BuildTarget target
Returns
Type Description
System.String
| Improve this Doc View Source

RenameRoot(String, String, String)

Declaration
protected IEnumerator RenameRoot(string archivePath, string oldName, string newName)
Parameters
Type Name Description
System.String archivePath
System.String oldName
System.String newName
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

Zip(DistroBase.BuildPath)

Declaration
protected IEnumerator Zip(DistroBase.BuildPath buildPath)
Parameters
Type Name Description
DistroBase.BuildPath buildPath
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

ZipBuilds(IEnumerable<DistroBase.BuildPath>)

Declaration
protected IEnumerator ZipBuilds(IEnumerable<DistroBase.BuildPath> buildPaths)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<DistroBase.BuildPath> buildPaths
Returns
Type Description
System.Collections.IEnumerator