https://github.com/abdelfattahradwan/cup

Create Unity Package (cup) is a command-line app that allows you to create Unity packages from the command line without installing Unity.
https://github.com/abdelfattahradwan/cup

csharp packaging unity unity3d

Last synced: about 1 year ago
JSON representation

Create Unity Package (cup) is a command-line app that allows you to create Unity packages from the command line without installing Unity.

• Host: GitHub
• URL: https://github.com/abdelfattahradwan/cup
• Owner: abdelfattahradwan
• License: mit
• Created: 2022-03-29T20:12:33.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-10T01:34:20.000Z (over 1 year ago)
• Last Synced: 2025-01-10T02:31:08.006Z (over 1 year ago)
• Topics: csharp, packaging, unity, unity3d
• Language: C#
• Homepage:
• Size: 30.3 KB
• Stars: 18
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Create Unity Package (cup)

Create Unity Package (cup) is a command-line app that allows you to create Unity packages from the command line without

installing Unity.

## Features

- Fast and efficient packing process

- Create packages without installing Unity

- Ignore files and folders automatically

- Create packages with different compression levels

## Arguments

    

        Argument

        Description

    

    

        -s, --src

        Root directory path.

    

    

        -o, --out

        Output package file path.

    

    

        -c, --cpr

        Level of compression. (0 = Optimal, 1 = Fastest, 2 = None, 3 = Smallest)

    

    

        -e, --exclude

        List of file/directory paths to ignore.

    

    

        --help

        Display this help screen.

    

    

        --version

        Display version information.

    

## Ignoring Files/Folders

You can ignore certain files/folders by creating a `.cupignore` file at the *root directory path* that you specify.

The `.cupignore` must contain only a single `JSON` array with glob patterns to ignore.

```json

[

  "**/Editor/*",

  "**/Tests/*",

  "**/Examples/*",

  "**/*.tmp",

  "Assets/Scripts/Debug/**/*"

]

```

If the file contains anything else, an exception is thrown.

## Downloads

Two different binaries are available for download:

- A self-contained binary that ***does not*** require .NET to be installed.

- A framework-dependent binary that ***requires .NET*** to be installed.

NOTE: The framework-dependent binary requires at least ***.NET 9*** to be installed.

## Help the Project

If you find this project useful, consider supporting it by buying me a coffee:

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Q5Q361YW5)

Your support is appreciated. Thank you!