Batch download tool for pooled accounts
For teams and enterprise users who work offline or have a need to have access to the library assets outside of the web platform or the Creative Cloud Desktop app integration, we are currently testing a batch download tool with a few users.
If you need access to it, please reach out to the person handling your account at Adobe.
This guide is aimed at helping Teams and Enterprise users with access to the batch download tool to start using it.
The batch download tool is a technical command line tool.
There are builds available for PC, Mac and Mac M1.
Configuration
The CLI allows for user configuration such as download or token directory, local HTTP server port, ...The configuration file is initialized when the CLI is used for the first time and is located at $SBS3D_ASSETS_CONFIG_DIR/config.ini (default: ".config/config.ini").
| PROPERTY | DESCRIPTION | DEFAULT VALUE |
|---|---|---|
server_port | Local HTTP server port (only used during login). | 8080 |
token_dir | Directory to save the token obtained after successful login. | .token |
no_purchase_prompt | Whether to skip user confirmation before purchase or not. | false |
download_dir | Directory to put the downloaded assets in. | ./substance3d_assets |
download_concurrency | Number of concurrent downloads (range 1-10). | 2 |
on_behalf_of | ID of the organization to purchase assets on behalf of; keep empty for "Personal account". |
Usage
login
Login with your Adobe account
| ARGUMENT | DESCRIPTION | DEFAULT VALUE |
|---|---|---|
--id | Adobe ID (email address) used to login. |
logout
Logout from your Adobe account. Removes any cached access token.
select-account
Select the Adobe account on behalf of which assets purchases and downloads will be done (login required).
account
Display basic Adobe profile and Substance 3D Assets entitlement information (login required).
download
Purchase and download Substance 3D Assets files (login required).
This command will be useful when you want to download or license+download assets.It will allow you to download asset files and license them if they are not yet licensed on your account,but it will not use more download points if you already have a license for the assets you are downloading.
| ARGUMENT | DESCRIPTION | DEFAULT VALUE |
|---|---|---|
--download-dir | Directory to put the downloaded files in. Using this flag overrides the value of download_dir set in configuration file. | $CLI_DIR/substance3d_assets |
--no-prompt | Skip user confirmation before purchasing assets. Using this flag overrides the value of no_purchase_prompt set in configuration file. Values: [true, false] Example:
| false |
--skip-existing | Skip assets that already exist in the destination path.Uncompleted downloads are also skipped. Values: [true, false] Example:
| false |
--owned | Download assets that are already licensed only. Values: [true, false] Example:
| false |
--categories | Download assets by categories (comma separated). Example: Download all assets from categories "Ground" and "Concrete - Asphalt": | |
--types | Download assets by types (comma separated). Values:
Example: Download all Substance Materials and Decals: | |
--format | Download assets by file format. Values:
Example: Download all SBSAR files: | |
--from | Download assets published after specified date. Values:
Example: Download all assets published after January 15th, 2022: | |
--to | Download assets published before specified date. Values:
Example: Download all assets published before April 13th, 2022: |
purchase
Purchase Substance 3D Assets files (login required).
This command will be useful when you want to license assets, but not download them at the moment.
The assets you purchase will be licensed on your account. You will find them in “my assets” on the 3D Assets website, and if you download them again in the future it will not use more download points.
| ARGUMENT | DESCRIPTION | DEFAULT VALUE |
|---|---|---|
--no-prompt | Skip user confirmation before purchasing assets. Values:
Example:
| false |
--categories | Download assets by categories (comma separated). Example: Download all assets from categories "Ground" and "Concrete - Asphalt": | |
--types | Download assets by types (comma separated). Values:
Example: Download all Substance Materials and Decals: | |
--format | Download assets by file format. Values:
Example: Download all SBSAR files: | |
--from | Download assets published after specified date. Values:
Example: Download all assets published after January 15th, 2022: | |
--to | Download assets published before specified date. Values:
Example: Download all assets published before April 13th, 2022: |