You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: bulk_upload_cli/README.md
+20-8Lines changed: 20 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,7 @@ Find and connect support services on the [Help & Support](https://cloud.unity.co
20
20
- [Editing metadata in the csv file](#editing-metadata-in-the-csv-file)
21
21
- [Use an existing configuration file](#use-an-existing-configuration-file)
22
22
- [Fine-tune the asset creation and upload](#fine-tune-the-asset-creation-and-upload)
23
+
- [Use keybindings](#use-keybindings)
23
24
-[Troubleshoot](#troubleshoot)
24
25
-[See also](#see-also)
25
26
-[Tell us what you think](#tell-us-what-you-think)
@@ -62,27 +63,31 @@ The bulk upload sample script is provided under the [Unity ToS license](../LICEN
62
63
* On Mac: `python3 bulk_cli.py --create`
63
64
* On Windows: `python bulk_cli.py --create`
64
65
66
+
### Select an action
67
+
68
+
Select one of the two possible actions:
69
+
70
+
-**Upload local assets**: Select this option to upload assets from your local machine to the cloud. See the [Select the input method](#select-the-input-method) section for more information.
71
+
-**Update assets' metadata**: Select this option to update the metadata of assets in the cloud. See the [Creating a csv from a Unity Cloud project](#creating-a-csv-from-a-unity-cloud-project) section for more information.
65
72
### Select the input method
66
73
67
-
Select one of the three strategies as the input method for bulk asset creation:
74
+
Select one of the four strategies as the input method for bulk asset creation:
68
75
69
-
-**listed in a casv respecting the CLI tool template**: Select this option if you built a CSV listing your assets location and details using the provided template.
76
+
-**listed in a csv respecting the CLI tool template**: Select this option if you built a CSV listing your assets location and details using the provided template.
70
77
* Provide the path to the csv file.
71
78
-**in a .unitypackage file**: Select this option if your assets are in a .unitypackage file. The tool extracts the assets from the .unitypackage file and uploads them to the cloud.
72
79
* Provide the path to the .unitypackage file.
73
80
-**in a local unity project**: Select this option if your assets are in a local Unity project.
74
81
* Provide the path to the asset folder of the Unity project.
75
-
-**in UnityCloud**: Select this option if your assets are in a Unity Cloud project.
76
-
* Provide the organization ID and project ID. As of now, this features is solely to update tags and metadata of assets in the cloud. See section [Creating a csv from a Unity Cloud project](#creating-a-csv-from-a-unity-cloud-project) for more information.
77
82
-**in a folder**: Select this option if your assets are in a folder on your local machine.
78
83
* Chose the grouping strategy for the assets:
79
84
- group files by name: Select this option if your assets are following a naming convention, for example, blueasset.fbx, blueasset.png.
80
85

81
86
- group files by folder: Select this option if your assets are organized by folder, that is, all relevant files are in distinct folders.
82
87

83
88
- one file = one asset: Select this option if no grouping is necessary. Each file in the asset folder and its subfolders is created as an asset.
84
-
- Confirm if you want automatic preview detection:
85
-
- If you said yes: any picture file with the suffix `_preview` will be associated to the file of the same name as a preview.
89
+
- Confirm if you want automatic preview detection:
90
+
- If you said yes: any picture file with the suffix `_preview` will be associated to the file of the same name as a preview.
86
91
87
92
### Validation step
88
93
@@ -104,7 +109,7 @@ To manage and customize the upload of assets, create an upload plan as follows:
104
109
105
110
To create a .csv file from a Unity Cloud project, follow these steps:
106
111
1. Run the CLI tool with the `--create` flag.
107
-
2. When prompted to chose where the assets are located, select `in Unity Cloud`.
112
+
2. When prompted to chose an action, select `Update assets' metadata`.
108
113
3. Answer the next questions normally.
109
114
> **Note**: The files won't be downloaded nor will they appear in the .csv file. Using the `Unity Cloud` assets source will only allow you to update assets tags and metadata.
110
115
> **Note**: The collection won't appear in the csv as this is a known limitation at the moment. You can still edit this colum in the csv file to update the collection of the assets.
@@ -131,11 +136,18 @@ To use an existing configuration file, follow these steps:
131
136
132
137
With the `app_settings.json` file, you can fine-tune the amount of assets created and uploaded in parallel. Depending on your network, the number of assets, and the size of the assets, you can adjust the following settings:
133
138
-`parallelCreationEdit`: The number of assets created and updated in parallel. This settings can be kept high as it is not resource intensive.
134
-
-`parallelAssetUpload`: The number of assets that will have their files uploaded in parallel. This setting should be adjusted depending on the size of the assets and the network speed. When dealing with large files (>100MB), it is recommended to keep this setting low (1-2) to avoid time out.
139
+
-`parallelAssetUpload`: The number of assets that will have their files uploaded in parallel. This setting should be adjusted depending on the size of the assets and the network speed. When dealing with large files (>100MB), it is recommended to keep this setting low (3-4) to avoid time out.
135
140
-`parallelFileUploadPerAsset`: The number of files uploaded in parallel for each asset. This setting should be adjusted depending on the number of files and the network speed. It is recommended to adjust it according to `parallelAssetUpload`, as the total number of files uploaded in parallel will be `parallelAssetUpload * parallelFileUploadPerAsset`.
141
+
-`httpTimeout`: The time (in seconds) before the http client triggers a timeout exception. When handling very large files (> 1GB) or when on a slow connection, it might be necessary to raise this value.
136
142
137
143
In the `app_settings.json` file, you can also add environment variables that will be set at runtime. This is useful when running the CLI tool in a private network environment.
138
144
145
+
### Use keybindings
146
+
147
+
When used in interactive mode, the CLI tool provides keybindings to help you navigate the tool more efficiently. The keybindings are as follows:
148
+
-`Ctrl + Q`: Exit the tool.
149
+
-`Ctrl + Z`: Go back to the previous question.
150
+
139
151
## Troubleshoot
140
152
141
153
Here's a list of common problems you might encounter while using the CLI Tool.
0 commit comments